public class WSClientConfig extends Object
Modifier and Type | Field and Description |
---|---|
static AuthCredentials |
DEFAULT_AUTH_CREDENTIALS
Default empty credentials for authenticating against the web service provider
|
static String |
DEFAULT_BASIC_AUTH_VALIDATOR_CLASS_NAME
Default class name for handling basic authentication
|
static int |
DEFAULT_CACHE_SIZE
Default cache size (1000) for the
IWSCacheManager |
static long |
DEFAULT_CACHE_TIMEOUT
Default timeout (10 mins) for the
IWSCacheManager |
static int |
DEFAULT_SOCKET_TIMEOUT
Default timeout (1 min) for socket connections
|
Constructor and Description |
---|
WSClientConfig()
Default constructor, uses default values for all configuration options
|
WSClientConfig(AuthCredentials authCredentials)
Create a new WSClientConfig instance with the specified web service authentication credentials.
|
WSClientConfig(AuthCredentials authCredentials,
IArtifactFactory artifactFactory)
Create a new WSClientConfig instance with the specified web service authentication credentials, as well as
register a factory for generating SAML security artifacts.
|
WSClientConfig(AuthCredentials authCredentials,
IArtifactFactory artifactFactory,
int initialCacheSize,
long cacheTimeout)
Create a new WSClientConfig instance with the specified web service authentication credentials,
register a factory for generating SAML security artifacts, as well as
override the defaults for web service result caching.
|
WSClientConfig(AuthCredentials authCredentials,
int initialCacheSize,
int cacheTimeout)
Create a new WSClientConfig instance with the specified web service authentication credentials, as well as
override the defaults for web service result caching.
|
Modifier and Type | Method and Description |
---|---|
boolean |
equals(WSClientConfig otherConfig)
Compare this instance of WSClient config with another instance, comparing all of the
configured options to determine if all are equal
|
IArtifactFactory |
getArtifactFactory()
Get the
IArtifactFactory implementation registered with WSClient for generating
SAML artifacts for outgoing web service requests with the SAML or HYBRID authentication methods. |
AuthCredentials |
getAuthCredentials()
Get the AuthCredentials object used when authenticating with the web service provider
|
String |
getBasicAuthValidatorClassName()
Get the class name of the registered basic authenticator registered with this instance of WSClient
|
long |
getCacheTimeout()
Get the time-to-live for web service results cache entries
|
int |
getInitialCacheSize()
Get the initial size of the web service results cache
|
String |
getSamlSecurityEndpoint()
Get the endpoint URL used for validating received SAML artifacts.
|
int |
getSocketTimeout()
Get the timeout for web service requests, measured in milliseconds
|
protected boolean |
isEqual(Object obj1,
Object obj2)
Helper method for comparing two objects for equality
|
void |
setArtifactFactory(IArtifactFactory artifactFactory)
Set the
IArtifactFactory implementation registered with WSClient for generating
SAML artifacts for outgoing web service requests with the SAML or HYBRID authentication methods. |
void |
setAuthCredentials(AuthCredentials authCredentials)
Set the AuthCredentials object used when authenticating with the web service provider
|
void |
setBasicAuthValidatorClassName(String basicAuthValidatorClassName)
Set the class name of the registered basic authenticator registered
|
void |
setCacheTimeout(long cacheTimeout)
Set the time-to-live for web service results cache entries
|
void |
setInitialCacheSize(int initialCacheSize)
Set the initial size of the web service results cache
|
void |
setSamlSecurityEndpoint(String samlSecurityEndpoint)
Set the endpoint URL used for validating received SAML artifacts.
|
void |
setSocketTimeout(int socketTimeout)
Set the timeout for web service requests
|
public static final int DEFAULT_CACHE_SIZE
IWSCacheManager
public static final long DEFAULT_CACHE_TIMEOUT
IWSCacheManager
public static final int DEFAULT_SOCKET_TIMEOUT
public static final AuthCredentials DEFAULT_AUTH_CREDENTIALS
public static final String DEFAULT_BASIC_AUTH_VALIDATOR_CLASS_NAME
public WSClientConfig()
public WSClientConfig(AuthCredentials authCredentials)
authCredentials
- the AuthCredentials
to use when authenticating with the web service provider.public WSClientConfig(AuthCredentials authCredentials, int initialCacheSize, int cacheTimeout)
authCredentials
- the AuthCredentials
to use when authenticating with the web service provider.initialCacheSize
- initial size of the web service results cachecacheTimeout
- time-to-live for web service result cache entries before then become stale and thrown awaypublic WSClientConfig(AuthCredentials authCredentials, IArtifactFactory artifactFactory)
authCredentials
- the AuthCredentials
to use when authenticating with the web service provider.artifactFactory
- implementation of IArtifactFactory
to generate SAML artifacts when authenticating web service requests with the SAML or Hybrid authentication method.public WSClientConfig(AuthCredentials authCredentials, IArtifactFactory artifactFactory, int initialCacheSize, long cacheTimeout)
authCredentials
- the AuthCredentials
to use when authenticating with the web service provider.artifactFactory
- implementation of IArtifactFactory
to generate SAML artifacts when authenticating web service requests with the SAML or Hybrid authentication method.initialCacheSize
- initial size of the web service results cachecacheTimeout
- time-to-live for web service result cache entries before then become stale and thrown awaypublic AuthCredentials getAuthCredentials()
public void setAuthCredentials(AuthCredentials authCredentials)
authCredentials
- the AuthCredentials to authenticate web service requestspublic int getInitialCacheSize()
public void setInitialCacheSize(int initialCacheSize)
initialCacheSize
- the initial size to use for the web service results cache, measured in millisecondspublic long getCacheTimeout()
public void setCacheTimeout(long cacheTimeout)
cacheTimeout
- the time-to-live for cache entries, measured in millisecondspublic int getSocketTimeout()
public void setSocketTimeout(int socketTimeout)
socketTimeout
- the timeout value in millisecondspublic String getSamlSecurityEndpoint()
public void setSamlSecurityEndpoint(String samlSecurityEndpoint)
samlSecurityEndpoint
- the SAML security endpoint URL as stringpublic IArtifactFactory getArtifactFactory()
IArtifactFactory
implementation registered with WSClient for generating
SAML artifacts for outgoing web service requests with the SAML or HYBRID authentication methods.IArtifactFactory
public void setArtifactFactory(IArtifactFactory artifactFactory)
IArtifactFactory
implementation registered with WSClient for generating
SAML artifacts for outgoing web service requests with the SAML or HYBRID authentication methods.artifactFactory
- an implementation of IArtifactFactory
to usepublic String getBasicAuthValidatorClassName()
public void setBasicAuthValidatorClassName(String basicAuthValidatorClassName)
basicAuthValidatorClassName
- the name of the authenticator classpublic boolean equals(WSClientConfig otherConfig)
otherConfig
- the instance of WSClientConfig to compare against