cgl.narada.wsinfra.wsrm
Interface WsrmFaults

All Known Implementing Classes:
WsrmFaultsImpl

public interface WsrmFaults

This class provides a one-stop for creating all the faults that occur during WSRM processing. This eliminates the need to hard-code this in several places. Furthermore, if the spec changes the impact of this change will be felt at far fewer places.


Method Summary
 SequenceFaultDocument getCreateSequenceRefused()
          This fault is sent by an RM Destination to indicate that it cannot begin a requested Sequence.
 String getCreateSequenceRefusedReason()
          Retrieve the reason associated with the fault
 SequenceFaultDocument getInvalidAcknowledgement(SequenceAcknowledgementDocument seqAckDocument)
          This fault is sent by the RM Source in response to a that violates the cumulative acknowledgement invariant.
 String getInvalidAcknowledgementReason()
          Retrieve the reason associated with the fault
 SequenceFaultDocument getInvalidMessage()
          This is a fault send by an RM node when it encounters an invalid message.
 SequenceFaultDocument getLastMessageNumberExceeded(String identifier)
          This fault is sent by the RM Source to indicate that it has run out of message numbers for a sequence.
 String getLastMessageNumberExceededReason()
          Retrieve the reason associated with the fault
 SequenceFaultDocument getMessageNumberRollover(String identifier)
          This fault is sent by the RM Source to indicate that it has run out of message numbers for a sequence.
 String getMessageNumberRolloverReason()
          Retrieve the reason associated with the fault
 SequenceFaultDocument getSequenceRefused(String identifier)
          This fault is sent by an RM Destination to indicate that it cannot begin a requested Sequence.
 String getSequenceRefusedReason()
          Retrieve the reason associated with the fault
 SequenceFaultDocument getSequenceTerminated(String identifier)
          This fault is sent by either the RM Source or the RM Destination to indicate that the endpoint that generates the fault has either encountered an unrecoverable condition, or has detected a violation of the protocol and as a consequence, has chosen to terminate the sequence.
 String getSequenceTerminatedReason()
          Retrieve the reason associated with the fault
 QName getSoapReceiverQName()
          Retrieves the Fault:Code for the receiver
 QName getSoapSenderQName()
          Retrieves the Fault:Code for the sender
 SequenceFaultDocument getUnknownSequence(String identifier)
          This fault is sent by either the RM Source or the RM Destination in response to a message containing an unknown sequence identifier.
 String getUnknownSequenceReason()
          Retrieve the reason associated with the fault
 

Method Detail

getSequenceTerminated

public SequenceFaultDocument getSequenceTerminated(String identifier)
This fault is sent by either the RM Source or the RM Destination to indicate that the endpoint that generates the fault has either encountered an unrecoverable condition, or has detected a violation of the protocol and as a consequence, has chosen to terminate the sequence.
  • Code Sender.


  • getSequenceTerminatedReason

    public String getSequenceTerminatedReason()
    Retrieve the reason associated with the fault


    getUnknownSequence

    public SequenceFaultDocument getUnknownSequence(String identifier)
    This fault is sent by either the RM Source or the RM Destination in response to a message containing an unknown sequence identifier.


    getUnknownSequenceReason

    public String getUnknownSequenceReason()
    Retrieve the reason associated with the fault


    getInvalidAcknowledgement

    public SequenceFaultDocument getInvalidAcknowledgement(SequenceAcknowledgementDocument seqAckDocument)
    This fault is sent by the RM Source in response to a that violates the cumulative acknowledgement invariant. An example of such a violation would be a SequenceAcknowledgement covering messages that have not been sent.


    getInvalidAcknowledgementReason

    public String getInvalidAcknowledgementReason()
    Retrieve the reason associated with the fault


    getMessageNumberRollover

    public SequenceFaultDocument getMessageNumberRollover(String identifier)
    This fault is sent by the RM Source to indicate that it has run out of message numbers for a sequence. It is an unrecoverable error and terminates the Sequence.


    getMessageNumberRolloverReason

    public String getMessageNumberRolloverReason()
    Retrieve the reason associated with the fault


    getLastMessageNumberExceeded

    public SequenceFaultDocument getLastMessageNumberExceeded(String identifier)
    This fault is sent by the RM Source to indicate that it has run out of message numbers for a sequence. It is an unrecoverable error and terminates the Sequence.


    getLastMessageNumberExceededReason

    public String getLastMessageNumberExceededReason()
    Retrieve the reason associated with the fault


    getSequenceRefused

    public SequenceFaultDocument getSequenceRefused(String identifier)
    This fault is sent by an RM Destination to indicate that it cannot begin a requested Sequence.


    getSequenceRefusedReason

    public String getSequenceRefusedReason()
    Retrieve the reason associated with the fault


    getCreateSequenceRefused

    public SequenceFaultDocument getCreateSequenceRefused()
    This fault is sent by an RM Destination to indicate that it cannot begin a requested Sequence.


    getCreateSequenceRefusedReason

    public String getCreateSequenceRefusedReason()
    Retrieve the reason associated with the fault


    getInvalidMessage

    public SequenceFaultDocument getInvalidMessage()
    This is a fault send by an RM node when it encounters an invalid message.


    getSoapSenderQName

    public QName getSoapSenderQName()
    Retrieves the Fault:Code for the sender


    getSoapReceiverQName

    public QName getSoapReceiverQName()
    Retrieves the Fault:Code for the receiver