weblogic.jws.jaxws.client.async
Class AsyncClientTransportFeature

java.lang.Object
  javax.xml.ws.WebServiceFeature
      weblogic.jws.jaxws.WLSWebServiceFeature
          weblogic.jws.jaxws.client.async.AsyncClientTransportFeature

All Implemented Interfaces:

com.oracle.webservices.impl.internalapi.client.ServiceCreationInterceptor, com.sun.xml.ws.api.ImpliesWebServiceFeature

public class AsyncClientTransportFeature
extends WLSWebServiceFeature
implements com.sun.xml.ws.api.ImpliesWebServiceFeature, com.oracle.webservices.impl.internalapi.client.ServiceCreationInterceptor

Designates a client that accesses the service through WS-Addressing and asynchronous transport. Use of this feature will by default publish a response endpoint to receive inbound response messages and correlate request and response exchanges. Clients may create multiple ports or Dispatch instances from the same Service instance that share the same response endpoint by specifying the same AsyncClientTransportFeature instance; however, at most one of the port instances may specify AsyncClientHandlerFeature.

ID

public static final String ID

Constant value identifying the AsyncClientTransportFeature

See Also:

Constant Field Values

AsyncClientTransportFeature

public AsyncClientTransportFeature()

Create an AsyncClientTransportFeature. Client proxies created using this feature will publish and use an asynchronous response endpoint with an auto-selected address.

AsyncClientTransportFeature

public AsyncClientTransportFeature(Object context)

Create an AsyncClientTransportFeature that will select an asynchronous response endpoint address within the scope of a pre-existing context. The context parameter may be an instance of javax.servlet.ServletContext. Other context types are implementation dependent.

Parameters:

context - Existing context that will scope response endpoint

See Also:

ServletContext

AsyncClientTransportFeature

public AsyncClientTransportFeature(Object context,
                                   boolean useAsyncWithSyncInvoke)

Create an AsyncClientTransportFeature that will select an asynchronous response endpoint address within the scope of a pre-existing context. The context parameter may be an instance of javax.servlet.ServletContext. Other context types are implementation dependent.

Parameters:

context - Existing context that will scope response endpoint

useAsyncWithSyncInvoke - Determines if async transport will be used with sync invocation

See Also:

ServletContext

AsyncClientTransportFeature

public AsyncClientTransportFeature(String address)

Create an AsyncClientTransportFeature that will publish an asynchronous response endpoint at the given address.
NOTE:This constructor should be used for off-server clients only. Any clients running inside a WLS cluster should use one of the "context based" constructors instead (allowing the client container to calculate the proper address based on the context associated with the container).

Parameters:

address - Asynchronous response endpoint address

AsyncClientTransportFeature

public AsyncClientTransportFeature(W3CEndpointReference replyTo)

Create an AsyncClientTransportFeature that will publish an asynchronous response endpoint at the address specified by the given endpoint reference. This endpoint reference will be used for outgoing ReplyTo headers.
NOTE:This constructor should be used for off-server clients only. Any clients running inside a WLS cluster should use one of the "context based" constructors instead (allowing the client container to calculate the proper address based on the context associated with the container).

Parameters:

replyTo - Asynchronous response endpoint reference

AsyncClientTransportFeature

public AsyncClientTransportFeature(W3CEndpointReference replyTo,
                                   W3CEndpointReference faultTo)

Create an AsyncClientTransportFeature that will publish an asynchronous response endpoint at the address specified by the given replyTo endpoint reference. The replyTo and faultTo endpoint references will be used for outgoing ReplyTo and FaultTo headers, respectively.
NOTE:This constructor should be used for off-server clients only. Any clients running inside a WLS cluster should use one of the "context based" constructors instead (allowing the client container to calculate the proper address based on the context associated with the container).

Parameters:

replyTo - Asynchronous response endpoint reference

faultTo - FaultTo endpoint reference

AsyncClientTransportFeature

public AsyncClientTransportFeature(String address,
                                   boolean doPublish)

Create an AsyncClientTransportFeature. If doPublish is true then an asynchronous response endpoint will be published at the given address. Otherwise, no endpoint will be published, but WSA headers will be added to outbound, non-oneway request messages.
NOTE:This constructor should be used for off-server clients only. Any clients running inside a WLS cluster should use one of the "context based" constructors instead (allowing the client container to calculate the proper address based on the context associated with the container).

Parameters:

address - Asynchronous response endpoint address

doPublish - Determines if response endpoint will be auto-published

AsyncClientTransportFeature

public AsyncClientTransportFeature(W3CEndpointReference replyTo,
                                   boolean doPublish)

Create an AsyncClientTransportFeature. If doPublish is true then an asynchronous response endpoint will be published at the address specified by the replyTo endpoint reference. Otherwise, no endpoint will be published, but WSA headers will be added to outbound, non-oneway request messages.
NOTE:This constructor should be used for off-server clients only. Any clients running inside a WLS cluster should use one of the "context based" constructors instead (allowing the client container to calculate the proper address based on the context associated with the container).

Parameters:

replyTo - Asynchronous response endpoint reference

doPublish - Determines if response endpoint will be auto-published

AsyncClientTransportFeature

public AsyncClientTransportFeature(W3CEndpointReference replyTo,
                                   W3CEndpointReference faultTo,
                                   boolean doPublish)

Create an AsyncClientTransportFeature. If doPublish is true then an asynchronous response endpoint will be published at the address specified by the replyTo endpoint reference. Otherwise, no endpoint will be published, but WSA headers will be added to outbound, non-oneway request messages. The replyTo and faultTo endpoint references will be used for outgoing ReplyTo and FaultTo headers, respectively.
NOTE:This constructor should be used for off-server clients only. Any clients running inside a WLS cluster should use one of the "context based" constructors instead (allowing the client container to calculate the proper address based on the context associated with the container).

Parameters:

replyTo - Asynchronous response endpoint reference

faultTo - FaultTo endpoint reference

doPublish - Determines if response endpoint will be auto-published

AsyncClientTransportFeature

public AsyncClientTransportFeature(String address,
                                   boolean doPublish,
                                   boolean useAsyncWithSyncInvoke)

Create an AsyncClientTransportFeature. If doPublish is true then an asynchronous response endpoint will be published at the given address. Otherwise, no endpoint will be published, but WSA headers will be added to outbound, non-oneway request messages.
NOTE:This constructor should be used for off-server clients only. Any clients running inside a WLS cluster should use one of the "context based" constructors instead (allowing the client container to calculate the proper address based on the context associated with the container).

Parameters:

address - Asynchronous response endpoint address

doPublish - Determines if feature deploys response endpoint or if client application is responsible

useAsyncWithSyncInvoke - Determines if async transport will be used with sync invocation

AsyncClientTransportFeature

public AsyncClientTransportFeature(W3CEndpointReference replyTo,
                                   boolean doPublish,
                                   boolean useAsyncWithSyncInvoke)

Create an AsyncClientTransportFeature. If doPublish is true then an asynchronous response endpoint will be published at the address specified by the replyTo endpoint reference. Otherwise, no endpoint will be published, but WSA headers will be added to outbound, non-oneway request messages.
NOTE:This constructor should be used for off-server clients only. Any clients running inside a WLS cluster should use one of the "context based" constructors instead (allowing the client container to calculate the proper address based on the context associated with the container).

Parameters:

replyTo - Asynchronous response endpoint reference

doPublish - Determines if response endpoint will be auto-published

useAsyncWithSyncInvoke - Determines if async transport will be used with sync invocation

AsyncClientTransportFeature

public AsyncClientTransportFeature(W3CEndpointReference replyTo,
                                   W3CEndpointReference faultTo,
                                   boolean doPublish,
                                   boolean useAsyncWithSyncInvoke)

Create an AsyncClientTransportFeature. If doPublish is true then an asynchronous response endpoint will be published at the address specified by the replyTo endpoint reference. Otherwise, no endpoint will be published, but WSA headers will be added to outbound, non-oneway request messages. The replyTo and faultTo endpoint references will be used for outgoing ReplyTo and FaultTo headers, respectively.
NOTE:This constructor should be used for off-server clients only. Any clients running inside a WLS cluster should use one of the "context based" constructors instead (allowing the client container to calculate the proper address based on the context associated with the container).

Parameters:

replyTo - Asynchronous response endpoint reference

faultTo - FaultTo endpoint reference

doPublish - Determines if response endpoint will be auto-published

useAsyncWithSyncInvoke - Determines if async transport will be used with sync invocation

setAsyncResponseEndpointRegistry

public static void setAsyncResponseEndpointRegistry(AsyncClientTransportFeature.AsyncResponseEndpointRegistry registry)

postCreateDispatch

public void postCreateDispatch(com.sun.xml.ws.developer.WSBindingProvider bp)

Description copied from interface: com.oracle.webservices.impl.internalapi.client.ServiceCreationInterceptor

A callback to notify that a Dispatch object is created. The callback could set some properties on the BindingProvider.

Specified by:

postCreateDispatch in interface com.oracle.webservices.impl.internalapi.client.ServiceCreationInterceptor

Parameters:

bp - BindingProvider of dispatch object

postCreateProxy

public void postCreateProxy(com.sun.xml.ws.developer.WSBindingProvider bp,
                            Class<?> serviceEndpointInterface)

Description copied from interface: com.oracle.webservices.impl.internalapi.client.ServiceCreationInterceptor

A callback to notify the event of creation of proxy object for SEI endpoint. The callback could set some properties on the BindingProvider.

Specified by:

postCreateProxy in interface com.oracle.webservices.impl.internalapi.client.ServiceCreationInterceptor

Parameters:

bp - created proxy instance

serviceEndpointInterface - SEI of the endpoint

setSslPort

public void setSslPort(int sslPort)

Set the port used for SSL or -1 to disable SSL use on this feature. NOTE: The SSL port is calculated automatically if this feature is initialized using a context object that supports automatic discovery of SSL configuration (e.g. running in WLS service, EJB or web app container).

getSslPort

public int getSslPort()

Get the port used for SSL or -1 if unset.

notifyEndpointListenersEndpointDisposed

public void notifyEndpointListenersEndpointDisposed()

preRegisterForSharedEndpoint

public void preRegisterForSharedEndpoint(ClientIdentityFeature clientIdFeature)

dispose

public void dispose()

isEndpointShared

public boolean isEndpointShared()

Determine if the endpoint returned by getEndpoint() is actually a 'shared' endpoint (that was registered/associated with a client identity). If this is the case, this endpoint has the same lifetime as the client identity. If the client identity is disposed, the endpoint will be closed.

getEndpoint

public Endpoint getEndpoint()

getEndpointReference

public <T extends EndpointReference> T getEndpointReference(Class<T> clazz,
                                                            Element... referenceParameters)

Generates endpoint reference for response endpoint

Parameters:

clazz - Endpoint reference type

referenceParameters - Reference parameters

Returns:

Endpoint reference for response endpoint

getID

public String getID()

Returns feature ID

Specified by:

getID in class WebServiceFeature

isUseAsyncWithSyncInvoke

public boolean isUseAsyncWithSyncInvoke()

setUseAsyncWithSyncInvoke

public void setUseAsyncWithSyncInvoke(boolean useAsyncWithSyncInvoke)

implyFeatures

public void implyFeatures(com.sun.xml.ws.api.WSFeatureList list)

Specified by:

implyFeatures in interface com.sun.xml.ws.api.ImpliesWebServiceFeature

isEndpointPublished

public boolean isEndpointPublished()

addAsyncEndpointListener

public void addAsyncEndpointListener(AsyncClientTransportFeature.AsyncEndpointListener listener)

removeAsyncEndpointListener

public void removeAsyncEndpointListener(AsyncClientTransportFeature.AsyncEndpointListener listener)

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object other)

Overrides:

equals in class Object

getClientIdComponent

public String getClientIdComponent()

Overrides:

getClientIdComponent in class WLSWebServiceFeature

toString

public String toString()

Overrides:

toString in class Object