weblogic.jws.jaxws.client
Class ClientIdentityFeature

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

public class ClientIdentityFeature
extends WLSWebServiceFeature

Client-side feature to track the identity for a client (client is a location in the code that creates client instances (Port/Stub instances) for a particular business purpose. If you decide to use durable client instances (client instances that are re-initialized if they don't complete before the current VM is restarted), you should take care to call the 'dispose' method on this class when you are done using any of the durable client instances you may have created using this ClientIdentityFeature.

Best practice is to initialize a ClientIdentityFeature as a VM singleton, and to dispose it when the 'container' for the code exits (for example in a PreDestroy annotated method).

ClientIdentityFeature

public ClientIdentityFeature()

Create a ClientIdentityFeature with a null raw client ID. If the caller doesn't immediately assign a client ID via setClientId, a default ID will be assigned.

ClientIdentityFeature

public ClientIdentityFeature(String rawClientId)

Create a ClientIdentityFeature with the given raw client ID. This raw ID will be combined with any context qualifier we find from the current environment (e.g. app/module name) to yield a server-wide unique ID.

setParentIdCalculator

public static void setParentIdCalculator(ClientIdentityFeature.ParentIdCalculator calc)

getID

public String getID()

Get the ID for this feature type

Specified by:

getID in class WebServiceFeature

Returns:

the ID

setClientId

public void setClientId(String clientId)

Allows a client to set its own unique client ID. This ID should be given any time the same client is constructed (for the same purpose, same variable, same code, etc.). This method is equivalent to calling setClientId(clientId, true). This method will fire a PropertyChangeEvent with the name ClientId.

Parameters:

clientId - The ID to use. Must not be null.

See Also:

ClientIdentityFeature.setClientId(String, boolean)

setClientId

public void setClientId(String clientId,
                        boolean prependContext)

Allows a client to set its own unique client ID. This ID should be given any time the same client is constructed (for the same purpose, same variable, same code, etc.). If prependContext is true, this name must be unique within the component or module within an application. The client-supplied ID is combined with the current context of this feture (e.g. on-server this is the name/version of the host application and component/module) to generate a server-wide unique ID. The getClientId() method returns this generated server-wide unique ID. The getRawClientId() method returns the raw client ID given to this method. If prependContext is false, the given ID is used directly as the client ID, and getClientId() and getRawClientId() will return the same value. This method will fire a PropertyChangeEvent with the name ClientId.

Parameters:

clientId - The ID to use. This will be the value returned by getRawClientId (and getClientId() too if prependContext is false). Must not be null.

prependContext - If true, the actual client ID used for this feature will be <context>:clientId where <context> is the context in which this client is being initialized. On-server, this context is <server name>:<app name>[_<app version>]:<component name> Off-server this context is empty. If prependContext is false, the clientID param is used directly as the full client ID of the feature

setGeneratedRawClientId

public void setGeneratedRawClientId(String rawClientId)

System use only. Sets a generated ID as needed.

isGeneratedRawClientId

public boolean isGeneratedRawClientId()

Returns an indication of whether the raw client ID for this feature was system generated (true) or not (false).

addPropertyChangeListener

public void addPropertyChangeListener(PropertyChangeListener listener)

removePropertyChangeListener

public void removePropertyChangeListener(PropertyChangeListener listener)

dispose

public void dispose()

Dispose of any resources held by the client identified by this feature, thus allowing the ID for this client to be reused later in the lifetime of the current VM.

calculateParentId

public String calculateParentId()

Calculates the ID of the parent container for this client.

Returns:

The ID of the parent or null if none could be determined.

getClientId

public String getClientId()

The unique ID for this client. This can be a system-generated ID or one that was specified directly by the client (in the latter case, the ID returned is the ID generated to contain both the client specified ID and the host application name/version.

Returns:

the unique id

getRawClientId

public String getRawClientId()

The unique ID for this client. This can be a system-generated ID or one that was specified directly by the client (and does not include any app name/version so will not generally be unique in the server).

Returns:

the unique id

getParentId

public String getParentId()

Get the portion of the clientId for this feature that was prepended to the rawClientId (if any).

Returns:

The prepended ID that together with rawClientId was used to form the full clientId for this feature, or null if no context was prepended.

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object other)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object