com.sun.identity.wss.provider
Class STSConfig

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

public abstract class STSConfig
extends TrustAuthorityConfig

This abstract class STSConfig represents the configuration of a Security Token Service client entity. It extends TrustAuthorityConfig.

This class can be extended to define the trust authority config which is WS-Trust protocol based client (STS client) configuration.

Pluggable implementation of this abstract class can choose to store this configuration in desired configuration store. This pluggable implementation class can be configured in client's AMConfig.properties as value of "com.sun.identity.wss.sts.config.plugin" property for STS client configuration.

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

Field Summary

protected String	kdcDomain
protected String	kdcServer
protected String	mexEndpoint
protected String	protocolVersion
protected String	servicePrincipal
protected String	stsConfigName
protected String	ticketCacheDir

Fields inherited from class com.sun.identity.wss.provider.TrustAuthorityConfig

customAdminToken, DISCOVERY_TRUST_AUTHORITY, encryptionAlgorithm, encryptionStrength, endpoint, isRequestEncrypted, isRequestHeaderEncrypted, isRequestSigned, isResponseEncrypted, isResponseSigned, name, privateKeyAlias, publicKeyAlias, secMech, signingRefType, STS_TRUST_AUTHORITY, type, usercredentials, WSS_DISCOVERY_CONFIG_PLUGIN, WSS_STS_CONFIG_PLUGIN

Constructor Summary

STSConfig()
Creates a new instance of STSConfig

Method Summary

String	getKDCDomain() Returns Kerberos Domain Controller Domain.
String	getKDCServer() Returns Kerberos Domain Controller Server.
String	getKerberosServicePrincipal() Returns kerberos service principal.
String	getKerberosTicketCacheDir() Returns the kerberos ticket cache directory.
String	getMexEndpoint() Returns STS Mex endpoint.
String	getProtocolVersion() Returns the protocol version.
String	getSTSConfigName() Returns STS configuration name.
void	setKDCDomain(String domain) Sets Kerberos Domain Controller Domain.
void	setKDCServer(String kdcServer) Sets Kerberos Domain Controller Server.
void	setKerberosServicePrincipal(String principal) Sets kerberos service principal.
void	setKerberosTicketCacheDir(String cacheDir) Sets kerberos ticket cache directory.
void	setMexEndpoint(String mexEndpoint) Sets STS Mex endpoint.
void	setProtocolVersion(String version) Sets the protocol version.
void	setSTSConfigName(String stsConfigName) Sets STS configuration name.

Methods inherited from class com.sun.identity.wss.provider.TrustAuthorityConfig

delete, deleteConfig, getConfig, getEncryptionAlgorithm, getEncryptionStrength, getEndpoint, getKeyAlias, getName, getPublicKeyAlias, getSecurityMech, getSigningRefType, getType, getUsers, init, isRequestEncryptEnabled, isRequestHeaderEncryptEnabled, isRequestSignEnabled, isResponseEncryptEnabled, isResponseSignEnabled, saveConfig, setAdminToken, setEncryptionAlgorithm, setEncryptionStrength, setEndpoint, setKeyAlias, setName, setPublicKeyAlias, setRequestEncryptEnabled, setRequestHeaderEncryptEnabled, setRequestSignEnabled, setResponseEncryptEnabled, setResponseSignEnabled, setSecurityMechs, setSigningRefType, setType, setUsers, store

Field Detail

mexEndpoint

protected String mexEndpoint

stsConfigName

protected String stsConfigName

kdcDomain

protected String kdcDomain

kdcServer

protected String kdcServer

ticketCacheDir

protected String ticketCacheDir

servicePrincipal

protected String servicePrincipal

protocolVersion

protected String protocolVersion

Constructor Detail

STSConfig

public STSConfig()

Creates a new instance of STSConfig

Method Detail

getMexEndpoint

public String getMexEndpoint()

Returns STS Mex endpoint.

Returns:

STS Mex endpoint

setMexEndpoint

public void setMexEndpoint(String mexEndpoint)

Sets STS Mex endpoint.

Parameters:

mexEndpoint - STS Mex endpoint

getSTSConfigName

public String getSTSConfigName()

Returns STS configuration name.

Returns:

STS configuration name

setSTSConfigName

public void setSTSConfigName(String stsConfigName)

Sets STS configuration name.

Parameters:

stsConfigName - STS configuration name

getKDCDomain

public String getKDCDomain()

Returns Kerberos Domain Controller Domain.

Returns:

Kerberos Domain Controller Domain

setKDCDomain

public void setKDCDomain(String domain)

Sets Kerberos Domain Controller Domain.

Parameters:

domain - Kerberos Domain Controller Domain

getKDCServer

public String getKDCServer()

Returns Kerberos Domain Controller Server.

Returns:

Kerberos Domain Controller Server.

setKDCServer

public void setKDCServer(String kdcServer)

Sets Kerberos Domain Controller Server.

Parameters:

kdcServer - Kerberos Domain Controller Server

getKerberosTicketCacheDir

public String getKerberosTicketCacheDir()

Returns the kerberos ticket cache directory. This method is used by the web services client to get the kerberos ticket cache directory.

Returns:

kerberos ticket cache dir

setKerberosTicketCacheDir

public void setKerberosTicketCacheDir(String cacheDir)

Sets kerberos ticket cache directory.

Parameters:

cacheDir - kerberos ticket cache dir

getKerberosServicePrincipal

public String getKerberosServicePrincipal()

Returns kerberos service principal.

Returns:

the kerberos service principal

setKerberosServicePrincipal

public void setKerberosServicePrincipal(String principal)

Sets kerberos service principal.

Parameters:

principal - the kerberos service principal.

getProtocolVersion

public String getProtocolVersion()

Returns the protocol version.

Returns:

the protocol version

setProtocolVersion

public void setProtocolVersion(String version)

Sets the protocol version.

Parameters:

version - the protocol version.