org.apache.cxf.ws.rm
Interface EncoderDecoder

All Known Implementing Classes:

EncoderDecoder10AImpl, EncoderDecoder10Impl, EncoderDecoder11Impl

public interface EncoderDecoder

Interface for converting WS-ReliableMessaging structures to and from XML. Implementations of this interface provide version-specific encoding and decoding.

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.

Method Detail

getWSRMNamespace

String getWSRMNamespace()

Get the WS-ReliableMessaging namespace used by this encoder/decoder.

Returns:

URI

getWSANamespace

String getWSANamespace()

Get the WS-Addressing namespace used by this encoder/decoder.

Returns:

URI

getConstants

RMConstants getConstants()

Get the WS-ReliableMessaging constants used by this encoder/decoder.

Returns:

getCreateSequenceType

Class getCreateSequenceType()

Get the class used for the CreateSequenceType.

Returns:

class

getCreateSequenceResponseType

Class getCreateSequenceResponseType()

Get the class used for the CreateSequenceResponseType.

Returns:

class

getTerminateSequenceType

Class getTerminateSequenceType()

Get the class used for the TerminateSequenceType.

Returns:

class

buildHeaders

Element buildHeaders(RMProperties rmps,
                     QName qname)
                     throws javax.xml.bind.JAXBException

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.

Parameters:

rmps -

qname - constructed element name

Returns:

element

Throws:

javax.xml.bind.JAXBException

buildHeaderFault

Element buildHeaderFault(SequenceFault sf,
                         QName qname)
                         throws javax.xml.bind.JAXBException

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.

Parameters:

sf -

qname - constructed element name

Returns:

element

Throws:

javax.xml.bind.JAXBException

encodeSequenceAcknowledgement

Element encodeSequenceAcknowledgement(SequenceAcknowledgement ack)
                                      throws javax.xml.bind.JAXBException

Marshals a SequenceAcknowledgement to the appropriate external form.

Parameters:

ack -

Returns:

element

Throws:

javax.xml.bind.JAXBException

encodeIdentifier

Element encodeIdentifier(Identifier id)
                         throws javax.xml.bind.JAXBException

Marshals an Identifier to the appropriate external form.

Parameters:

id -

Returns:

element

Throws:

javax.xml.bind.JAXBException

decodeSequenceType

SequenceType decodeSequenceType(Element elem)
                                throws javax.xml.bind.JAXBException

Unmarshals a SequenceType, converting it if necessary to the internal form.

Parameters:

elem -

Returns:

Throws:

javax.xml.bind.JAXBException

decodeSequenceTypeCloseSequence

CloseSequenceType decodeSequenceTypeCloseSequence(Element elem)
                                                  throws javax.xml.bind.JAXBException

Generates a CloseSequenceType if a SequenceType represents a last message state.

Parameters:

elem -

Returns:

CloseSequenceType if last message state, else null

Throws:

javax.xml.bind.JAXBException

decodeSequenceAcknowledgement

SequenceAcknowledgement decodeSequenceAcknowledgement(Element elem)
                                                      throws javax.xml.bind.JAXBException

Unmarshals a SequenceAcknowledgement, converting it if necessary to the internal form.

Parameters:

elem -

Returns:

Throws:

javax.xml.bind.JAXBException

decodeAckRequestedType

AckRequestedType decodeAckRequestedType(Element elem)
                                        throws javax.xml.bind.JAXBException

Unmarshals a AckRequestedType, converting it if necessary to the internal form.

Parameters:

elem -

Returns:

Throws:

javax.xml.bind.JAXBException

convertToSend

Object convertToSend(CreateSequenceType create)

Convert a CreateSequence message to the correct format for transmission.

Parameters:

create -

Returns:

converted

convertToSend

Object convertToSend(CreateSequenceResponseType create)

Convert a CreateSequenceResponse message to the correct format for transmission.

Parameters:

create -

Returns:

converted

convertToSend

Object convertToSend(TerminateSequenceType term)

Convert a TerminateSequence message to the correct format for transmission.

Parameters:

term -

Returns:

converted

convertReceivedTerminateSequence

TerminateSequenceType convertReceivedTerminateSequence(Object term)

Convert a received TerminateSequence message to internal form.

Parameters:

term -

Returns:

converted

convertReceivedCreateSequence

CreateSequenceType convertReceivedCreateSequence(Object create)

Convert a received CreateSequence message to internal form.

Parameters:

create -

Returns:

converted

convertReceivedCreateSequenceResponse

CreateSequenceResponseType convertReceivedCreateSequenceResponse(Object create)

Convert a received CreateSequenceResponse message to internal form.

Parameters:

create -

Returns:

converted