atg.deployment.server.messaging
Class DeploymentStatusMessage

java.lang.Object
  extended by atg.epub.messaging.PublishingMessage
      extended by atg.deployment.server.messaging.DeploymentMessage
          extended by atg.deployment.server.messaging.DeploymentStatusMessage
All Implemented Interfaces:
java.io.Serializable

public class DeploymentStatusMessage
extends DeploymentMessage

This class represents a JMS message deployment status. It contains information about a completed deployment and is used primarily by the Publishing workflows.

See Also:
DeploymentMessage, Serialized Form

Field Summary
static java.lang.String CLASS_VERSION
          Class version string
static int FAILURE
           
static java.lang.String PORT_NAME
           
static int SUCCESS
           
static java.lang.String TYPE_NAME
           
 
Constructor Summary
DeploymentStatusMessage(int pStatus, java.lang.String pTargetId, java.lang.String pProjectId)
          Constructs a JMS message with the given arguments.
 
Method Summary
 int getStatus()
           
static void sendMessage(int pStatus, java.lang.String pTargetId, java.lang.String pProjectId)
           
static void sendMessage(int pStatus, java.lang.String pTargetId, java.lang.String[] pProjectIds)
           
static void sendMessage(int pStatus, java.lang.String pTargetId, java.lang.String[] pProjectIds, java.lang.String[] pProcessIds)
           
static void sendMessage(int pStatus, java.lang.String pTargetId, java.lang.String[] pProjectIds, java.lang.String[] pProcessIds, java.lang.String pPortName, java.lang.String pJMSType)
           
static void sendMessage(int pStatus, java.lang.String pTargetId, java.lang.String pProjectId, java.lang.String pProcessId)
           
 void setStatus(int pStatus)
          Set the status of this message.
 java.lang.String toString()
           
 
Methods inherited from class atg.deployment.server.messaging.DeploymentMessage
getTargetId, setTargetId
 
Methods inherited from class atg.epub.messaging.PublishingMessage
getProcessId, getProjectId, getSubjectId, setProcessId, setProjectId
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

CLASS_VERSION

public static java.lang.String CLASS_VERSION
Class version string


FAILURE

public static final int FAILURE
See Also:
Constant Field Values

SUCCESS

public static final int SUCCESS
See Also:
Constant Field Values

PORT_NAME

public static final java.lang.String PORT_NAME
See Also:
Constant Field Values

TYPE_NAME

public static final java.lang.String TYPE_NAME
See Also:
Constant Field Values
Constructor Detail

DeploymentStatusMessage

public DeploymentStatusMessage(int pStatus,
                               java.lang.String pTargetId,
                               java.lang.String pProjectId)
Constructs a JMS message with the given arguments.

Method Detail

sendMessage

public static void sendMessage(int pStatus,
                               java.lang.String pTargetId,
                               java.lang.String pProjectId)
                        throws javax.jms.JMSException,
                               TransactionDemarcationException
Throws:
javax.jms.JMSException
TransactionDemarcationException

sendMessage

public static void sendMessage(int pStatus,
                               java.lang.String pTargetId,
                               java.lang.String pProjectId,
                               java.lang.String pProcessId)
                        throws javax.jms.JMSException,
                               TransactionDemarcationException
Throws:
javax.jms.JMSException
TransactionDemarcationException

sendMessage

public static void sendMessage(int pStatus,
                               java.lang.String pTargetId,
                               java.lang.String[] pProjectIds)
                        throws javax.jms.JMSException,
                               TransactionDemarcationException
Throws:
javax.jms.JMSException
TransactionDemarcationException

sendMessage

public static void sendMessage(int pStatus,
                               java.lang.String pTargetId,
                               java.lang.String[] pProjectIds,
                               java.lang.String[] pProcessIds)
                        throws javax.jms.JMSException,
                               TransactionDemarcationException
Throws:
javax.jms.JMSException
TransactionDemarcationException

sendMessage

public static void sendMessage(int pStatus,
                               java.lang.String pTargetId,
                               java.lang.String[] pProjectIds,
                               java.lang.String[] pProcessIds,
                               java.lang.String pPortName,
                               java.lang.String pJMSType)
                        throws javax.jms.JMSException,
                               TransactionDemarcationException
Throws:
javax.jms.JMSException
TransactionDemarcationException

getStatus

public int getStatus()
Returns:
the status of a deployment, either SUCCESS or FAILURE

setStatus

public void setStatus(int pStatus)
Set the status of this message.

Parameters:
pStatus - the status to set, either SUCCESS or FAILURE

toString

public java.lang.String toString()
Overrides:
toString in class DeploymentMessage