Apache CXF API

org.apache.cxf.ws.rm
Class EncoderDecoder11Impl

java.lang.Object
  extended by org.apache.cxf.ws.rm.EncoderDecoder11Impl
All Implemented Interfaces:
EncoderDecoder

public final class EncoderDecoder11Impl
extends Object
implements EncoderDecoder

WS-ReliableMessaging 1.1 encoding and decoding. This just works with the standard internal form of the WS-RM data structures.


Field Summary
static EncoderDecoder11Impl INSTANCE
           
 
Method Summary
 Element buildHeaderFault(SequenceFault sf, QName qname)
          Builds an element containing a WS-RM Fault.
 Element buildHeaders(RMProperties rmps, QName qname)
          Builds an element containing WS-RM headers.
 CreateSequenceType convertReceivedCreateSequence(Object create)
          Convert a received CreateSequence message to internal form.
 CreateSequenceResponseType convertReceivedCreateSequenceResponse(Object create)
          Convert a received CreateSequenceResponse message to internal form.
 TerminateSequenceType convertReceivedTerminateSequence(Object term)
          Convert a received TerminateSequence message to internal form.
 Object convertToSend(CreateSequenceResponseType create)
          Convert a CreateSequenceResponse message to the correct format for transmission.
 Object convertToSend(CreateSequenceType create)
          Convert a CreateSequence message to the correct format for transmission.
 Object convertToSend(TerminateSequenceType term)
          Convert a TerminateSequence message to the correct format for transmission.
 AckRequestedType decodeAckRequestedType(Element elem)
          Unmarshals a AckRequestedType, converting it if necessary to the internal form.
 SequenceAcknowledgement decodeSequenceAcknowledgement(Element elem)
          Unmarshals a SequenceAcknowledgement, converting it if necessary to the internal form.
 SequenceType decodeSequenceType(Element elem)
          Unmarshals a SequenceType, converting it if necessary to the internal form.
 CloseSequenceType decodeSequenceTypeCloseSequence(Element elem)
          Generates a CloseSequenceType if a SequenceType represents a last message state.
 Element encodeIdentifier(Identifier id)
          Marshals an Identifier to the appropriate external form.
 Element encodeSequenceAcknowledgement(SequenceAcknowledgement ack)
          Marshals a SequenceAcknowledgement to the appropriate external form.
 RMConstants getConstants()
          Get the WS-ReliableMessaging constants used by this encoder/decoder.
 Class getCreateSequenceResponseType()
          Get the class used for the CreateSequenceResponseType.
 Class getCreateSequenceType()
          Get the class used for the CreateSequenceType.
 Class getTerminateSequenceType()
          Get the class used for the TerminateSequenceType.
 String getWSANamespace()
          Get the WS-Addressing namespace used by this encoder/decoder.
 String getWSRMNamespace()
          Get the WS-ReliableMessaging namespace used by this encoder/decoder.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

INSTANCE

public static final EncoderDecoder11Impl INSTANCE
Method Detail

getWSRMNamespace

public String getWSRMNamespace()
Description copied from interface: EncoderDecoder
Get the WS-ReliableMessaging namespace used by this encoder/decoder.

Specified by:
getWSRMNamespace in interface EncoderDecoder
Returns:
URI

getWSANamespace

public String getWSANamespace()
Description copied from interface: EncoderDecoder
Get the WS-Addressing namespace used by this encoder/decoder.

Specified by:
getWSANamespace in interface EncoderDecoder
Returns:
URI

getConstants

public RMConstants getConstants()
Description copied from interface: EncoderDecoder
Get the WS-ReliableMessaging constants used by this encoder/decoder.

Specified by:
getConstants in interface EncoderDecoder
Returns:

getCreateSequenceType

public Class getCreateSequenceType()
Description copied from interface: EncoderDecoder
Get the class used for the CreateSequenceType.

Specified by:
getCreateSequenceType in interface EncoderDecoder
Returns:
class

getCreateSequenceResponseType

public Class getCreateSequenceResponseType()
Description copied from interface: EncoderDecoder
Get the class used for the CreateSequenceResponseType.

Specified by:
getCreateSequenceResponseType in interface EncoderDecoder
Returns:
class

getTerminateSequenceType

public Class getTerminateSequenceType()
Description copied from interface: EncoderDecoder
Get the class used for the TerminateSequenceType.

Specified by:
getTerminateSequenceType in interface EncoderDecoder
Returns:
class

buildHeaders

public Element buildHeaders(RMProperties rmps,
                            QName qname)
                     throws javax.xml.bind.JAXBException
Description copied from interface: EncoderDecoder
Builds an element containing WS-RM headers. This adds the appropriate WS-RM and WS-A namespace declarations to the element, and then adds any WS-RM headers set in the supplied properties as child elements.

Specified by:
buildHeaders in interface EncoderDecoder
qname - constructed element name
Returns:
element
Throws:
javax.xml.bind.JAXBException

buildHeaderFault

public Element buildHeaderFault(SequenceFault sf,
                                QName qname)
                         throws javax.xml.bind.JAXBException
Description copied from interface: EncoderDecoder
Builds an element containing a WS-RM Fault. This adds the appropriate WS-RM namespace declaration to the element, and then adds the Fault as a child element.

Specified by:
buildHeaderFault in interface EncoderDecoder
qname - constructed element name
Returns:
element
Throws:
javax.xml.bind.JAXBException

encodeSequenceAcknowledgement

public Element encodeSequenceAcknowledgement(SequenceAcknowledgement ack)
                                      throws javax.xml.bind.JAXBException
Description copied from interface: EncoderDecoder
Marshals a SequenceAcknowledgement to the appropriate external form.

Specified by:
encodeSequenceAcknowledgement in interface EncoderDecoder
Returns:
element
Throws:
javax.xml.bind.JAXBException

encodeIdentifier

public Element encodeIdentifier(Identifier id)
                         throws javax.xml.bind.JAXBException
Description copied from interface: EncoderDecoder
Marshals an Identifier to the appropriate external form.

Specified by:
encodeIdentifier in interface EncoderDecoder
Returns:
element
Throws:
javax.xml.bind.JAXBException

decodeSequenceType

public SequenceType decodeSequenceType(Element elem)
                                throws javax.xml.bind.JAXBException
Description copied from interface: EncoderDecoder
Unmarshals a SequenceType, converting it if necessary to the internal form.

Specified by:
decodeSequenceType in interface EncoderDecoder
Returns:
Throws:
javax.xml.bind.JAXBException

decodeSequenceTypeCloseSequence

public CloseSequenceType decodeSequenceTypeCloseSequence(Element elem)
                                                  throws javax.xml.bind.JAXBException
Description copied from interface: EncoderDecoder
Generates a CloseSequenceType if a SequenceType represents a last message state.

Specified by:
decodeSequenceTypeCloseSequence in interface EncoderDecoder
Returns:
CloseSequenceType if last message state, else null
Throws:
javax.xml.bind.JAXBException

decodeSequenceAcknowledgement

public SequenceAcknowledgement decodeSequenceAcknowledgement(Element elem)
                                                      throws javax.xml.bind.JAXBException
Description copied from interface: EncoderDecoder
Unmarshals a SequenceAcknowledgement, converting it if necessary to the internal form.

Specified by:
decodeSequenceAcknowledgement in interface EncoderDecoder
Returns:
Throws:
javax.xml.bind.JAXBException

decodeAckRequestedType

public AckRequestedType decodeAckRequestedType(Element elem)
                                        throws javax.xml.bind.JAXBException
Description copied from interface: EncoderDecoder
Unmarshals a AckRequestedType, converting it if necessary to the internal form.

Specified by:
decodeAckRequestedType in interface EncoderDecoder
Returns:
Throws:
javax.xml.bind.JAXBException

convertToSend

public Object convertToSend(CreateSequenceType create)
Description copied from interface: EncoderDecoder
Convert a CreateSequence message to the correct format for transmission.

Specified by:
convertToSend in interface EncoderDecoder
Returns:
converted

convertToSend

public Object convertToSend(CreateSequenceResponseType create)
Description copied from interface: EncoderDecoder
Convert a CreateSequenceResponse message to the correct format for transmission.

Specified by:
convertToSend in interface EncoderDecoder
Returns:
converted

convertToSend

public Object convertToSend(TerminateSequenceType term)
Description copied from interface: EncoderDecoder
Convert a TerminateSequence message to the correct format for transmission.

Specified by:
convertToSend in interface EncoderDecoder
Returns:
converted

convertReceivedCreateSequence

public CreateSequenceType convertReceivedCreateSequence(Object create)
Description copied from interface: EncoderDecoder
Convert a received CreateSequence message to internal form.

Specified by:
convertReceivedCreateSequence in interface EncoderDecoder
Returns:
converted

convertReceivedCreateSequenceResponse

public CreateSequenceResponseType convertReceivedCreateSequenceResponse(Object create)
Description copied from interface: EncoderDecoder
Convert a received CreateSequenceResponse message to internal form.

Specified by:
convertReceivedCreateSequenceResponse in interface EncoderDecoder
Returns:
converted

convertReceivedTerminateSequence

public TerminateSequenceType convertReceivedTerminateSequence(Object term)
Description copied from interface: EncoderDecoder
Convert a received TerminateSequence message to internal form.

Specified by:
convertReceivedTerminateSequence in interface EncoderDecoder
Returns:
converted

Apache CXF API

Apache CXF