|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.sun.xml.ws.rm.runtime.PacketAdapter
public abstract class PacketAdapter
Method Summary | ||
---|---|---|
abstract void |
appendAckRequestedHeader(java.lang.String sequenceId)
TODO javadoc |
|
void |
appendHeader(java.lang.Object jaxbHeaderContent)
Utility method which creates a RM Header with the specified JAXB bean content
and adds it to the message stored in the underlying packet. |
|
abstract void |
appendSequenceAcknowledgementHeader(Sequence sequence)
TODO javadoc |
|
abstract void |
appendSequenceHeader(java.lang.String sequenceId,
long messageNumber)
TODO javadoc |
|
void |
checkMessageReadyState()
Checks internal state of this PacketAdapter instance whether it is
safe to perform message read or update operations. |
|
void |
checkPacketReadyState()
Checks internal state of this PacketAdapter instance whether it is
safe to perform packet read or update operations. |
|
PacketAdapter |
closeTransportAndReturnNull()
|
|
void |
consume()
TODO javadoc |
|
boolean |
containsMessage()
TODO javadoc |
|
com.sun.xml.ws.api.message.Packet |
copyPacket(boolean copyMessage)
TODO javadoc |
|
PacketAdapter |
createAckResponse(Sequence sequence,
java.lang.String wsaAction)
TODO javadoc |
|
PacketAdapter |
createEmptyServerResponse(java.lang.String wsaAction)
TODO javadoc |
|
PacketAdapter |
createServerResponse(java.lang.Object jaxbElement,
java.lang.String wsaAction)
TODO javadoc |
|
void |
exposeSequenceDataToUser()
|
|
java.lang.String |
getAckRequestedHeaderSequenceId()
TODO javadoc |
|
java.lang.String |
getDestination()
Provides information about value of the addressing To header
of the message in the wrapped Packet instance. |
|
static PacketAdapter |
getInstance(RmVersion rmVersion,
com.sun.xml.ws.api.SOAPVersion soapVersion,
com.sun.xml.ws.api.addressing.AddressingVersion addressingVersion,
com.sun.xml.ws.api.message.Packet packet)
|
|
static PacketAdapter |
getInstance(RxConfiguration configuration,
com.sun.xml.ws.api.message.Packet packet)
Provides an instance of a packet adapter based on the configuration and attaches a provided packet instance to it. |
|
long |
getMessageNumber()
TODO javadoc |
|
com.sun.xml.ws.api.message.Packet |
getPacket()
TODO javadoc |
|
java.lang.String |
getSecurityContextTokenId()
TODO javadoc |
|
java.lang.String |
getSequenceId()
TODO javadoc |
|
Session |
getSession()
TODO javadoc |
|
java.lang.String |
getWsaAction()
Provides information about value of the addressing Action header
of the message in the wrapped Packet instance. |
|
boolean |
hasSession()
TODO javadoc |
|
boolean |
isFault()
TODO javadoc |
|
boolean |
isProtocolMessage()
TODO javadoc |
|
boolean |
isProtocolRequest()
TODO javadoc |
|
boolean |
isProtocolResponse()
TODO javadoc |
|
boolean |
isRmFault()
TODO javadoc |
|
boolean |
isSecurityContextTokenIdValid(java.lang.String expectedSctId)
Determines whether the security context token identifier used to secure the message wrapped in this adapter is the expected one |
|
PacketAdapter |
keepTransportBackChannelOpen()
TODO javadoc |
|
abstract void |
processAcknowledgements(SequenceManager sequenceManager,
java.lang.String expectedAckedSequenceId)
TODO javadoc |
|
|
readHeaderAsUnderstood(java.lang.String name)
Utility method which retrieves the RM header with the specified name from the underlying Message 's
{@link HeaderList) in the form of JAXB element and marks the header as understood. |
|
PacketAdapter |
setEmptyRequestMessage(java.lang.String wsaAction)
Creates a new JAX-WS Message object that doesn't have any payload
and sets it as the current packet content as a request message. |
|
PacketAdapter |
setEmptyResponseMessage(PacketAdapter requestAdapter,
java.lang.String wsaAction)
TODO javadoc |
|
PacketAdapter |
setRequestMessage(java.lang.Object jaxbElement,
java.lang.String wsaAction)
TODO javadoc Creates a new JAX-WS Message object backed by a JAXB bean using JAXB context of a configured RM version. |
|
void |
setSequenceData(java.lang.String sequenceId,
long messageNumber)
TODO javadoc |
|
void |
setSession(java.lang.String sessionId)
TODO javadoc |
|
|
unmarshallMessage()
Unmarshalls underlying JAXWS Message using JAXB context of a configured RM version |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Method Detail |
---|
public static PacketAdapter getInstance(@NotNull RxConfiguration configuration, @NotNull com.sun.xml.ws.api.message.Packet packet)
packet
instance to it.
configuration
- configuration used to configure newly created packetpacket
- Packet
instance to be attached to the newly created packet adapter
PacketAdapter
instancepublic static PacketAdapter getInstance(@NotNull RmVersion rmVersion, @NotNull com.sun.xml.ws.api.SOAPVersion soapVersion, @NotNull com.sun.xml.ws.api.addressing.AddressingVersion addressingVersion, @NotNull com.sun.xml.ws.api.message.Packet packet)
public final void consume()
public final com.sun.xml.ws.api.message.Packet getPacket()
public final com.sun.xml.ws.api.message.Packet copyPacket(boolean copyMessage)
public final PacketAdapter createServerResponse(java.lang.Object jaxbElement, java.lang.String wsaAction)
public final PacketAdapter createEmptyServerResponse(java.lang.String wsaAction)
public final PacketAdapter createAckResponse(Sequence sequence, java.lang.String wsaAction) throws RxRuntimeException
requestAdapter
- inboundSequence
- wsaAction
-
RxRuntimeException
public final PacketAdapter closeTransportAndReturnNull()
public final void appendHeader(java.lang.Object jaxbHeaderContent) throws java.lang.IllegalStateException
Header
with the specified JAXB bean content
and adds it to the message stored in the underlying packet.
jaxbHeaderContent
- content of the newly created Header
java.lang.IllegalStateException
- in case of failed internal state checkpublic abstract void appendSequenceHeader(@NotNull java.lang.String sequenceId, long messageNumber) throws RxRuntimeException
RxRuntimeException
public abstract void appendAckRequestedHeader(@NotNull java.lang.String sequenceId) throws RxRuntimeException
RxRuntimeException
public abstract void appendSequenceAcknowledgementHeader(@NotNull Sequence sequence) throws RxRuntimeException
RxRuntimeException
public final PacketAdapter keepTransportBackChannelOpen()
public final PacketAdapter setEmptyRequestMessage(java.lang.String wsaAction)
Message
object that doesn't have any payload
and sets it as the current packet content as a request message.
wsaAction
- WS-Addressing action header to set
PacketAdapter
instancepublic final PacketAdapter setEmptyResponseMessage(PacketAdapter requestAdapter, java.lang.String wsaAction)
requestAdapter
- wsaAction
-
public final PacketAdapter setRequestMessage(java.lang.Object jaxbElement, java.lang.String wsaAction)
Message
object backed by a JAXB bean using JAXB context of a configured RM version.
jaxbObject
- The JAXB object that represents the payload. must not be null. This object
must be bound to an element (which means it either is a JAXBElement
or
an instanceof a class with XmlRootElement
).wsaAction
-
PacketAdapter
instancepublic final boolean isProtocolMessage()
public final boolean isProtocolRequest()
public final boolean isProtocolResponse()
public final boolean isRmFault()
public final boolean isFault()
public final boolean containsMessage()
public final java.lang.String getWsaAction()
Action
header
of the message in the wrapped Packet
instance.
Action
header of the message in the wrapped Packet
instance.public final java.lang.String getDestination()
To
header
of the message in the wrapped Packet
instance.
To
header of the message in the wrapped Packet
instance.public final <T> T readHeaderAsUnderstood(java.lang.String name) throws RxRuntimeException
Message
's
{@link HeaderList) in the form of JAXB element and marks the header as understood.
name
- the name of the Header
to find.
null
in case no such header was found
RxRuntimeException
public final <T> T unmarshallMessage() throws RxRuntimeException
Message
using JAXB context of a configured RM version
RxException
- in case the message unmarshalling failed
RxRuntimeException
public final java.lang.String getSequenceId() throws RxRuntimeException
RxRuntimeException
public final long getMessageNumber() throws RxRuntimeException
RxRuntimeException
public final void setSequenceData(java.lang.String sequenceId, long messageNumber)
public final java.lang.String getAckRequestedHeaderSequenceId() throws RxRuntimeException
RxRuntimeException
public abstract void processAcknowledgements(SequenceManager sequenceManager, java.lang.String expectedAckedSequenceId) throws RxRuntimeException
RxRuntimeException
public Session getSession()
public boolean hasSession()
public void setSession(java.lang.String sessionId)
public void exposeSequenceDataToUser()
public final java.lang.String getSecurityContextTokenId()
public final void checkMessageReadyState() throws java.lang.IllegalStateException
PacketAdapter
instance whether it is
safe to perform message read or update operations. Success of this condition guarantees
the success of #checkPacketUpdateState()
operation.
java.lang.IllegalStateException
- if the check failspublic final void checkPacketReadyState() throws java.lang.IllegalStateException
PacketAdapter
instance whether it is
safe to perform packet read or update operations. Success of this condition does not
guarantee the success of #checkMessageUpdateState()
operation.
java.lang.IllegalStateException
- if the check failspublic final boolean isSecurityContextTokenIdValid(java.lang.String expectedSctId)
expectedStrId
- expected security context token identifier
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |