|
IBM WebSphere Application ServerTM Release 7 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface ProviderConfig
A ProviderConfig object encapsulates the state information needed for Trust
Client communications with a Security Token provider.
See
com.ibm.websphere.wssecurity.wssapi.trust.WSSTrustClient
Settings include:
setBindingName(java.lang.String)
)
setBindingScope(java.lang.String)
)
setPolicySetConfiguration(java.lang.Object)
)
setPolicySetName(java.lang.String)
)
setPortName(javax.xml.namespace.QName)
)
setServiceName(javax.xml.namespace.QName)
)
setSystemClassLoader(java.lang.ClassLoader)
)
setApplicationClassLoader(java.lang.ClassLoader)
)
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 |
---|
java.lang.ClassLoader getApplicationClassLoader()
setApplicationClassLoader(java.lang.ClassLoader)
)
java.lang.String getApplicationName()
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.
java.lang.String getBindingName()
setBindingName(java.lang.String)
).
java.lang.String getBindingScope()
setBindingScope(java.lang.String)
boolean getIncludeRSTRProperties()
setIncludeRSTRProperties(boolean)
java.lang.Object getPolicySetConfiguration()
setPolicySetConfiguration(java.lang.Object)
).
java.lang.String getPolicySetName()
setPolicySetName(java.lang.String)
).
javax.xml.namespace.QName getPortName()
setPortName(javax.xml.namespace.QName)
).
java.lang.String getProvider()
#setProvider
).
javax.xml.namespace.QName getServiceName()
setServiceName(javax.xml.namespace.QName)
).
java.lang.ClassLoader getSystemClassLoader()
setSystemClassLoader(java.lang.ClassLoader)
).
java.lang.String getWSTrustNamespace()
#setWSTrustNamespace
).
void init(java.lang.String wstNamespace, java.lang.String stsAddress) throws com.ibm.websphere.wssecurity.wssapi.WSSException
wstNamespace
- The WS-Trust namespacestsAddress
- The STS provider address.
com.ibm.websphere.wssecurity.wssapi.WSSException
- Exception thrown for invalid WS-Trust namespace.void setApplicationClassLoader(java.lang.ClassLoader appClassLoader)
appClassLoader
- The application class loader.void setApplicationName(java.lang.String applicationName)
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.
applicationName
- The application name used to locate custom binding data.void setBindingName(java.lang.String bindingName)
bindingName
- The name of the binding to be loaded.void setBindingScope(java.lang.String scope)
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.void setIncludeRSTRProperties(boolean includeRSTRProperties)
includeRSTRProperties
- When set true
a Security Token returned by the WSSTrustClient will include properties from the RequestSecurityTokenResponse message.void setPolicySet(java.lang.ClassLoader appClassLoader, java.lang.ClassLoader systemClassLoader, java.lang.String policySetName, java.lang.String bindingName, java.lang.String bindingScope)
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)
)void setPolicySetConfiguration(java.lang.Object psc)
psc
- The policy set configuration instance.void setPolicySetName(java.lang.String policySetName)
policySetName
- The policy set name.void setPortName(javax.xml.namespace.QName portName)
portName
- The port name as declared in the Security Token Provider's WSDL.void setServiceName(javax.xml.namespace.QName serviceName)
serviceName
- The service name as declared in the Security Token Provider's
WSDL.void setSystemClassLoader(java.lang.ClassLoader sysClassLoader)
sysClassLoader
- The system class loader.java.util.Map getProperties()
|
IBM WebSphere Application ServerTM Release 7 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |