com.day.cq.replication
Interface ReplicationStatus

public interface ReplicationStatus

ReplicationStatus

Field Summary

static String	NODE_PROPERTY_LAST_PUBLISHED Deprecated. use NODE_PROPERTY_LAST_REPLICATED
static String	NODE_PROPERTY_LAST_PUBLISHED_BY Deprecated. use NODE_PROPERTY_LAST_REPLICATED_BY
static String	NODE_PROPERTY_LAST_REPLICATED The name of the property that records the date of the last replication.
static String	NODE_PROPERTY_LAST_REPLICATED_BY The name of the property that records the userid of the last replication
static String	NODE_PROPERTY_LAST_REPLICATION_ACTION The name of the property that records the last replication action
static String	NODE_TYPE Name of the node type

Method Summary

Calendar	getLastPublished() Returns the time when the page was last published (i.e.
String	getLastPublishedBy() Returns the user id who issues the last publish action.
ReplicationActionType	getLastReplicationAction() Return the last replication action.
List<ReplicationQueue.Entry>	getPending() Checks if the last publish action is still pending, i.e.
List<ReplicationQueue.Entry>	getQueueStatus() Returns the queue status of this page.
boolean	isActivated() Convenience method that checks if the last publish action was 'activate'.
boolean	isDeactivated() Convenience method that checks if the last publish action was 'deactivate'.
boolean	isDelivered() Checks if the page is delivered.
boolean	isPending() Checks if the last publish action is pending, i.e.
boolean	isPublished() Deprecated. use isDelivered()

Field Detail

NODE_PROPERTY_LAST_REPLICATED

static final String NODE_PROPERTY_LAST_REPLICATED

The name of the property that records the date of the last replication.

See Also:

Constant Field Values

NODE_PROPERTY_LAST_REPLICATED_BY

static final String NODE_PROPERTY_LAST_REPLICATED_BY

The name of the property that records the userid of the last replication

See Also:

Constant Field Values

NODE_PROPERTY_LAST_REPLICATION_ACTION

static final String NODE_PROPERTY_LAST_REPLICATION_ACTION

The name of the property that records the last replication action

See Also:

Constant Field Values

NODE_TYPE

static final String NODE_TYPE

Name of the node type

See Also:

Constant Field Values

NODE_PROPERTY_LAST_PUBLISHED

static final String NODE_PROPERTY_LAST_PUBLISHED

Deprecated. use NODE_PROPERTY_LAST_REPLICATED

See Also:

Constant Field Values

NODE_PROPERTY_LAST_PUBLISHED_BY

static final String NODE_PROPERTY_LAST_PUBLISHED_BY

Deprecated. use NODE_PROPERTY_LAST_REPLICATED_BY

See Also:

Constant Field Values

Method Detail

getLastPublished

Calendar getLastPublished()

Returns the time when the page was last published (i.e. activated or deactivated).

Returns:

last publish date or null

getLastPublishedBy

String getLastPublishedBy()

Returns the user id who issues the last publish action.

Returns:

The publish user id or null

getLastReplicationAction

ReplicationActionType getLastReplicationAction()

Return the last replication action.

Returns:

The action type or null

isDelivered

boolean isDelivered()

Checks if the page is delivered. Note that this is calculated only by the logs of replication actions. It does not check if the page is physically on the server. a page is delivered if the last action was 'Activate' and the action is processed. of if the action was 'deactivate' and the action is still pending.

Returns:

true if the page is delivered.

isPublished

@Deprecated
boolean isPublished()

Deprecated. use isDelivered()

Returns:

same as isDelivered()

isActivated

boolean isActivated()

Convenience method that checks if the last publish action was 'activate'. Note that !isActivated() does not automatically meen that the page is deactivated.

Returns:

true if the last publish action was 'activate'

isDeactivated

boolean isDeactivated()

Convenience method that checks if the last publish action was 'deactivate'. Note that !isDeactivated() does not automatically meen that the page is activated.

Returns:

true if the last publish action was 'activate'

isPending

boolean isPending()

Checks if the last publish action is pending, i.e. if it's still present in any of the queues.

Returns:

true if the action is pending

getPending

List<ReplicationQueue.Entry> getPending()

Checks if the last publish action is still pending, i.e. if it's still present in any of the queues.

Returns:

the list of pending queue entries

getQueueStatus

List<ReplicationQueue.Entry> getQueueStatus()

Returns the queue status of this page. if this page is not queued at all, an empty array is returned.

Returns:

a queue status for each queue.