public abstract class ObservationService extends java.lang.Object implements ExternalModificationListener
| Modifier and Type | Field and Description |
|---|---|
static int |
EXTERNAL
Mask flag used to identify events coming from outside of the Communiqu�
through some other messaging system such as JMS.
|
protected static int |
EXTERNAL_BIT
The bit numbmer for the
EXTERNAL flag. |
protected static int |
HIGHEST_BIT
The highest mask bit number defined.
|
static int |
INTERNAL
Mask flag used to identify events coming from within the Communiqu�
system.
|
protected static int |
INTERNAL_BIT
The bit numbmer for the
INTERNAL flag. |
static java.lang.String |
MSG_DISPATCHER_NAME
Name of the message dispatcher thread
|
static int |
SYNCHRON
Mask flag used to identify events which should be handled synchronously.
|
protected static int |
SYNCHRON_BIT
The bit numbmer for the
SYNCHRON flag. |
| Constructor and Description |
|---|
ObservationService() |
| Modifier and Type | Method and Description |
|---|---|
abstract void |
addListener(ModificationListener listener)
Registers the listener to receive internal
PageModification
events from the observation service. |
abstract void |
addListener(ModificationListener listener,
ContentPackage pkg)
Deprecated.
As of gumbaer, use
addListener(com.day.cq.contentbus.observation.ModificationListener) instead. The
semantics of the ModificationListener has been changed in
that the listener should itself check whether it is interested in
the modification events. To ease upgrade the
AbstractModificationListener and
com.day.cq.contentbus.observation.DefaultModificationListener classes are provided, which
provide some form of backwards compatibility. |
abstract void |
addListener(ModificationListener listener,
ContentPackage pkg,
int mask)
Deprecated.
As of gumbaer, use
addListener(com.day.cq.contentbus.observation.ModificationListener, int) instead. The
semantics of the ModificationListener has been changed in
that the listener should itself check whether it is interested in
the modification events. To ease upgrade the
com.day.cq.contentbus.observation.AbstractModificationListener and
com.day.cq.contentbus.observation.DefaultModificationListener classes are provided, which
provide some form of backwards compatibility. |
abstract void |
addListener(ModificationListener listener,
int mask)
Registers the listener to receive
PageModification events from
the observation service. |
abstract void |
externalPageModified(PageModification mod)
Called when a
PageModification is delivered through JMS. |
abstract java.lang.String |
getAudit(java.lang.String handle,
java.lang.Number max) |
abstract java.lang.String[] |
getExternalListeners() |
abstract java.lang.String[] |
getInternalListeners() |
abstract int |
getNumExternalListeners() |
abstract int |
getNumInternalListeners() |
abstract int |
getNumSynchronousListeners() |
abstract java.lang.String[] |
getSynchronousListeners() |
abstract void |
pageCreated(Ticket ticket,
java.lang.String handle,
UUID uuid,
java.lang.String csd,
java.lang.String above)
Deprecated.
|
abstract void |
pageCreated(Ticket ticket,
java.lang.String handle,
UUID uuid,
java.lang.String csd,
java.lang.String above,
int mask)
Deprecated.
|
abstract void |
pageCreated(Ticket ticket,
java.lang.String handle,
UUID uuid,
java.lang.String csd,
java.lang.String above,
int mask,
java.lang.Object userObject)
Invoked whenever a page is created.
|
abstract void |
pageCreated(Ticket ticket,
java.lang.String handle,
UUID uuid,
java.lang.String csd,
java.lang.String above,
java.lang.Object userObject)
Invoked whenever a page is created.
|
abstract void |
pageDeleted(Ticket ticket,
java.lang.String handle)
Deprecated.
as of gumbaer, use
pageDeleted(com.day.cq.contentbus.Ticket, java.lang.String, java.lang.Object)
instead. |
abstract void |
pageDeleted(Ticket ticket,
java.lang.String handle,
int mask)
Deprecated.
as of gumbaer, use
pageDeleted(com.day.cq.contentbus.Ticket, java.lang.String, int, java.lang.Object)
instead. |
abstract void |
pageDeleted(Ticket ticket,
java.lang.String handle,
int mask,
java.lang.Object userObject)
Invoked whenever a page is deleted.
|
abstract void |
pageDeleted(Ticket ticket,
java.lang.String handle,
java.lang.Object userObject)
Invoked whenever a page is deleted.
|
abstract void |
pageModified(Ticket ticket,
java.lang.String handle)
Deprecated.
as of gumbaer, use
pageModified(com.day.cq.contentbus.Ticket, java.lang.String, java.lang.Object)
instead. |
abstract void |
pageModified(Ticket ticket,
java.lang.String handle,
int mask)
Deprecated.
as of gumbaer, use
pageModified(com.day.cq.contentbus.Ticket, java.lang.String, int, java.lang.Object)
instead. |
abstract void |
pageModified(Ticket ticket,
java.lang.String handle,
int mask,
java.lang.Object userObject)
Invoked whenever a page is modified.
|
abstract void |
pageModified(Ticket ticket,
java.lang.String handle,
java.lang.Object userObject)
Invoked whenever a page is modified.
|
abstract void |
pageModified(Ticket ticket,
java.lang.String handle,
VersionId vid)
Deprecated.
as of gumbaer, use
pageModified(com.day.cq.contentbus.Ticket, java.lang.String, com.day.cq.contentbus.VersionId, java.lang.Object)
instead. |
abstract void |
pageModified(Ticket ticket,
java.lang.String handle,
VersionId vid,
int mask)
Deprecated.
|
abstract void |
pageModified(Ticket ticket,
java.lang.String handle,
VersionId vid,
int mask,
java.lang.Object userObject)
Invoked whenever a page is modified.
|
abstract void |
pageModified(Ticket ticket,
java.lang.String handle,
VersionId vid,
java.lang.Object userObject)
Invoked whenever a page is modified.
|
abstract void |
pageMoved(Ticket ticket,
java.lang.String fromHandle,
java.lang.String toHandle,
java.lang.String above)
Deprecated.
as of gumbaer, use
pageMoved(com.day.cq.contentbus.Ticket, java.lang.String, java.lang.String, java.lang.String, java.lang.Object)
instead. |
abstract void |
pageMoved(Ticket ticket,
java.lang.String fromHandle,
java.lang.String toHandle,
java.lang.String above,
int mask)
Deprecated.
|
abstract void |
pageMoved(Ticket ticket,
java.lang.String fromHandle,
java.lang.String toHandle,
java.lang.String above,
int mask,
java.lang.Object userObject)
Invoked whenever a page is moved.
|
abstract void |
pageMoved(Ticket ticket,
java.lang.String fromHandle,
java.lang.String toHandle,
java.lang.String above,
java.lang.Object userObject)
Invoked whenever a page is moved.
|
abstract void |
pageRestored(Ticket ticket,
java.lang.String handle,
VersionId vid,
int mask,
java.lang.Object userObject)
Invoked whenever a page is modified.
|
abstract void |
pageRestored(Ticket ticket,
java.lang.String handle,
VersionId vid,
java.lang.Object userObject)
Invoked whenever a page is modified.
|
abstract void |
removeListener(ModificationListener listener)
Remove a
ModificationListener |
abstract void |
versionCreated(Ticket ticket,
java.lang.String handle,
VersionId vid)
Deprecated.
|
abstract void |
versionCreated(Ticket ticket,
java.lang.String handle,
VersionId vid,
int mask)
Deprecated.
|
abstract void |
versionCreated(Ticket ticket,
java.lang.String handle,
VersionId vid,
int mask,
java.lang.Object userObject)
Invoked whenever a page is modified.
|
abstract void |
versionCreated(Ticket ticket,
java.lang.String handle,
VersionId vid,
java.lang.Object userObject)
Invoked whenever a page is modified.
|
abstract void |
versionDeleted(Ticket ticket,
java.lang.String handle,
UUID uuid,
VersionId vid,
int mask,
java.lang.Object userObject)
Invoked whenever a page is modified.
|
abstract void |
versionDeleted(Ticket ticket,
java.lang.String handle,
UUID uuid,
VersionId vid,
java.lang.Object userObject)
Invoked whenever a page is deleted.
|
public static final java.lang.String MSG_DISPATCHER_NAME
protected static final int INTERNAL_BIT
INTERNAL flag.protected static final int EXTERNAL_BIT
EXTERNAL flag.protected static final int SYNCHRON_BIT
SYNCHRON flag.protected static final int HIGHEST_BIT
public static final int INTERNAL
public static final int EXTERNAL
public static final int SYNCHRON
ModificationListener who wants
to handle internal PageModification events in the same thread
in which the were generated. Combining this flag with the
INTERNAL flag when registering the ModificationListener
results in the listener receiving the event twice, once when event is
generated and once when the event is dequeued asynchronously.public abstract void addListener(ModificationListener listener, ContentPackage pkg)
addListener(com.day.cq.contentbus.observation.ModificationListener) instead. The
semantics of the ModificationListener has been changed in
that the listener should itself check whether it is interested in
the modification events. To ease upgrade the
AbstractModificationListener and
com.day.cq.contentbus.observation.DefaultModificationListener classes are provided, which
provide some form of backwards compatibility.ModificationListener to only handle internal events
for pages whose handle is contained in the named content package.
Calling this method is equivalent to calling the
addListener(ModificationListener, ContentPackage, int) method
with a mask value of INTERNAL.
This method wraps the listener with an instance of the
DefaultModificationListener class to encapsulate package
contents checking.
listener - The ModificationListener to register. It is
expected that this listener is only interested in receiving events
whose handle is contained in the named content package.pkg - The ContentPackage describing the set of handles for
which the listener is interested to receive events.java.lang.NullPointerException - if the listener or
pkg is null.public abstract void addListener(ModificationListener listener, ContentPackage pkg, int mask)
addListener(com.day.cq.contentbus.observation.ModificationListener, int) instead. The
semantics of the ModificationListener has been changed in
that the listener should itself check whether it is interested in
the modification events. To ease upgrade the
com.day.cq.contentbus.observation.AbstractModificationListener and
com.day.cq.contentbus.observation.DefaultModificationListener classes are provided, which
provide some form of backwards compatibility.
This method wraps the listener with an instance of the
com.day.cq.contentbus.observation.DefaultModificationListener class to encapsulate package
contents checking.
listener - modification listener. will be called asynchronously
when a change is observed.pkg - package definition containing the range of items we're
interested inmask - mask containing a combination of the flags
INTERNAL and EXTERNAL.java.lang.NullPointerException - if one of the arguments is nullpublic abstract void addListener(ModificationListener listener)
PageModification
events from the observation service. Calling this method is equivalent
to calling addListener(com.day.cq.contentbus.observation.ModificationListener, int) with the
INTERNAL flag.listener - The ModificationListener to register. This must
not be null.java.lang.NullPointerException - if the listener is null.public abstract void addListener(ModificationListener listener, int mask)
PageModification events from
the observation service.listener - The ModificationListener to register. This must
not be null.mask - mask containing a combination of the flags INTERNAL,
EXTERNAL, and SYNCHRON.java.lang.NullPointerException - if the listener is null.public abstract void removeListener(ModificationListener listener)
ModificationListenerpublic abstract void pageCreated(Ticket ticket, java.lang.String handle, UUID uuid, java.lang.String csd, java.lang.String above, java.lang.Object userObject)
ticket - ticket used to create pagehandle - handle of new pageuuid - UUID of new pagecsd - csd of new pageabove - label of successor, may be nulluserObject - user defined object to be added to the
PageModification event created.public abstract void pageCreated(Ticket ticket, java.lang.String handle, UUID uuid, java.lang.String csd, java.lang.String above, int mask, java.lang.Object userObject)
maskticket - ticket used to create pagehandle - handle of new pageuuid - UUID of new pagecsd - csd of new pageabove - label of successor, may be nullmask - mask containing a combination of the flags
INTERNAL and EXTERNAL.userObject - user defined object to be added to the
PageModification event created.public abstract void pageModified(Ticket ticket, java.lang.String handle, java.lang.Object userObject)
ticket - ticket used to create pagehandle - handle of new pageuserObject - user defined object to be added to the
PageModification event created.public abstract void pageModified(Ticket ticket, java.lang.String handle, VersionId vid, java.lang.Object userObject)
ticket - ticket used to create pagehandle - handle of new pageuserObject - user defined object to be added to the
PageModification event created.public abstract void pageModified(Ticket ticket, java.lang.String handle, int mask, java.lang.Object userObject)
maskticket - ticket used to create pagehandle - handle of pagemask - mask containing a combination of the flags
INTERNAL and EXTERNAL.userObject - user defined object to be added to the
PageModification event created.public abstract void pageModified(Ticket ticket, java.lang.String handle, VersionId vid, int mask, java.lang.Object userObject)
maskticket - ticket used to create pagehandle - handle of pagevid - version id.mask - mask containing a combination of the flags
INTERNAL and EXTERNAL.userObject - user defined object to be added to the
PageModification event created.public abstract void versionCreated(Ticket ticket, java.lang.String handle, VersionId vid, java.lang.Object userObject)
ticket - ticket used to create pagehandle - handle of new pagevid - the version iduserObject - user defined object to be added to the
PageModification event created.public abstract void versionCreated(Ticket ticket, java.lang.String handle, VersionId vid, int mask, java.lang.Object userObject)
maskticket - ticket used to create pagehandle - handle of pagevid - version id.mask - mask containing a combination of the flags
INTERNAL and EXTERNAL.userObject - user defined object to be added to the
PageModification event created.public abstract void versionDeleted(Ticket ticket, java.lang.String handle, UUID uuid, VersionId vid, int mask, java.lang.Object userObject)
maskticket - ticket used to create pageuuid - handle of pagevid - version id.mask - mask containing a combination of the flags
INTERNAL and EXTERNAL.userObject - user defined object to be added to the
PageModification event created.public abstract void versionDeleted(Ticket ticket, java.lang.String handle, UUID uuid, VersionId vid, java.lang.Object userObject)
ticket - ticket used to create pagehandle - handle of new pageuserObject - user defined object to be added to the
PageModification event created.public abstract void pageRestored(Ticket ticket, java.lang.String handle, VersionId vid, int mask, java.lang.Object userObject)
maskticket - ticket used to create pagehandle - handle of pagevid - version id.mask - mask containing a combination of the flags
INTERNAL and EXTERNAL.userObject - user defined object to be added to the
PageModification event created.public abstract void pageRestored(Ticket ticket, java.lang.String handle, VersionId vid, java.lang.Object userObject)
maskticket - ticket used to create pagehandle - handle of pagevid - version id.userObject - user defined object to be added to the
PageModification event created.public abstract void pageMoved(Ticket ticket, java.lang.String fromHandle, java.lang.String toHandle, java.lang.String above, java.lang.Object userObject)
ticket - ticket used to create pagefromHandle - handle of pagetoHandle - destination handle of pageabove - label of successor sibling, may be nulluserObject - user defined object to be added to the
PageModification event created.public abstract void pageMoved(Ticket ticket, java.lang.String fromHandle, java.lang.String toHandle, java.lang.String above, int mask, java.lang.Object userObject)
maskticket - ticket used to create pagefromHandle - handle of pagetoHandle - destination handle of page, may be nullabove - label of successor sibling, may be nullmask - mask containing a combination of the flags
INTERNAL and EXTERNAL.userObject - user defined object to be added to the
PageModification event created.public abstract void pageDeleted(Ticket ticket, java.lang.String handle, java.lang.Object userObject)
ticket - ticket used to create pagehandle - handle of new pageuserObject - user defined object to be added to the
PageModification event created.public abstract void pageDeleted(Ticket ticket, java.lang.String handle, int mask, java.lang.Object userObject)
maskticket - ticket used to create pagehandle - handle of new pagemask - mask containing a combination of the flags
INTERNAL and EXTERNAL.userObject - user defined object to be added to the
PageModification event created.public abstract void pageCreated(Ticket ticket, java.lang.String handle, UUID uuid, java.lang.String csd, java.lang.String above)
pageCreated(com.day.cq.contentbus.Ticket, java.lang.String, com.day.cq.contentbus.UUID, java.lang.String, java.lang.String, java.lang.Object)
instead.ticket - ticket used to create pagehandle - handle of new pageuuid - UUID of new pagecsd - csd of new pageabove - label of successor, may be nullpublic abstract void pageCreated(Ticket ticket, java.lang.String handle, UUID uuid, java.lang.String csd, java.lang.String above, int mask)
pageCreated(com.day.cq.contentbus.Ticket, java.lang.String, com.day.cq.contentbus.UUID, java.lang.String, java.lang.String, int, java.lang.Object)
instead.maskpublic abstract void pageModified(Ticket ticket, java.lang.String handle)
pageModified(com.day.cq.contentbus.Ticket, java.lang.String, java.lang.Object)
instead.ticket - ticket used to create pagehandle - handle of new pagepublic abstract void pageModified(Ticket ticket, java.lang.String handle, VersionId vid)
pageModified(com.day.cq.contentbus.Ticket, java.lang.String, com.day.cq.contentbus.VersionId, java.lang.Object)
instead.ticket - ticket used to create pagehandle - handle of new pagepublic abstract void pageModified(Ticket ticket, java.lang.String handle, int mask)
pageModified(com.day.cq.contentbus.Ticket, java.lang.String, int, java.lang.Object)
instead.maskpublic abstract void pageModified(Ticket ticket, java.lang.String handle, VersionId vid, int mask)
pageModified(com.day.cq.contentbus.Ticket, java.lang.String, com.day.cq.contentbus.VersionId, int, java.lang.Object)
instead.maskpublic abstract void versionCreated(Ticket ticket, java.lang.String handle, VersionId vid)
versionCreated(com.day.cq.contentbus.Ticket, java.lang.String, com.day.cq.contentbus.VersionId, java.lang.Object)
instead.ticket - ticket used to create pagehandle - handle of new pagevid - the version idpublic abstract void versionCreated(Ticket ticket, java.lang.String handle, VersionId vid, int mask)
versionCreated(com.day.cq.contentbus.Ticket, java.lang.String, com.day.cq.contentbus.VersionId, int, java.lang.Object)
instead.maskpublic abstract void pageMoved(Ticket ticket, java.lang.String fromHandle, java.lang.String toHandle, java.lang.String above)
pageMoved(com.day.cq.contentbus.Ticket, java.lang.String, java.lang.String, java.lang.String, java.lang.Object)
instead.ticket - ticket used to create pagefromHandle - handle of pagetoHandle - destination handle of pageabove - label of successor sibling, may be nullpublic abstract void pageMoved(Ticket ticket, java.lang.String fromHandle, java.lang.String toHandle, java.lang.String above, int mask)
pageMoved(com.day.cq.contentbus.Ticket, java.lang.String, java.lang.String, java.lang.String, int, java.lang.Object)
instead.maskpublic abstract void pageDeleted(Ticket ticket, java.lang.String handle)
pageDeleted(com.day.cq.contentbus.Ticket, java.lang.String, java.lang.Object)
instead.ticket - ticket used to create pagehandle - handle of new pagepublic abstract void pageDeleted(Ticket ticket, java.lang.String handle, int mask)
pageDeleted(com.day.cq.contentbus.Ticket, java.lang.String, int, java.lang.Object)
instead.maskpublic abstract void externalPageModified(PageModification mod)
PageModification is delivered through JMS.
We send this modification to all listeners for external messages.externalPageModified in interface ExternalModificationListenermod - page modification that took placepublic abstract int getNumInternalListeners()
public abstract java.lang.String[] getInternalListeners()
public abstract int getNumExternalListeners()
public abstract java.lang.String[] getExternalListeners()
public abstract int getNumSynchronousListeners()
public abstract java.lang.String[] getSynchronousListeners()
public abstract java.lang.String getAudit(java.lang.String handle,
java.lang.Number max)