com.sun.identity.wss.provider
Class ProviderConfig

java.lang.Object
  com.sun.identity.wss.provider.ProviderConfig

public abstract class ProviderConfig
extends Object

This class ProviderConfig represents the web services server provider or the web services client provider configuration.

All the static methods in this class are for the persistent operations.

Field Summary

protected String	attributeNS
protected String	authenticationChain
protected boolean	forceAuthn
protected boolean	includeMemberships
protected boolean	isDefaultKeyStore
protected boolean	isRequestEncrypted
protected boolean	isRequestHeaderEncrypted
protected boolean	isRequestSigned
protected boolean	isResponseEncrypted
protected boolean	isResponseSigned
protected String	keyPasswd
protected KeyStore	keyStore
protected String	ksFile
protected String	ksPasswd
protected String	nameIDMapper
protected boolean	preserveSecHeaders
protected String	privateKeyAlias
protected String	privateKeyType
protected Properties	properties
protected String	providerName
protected String	providerType
protected String	publicKeyAlias
protected Set	samlAttributes
protected List	secMech
protected String	serviceType
protected String	serviceURI
protected TrustAuthorityConfig	taconfig
protected List	trustAuthorities
protected List	usercredentials
static String	WSC Constant to define the web services client type.
static String	WSP Constant to define the web services provider type.
protected String	wspEndpoint
static String	WSS_PROVIDER_CONFIG_PLUGIN Property for the web services provider configuration plugin.
protected String	wssProxyEndpoint

Constructor Summary

ProviderConfig()

Method Summary

protected abstract void	delete() Deletes the provider configuration
static void	deleteProvider(String providerName, String providerType) Removes the provider configuration.
boolean	forceUserAuthentication() Returns true if the user force authentication is enabled.
static List	getAllMessageLevelSecurityMech() Returns the list of message level security mechanism objects.
static List	getAllSupportedSecurityMech() Returns the list of all available security mechanism objects.
String	getAuthenticationChain() Returns the authentication chain mechanism to be used.
String	getKeyAlias() Returns the key alias for this provider.
String	getKeyEncryptedPassword() Returns the keystore encrypted password.
String	getKeyPassword() Returns the key password in the keystore.
KeyStore	getKeyStore() Returns the provider JKS KeyStore
String	getKeyStoreEncryptedPasswd() Returns the keystore encrypted password.
String	getKeyStoreFile() Returns the keystore file.
String	getKeyStorePassword() Returns the keystore password.
String	getKeyType() Returns the key type for this provider.
String	getNameIDMapper() Returns the NameID mapper class
String	getProperty(String property) Returns the value of the property.
static ProviderConfig	getProvider(String providerName, String providerType) Returns the provider configuration for a given provider name.
static ProviderConfig	getProvider(String providerName, String providerType, boolean isEndPoint) Returns the provider configuration for a given provider name.
String	getProviderName() Returns the name of the Provider.
String	getProviderType() Returns the provider type.
String	getPublicKeyAlias() Returns the Public key alias for this provider's partner.
Set	getSAMLAttributeMapping() Returns the SAML Attribute Mapping list.
String	getSAMLAttributeNamespace() Returns SAML attribute namespace.
List	getSecurityMechanisms() Returns the list of security mechanims that the provider is configured.
String	getServiceType() Returns the service type.
TrustAuthorityConfig	getTrustAuthorityConfig() Returns the provider's trusted authorities list.
List	getUsers() Returns the list of PasswordCredentials of the user.
String	getWSPEndpoint() Returns the endpoint of the web services provider.
String	getWSSProxyEndpoint() Returns the endpoint of the web services security proxy.
protected abstract void	init(String providerName, String providerType, SSOToken token, boolean isEndPoint) Initializes the provider.
protected abstract boolean	isExists() Checks if the provider configuration exists
static boolean	isProviderExists(String providerName, String providerType) Checks if the provider of given type does exists.
boolean	isRequestEncryptEnabled() Checks if the request needs to be encrypted or not.
boolean	isRequestHeaderEncryptEnabled() Checks if the request header needs to be encrypted or not.
boolean	isRequestSignEnabled() Checks if the request needs to be signed or not.
boolean	isResponseEncryptEnabled() Checks if the response needs to be encrypted or not.
boolean	isResponseSignEnabled() Checks if the response needs to be signed or not.
boolean	preserveSecurityHeader() Returns true if security header needs to be preserved.
static void	saveProvider(ProviderConfig config) Saves the Provider in the configuration repository.
void	setAuthenticationChain(String authenticationChain) Sets the authentication chain mechanism.
void	setDefaultKeyStore(boolean set) Sets the provider to use the default keystore.
void	setForceUserAuthentication(boolean forceAuthn) Sets the user force authentication attribute.
void	setIncludeMemberships(boolean include) Sets a flag to include memberships for SAML attribute mapping.
void	setKeyAlias(String alias) Sets the key alias for this provider.
void	setKeyStore(KeyStore keyStore, String password) Sets the keystore for this provider.
void	setKeyStore(String fileName, String keyStorePassword, String keyPassword) Sets the keystore for this provider.
void	setKeyType(String keyType) Sets the key type for this provider.
void	setNameIDMapper(String nameIDMapper) Sets the NameID Mapper class.
void	setPreserveSecurityHeader(boolean preserve) Sets if security header needs to be preserved.
void	setProperty(String property, String value) Sets the value for the given property in Provider Configuration.
void	setPublicKeyAlias(String alias) Sets the Public key alias for this provider's partner.
void	setRequestEncryptEnabled(boolean enable) Sets the request encrypt enable flag.
void	setRequestHeaderEncryptEnabled(boolean enable) Sets the request header encrypt enable flag.
void	setRequestSignEnabled(boolean enable) Sets the request sign enable flag.
void	setResponseEncryptEnabled(boolean enable) Sets the response encrypt enable flag.
void	setResponseSignEnabled(boolean enable) Sets the response sign enable flag.
void	setSAMLAttributeMapping(Set attributeMap) Sets the list of SAML attribute mappings.
void	setSAMLAttributeNamespace(String attributeNS) Sets SAML attribute namespace.
void	setSecurityMechanisms(List authMech) Sets the list of security mechanisms.
void	setServiceType(String serviceType) Sets the service type.
void	setTrustAuthorityConfig(TrustAuthorityConfig taconfig) Sets the trusted authority configurations.
void	setUsers(List usercredentials) Sets the user credentials list.
void	setWSPEndpoint(String endpoint) Sets the web services provider endpoint.
void	setWSSProxyEndpoint(String endpoint) Sets the web services security proxy endpoint.
boolean	shouldIncludeMemberships() Checks if the memberships should be included in the SAML attribute mapping.
protected abstract void	store() Stores the provider configuration
boolean	useDefaultKeyStore() Returns true if the provider uses default keystore.

Field Detail

WSC

public static final String WSC

Constant to define the web services client type.

See Also:

Constant Field Values

WSP

public static final String WSP

Constant to define the web services provider type.

See Also:

Constant Field Values

WSS_PROVIDER_CONFIG_PLUGIN

public static final String WSS_PROVIDER_CONFIG_PLUGIN

Property for the web services provider configuration plugin.

See Also:

Constant Field Values

secMech

protected List secMech

serviceURI

protected String serviceURI

providerName

protected String providerName

wspEndpoint

protected String wspEndpoint

wssProxyEndpoint

protected String wssProxyEndpoint

providerType

protected String providerType

keyStore

protected KeyStore keyStore

privateKeyAlias

protected String privateKeyAlias

privateKeyType

protected String privateKeyType

publicKeyAlias

protected String publicKeyAlias

isResponseSigned

protected boolean isResponseSigned

isResponseEncrypted

protected boolean isResponseEncrypted

isRequestSigned

protected boolean isRequestSigned

isRequestEncrypted

protected boolean isRequestEncrypted

isRequestHeaderEncrypted

protected boolean isRequestHeaderEncrypted

trustAuthorities

protected List trustAuthorities

ksPasswd

protected String ksPasswd

keyPasswd

protected String keyPasswd

ksFile

protected String ksFile

properties

protected Properties properties

usercredentials

protected List usercredentials

serviceType

protected String serviceType

isDefaultKeyStore

protected boolean isDefaultKeyStore

forceAuthn

protected boolean forceAuthn

preserveSecHeaders

protected boolean preserveSecHeaders

authenticationChain

protected String authenticationChain

taconfig

protected TrustAuthorityConfig taconfig

samlAttributes

protected Set samlAttributes

includeMemberships

protected boolean includeMemberships

nameIDMapper

protected String nameIDMapper

attributeNS

protected String attributeNS

Constructor Detail

ProviderConfig

public ProviderConfig()

Method Detail

getSecurityMechanisms

public List getSecurityMechanisms()

Returns the list of security mechanims that the provider is configured.

Returns:

list of security mechanisms.

setSecurityMechanisms

public void setSecurityMechanisms(List authMech)

Sets the list of security mechanisms.

Parameters:

authMech - the list of security mechanisms.

getProviderName

public String getProviderName()

Returns the name of the Provider.

Returns:

the provider name.

getProperty

public String getProperty(String property)

Returns the value of the property.

Returns:

the value of the property.

setProperty

public void setProperty(String property,
                        String value)

Sets the value for the given property in Provider Configuration.

Parameters:

property - the name of the being set.

value - the property value being set.

getWSPEndpoint

public String getWSPEndpoint()

Returns the endpoint of the web services provider.

Returns:

the endpoint of the web services provider.

setWSPEndpoint

public void setWSPEndpoint(String endpoint)

Sets the web services provider endpoint.

Parameters:

endpoint - the web services provider endpoint.

getWSSProxyEndpoint

public String getWSSProxyEndpoint()

Returns the endpoint of the web services security proxy.

Returns:

the endpoint of the web services security proxy.

setWSSProxyEndpoint

public void setWSSProxyEndpoint(String endpoint)

Sets the web services security proxy endpoint.

Parameters:

endpoint - the web services security proxy endpoint.

setServiceType

public void setServiceType(String serviceType)

Sets the service type.

Parameters:

serviceType - the service type.

getServiceType

public String getServiceType()

Returns the service type.

Returns:

the service type.

setUsers

public void setUsers(List usercredentials)

Sets the user credentials list.

Parameters:

usercredentials - list of PasswordCredentialobjects.

getUsers

public List getUsers()

Returns the list of PasswordCredentials of the user.

Returns:

the list of PasswordCredential objects.

getProviderType

public String getProviderType()

Returns the provider type. It will be ProviderConfig.WSP or ProviderConfig.WSC

Returns:

the provider type.

getKeyStore

public KeyStore getKeyStore()

Returns the provider JKS KeyStore

Returns:

the JKS KeyStore

getKeyStoreFile

public String getKeyStoreFile()

Returns the keystore file.

Returns:

the keystore file name.

getKeyStorePassword

public String getKeyStorePassword()

Returns the keystore password.

Returns:

the keystore password.

getKeyStoreEncryptedPasswd

public String getKeyStoreEncryptedPasswd()

Returns the keystore encrypted password.

Returns:

the keystore encrypted password.

getKeyPassword

public String getKeyPassword()

Returns the key password in the keystore.

Returns:

the key password in the keystore.

getKeyEncryptedPassword

public String getKeyEncryptedPassword()

Returns the keystore encrypted password.

Returns:

the keystore encrypted password.

setKeyStore

public void setKeyStore(String fileName,
                        String keyStorePassword,
                        String keyPassword)
                 throws ProviderException

Sets the keystore for this provider.

Parameters:

fileName - the provider key store fully qualified file name.

keyStorePassword - the password required to access the key store file.

keyPassword - the password required to access the key from the keystore.

Throws:

ProviderException - if the key store file does not exist or an invalid password.

setKeyStore

public void setKeyStore(KeyStore keyStore,
                        String password)

Sets the keystore for this provider.

Parameters:

keyStore - the provider key store.

password - the password required to access the key store file.

getKeyType

public String getKeyType()

Returns the key type for this provider.

Returns:

the key type of the provider.

setKeyType

public void setKeyType(String keyType)

Sets the key type for this provider.

Parameters:

keyType - the key type for this provider.

getKeyAlias

public String getKeyAlias()

Returns the key alias for this provider.

Returns:

the key alias of the provider.

setKeyAlias

public void setKeyAlias(String alias)

Sets the key alias for this provider.

Parameters:

alias - the key alias for this provider.

getPublicKeyAlias

public String getPublicKeyAlias()

Returns the Public key alias for this provider's partner.

Returns:

the Public key alias of the provider's partner.

setPublicKeyAlias

public void setPublicKeyAlias(String alias)

Sets the Public key alias for this provider's partner.

Parameters:

alias - the Public key alias for this provider's partner.

useDefaultKeyStore

public boolean useDefaultKeyStore()

Returns true if the provider uses default keystore.

Returns:

true if the provider uses default keystore.

setDefaultKeyStore

public void setDefaultKeyStore(boolean set)

Sets the provider to use the default keystore.

Parameters:

set - boolean variable to enable or disable to use the default keystore.

getSAMLAttributeMapping

public Set getSAMLAttributeMapping()

Returns the SAML Attribute Mapping list. This method is used by the WSP configuration when enabled for SAML.

setSAMLAttributeMapping

public void setSAMLAttributeMapping(Set attributeMap)

Sets the list of SAML attribute mappings. This method is used by the WSP configuration when enabled for SAML.

Parameters:

attributeMap - the list of SAML attribute mapping

shouldIncludeMemberships

public boolean shouldIncludeMemberships()

Checks if the memberships should be included in the SAML attribute mapping.

Returns:

true if the memberships are included.

setIncludeMemberships

public void setIncludeMemberships(boolean include)

Sets a flag to include memberships for SAML attribute mapping.

Parameters:

include - boolean flag to indicate if the memberships needs to be included.

getNameIDMapper

public String getNameIDMapper()

Returns the NameID mapper class

Returns:

returns the nameid mapper class.

setNameIDMapper

public void setNameIDMapper(String nameIDMapper)

Sets the NameID Mapper class.

Parameters:

nameIDMapper - NameID Mapper class.

getSAMLAttributeNamespace

public String getSAMLAttributeNamespace()

Returns SAML attribute namespace.

Returns:

returns SAML attribute namespace.

setSAMLAttributeNamespace

public void setSAMLAttributeNamespace(String attributeNS)

Sets SAML attribute namespace.

Parameters:

attributeNS - SAML attribute namespace.

getTrustAuthorityConfig

public TrustAuthorityConfig getTrustAuthorityConfig()

Returns the provider's trusted authorities list.

Returns:

the list of the TrustAuthorityConfig s.

setTrustAuthorityConfig

public void setTrustAuthorityConfig(TrustAuthorityConfig taconfig)

Sets the trusted authority configurations.

Parameters:

taconfig - instance of the TrustAuthorityConfig.

isResponseSignEnabled

public boolean isResponseSignEnabled()

Checks if the response needs to be signed or not.

Returns:

true if the response needs to be signed.

setResponseSignEnabled

public void setResponseSignEnabled(boolean enable)

Sets the response sign enable flag.

Parameters:

enable - enables the response signing.

isResponseEncryptEnabled

public boolean isResponseEncryptEnabled()

Checks if the response needs to be encrypted or not.

Returns:

true if the response needs to be encrypted.

setResponseEncryptEnabled

public void setResponseEncryptEnabled(boolean enable)

Sets the response encrypt enable flag.

Parameters:

enable - enables the response encryption.

isRequestSignEnabled

public boolean isRequestSignEnabled()

Checks if the request needs to be signed or not.

Returns:

true if the request needs to be signed.

setRequestSignEnabled

public void setRequestSignEnabled(boolean enable)

Sets the request sign enable flag.

Parameters:

enable - enables the request signing.

isRequestEncryptEnabled

public boolean isRequestEncryptEnabled()

Checks if the request needs to be encrypted or not.

Returns:

true if the request needs to be encrypted.

setRequestEncryptEnabled

public void setRequestEncryptEnabled(boolean enable)

Sets the request encrypt enable flag.

Parameters:

enable - enables the request encryption.

isRequestHeaderEncryptEnabled

public boolean isRequestHeaderEncryptEnabled()

Checks if the request header needs to be encrypted or not.

Returns:

true if the request header needs to be encrypted.

setRequestHeaderEncryptEnabled

public void setRequestHeaderEncryptEnabled(boolean enable)

Sets the request header encrypt enable flag.

Parameters:

enable - enables the request header encryption.

forceUserAuthentication

public boolean forceUserAuthentication()

Returns true if the user force authentication is enabled.

Returns:

true if the user force authentication is enabled.

setForceUserAuthentication

public void setForceUserAuthentication(boolean forceAuthn)

Sets the user force authentication attribute.

Parameters:

forceAuthn - the user force authentication attribute.

preserveSecurityHeader

public boolean preserveSecurityHeader()

Returns true if security header needs to be preserved.

Returns:

true if the security header needs to be preserved.

setPreserveSecurityHeader

public void setPreserveSecurityHeader(boolean preserve)

Sets if security header needs to be preserved.

Parameters:

preserve - value to be set, true if the security header needs to be preserved, false otherwise.

getAuthenticationChain

public String getAuthenticationChain()

Returns the authentication chain mechanism to be used. This method is used only by the WSP configuration.

Returns:

the name of the authentication chain mechanism.

setAuthenticationChain

public void setAuthenticationChain(String authenticationChain)

Sets the authentication chain mechanism. This method is used only by the WSP configuration.

Parameters:

authenticationChain - the name of the authentication chain mechanism.

store

protected abstract void store()
                       throws ProviderException

Stores the provider configuration

Throws:

ProviderException - if there is any failure.

delete

protected abstract void delete()
                        throws ProviderException

Deletes the provider configuration

Throws:

ProviderException - if there is any failure.

isExists

protected abstract boolean isExists()

Checks if the provider configuration exists

Returns:

true if the provider exists.

init

protected abstract void init(String providerName,
                             String providerType,
                             SSOToken token,
                             boolean isEndPoint)
                      throws ProviderException

Initializes the provider.

Parameters:

providerName - the provider name.

providerType - the provider type.

token - Single Sign-on token.

Throws:

ProviderException - if there is any failure.

saveProvider

public static void saveProvider(ProviderConfig config)
                         throws ProviderException

Saves the Provider in the configuration repository.

Parameters:

config - the provider configuration.

Throws:

ProviderException - if the creation is failed.

getProvider

public static ProviderConfig getProvider(String providerName,
                                         String providerType)
                                  throws ProviderException

Returns the provider configuration for a given provider name.

Parameters:

providerName - the provider name.

providerType - the provider type.

Throws:

ProviderException - if unable to retrieve.

getProvider

public static ProviderConfig getProvider(String providerName,
                                         String providerType,
                                         boolean isEndPoint)
                                  throws ProviderException

Returns the provider configuration for a given provider name.

Parameters:

providerName - the provider name.

providerType - the provider type.

isEndPoint - flag to indicate search based on WSP end point.

Throws:

ProviderException - if unable to retrieve.

isProviderExists

public static boolean isProviderExists(String providerName,
                                       String providerType)

Checks if the provider of given type does exists.

Parameters:

providerName - the name of the provider.

providerType - type of the provider.

Returns:

true if the provider exists with a given name and type.

deleteProvider

public static void deleteProvider(String providerName,
                                  String providerType)
                           throws ProviderException

Removes the provider configuration.

Parameters:

providerName - the name of the provider.

providerType - the type of the provider.

Throws:

ProviderException - if any failure.

getAllSupportedSecurityMech

public static List getAllSupportedSecurityMech()

Returns the list of all available security mechanism objects.

Returns:

the list of SecurityMechanism objects.

getAllMessageLevelSecurityMech

public static List getAllMessageLevelSecurityMech()

Returns the list of message level security mechanism objects.

Returns:

the list of message level SecurityMechanism objects.