Node Updated Event - Alfresco Content Services - 23.4 - 23.4 - Ready - Alfresco - external

SDK5 - Plain Java

The following code shows how this can be done with SDK 5 and plain Java event handlers:

package org.alfresco.tutorial.events;

import org.alfresco.event.sdk.handling.filter.EventFilter;
import org.alfresco.event.sdk.handling.filter.IsFileFilter;
import org.alfresco.event.sdk.handling.handler.OnNodeUpdatedEventHandler;
import org.alfresco.event.sdk.model.v1.model.DataAttributes;
import org.alfresco.event.sdk.model.v1.model.NodeResource;
import org.alfresco.event.sdk.model.v1.model.RepoEvent;
import org.alfresco.event.sdk.model.v1.model.Resource;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.stereotype.Component;


/**
 * Sample event handler to demonstrate reacting to a document/file being updated.
 */
@Component
public class ContentUpdatedEventHandler implements OnNodeUpdatedEventHandler {
    private static final Logger LOGGER = LoggerFactory.getLogger(ContentUploadedEventHandler.class);

    public void handleEvent(final RepoEvent<DataAttributes<Resource>> repoEvent) {
        NodeResource beforeUpdateResource = (NodeResource) repoEvent.getData().getResourceBefore();
        NodeResource afterUpdateResource = (NodeResource) repoEvent.getData().getResource();
        LOGGER.info("A file was updated in the repository: {}, {}, {}", afterUpdateResource.getId(), 
                afterUpdateResource.getNodeType(), afterUpdateResource.getName());
    }

    public EventFilter getEventFilter() {
        return IsFileFilter.get() // Make sure it's a file
                .and(ParentFolderFilter.of("5f355d16-f824-4173-bf4b-b1ec37ef5549")); // Located in the /Company Home/Testing/Inbound folder
    }
}

Note that you can get to the property values before the update via the repoEvent.getData().getResourceBefore() call. You can compare those to the values retreived via repoEvent.getData().getResource() and see what’s changed.

This code uses a custom ParentFolderFilter. For more information on a parent folder filter, see Software Development Kits (SDK).

For more information about how to extract all the properties from the message payload see the NodeResource object information available at Software Development Kits (SDK).

To create an SDK event handler project that uses Spring Integration follow the instructions on spring integration event handlers available at Software Development Kits (SDK).

SDK5 - Spring Integration

The following code shows how this can be done with SDK 5 and Spring Integration event handlers:

package org.alfresco.tutorial.events;

import org.alfresco.event.sdk.handling.filter.EventTypeFilter;
import org.alfresco.event.sdk.handling.filter.IsFileFilter;
import org.alfresco.event.sdk.integration.EventChannels;
import org.alfresco.event.sdk.integration.filter.IntegrationEventFilter;
import org.alfresco.event.sdk.model.v1.model.DataAttributes;
import org.alfresco.event.sdk.model.v1.model.NodeResource;
import org.alfresco.event.sdk.model.v1.model.RepoEvent;
import org.alfresco.event.sdk.model.v1.model.Resource;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.integration.dsl.IntegrationFlowAdapter;
import org.springframework.integration.dsl.IntegrationFlowDefinition;
import org.springframework.messaging.Message;
import org.springframework.stereotype.Component;

/**
 * Spring Integration based event handler that will execute code when a file is updated
 */
@Component
public class UpdatedContentFlow extends IntegrationFlowAdapter {
    private static final Logger LOGGER = LoggerFactory.getLogger(UpdatedContentFlow.class);

    // Use builder to create an integration flow based on alfresco.events.main.channel event channel
    @Override
    protected IntegrationFlowDefinition<?> buildFlow() {
        return from(EventChannels.MAIN) // Listen to events coming from the Alfresco events channel
                .filter(IntegrationEventFilter.of(EventTypeFilter.NODE_UPDATED)) // Filter events and select only node updated events
                .filter(IntegrationEventFilter.of(IsFileFilter.get())) // Filter node and make sure it is a file node
                .filter(IntegrationEventFilter.of(ParentFolderFilter.of("5f355d16-f824-4173-bf4b-b1ec37ef5549"))) // Filter node and make sure we got correct parent folder ID (/Company Home/Testing/Inbound)
                .handle(t -> handleEvent(t)); // Handle event with a bit of logging
    }

    private void handleEvent(Message message) {
        RepoEvent<DataAttributes<Resource>> repoEvent = (RepoEvent<DataAttributes<Resource>>)message.getPayload();
        NodeResource beforeUpdateResource = (NodeResource) repoEvent.getData().getResourceBefore();
        NodeResource afterUpdateResource = (NodeResource) repoEvent.getData().getResource();

        LOGGER.info("File updated: Before update {}, after update {}", beforeUpdateResource.toString(),
                afterUpdateResource.toString());
    }
}

Note that you can get to the property values before the update via the repoEvent.getData().getResourceBefore() call. You can compare those to the values retreived via repoEvent.getData().getResource() and see what’s changed.

This code uses a custom ParentFolderFilter. For more information on a parent folder filter, see Software Development Kits (SDK).

For more information about how to extract all the properties from the message payload see the NodeResource object information available at Software Development Kits (SDK).

To create an SDK event handler project that uses Spring Integration follow the instructions on spring integration event handlers available at Software Development Kits (SDK).

Apache Camel

The following code snippet shows how this could be done with an Apache Camel route configuration:

public class SimpleRoute extends RouteBuilder {

    @Override
    public void configure() {
        from("amqpConnection:topic:alfresco.repo.event2")
            .id("UpdatedFileRoute")
            .log("${body}") // Log all incoming events on this topic, even those that we are not interested in
            .choice()
            .when() // When the following is true:
                // The event type is node updated
                .jsonpath("$[?(@.type=='org.alfresco.event.node.Updated' && " +
                // and the node that was updated is a file
                "@.data.resource.nodeType=='cm:content' && " +
                // and the file is located in the /Company Home/Testing/Inbound folder
                "'5f355d16-f824-4173-bf4b-b1ec37ef5549' in @.data.resource.primaryHierarchy[:1])]")
            // Unpack the data into JSON format
            .unmarshal("publicDataFormat")
            // Call a Spring Bean with the event data
            .bean("updatedEventHandlerImpl", "onReceive(*, COPY)")
            .end();
    }
}

The jsonpath expression uses several of the event data properties to filter out exactly the events we are interested in.

In this case a Spring Bean with ID updatedEventHandlerImpl is called at the end of the route from where you could make the necessary ReST API calls.