com.sun.identity.wss.provider
Class TrustAuthorityConfig

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

Direct Known Subclasses:

STSConfig

public abstract class TrustAuthorityConfig
extends Object

This is an abstract that represents the configuration about a trusted authority.

The trusted authority configuration is used to register the provider configuration information at a trusted authority.

This class can be extended to define the trust authority config such as discovery configuration, ws-trust etc.

Field Summary

static String	DISCOVERY_TRUST_AUTHORITY Discovery service configuration type.
protected String	endpoint
protected boolean	isRequestEncrypted
protected boolean	isRequestHeaderEncrypted
protected boolean	isRequestSigned
protected boolean	isResponseEncrypted
protected boolean	isResponseSigned
protected String	name
protected String	privateKeyAlias
protected String	publicKeyAlias
protected List	secMech
static String	STS_TRUST_AUTHORITY
protected String	type
protected List	usercredentials
static String	WSS_DISCOVERY_CONFIG_PLUGIN Property string for the web services discovery configuration plugin.
static String	WSS_STS_CONFIG_PLUGIN Property string for the web services sts configuration plugin.

Constructor Summary

TrustAuthorityConfig()

Method Summary

protected abstract void	delete() Deletes the trust authrority configuration.
static void	deleteConfig(String name, String type) Deletes the trust authority configuration.
static TrustAuthorityConfig	getConfig(String name, String type) Returns the trust authority configuration object.
String	getEndpoint() Returns the authority end point.
String	getKeyAlias() Returns the key alias for this provider.
String	getName() Returns the trust authority name.
String	getPublicKeyAlias() Returns the Public key alias for this provider's partner.
List	getSecurityMech() Returns the list of security mechanisms that the trust authority supports
String	getType() Returns the trust authority type.
List	getUsers() Returns the list of PasswordCredentials of the user.
protected abstract void	init(String name, String type, SSOToken ssoToken) Initialize the trust authority.
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.
static void	saveConfig(TrustAuthorityConfig config) Saves the trust authority configuration.
void	setEndpoint(String endpoint) Sets the end point.
void	setKeyAlias(String alias) Sets the key alias for this provider.
void	setName(String name)
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	setSecurityMechs(List secMech) Sets the list of security mechanisms that the trust authority supports
void	setType(String type) Sets the trust authority type.
void	setUsers(List usercredentials) Sets the user credentials list.
protected abstract void	store() Saves the trust authority configuration.

Field Detail

endpoint

protected String endpoint

privateKeyAlias

protected String privateKeyAlias

publicKeyAlias

protected String publicKeyAlias

name

protected String name

type

protected String type

secMech

protected List secMech

isResponseSigned

protected boolean isResponseSigned

isResponseEncrypted

protected boolean isResponseEncrypted

isRequestSigned

protected boolean isRequestSigned

isRequestEncrypted

protected boolean isRequestEncrypted

isRequestHeaderEncrypted

protected boolean isRequestHeaderEncrypted

usercredentials

protected List usercredentials

WSS_DISCOVERY_CONFIG_PLUGIN

public static final String WSS_DISCOVERY_CONFIG_PLUGIN

Property string for the web services discovery configuration plugin.

See Also:

Constant Field Values

WSS_STS_CONFIG_PLUGIN

public static final String WSS_STS_CONFIG_PLUGIN

Property string for the web services sts configuration plugin.

See Also:

Constant Field Values

DISCOVERY_TRUST_AUTHORITY

public static final String DISCOVERY_TRUST_AUTHORITY

Discovery service configuration type.

See Also:

Constant Field Values

STS_TRUST_AUTHORITY

public static final String STS_TRUST_AUTHORITY

See Also:

Constant Field Values

Constructor Detail

TrustAuthorityConfig

public TrustAuthorityConfig()

Method Detail

getName

public String getName()

Returns the trust authority name.

Returns:

the name of the trust authority.

setName

public void setName(String name)

getType

public String getType()

Returns the trust authority type.

Returns:

the type of the trust authority.

setType

public void setType(String type)

Sets the trust authority type.

Parameters:

type - the type of the trust authority.

getEndpoint

public String getEndpoint()

Returns the authority end point.

Returns:

the endpoint of the trust authority.

setEndpoint

public void setEndpoint(String endpoint)

Sets the end point.

Parameters:

endpoint - the end point for the trust authority.

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.

setSecurityMechs

public void setSecurityMechs(List secMech)

Sets the list of security mechanisms that the trust authority supports

Parameters:

secMech - list of security mechanisms that the trust authority supports

getSecurityMech

public List getSecurityMech()

Returns the list of security mechanisms that the trust authority supports

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.

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.

init

protected abstract void init(String name,
                             String type,
                             SSOToken ssoToken)
                      throws ProviderException

Initialize the trust authority.

Parameters:

name - the name of the trust authority.

type - the type of the trust authority.

ssoToken - Single sign-on token.

Throws:

ProviderException - if the initialization fails.

store

protected abstract void store()
                       throws ProviderException

Saves the trust authority configuration.

Throws:

ProviderException - if the trust authority configuration is unable to save.

delete

protected abstract void delete()
                        throws ProviderException

Deletes the trust authrority configuration.

Throws:

ProviderException

getConfig

public static TrustAuthorityConfig getConfig(String name,
                                             String type)
                                      throws ProviderException

Returns the trust authority configuration object.

Parameters:

name - the name of the trust authority.

type - the type of the trust authority. The type must have one of the following values.

TrustAuthorityConfig.DISCOVERY_TRUST_AUTHORITY

TrustAuthorityConfig.STS_TRUST_AUTHORITY

Throws:

ProviderException - if any failure in retrieving the trust authority configuration.

saveConfig

public static void saveConfig(TrustAuthorityConfig config)
                       throws ProviderException

Saves the trust authority configuration.

Parameters:

config - the trust authority configuration.

Throws:

ProviderException - if any failure in saving the configuration.

deleteConfig

public static void deleteConfig(String name,
                                String type)
                         throws ProviderException

Deletes the trust authority configuration.

Parameters:

name - the name of the trust authority configuration.

type - the type of the trust authority. The type must have one of the values.

TrustAuthorityConfig.DISCOVERY_TRUST_AUTHORITY

Throws:

ProviderException - if any failure in deleting the trust authority configuration.