org.picketlink.identity.federation.core.wstrust

Class STSClientConfig

java.lang.Object

org.picketlink.identity.federation.core.wstrust.STSClientConfig

All Implemented Interfaces:

STSClientConfigKeyProvider

public class STSClientConfig
extends Object
implements STSClientConfigKeyProvider

STSClientConfig has the ability to either programatically construct the configuration needed for STSClient or parse a file containing the configuration parameters.

Configure programatically

Example:

 
 Builder builder = new STSClientConfig.Builder();
 builder.serviceName("PicketLinkSTS");
 builder.portName("PicketLinkSTSPort");
 ...
 STSClientConfig config = builder.build();
 
 

Configure from file

Example:

 {
     @code
     STSClientConfig config = new STSClientConfig.Builder(configFile).build();
 }
 

Author:

Daniel Bevenius, Anil Saldhana

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	STSClientConfig.Builder

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT_CONFIG_FILE
static String	ENDPOINT_ADDRESS
static String	IS_BATCH
static String	NO_MODULE
static String	PASSWORD
static String	PORT_NAME
static String	REQUEST_TYPE
static String	SERVICE_NAME
static String	SOAP_BINDING
static String	SUBSTITUTE_MODULE
static String	TOKEN_TYPE
static String	USERNAME
static String	WSA_ISSUER
static String	WSP_APPLIES_TO

Method Summary

Modifier and Type	Method and Description
static String	computeSTSClientConfigKey(String module, String serviceName, String portName, String endPointAddress, String userName)
String	getEndPointAddress()
String	getPassword()
String	getPortName()
String	getRequestType()
String	getServiceName()
String	getSoapBinding()
String	getSTSClientConfigKey() Method returns String key by which STSClient can be stored and found in key maps.
String	getUsername()
String	getWsaIssuer()
String	getWspAppliesTo()
boolean	isBatch()
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

DEFAULT_CONFIG_FILE

public static final String DEFAULT_CONFIG_FILE

See Also:

Constant Field Values

SERVICE_NAME

public static final String SERVICE_NAME

See Also:

Constant Field Values

PORT_NAME

public static final String PORT_NAME

See Also:

Constant Field Values

ENDPOINT_ADDRESS

public static final String ENDPOINT_ADDRESS

See Also:

Constant Field Values

USERNAME

public static final String USERNAME

See Also:

Constant Field Values

PASSWORD

public static final String PASSWORD

See Also:

Constant Field Values

TOKEN_TYPE

public static final String TOKEN_TYPE

See Also:

Constant Field Values

WSA_ISSUER

public static final String WSA_ISSUER

See Also:

Constant Field Values

WSP_APPLIES_TO

public static final String WSP_APPLIES_TO

See Also:

Constant Field Values

IS_BATCH

public static final String IS_BATCH

See Also:

Constant Field Values

REQUEST_TYPE

public static final String REQUEST_TYPE

See Also:

Constant Field Values

SOAP_BINDING

public static final String SOAP_BINDING

See Also:

Constant Field Values

NO_MODULE

public static final String NO_MODULE

See Also:

Constant Field Values

SUBSTITUTE_MODULE

public static final String SUBSTITUTE_MODULE

See Also:

Constant Field Values

Method Detail

getServiceName

public String getServiceName()

getPortName

public String getPortName()

getEndPointAddress

public String getEndPointAddress()

getUsername

public String getUsername()

getPassword

public String getPassword()

getWsaIssuer

public String getWsaIssuer()

getWspAppliesTo

public String getWspAppliesTo()

isBatch

public boolean isBatch()

getRequestType

public String getRequestType()

getSoapBinding

public String getSoapBinding()

toString

public String toString()

Overrides:

toString in class Object

getSTSClientConfigKey

public String getSTSClientConfigKey()

Description copied from interface: STSClientConfigKeyProvider

Method returns String key by which STSClient can be stored and found in key maps.

Specified by:

getSTSClientConfigKey in interface STSClientConfigKeyProvider

Returns:

computeSTSClientConfigKey

public static String computeSTSClientConfigKey(String module,
                                               String serviceName,
                                               String portName,
                                               String endPointAddress,
                                               String userName)