Package com.day.cq.replication

Class ReplicationResult

  • public class ReplicationResult
extends java.lang.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.

    • Constructor Summary

      Constructors 
      Constructor Description
      ReplicationResult​(boolean success, int code, java.lang.String message)
      Creates an instance of this class.

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      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.
      java.lang.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.
      boolean isSuccess()
      Returns true If the replication action and optional content could be sent to the recipient.

      • Methods inherited from class java.lang.Object

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

    • Constructor Detail

      • ReplicationResult

        public ReplicationResult​(boolean success,
                         int code,
                         java.lang.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 java.lang.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.