public class ClientIdentityFeature extends WebServiceFeature
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).
Modifier and Type | Class and Description |
---|---|
static interface |
ClientIdentityFeature.ParentIdCalculator
Deprecated.
|
static class |
ClientIdentityFeature.Type
Deprecated.
|
enabled
Constructor and Description |
---|
ClientIdentityFeature()
Deprecated.
Create a ClientIdentityFeature with a null raw client ID.
|
ClientIdentityFeature(String rawClientId)
Deprecated.
Create a ClientIdentityFeature with the given raw client ID.
|
Modifier and Type | Method and Description |
---|---|
void |
addPropertyChangeListener(PropertyChangeListener listener)
Deprecated.
|
String |
calculateParentId()
Deprecated.
Calculates the ID of the parent container for this client.
|
void |
dispose()
Deprecated.
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.
|
boolean |
equals(Object other)
Deprecated.
|
String |
getClientId()
Deprecated.
The unique ID for this client.
|
String |
getID()
Deprecated.
Get the ID for this feature type
|
String |
getParentId()
Deprecated.
Get the portion of the clientId for this feature that was prepended to
the rawClientId (if any).
|
String |
getRawClientId()
Deprecated.
The unique ID for this client.
|
int |
hashCode()
Deprecated.
|
boolean |
isGeneratedRawClientId()
Deprecated.
Returns an indication of whether the raw client ID for this feature was
system generated (true) or not (false).
|
void |
removePropertyChangeListener(PropertyChangeListener listener)
Deprecated.
|
void |
setClientId(String clientId)
Deprecated.
Allows a client to set its own unique client ID.
|
void |
setClientId(String clientId,
boolean prependContext)
Deprecated.
Allows a client to set its own unique client ID.
|
void |
setGeneratedRawClientId(String rawClientId)
Deprecated.
System use only.
|
static void |
setParentIdCalculator(ClientIdentityFeature.ParentIdCalculator calc)
Deprecated.
|
String |
toString()
Deprecated.
|
isEnabled
public ClientIdentityFeature()
public ClientIdentityFeature(String rawClientId)
public static void setParentIdCalculator(ClientIdentityFeature.ParentIdCalculator calc)
public String getID()
getID
in class WebServiceFeature
public void setClientId(String clientId)
clientId
- The ID to use. Must not be null.ClientIdentityFeature.setClientId(String, boolean)
public void setClientId(String clientId, boolean prependContext)
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 featurepublic void setGeneratedRawClientId(String rawClientId)
public boolean isGeneratedRawClientId()
public void addPropertyChangeListener(PropertyChangeListener listener)
public void removePropertyChangeListener(PropertyChangeListener listener)
public void dispose()
public String calculateParentId()
public String getClientId()
public String getRawClientId()
public String getParentId()