Package com.day.cq.replication
Interface ReplicationStatus
-
@ProviderType public interface ReplicationStatus
Determines the replication status of an asset/page.
-
-
Field Summary
Fields Modifier and Type Field Description static String
NODE_PROPERTY_LAST_PUBLISHED
Deprecated.static String
NODE_PROPERTY_LAST_PUBLISHED_BY
Deprecated.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 replicationstatic String
NODE_PROPERTY_LAST_REPLICATION_ACTION
The name of the property that records the last replication actionstatic String
NODE_TYPE
Name of the node type
-
Method Summary
All Methods Instance Methods Abstract Methods Deprecated Methods Modifier and Type Method Description Set<String>
getAvailableAgents()
Returns all agents for which a replication status is available; these agents must be present and active in the system.Calendar
getLastPublished()
Returns the time when the content 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 content.ReplicationStatus
getStatusForAgent(String agentName)
Return the replication status for exactly one agent.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 content is delivered.boolean
isPending()
Checks if the last publish action is pending, i.e.boolean
isPublished()
Deprecated.useisDelivered()
-
-
-
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
@Deprecated static final String NODE_PROPERTY_LAST_PUBLISHED
Deprecated.- See Also:
- Constant Field Values
-
NODE_PROPERTY_LAST_PUBLISHED_BY
@Deprecated static final String NODE_PROPERTY_LAST_PUBLISHED_BY
Deprecated.- See Also:
- Constant Field Values
-
-
Method Detail
-
getLastPublished
Calendar getLastPublished()
Returns the time when the content 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 content is delivered. Note that this is calculated only by the logs of replication actions. It does not check if the content is physically on the server. a content 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 content is delivered.
-
isPublished
@Deprecated boolean isPublished()
Deprecated.useisDelivered()
- Returns:
- same as
isDelivered()
-
isActivated
boolean isActivated()
Convenience method that checks if the last publish action was 'activate'. Note that !isActivated() does not automatically mean that the content 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 mean that the content 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 content. if this content is not queued at all, an empty list is returned.- Returns:
- a queue status for each queue.
-
getAvailableAgents
Set<String> getAvailableAgents()
Returns all agents for which a replication status is available; these agents must be present and active in the system.- Returns:
- the agents for which a replication status is available, or an empty set if no status is available for an agent.
- Since:
- 6.6.0
-
getStatusForAgent
ReplicationStatus getStatusForAgent(String agentName)
Return the replication status for exactly one agent.- Parameters:
agentName
- the name of an existing agent (as returned bygetAvailableAgents()
)- Returns:
- the ReplicationStatus for that agent;
null
if the replication agent does not exist or no status is available for it. - Since:
- 6.6.0
-
-