java.lang.Object
- com.day.cq.replication.ReplicationAction

All Implemented Interfaces:

Serializable
```
public class ReplicationAction
extends Object
implements Serializable
```
Defines the control information of a replication

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type	Field	Description
`static String`	`EVENT_TOPIC`	Event topic for replication status events.
`static String`	`PN_ACTION_TYPE`	Replication action type property name.
`static String`	`PN_PATH`	Replication path property name.
`static String`	`PROPERTY_MODIFICATION_DATE`	The OSGi event property containing the modification date
`static String`	`PROPERTY_PATH`	The OSGi event property containing the path
`static String`	`PROPERTY_PATHS`	The OSGi event property containing the paths
`static String`	`PROPERTY_REVISION`	The OSGi event property containing the replicated revision (optional)
`static String`	`PROPERTY_TYPE`	The OSGi event property containing replication action
`static String`	`PROPERTY_USER_ID`	The OSGi event property containing the user id

Constructor Summary

Constructors
Constructor	Description
`ReplicationAction(ReplicationActionType type, String path)`	Create a new instance of this class.
`ReplicationAction(ReplicationActionType type, String[] paths, long time, String userId, String revision)`
`ReplicationAction(ReplicationActionType type, String path, long time, String userId, String revision)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`Map<String,Object>`	`createEventProperties(boolean distribute)`	Create the OSGi event properties.
`static ReplicationAction`	`fromEvent(Event evt)`	Convert an OSGi event to a replication event.
`AgentConfig`	`getConfig()`	Return the agent config.
`ReplicationLog`	`getLog()`	Return the replication log.
`String`	`getPath()`	Returns the path
`String[]`	`getPaths()`	Returns the replication paths.
`String`	`getRevision()`	Returns the revision
`long`	`getTime()`	Returns the replication time
`ReplicationActionType`	`getType()`	Returns the action type
`String`	`getUserId()`	Returns the user id.
`void`	`setConfig(AgentConfig config)`	Set the agent config.
`void`	`setLog(ReplicationLog log)`	Set the replication log.
`Event`	`toEvent()`	Create an OSGi event out of the replication event.
`Event`	`toEvent(boolean distribute)`	Create an OSGi event out of the replication event.
`String`	`toString()`

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - EVENT_TOPIC
```
public static final String EVENT_TOPIC
```
    Event topic for replication status events.
    
    See Also:
    
    Constant Field Values
  - PROPERTY_MODIFICATION_DATE
```
public static final String PROPERTY_MODIFICATION_DATE
```
    The OSGi event property containing the modification date
    
    See Also:
    
    Constant Field Values
  - PROPERTY_USER_ID
```
public static final String PROPERTY_USER_ID
```
    The OSGi event property containing the user id
    
    See Also:
    
    Constant Field Values
  - PROPERTY_PATH
```
public static final String PROPERTY_PATH
```
    The OSGi event property containing the path
    
    See Also:
    
    Constant Field Values
  - PROPERTY_PATHS
```
public static final String PROPERTY_PATHS
```
    The OSGi event property containing the paths
    
    Since:
    
    5.5
    
    See Also:
    
    Constant Field Values
  - PROPERTY_TYPE
```
public static final String PROPERTY_TYPE
```
    The OSGi event property containing replication action
    
    See Also:
    
    Constant Field Values
  - PROPERTY_REVISION
```
public static final String PROPERTY_REVISION
```
    The OSGi event property containing the replicated revision (optional)
    
    See Also:
    
    Constant Field Values
  - PN_PATH
```
public static final String PN_PATH
```
    Replication path property name.
    
    See Also:
    
    Constant Field Values
  - PN_ACTION_TYPE
```
public static final String PN_ACTION_TYPE
```
    Replication action type property name.
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - ReplicationAction
```
public ReplicationAction(ReplicationActionType type,
                         String path,
                         long time,
                         String userId,
                         String revision)
```
  - ReplicationAction
```
public ReplicationAction(ReplicationActionType type,
                         String[] paths,
                         long time,
                         String userId,
                         String revision)
```
  - ReplicationAction
```
public ReplicationAction(ReplicationActionType type,
                         String path)
```
    Create a new instance of this class. Used for actions that do not carry content (e.g. DELETE).
    
    Parameters:
    
    type - action type
    
    path - path
- Method Detail
  - getType
```
public ReplicationActionType getType()
```
    Returns the action type
    
    Returns:
    
    replication action type
  - getPath
```
public String getPath()
```
    Returns the path
    
    Returns:
    
    path
  - getPaths
```
public String[] getPaths()
```
    Returns the replication paths. Currently the array may only contain more than 1 elements for a delete replication. in that case, the paths are the ones of the deleted aggregates (content nodes).
    
    Returns:
    
    the paths
    
    Since:
    
    5.5
  - getRevision
```
public String getRevision()
```
    Returns the revision
    
    Returns:
    
    the revision
  - getTime
```
public long getTime()
```
    Returns the replication time
    
    Returns:
    
    the replication time
  - getUserId
```
public String getUserId()
```
    Returns the user id.
    
    Returns:
    
    the user id.
  - getConfig
```
public AgentConfig getConfig()
```
    Return the agent config.
    
    Returns:
    
    agent config
  - setConfig
```
public void setConfig(AgentConfig config)
```
    Set the agent config.
    
    Parameters:
    
    config - agent config
  - getLog
```
public ReplicationLog getLog()
```
    Return the replication log.
    
    Returns:
    
    replication log
  - setLog
```
public void setLog(ReplicationLog log)
```
    Set the replication log.
    
    Parameters:
    
    log - the log
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - fromEvent
```
public static ReplicationAction fromEvent(Event evt)
```
    Convert an OSGi event to a replication event.
    
    Parameters:
    
    evt - The OSGi event
    
    Returns:
    
    The replication event if the OSGi event contained a replication event. Otherwise null is returned.
  - createEventProperties
```
public Map<String,Object> createEventProperties(boolean distribute)
```
    Create the OSGi event properties.
    
    Parameters:
    
    distribute - Whether this event should be distributed across the cluster.
    
    Returns:
    
    OSGi event properties
    
    Since:
    
    5.18.0
  - toEvent
```
public Event toEvent()
```
    Create an OSGi event out of the replication event.
    
    Returns:
    
    A new OSGi event.
  - toEvent
```
public Event toEvent(boolean distribute)
```
    Create an OSGi event out of the replication event.
    
    Parameters:
    
    distribute - if true a distributed event is created
    
    Returns:
    
    A new OSGi event.

Class ReplicationAction

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

EVENT_TOPIC

PROPERTY_MODIFICATION_DATE

PROPERTY_USER_ID

PROPERTY_PATH

PROPERTY_PATHS

PROPERTY_TYPE

PROPERTY_REVISION

PN_PATH

PN_ACTION_TYPE

Constructor Detail

ReplicationAction

ReplicationAction

ReplicationAction

Method Detail

getType

getPath

getPaths

getRevision

getTime

getUserId

getConfig

setConfig

getLog

setLog

toString

fromEvent

createEventProperties

toEvent

toEvent