Package com.day.cq.replication

Class ReplicationResult

java.lang.Object

com.day.cq.replication.ReplicationResult

public class ReplicationResult
extends Object

The ReplicationResult is returned by the TransportHandler after sending a request to the recipient. The instance conveys information on the success of request delivery and request processing. Optionally it also adds additional information for the result through ReplicationResultInfo

Field Summary

Fields

Modifier and Type	Field	Description
static ReplicationResult	OK	OK result.

Constructor Summary

Constructors

Constructor	Description
ReplicationResult(boolean success, int code, String message)	Creates an instance of this class.
ReplicationResult(boolean success, int code, String message, ReplicationResultInfo resultInfo)	Creates an instance of this class.

Method Summary

Modifier and Type	Method	Description
int	getCode()	Returns some status code indication sent by the recipient about the success of processing the replication action and optional content.
String	getMessage()	Returns some status message providing clear text indication sent by the recipient about the success of processing the replication action and optional content.
ReplicationResultInfo	getReplicationResultInfo()	Returns any additional information for replication action
boolean	isSuccess()	Returns true If the replication action and optional content could be sent to the recipient.
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

OK

public static final ReplicationResult OK

OK result.

Constructor Detail

ReplicationResult

public ReplicationResult(boolean success,
                         int code,
                         String message,
                         ReplicationResultInfo resultInfo)

Creates an instance of this class.

Parameters:

success - See isSuccess()

code - See getCode()

message - See getMessage()

message - See getReplicationResultInfo()

ReplicationResult

public ReplicationResult(boolean success,
                         int code,
                         String message)

Creates an instance of this class.

Parameters:

success - See isSuccess()

code - See getCode()

message - See getMessage()

Method Detail

isSuccess

public boolean isSuccess()

Returns true If the replication action and optional content could be sent to the recipient. false is returned if there was a transfer problem.

Note that this flag indicates whether the recipient received the request for further processing. It does not indicate whether the recipient could do something useful with it.

Returns:

true If the replication action and optional content could be sent to the recipient. false is returned if there was a transfer problem.

getCode

public int getCode()

Returns some status code indication sent by the recipient about the success of processing the replication action and optional content.

For example an HTTP based transport agent may set this field to the HTTP response status code.

Returns:

some status code indication sent by the recipient about the success of processing the replication action and optional content.

getMessage

public String getMessage()

Returns some status message providing clear text indication sent by the recipient about the success of processing the replication action and optional content.

For example an HTTP based transport agent may set this field to the HTTP response status message.

Returns:

some status message providing clear text indication sent by the recipient about the success of processing the replication action and optional content.

getReplicationResultInfo

public ReplicationResultInfo getReplicationResultInfo()

Returns any additional information for replication action

Returns:

additional info

toString

public String toString()

Overrides:

toString in class Object