uk.nhs.interoperability.transport.WS

Class WSSOAPMessageImpl

java.lang.Object

uk.nhs.interoperability.payload.ITKMessageImpl

uk.nhs.interoperability.transport.WS.WSSOAPMessageImpl

All Implemented Interfaces:

ITKMessage

public class WSSOAPMessageImpl
extends ITKMessageImpl

The Class WSSOAPMessageImpl.

Since:

0.1

Author:

Michael Odling-Smee, Nicholas Jones

Field Summary

Fields

Modifier and Type	Field and Description
static String	ASYNCREQ The Constant ASYNCREQ.
static String	ASYNCRESP The Constant ASYNCRESP.
static String	SYNCREQ The Constant SYNCREQ.
static String	SYNCRESP The Constant SYNCRESP.

Fields inherited from class uk.nhs.interoperability.payload.ITKMessageImpl

businessPayload, isResponse, messageProperties, preResolvedTransportRoute

Constructor Summary

Constructors

Constructor and Description
WSSOAPMessageImpl() Instantiates a new wSSOAP message impl.
WSSOAPMessageImpl(ITKMessage itkMessage, String messageType)
WSSOAPMessageImpl(ITKTransportRoute destination, ITKMessage itkMessage, String messageType) Instantiates a new wSSOAP message impl.

Method Summary

Methods

Modifier and Type	Method and Description
String	getAction() Gets the action.
Calendar	getCreated() Gets the created.
String	getCreatedDateString() Gets the created date string.
Calendar	getExpires() Gets the expires.
String	getExpiryDateString() Gets the expiry date string.
String	getFaultTo() Gets the fault to.
String	getFrom() Gets the from.
String	getFullPayload() Obtains the full ITKMessage including any wrappers
String	getMessageId() Gets the message id.
String	getMsgType() Gets the msg type.
String	getPayload() Gets the payload.
ITKTransportRoute	getPreresolvedRoute() Obtains any pre-resolved ITKTransportRoute associated with this ITKMessage. A pre-resolved transport route might be present if this ITKMessage instance is a response where the return address is already known (e.g.
String	getReplyTo() Gets the reply to.
int	getTimeToLive() Gets the time to live.
String	getTo() Gets the to.
String	getUsername() Gets the username.
String	serialise() Serialise.
void	setAction(String action) Sets the action.
void	setFaultTo(String faultTo) Sets the fault to.
void	setFrom(String from) Sets the from.
void	setMsgType(String msgType) Sets the msg type.
void	setPayload(String businessPayload) Sets the payload.
void	setReplyTo(String replyTo) Sets the reply to.
void	setTimeToLive(int ttl) Sets the time to live.
void	setTo(String to) Sets the to.
void	setUsername(String username) Sets the username.

Methods inherited from class uk.nhs.interoperability.payload.ITKMessageImpl

getBusinessPayload, getMessageProperties, isResponse, setBusinessPayload, setIsReponse, setMessageProperties

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

SYNCREQ

public static final String SYNCREQ

The Constant SYNCREQ.

See Also:

Constant Field Values

SYNCRESP

public static final String SYNCRESP

The Constant SYNCRESP.

See Also:

Constant Field Values

ASYNCREQ

public static final String ASYNCREQ

The Constant ASYNCREQ.

See Also:

Constant Field Values

ASYNCRESP

public static final String ASYNCRESP

The Constant ASYNCRESP.

See Also:

Constant Field Values

Constructor Detail

WSSOAPMessageImpl

public WSSOAPMessageImpl()

Instantiates a new wSSOAP message impl.

WSSOAPMessageImpl

public WSSOAPMessageImpl(ITKMessage itkMessage,
                 String messageType)
                  throws ITKMessagingException

Throws:

ITKMessagingException

WSSOAPMessageImpl

public WSSOAPMessageImpl(ITKTransportRoute destination,
                 ITKMessage itkMessage,
                 String messageType)
                  throws ITKMessagingException

Instantiates a new wSSOAP message impl.

Parameters:

destination - the destination

itkMessage - the itk message

messageType - the message type

Throws:

ITKMessagingException - the iTK messaging exception

Method Detail

getMessageId

public String getMessageId()

Gets the message id.

Returns:

the message id

getAction

public String getAction()

Gets the action.

Returns:

the action

setAction

public void setAction(String action)

Sets the action.

Parameters:

action - the new action

getFrom

public String getFrom()

Gets the from.

Returns:

the from

setFrom

public void setFrom(String from)

Sets the from.

Parameters:

from - the new from

getTo

public String getTo()

Gets the to.

Returns:

the to

setTo

public void setTo(String to)

Sets the to.

Parameters:

to - the new to

getUsername

public String getUsername()

Gets the username.

Returns:

the username

setUsername

public void setUsername(String username)

Sets the username.

Parameters:

username - the new username

getCreated

public Calendar getCreated()

Gets the created.

Returns:

the created

getCreatedDateString

public String getCreatedDateString()

Gets the created date string.

Returns:

the created date string

getExpiryDateString

public String getExpiryDateString()

Gets the expiry date string.

Returns:

the expiry date string

getExpires

public Calendar getExpires()

Gets the expires.

Returns:

the expires

getPayload

public String getPayload()

Gets the payload.

Returns:

the payload

getMsgType

public String getMsgType()

Gets the msg type.

Returns:

the msg type

setMsgType

public void setMsgType(String msgType)

Sets the msg type.

Parameters:

msgType - the new msg type

getReplyTo

public String getReplyTo()

Gets the reply to.

Returns:

the reply to

setReplyTo

public void setReplyTo(String replyTo)

Sets the reply to.

Parameters:

replyTo - the new reply to

getFaultTo

public String getFaultTo()

Gets the fault to.

Returns:

the fault to

setFaultTo

public void setFaultTo(String faultTo)

Sets the fault to.

Parameters:

faultTo - the new fault to

getTimeToLive

public int getTimeToLive()

Gets the time to live.

Returns:

the time to live

setTimeToLive

public void setTimeToLive(int ttl)

Sets the time to live.

Parameters:

ttl - the new time to live

getPreresolvedRoute

public ITKTransportRoute getPreresolvedRoute()

Description copied from interface: ITKMessage

Obtains any pre-resolved ITKTransportRoute associated with this ITKMessage.

A pre-resolved transport route might be present if this ITKMessage instance is a response where the return address is already known (e.g. via a SOAP <wsa:ReplyTo/> address provided in the request), or because the application layer has already resolved the ITKTransportRoute for the target destination.

Specified by:

getPreresolvedRoute in interface ITKMessage

Overrides:

getPreresolvedRoute in class ITKMessageImpl

Returns:

a pre-resolved ITKTransportRoute if present, or null otherwise. If no pre-resolved transport route is present it is the responsibility of the implementation to determine the ITKTransportRoute via the DirectoryOfServices.resolveDestination(String, uk.nhs.interoperability.infrastructure.ITKAddress) method call

setPayload

public void setPayload(String businessPayload)

Sets the payload.

Parameters:

businessPayload - the new payload

getFullPayload

public String getFullPayload()
                      throws ITKMessagingException

Description copied from interface: ITKMessage

Obtains the full ITKMessage including any wrappers

Returns:

The full ITK message payload including wrappers. For ITKMessage instances that includes wrappers (for instance where the business payload has been wrapped in a distribution envelope or SOAP envelope) this method returns the full message. Otherwise the method returns an identical String to ITKMessage.getBusinessPayload()

Throws:

ITKMessagingException - If there is an error serialising the full ITKMessage

serialise

@Requirement(traceTo="WS-STD-03",
             status="implemented")
public String serialise()

Serialise.

Returns:

the string