org.apache.sling.distribution.trigger.impl

Class AbstractJcrEventTrigger

java.lang.Object

org.apache.sling.distribution.trigger.impl.AbstractJcrEventTrigger

All Implemented Interfaces:

DistributionTrigger

Direct Known Subclasses:

JcrEventDistributionTrigger, PersistedJcrEventDistributionTrigger

public abstract class AbstractJcrEventTrigger
extends Object
implements DistributionTrigger

Abstract implementation of a DistributionTrigger that listens for 'safe' events and triggers a DistributionRequest from that.

Method Summary

Modifier and Type	Method and Description
void	disable()
void	enable()
protected abstract org.apache.sling.distribution.DistributionRequest	processEvent(javax.jcr.observation.Event event) process the received event and generates a distribution request
void	register(@NotNull DistributionRequestHandler requestHandler) register a request handler to be triggered and returns a corresponding registration id
void	unregister(@NotNull DistributionRequestHandler requestHandler) unregister the given handler, if existing

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

register

public void register(@NotNull
                     @NotNull DistributionRequestHandler requestHandler)
              throws DistributionException

Description copied from interface: DistributionTrigger

register a request handler to be triggered and returns a corresponding registration id

Specified by:

register in interface DistributionTrigger

Parameters:

requestHandler - handler

Throws:

DistributionException - if registration fails

unregister

public void unregister(@NotNull
                       @NotNull DistributionRequestHandler requestHandler)
                throws DistributionException

Description copied from interface: DistributionTrigger

unregister the given handler, if existing

Specified by:

unregister in interface DistributionTrigger

Parameters:

requestHandler - handler to unregister

Throws:

DistributionException - if any error happen

enable

public void enable()

disable

public void disable()

processEvent

protected abstract org.apache.sling.distribution.DistributionRequest processEvent(javax.jcr.observation.Event event)
                                                                           throws javax.jcr.RepositoryException

process the received event and generates a distribution request

Parameters:

event - an Event to be processed

Returns:

the DistributionRequest originated by processing the event, or null if no request could be generated

Throws:

javax.jcr.RepositoryException