com.sun.identity.wss.sts
Class TrustAuthorityClient

java.lang.Object
  com.sun.identity.wss.sts.TrustAuthorityClient

public class TrustAuthorityClient
extends Object

The class TrustAuthorityClient is used to obtain the security tokens from the trusted authority services such as Security Token Service (STS) or Liberty Discovery Service.

Field Summary

static String[]

jars The list of jar files to be loaded by FAMClassLoader.

Constructor Summary

TrustAuthorityClient()
Creates a new instance of TrustAuthorityClient.

Method Summary

boolean	cancelIssuedToken(SecurityToken securityToken, ProviderConfig pc) Cancels the issued security token that was obtained from previous interactions.
SecurityToken	getSecurityToken(ProviderConfig pc, Object ssoToken) Returns the SecurityToken for the web services client from a trusted authority, which is Security Token Service (STS).
SecurityToken	getSecurityToken(ProviderConfig pc, Object ssoToken, ServletContext context) Returns the SecurityToken for the web services client from a trusted authority, which is Security Token Service (STS).
SecurityToken	getSecurityToken(String wspEndPoint, String stsEndPoint, String stsMexEndPoint, Object ssoToken, String securityMech, ServletContext context) Returns the SecurityToken for the web services client from a trusted authority, which is Security Token Service (STS).
SecurityToken	renewIssuedToken(SecurityToken securityToken, ProviderConfig pc, Object ssoToken) Renews the issued security token that was obtained from previous interactions.

Field Detail

jars

public static String[] jars

The list of jar files to be loaded by FAMClassLoader.

Constructor Detail

TrustAuthorityClient

public TrustAuthorityClient()

Creates a new instance of TrustAuthorityClient.

Method Detail

getSecurityToken

public SecurityToken getSecurityToken(ProviderConfig pc,
                                      Object ssoToken)
                               throws FAMSTSException

Returns the SecurityToken for the web services client from a trusted authority, which is Security Token Service (STS). The web services client configuation and web service information is identified by the provider configuration.

Parameters:

pc - Provider configuration of the web services client.

ssoToken - Single sign-on token of the principal.

Returns:

SecurityToken security token for the web services consumer.

Throws:

FAMSTSException - if it's unable to retrieve security token.

getSecurityToken

public SecurityToken getSecurityToken(ProviderConfig pc,
                                      Object ssoToken,
                                      ServletContext context)
                               throws FAMSTSException

Returns the SecurityToken for the web services client from a trusted authority, which is Security Token Service (STS). The web services client configuation and web service information is identified by the provider configuration.

Parameters:

pc - Provider configuration of the web services client.

ssoToken - Single sign-on token of the principal.

context - Web context under which this class is running.

Returns:

SecurityToken security token for the web services consumer.

Throws:

FAMSTSException - if it's unable to retrieve security token.

getSecurityToken

public SecurityToken getSecurityToken(String wspEndPoint,
                                      String stsEndPoint,
                                      String stsMexEndPoint,
                                      Object ssoToken,
                                      String securityMech,
                                      ServletContext context)
                               throws FAMSTSException

Returns the SecurityToken for the web services client from a trusted authority, which is Security Token Service (STS).

Parameters:

wspEndPoint - Web Service Provider end point.

stsEndPoint - Security Token Service end point.

stsMexEndPoint - Security Token Service MEX end point.

ssoToken - single sign-on token of the principal.

securityMech - Required Security Mechanism by Web Service Client.

context - web context under which this class is running.

Returns:

SecurityToken security token for the web services consumer.

Throws:

FAMSTSException - if it's unable to retrieve security token.

renewIssuedToken

public SecurityToken renewIssuedToken(SecurityToken securityToken,
                                      ProviderConfig pc,
                                      Object ssoToken)
                               throws FAMSTSException

Renews the issued security token that was obtained from previous interactions. This method applies only for the STS Tokens.

Parameters:

securityToken - security token that needs to be renewed.

pc - provider configuration of the web services client.

ssoToken - single sign-on token of the principal.

Returns:

SecurityToken security token for the web services consumer.

Throws:

FAMSTSException - if it's unable to renew security token or if the trust authority configuration is not of STS.

cancelIssuedToken

public boolean cancelIssuedToken(SecurityToken securityToken,
                                 ProviderConfig pc)
                          throws FAMSTSException

Cancels the issued security token that was obtained from previous interactions. This method applies only for the STS Tokens.

Parameters:

securityToken - security token that needs to be renewed.

pc - provider configuration of the web services client.

Returns:

true if succeed in cancelling the issued token.

Throws:

FAMSTSException - if there is an exception in cancelling issued security token or if the trust authority configuration is not of STS.