org.apache.sling.api.resource.observation

Class ResourceChange

java.lang.Object

org.apache.sling.api.resource.observation.ResourceChange

public class ResourceChange
extends java.lang.Object

A resource change event is immutable. A change event can either be local or external. Local changes happended on the same instance, while external changes happended on a different instance. Resource listeners only receive external changes if they mark themselves as a ExternalResourceChangeListener. For all events (local and external), the path and the type of change is set. Resource provider events are always local events and only provide the path. Local events for resources provide the names of the properties that have been added, removed or changed. This information might be missing for external events.

Since:

1.0.0 (Sling API Bundle 2.11.0)

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ResourceChange.ChangeType The type of the change

Constructor Summary

Constructors

Constructor and Description
ResourceChange(ResourceChange.ChangeType changeType, java.lang.String path, boolean isExternal, java.util.Set<java.lang.String> addedPropertyNames, java.util.Set<java.lang.String> changedPropertyNames, java.util.Set<java.lang.String> removedPropertyNames) Create a new change object

Method Summary

Modifier and Type	Method and Description
java.util.Set<java.lang.String>	getAddedPropertyNames() Optional information about added properties.
java.util.Set<java.lang.String>	getChangedPropertyNames() Optional information about changed properties.
java.lang.String	getPath() Get the resource path.
java.util.Set<java.lang.String>	getRemovedPropertyNames() Optional information about removed properties.
ResourceChange.ChangeType	getType() Get the type of change
java.lang.String	getUserId() Get the user id of the user initiating the change
boolean	isExternal() Is this an external event?

Methods inherited from class java.lang.Object

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

Constructor Detail

ResourceChange

public ResourceChange(ResourceChange.ChangeType changeType,
                      java.lang.String path,
                      boolean isExternal,
                      java.util.Set<java.lang.String> addedPropertyNames,
                      java.util.Set<java.lang.String> changedPropertyNames,
                      java.util.Set<java.lang.String> removedPropertyNames)

Create a new change object

Parameters:

changeType - The change type

path - The resource path

isExternal - {code true} if the change happened on another node

addedPropertyName - set of added property names, if provided must be immutable

changedPropertyNames - set of added property names, if provided must be immutable

removedPropertyNames - set of added property names, if provided must be immutable

Method Detail

getPath

public java.lang.String getPath()

Get the resource path.

Returns:

The path to the resource.

getUserId

public java.lang.String getUserId()

Get the user id of the user initiating the change

Returns:

The user id or null if it's not available.

isExternal

public boolean isExternal()

Is this an external event?

Returns:

true if the event is external.

getType

public ResourceChange.ChangeType getType()

Get the type of change

Returns:

The type of change

getChangedPropertyNames

public java.util.Set<java.lang.String> getChangedPropertyNames()

Optional information about changed properties.

Returns:

The set of changed property names. For external events or resource provider events null is returned.

getAddedPropertyNames

public java.util.Set<java.lang.String> getAddedPropertyNames()

Optional information about added properties.

Returns:

The set of changed property names. For external events or resource provider events null is returned.

getRemovedPropertyNames

public java.util.Set<java.lang.String> getRemovedPropertyNames()

Optional information about removed properties.

Returns:

The set of changed property names. For external events or resource provider events null is returned.