Package com.sun.xml.ws.api.addressing

Class OneWayFeature

java.lang.Object

javax.xml.ws.WebServiceFeature

com.sun.xml.ws.api.addressing.OneWayFeature

@ManagedData
public class OneWayFeature
extends javax.xml.ws.WebServiceFeature

Unsupported RI extension to work around an issue in WSIT.

This feature is not meant to be used by a common Web service developer as there is no need to send the above mentioned header for a one-way operation. But these properties may need to be sent in certain middleware Web services.

This feature allows ReplyTo, From and RelatesTo Message Addressing Properties to be added for all messages that are sent from the port configured with this annotation. All operations are assumed to be one-way, and this feature should be used for one-way operations only. If a non-null ReplyTo is specified, then MessageID property is also added.

Author:

Arun Gupta

Field Summary

Fields

Modifier and Type	Field	Description
static String	ID	Constant value identifying the OneWayFeature

Fields inherited from class javax.xml.ws.WebServiceFeature

enabled

Constructor Summary

Constructors

Constructor	Description
OneWayFeature()	Create an OneWayFeature.
OneWayFeature(boolean enabled)	Create an OneWayFeature
OneWayFeature(boolean enabled, WSEndpointReference replyTo)	Create an OneWayFeature
OneWayFeature(boolean enabled, WSEndpointReference replyTo, WSEndpointReference from, String relatesTo)	Create an OneWayFeature
OneWayFeature(AddressingPropertySet a, AddressingVersion v)

Method Summary

Modifier and Type	Method	Description
static WSEndpointReference	enableSslForEpr(WSEndpointReference epr, String sslHost, int sslPort)	Calculate a new EPR using an existing one and substituting SSL specific host and port values.
WSEndpointReference	getFaultTo()	Getter for wsa:FaultTo header WSEndpointReference.
WSEndpointReference	getFaultTo(boolean ssl)
WSEndpointReference	getFrom()	Getter for wsa:From header WSEndpointReference.
String	getID()
String	getMessageId()
String	getRelatesToID()	Getter for MessageID for wsa:RelatesTo header.
WSEndpointReference	getReplyTo()	Getter for wsa:ReplyTo header WSEndpointReference .
WSEndpointReference	getReplyTo(boolean ssl)
WSEndpointReference	getSslFaultTo()
WSEndpointReference	getSslReplyTo()
boolean	hasSslEprs()
boolean	isUseAsyncWithSyncInvoke()	Getter for whether async is to be used with sync invoke
void	setFaultTo(WSEndpointReference address)	Setter for wsa:FaultTo header WSEndpointReference.
void	setFrom(WSEndpointReference address)	Setter for wsa:From header WSEndpointReference.
void	setRelatesToID(String id)	Setter for MessageID for wsa:RelatesTo header.
void	setReplyTo(WSEndpointReference address)	Setter for wsa:ReplyTo header WSEndpointReference.
void	setSslFaultTo(WSEndpointReference sslFaultTo)
void	setSslReplyTo(WSEndpointReference sslReplyTo)
void	setUseAsyncWithSyncInvoke(boolean useAsyncWithSyncInvoke)	Setter for whether async is to be used with sync invoke

Methods inherited from class javax.xml.ws.WebServiceFeature

isEnabled

Methods inherited from class java.lang.Object

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

Field Detail

ID

public static final String ID

Constant value identifying the OneWayFeature

See Also:

Constant Field Values

Constructor Detail

OneWayFeature

public OneWayFeature()

Create an OneWayFeature. The instance created will be enabled.

OneWayFeature

public OneWayFeature(boolean enabled)

Create an OneWayFeature

Parameters:

enabled - specifies whether this feature should be enabled or not.

OneWayFeature

public OneWayFeature(boolean enabled,
                     WSEndpointReference replyTo)

Create an OneWayFeature

Parameters:

enabled - specifies whether this feature should be enabled or not.

replyTo - specifies the WSEndpointReference of wsa:ReplyTo header.

OneWayFeature

public OneWayFeature(boolean enabled,
                     WSEndpointReference replyTo,
                     WSEndpointReference from,
                     String relatesTo)

Create an OneWayFeature

Parameters:

enabled - specifies whether this feature should be enabled or not.

replyTo - specifies the WSEndpointReference of wsa:ReplyTo header.

from - specifies the WSEndpointReference of wsa:From header.

relatesTo - specifies the MessageID to be used for wsa:RelatesTo header.

OneWayFeature

public OneWayFeature(AddressingPropertySet a,
                     AddressingVersion v)

Method Detail

getMessageId

public String getMessageId()

getID

@ManagedAttribute
public String getID()

Specified by:

getID in class javax.xml.ws.WebServiceFeature

hasSslEprs

public boolean hasSslEprs()

getReplyTo

@ManagedAttribute
public WSEndpointReference getReplyTo()

Getter for wsa:ReplyTo header WSEndpointReference .

Returns:

address of the wsa:ReplyTo header

getReplyTo

public WSEndpointReference getReplyTo(boolean ssl)

setReplyTo

public void setReplyTo(WSEndpointReference address)

Setter for wsa:ReplyTo header WSEndpointReference.

Parameters:

address -

getSslReplyTo

public WSEndpointReference getSslReplyTo()

setSslReplyTo

public void setSslReplyTo(WSEndpointReference sslReplyTo)

getFrom

@ManagedAttribute
public WSEndpointReference getFrom()

Getter for wsa:From header WSEndpointReference.

Returns:

address of the wsa:From header

setFrom

public void setFrom(WSEndpointReference address)

Setter for wsa:From header WSEndpointReference.

Parameters:

address - of the wsa:From header

getRelatesToID

@ManagedAttribute
public String getRelatesToID()

Getter for MessageID for wsa:RelatesTo header.

Returns:

address of the wsa:FaultTo header

setRelatesToID

public void setRelatesToID(String id)

Setter for MessageID for wsa:RelatesTo header.

Parameters:

id -

getFaultTo

public WSEndpointReference getFaultTo()

Getter for wsa:FaultTo header WSEndpointReference.

Returns:

address of the wsa:FaultTo header

getFaultTo

public WSEndpointReference getFaultTo(boolean ssl)

setFaultTo

public void setFaultTo(WSEndpointReference address)

Setter for wsa:FaultTo header WSEndpointReference.

Parameters:

address - of the wsa:FaultTo header

getSslFaultTo

public WSEndpointReference getSslFaultTo()

setSslFaultTo

public void setSslFaultTo(WSEndpointReference sslFaultTo)

isUseAsyncWithSyncInvoke

public boolean isUseAsyncWithSyncInvoke()

Getter for whether async is to be used with sync invoke

Returns:

whether async is to be used with sync invoke

setUseAsyncWithSyncInvoke

public void setUseAsyncWithSyncInvoke(boolean useAsyncWithSyncInvoke)

Setter for whether async is to be used with sync invoke

Parameters:

useAsyncWithSyncInvoke - whether async is to be used with sync invoke

enableSslForEpr

public static WSEndpointReference enableSslForEpr(@NotNull
                                                  WSEndpointReference epr,
                                                  @Nullable
                                                  String sslHost,
                                                  int sslPort)

Calculate a new EPR using an existing one and substituting SSL specific host and port values.

Parameters:

epr - Existing EPR that will be the starting point for the SSL version

sslHost - New SSL host or null if the existing host should be used

sslPort - New SSL port or -1 if the existing port should be used

Returns: