IBM WebSphere Application ServerTM
Release 8

com.ibm.wsspi.wssecurity.trust.config
Interface ProviderConfig

All Superinterfaces:
Configuration, ProviderConfiguration

public interface ProviderConfig
extends ProviderConfiguration

A ProviderConfig object encapsulates the state information needed for Trust Client communications with a Security Token provider.
See WSSTrustClient

Settings include:


Method Summary
 java.lang.ClassLoader getApplicationClassLoader()
          Gets the application class loader configuration setting.
 java.lang.String getApplicationName()
          Gets the application name configuration setting.
 java.lang.String getBindingName()
          Gets the binding name configuration setting.
 java.lang.String getBindingScope()
          Gets the binding scope configuration setting.
 boolean getIncludeRSTRProperties()
          Gets the IncludeRSTRProperties configuration setting.
 java.lang.Object getPolicySetConfiguration()
          Gets the policy set configuration configuration setting.
 java.lang.String getPolicySetName()
          Gets the policy set name configuration setting.
 javax.xml.namespace.QName getPortName()
          Gets the port name configuration setting.
 java.util.Map getProperties()
          Retrieves a map of properties related to the provider.
 java.lang.String getProvider()
          Gets the provider configuration setting.
 javax.xml.namespace.QName getServiceName()
          Gets the service name configuration setting.
 java.lang.ClassLoader getSystemClassLoader()
          Gets the system class loader configuration setting.
 java.lang.String getWSTrustNamespace()
          Gets the WS-Trust namespace configuration setting.
 void init(java.lang.String wstNamespace, java.lang.String stsAddress)
          Initializes the ProviderConfig's WS-Trust namespace and STS provider address.
 void setApplicationClassLoader(java.lang.ClassLoader appClassLoader)
          Sets the application class loader configuration setting.
 void setApplicationName(java.lang.String applicationName)
          Using this API may make an application non-portable and and establish a fragile dependency on the application name, i.e., changing the application name during deployment would break the application.
 void setBindingName(java.lang.String bindingName)
          Sets the Binding Name configuration setting.
 void setBindingScope(java.lang.String scope)
          Sets the Binding Scope configuration setting.
 void setIncludeRSTRProperties(boolean includeRSTRProperties)
          Setting indicates if the RSTR Properties should be set in Security Tokens returned by WSSTrustClient.
 void setPolicySet(java.lang.ClassLoader appClassLoader, java.lang.ClassLoader systemClassLoader, java.lang.String policySetName, java.lang.String bindingName, java.lang.String bindingScope)
          Sets policy set related configuration settings.
 void setPolicySetConfiguration(java.lang.Object psc)
          Sets the PolicySetConfiguration configuration setting.
 void setPolicySetName(java.lang.String policySetName)
          Sets the PolicySet name configuration setting.
 void setPortName(javax.xml.namespace.QName portName)
          Sets the Security Token provider's port name configuration setting.
 void setServiceName(javax.xml.namespace.QName serviceName)
          Sets the Security Token provider's service name configuration setting.
 void setSystemClassLoader(java.lang.ClassLoader sysClassLoader)
          Sets the system class loader configuration setting.
 
Methods inherited from interface com.ibm.wsspi.wssecurity.core.token.config.ProviderConfiguration
getIssuerURI, setIssuerURI
 
Methods inherited from interface com.ibm.wsspi.wssecurity.core.config.Configuration
validate
 

Method Detail

getApplicationClassLoader

java.lang.ClassLoader getApplicationClassLoader()
Gets the application class loader configuration setting. (see setApplicationClassLoader(java.lang.ClassLoader))

Returns:
The application class loader configuration setting.

getApplicationName

java.lang.String getApplicationName()
Gets the application name configuration setting. (see setApplicationName(java.lang.String)).

The application name setting is optional. Users are recommend NOT to set the application name. The WSTrustClient runtime will dynamically determine application name as needed.

Returns:
The application name configuration setting.

getBindingName

java.lang.String getBindingName()
Gets the binding name configuration setting. (see setBindingName(java.lang.String)).

Returns:
The binding name configuration setting.

getBindingScope

java.lang.String getBindingScope()
Gets the binding scope configuration setting. (see setBindingScope(java.lang.String)

Returns:
The binding scope configuration setting.

getIncludeRSTRProperties

boolean getIncludeRSTRProperties()
Gets the IncludeRSTRProperties configuration setting. (see setIncludeRSTRProperties(boolean)

Returns:
The current setting indicating if the RSTR Properties will be set in a returned Security Token.

getPolicySetConfiguration

java.lang.Object getPolicySetConfiguration()
Gets the policy set configuration configuration setting. (see setPolicySetConfiguration(java.lang.Object)).

Returns:
The policy set configuration configuration setting.

getPolicySetName

java.lang.String getPolicySetName()
Gets the policy set name configuration setting. (see setPolicySetName(java.lang.String)).

Returns:
The policy set name configuration setting

getPortName

javax.xml.namespace.QName getPortName()
Gets the port name configuration setting. (see setPortName(javax.xml.namespace.QName)).

Returns:
The port name configuration setting

getProvider

java.lang.String getProvider()
Gets the provider configuration setting. (see #setProvider).

Returns:
The provider configuration setting

getServiceName

javax.xml.namespace.QName getServiceName()
Gets the service name configuration setting. (see setServiceName(javax.xml.namespace.QName)).

Returns:
The service name configuration setting.

getSystemClassLoader

java.lang.ClassLoader getSystemClassLoader()
Gets the system class loader configuration setting. (see setSystemClassLoader(java.lang.ClassLoader)).

Returns:
The system class loader configuration setting.

getWSTrustNamespace

java.lang.String getWSTrustNamespace()
Gets the WS-Trust namespace configuration setting. (see #setWSTrustNamespace).

Returns:
The WS-Trust namespace configuration setting.

init

void init(java.lang.String wstNamespace,
          java.lang.String stsAddress)
          throws com.ibm.websphere.wssecurity.wssapi.WSSException
Initializes the ProviderConfig's WS-Trust namespace and STS provider address.

Parameters:
wstNamespace - The WS-Trust namespace
stsAddress - The STS provider address.
Throws:
com.ibm.websphere.wssecurity.wssapi.WSSException - Exception thrown for invalid WS-Trust namespace.

setApplicationClassLoader

void setApplicationClassLoader(java.lang.ClassLoader appClassLoader)
Sets the application class loader configuration setting. The class loader may be used to locate and load PolicySet and Binding information for the trust request.

Parameters:
appClassLoader - The application class loader.

setApplicationName

void setApplicationName(java.lang.String applicationName)
Using this API may make an application non-portable and and establish a fragile dependency on the application name, i.e., changing the application name during deployment would break the application. Typically, you do not need to specify the application name using the WSSTrustClient API.

Sets the Application Name configuration setting.

This setting is optional. Users are recommend NOT to set the application name. The WSTrustClient runtime will dynamically determine application name as needed.

WARNING!: Setting the application name will disable the WSTtrustClient runtime dynamic determination of the application name at runtime. Specifying an incorrect application name may effect locating and loading the correct PolicySet application specific Binding.

Parameters:
applicationName - The application name used to locate custom binding data.

setBindingName

void setBindingName(java.lang.String bindingName)
Sets the Binding Name configuration setting. This name is used to identify binding data used to secure the WSSTrustClient communications.

Parameters:
bindingName - The name of the binding to be loaded.

setBindingScope

void setBindingScope(java.lang.String scope)
Sets the Binding Scope configuration setting. This setting applies only to deployed applications.

Parameters:
scope - The binding scope value may be "application", "domain" or null. When "application" is specified, custom binding will be used. When "domain" is specified, general binding will be used. When null is specified, if application binding exist, they will be used. Otherwise if general binding exists they will be used. If neither application nor general binding exist then the default binding will be used.

setIncludeRSTRProperties

void setIncludeRSTRProperties(boolean includeRSTRProperties)
Setting indicates if the RSTR Properties should be set in Security Tokens returned by WSSTrustClient.

Parameters:
includeRSTRProperties - When set true a Security Token returned by the WSSTrustClient will include properties from the RequestSecurityTokenResponse message.

setPolicySet

void setPolicySet(java.lang.ClassLoader appClassLoader,
                  java.lang.ClassLoader systemClassLoader,
                  java.lang.String policySetName,
                  java.lang.String bindingName,
                  java.lang.String bindingScope)
Sets policy set related configuration settings.

Parameters:
appClassLoader - (see setApplicationClassLoader(java.lang.ClassLoader))
systemClassLoader - (see setSystemClassLoader(java.lang.ClassLoader))
policySetName - (see setPolicySetName(java.lang.String))
bindingName - (see setBindingName(java.lang.String))
bindingScope - (see setBindingScope(java.lang.String))

setPolicySetConfiguration

void setPolicySetConfiguration(java.lang.Object psc)
Sets the PolicySetConfiguration configuration setting. This passes an existing loaded PolicySetConfiguration instance to the WSSTrustClient. This setting may be used instead of specifying the PolicySet name, Binding name and other settings required to locate and load a PolicySetConfiguration.

Parameters:
psc - The policy set configuration instance.

setPolicySetName

void setPolicySetName(java.lang.String policySetName)
Sets the PolicySet name configuration setting. This name is used to identify PolicySet data used to secure the WSSTrustClient communications.

Parameters:
policySetName - The policy set name.

setPortName

void setPortName(javax.xml.namespace.QName portName)
Sets the Security Token provider's port name configuration setting. This is the port name specified in the Security Token provider's WSDL.

Parameters:
portName - The port name as declared in the Security Token Provider's WSDL.

setServiceName

void setServiceName(javax.xml.namespace.QName serviceName)
Sets the Security Token provider's service name configuration setting. This is the service name specified in the Security Token provider's WSDL.

Parameters:
serviceName - The service name as declared in the Security Token Provider's WSDL.

setSystemClassLoader

void setSystemClassLoader(java.lang.ClassLoader sysClassLoader)
Sets the system class loader configuration setting. The class loader may be used to locate and load PolicySet and Binding information.

Parameters:
sysClassLoader - The system class loader.

getProperties

java.util.Map getProperties()
Retrieves a map of properties related to the provider.

Returns:
a Map of ProviderConfig properties.

IBM WebSphere Application ServerTM
Release 8