com.pingidentity.sts.clientapi
Class STSClientConfiguration

java.lang.Object
  extended by com.pingidentity.sts.clientapi.STSClientConfiguration

public class STSClientConfiguration
extends java.lang.Object

Property holder for STSClient.


Nested Class Summary
static class STSClientConfiguration.SystemAuthType
          Options for HTTP transport authentication for the STS endpoint
static class STSClientConfiguration.TokenType
          Possible Token Types
 
Constructor Summary
STSClientConfiguration()
           
 
Method Summary
 java.lang.String getAppliesTo()
          Value of AppliesTo element of RST
 java.lang.String getClientCertificateKeystore()
          Full path to the client certificate keystore
 java.lang.String getClientCertificateKeystorePassword()
          Password for the client certificate keystore
 STSClientConfiguration.TokenType getInTokenType()
          Value type of binary token that is desired to be issued by the STS
 STSClientConfiguration.TokenType getInTokenValueType()
          Value type of token that is sent to the STS
 STSClientConfiguration.TokenType getOutTokenType()
          Type of token that is desired to be issued by the STS
 java.util.Map<java.lang.String,java.lang.String> getRequestParameters()
          Retrieves the request parameters
 java.lang.String getStsEndpoint()
          URL of the STS endpoint
 java.lang.String getSystemAuthPassword()
          Password for HTTP Basic Authentication to the STS
 STSClientConfiguration.SystemAuthType getSystemAuthType()
          Type of HTTP transport authentication to use with the STS
 java.lang.String getSystemAuthUsername()
          Username for HTTP Basic Authentication to the STS
 int getToleranceWindow()
          Returns tolerance window in minutes, work around clock skew
 int getWsseCreatedOffset()
          Returns wsse Created header negative offset (to be substracted from now) in minutes
 int getWsseLifetime()
          Returns wsse security header lifetime (duration) in minutes
 boolean isEmbeddedToken()
          True if token should be put into the RST body, false if in the SOAP Header
 boolean isIgnoreSSLTrustErrors()
          True if STSClient is to accept any certificates from the STS during interaction over SSL/TLS , false otherwise
 void setAppliesTo(java.lang.String appliesTo)
          Value of AppliesTo element of RST
 void setClientCertificateKeystore(java.lang.String clientCertificateKeystore)
          Full path to the client certificate keystore
 void setClientCertificateKeystorePassword(java.lang.String clientCertificateKeystorePassword)
          Password for the client certificate keystore
 void setEmbeddedToken(boolean embeddedToken)
          Set to true if the token should be put into the RST body instead of SOAP Header.
 void setIgnoreSSLTrustErrors(boolean ignoreSSLTrustErrors)
          If STSClient is to accept any certificates from the PingFederate Server during interaction over SSL/TLS , false otherwise
 void setInTokenType(STSClientConfiguration.TokenType inTokenType)
          Type of token that is sent to the STS
 void setInTokenValueType(java.lang.String inTokenValueType)
          Value type of token that is sent to the STS
 void setInTokenValueType(STSClientConfiguration.TokenType inTokenValueType)
          Value type of token that is sent to the STS
 void setOutTokenType(STSClientConfiguration.TokenType outTokenType)
          Type of token that is desired to be issued by the STS
 void setOutTokenValueType(STSClientConfiguration.TokenType outTokenValueType)
          Value type of binary token that is desired to be issued by the STS
 void setRequestParameters(java.util.Map<java.lang.String,java.lang.String> requestParameters)
          Sets the request parameters
 void setStsEndpoint(java.lang.String stsEndpoint)
          URL of the STS endpoint
 void setSystemAuthPassword(java.lang.String systemAuthPassword)
          Password for HTTP Basic Authentication to the STS
 void setSystemAuthType(STSClientConfiguration.SystemAuthType systemAuthType)
          Type of HTTP transport authentication to use with the STS
 void setSystemAuthUsername(java.lang.String systemAuthUsername)
          Username for HTTP Basic Authentication to the STS
 void setToleranceWindow(int toleranceWindow)
          Sets tolerance window in minutes, work around clock skew
 void setWsseCreatedOffset(int wsseCreatedOffset)
          Sets wsse Created header negative offset (to be substracted from now) in minutes
 void setWsseLifetime(int wsseLifetime)
          Sets wsse security header lifetime (duration) in minutes
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

STSClientConfiguration

public STSClientConfiguration()
Method Detail

getWsseCreatedOffset

public int getWsseCreatedOffset()
Returns wsse Created header negative offset (to be substracted from now) in minutes

Returns:
created header offset

setWsseCreatedOffset

public void setWsseCreatedOffset(int wsseCreatedOffset)
Sets wsse Created header negative offset (to be substracted from now) in minutes


getWsseLifetime

public int getWsseLifetime()
Returns wsse security header lifetime (duration) in minutes

Returns:
security header lifetime

setWsseLifetime

public void setWsseLifetime(int wsseLifetime)
Sets wsse security header lifetime (duration) in minutes

Parameters:
wsseLifetime -

getToleranceWindow

public int getToleranceWindow()
Returns tolerance window in minutes, work around clock skew

Returns:
tolerance window

setToleranceWindow

public void setToleranceWindow(int toleranceWindow)
Sets tolerance window in minutes, work around clock skew

Parameters:
toleranceWindow - tolerance window in minutes

setEmbeddedToken

public void setEmbeddedToken(boolean embeddedToken)
Set to true if the token should be put into the RST body instead of SOAP Header.

Parameters:
embeddedToken - true if token to be put in the RST, false if in the SOAP Header

isEmbeddedToken

public boolean isEmbeddedToken()
True if token should be put into the RST body, false if in the SOAP Header


getOutTokenType

public STSClientConfiguration.TokenType getOutTokenType()
Type of token that is desired to be issued by the STS


setOutTokenType

public void setOutTokenType(STSClientConfiguration.TokenType outTokenType)
Type of token that is desired to be issued by the STS


setOutTokenValueType

public void setOutTokenValueType(STSClientConfiguration.TokenType outTokenValueType)
Value type of binary token that is desired to be issued by the STS


getInTokenType

public STSClientConfiguration.TokenType getInTokenType()
Value type of binary token that is desired to be issued by the STS


setInTokenType

public void setInTokenType(STSClientConfiguration.TokenType inTokenType)
Type of token that is sent to the STS


getStsEndpoint

public java.lang.String getStsEndpoint()
URL of the STS endpoint


setStsEndpoint

public void setStsEndpoint(java.lang.String stsEndpoint)
URL of the STS endpoint


getAppliesTo

public java.lang.String getAppliesTo()
Value of AppliesTo element of RST


setAppliesTo

public void setAppliesTo(java.lang.String appliesTo)
Value of AppliesTo element of RST


getInTokenValueType

public STSClientConfiguration.TokenType getInTokenValueType()
Value type of token that is sent to the STS


setInTokenValueType

public void setInTokenValueType(STSClientConfiguration.TokenType inTokenValueType)
Value type of token that is sent to the STS


setInTokenValueType

public void setInTokenValueType(java.lang.String inTokenValueType)
Value type of token that is sent to the STS

Parameters:
inTokenValueType - String URI value

getSystemAuthUsername

public java.lang.String getSystemAuthUsername()
Username for HTTP Basic Authentication to the STS


setSystemAuthUsername

public void setSystemAuthUsername(java.lang.String systemAuthUsername)
Username for HTTP Basic Authentication to the STS


getSystemAuthPassword

public java.lang.String getSystemAuthPassword()
Password for HTTP Basic Authentication to the STS


setSystemAuthPassword

public void setSystemAuthPassword(java.lang.String systemAuthPassword)
Password for HTTP Basic Authentication to the STS


getSystemAuthType

public STSClientConfiguration.SystemAuthType getSystemAuthType()
Type of HTTP transport authentication to use with the STS


setSystemAuthType

public void setSystemAuthType(STSClientConfiguration.SystemAuthType systemAuthType)
Type of HTTP transport authentication to use with the STS


getClientCertificateKeystore

public java.lang.String getClientCertificateKeystore()
Full path to the client certificate keystore


setClientCertificateKeystore

public void setClientCertificateKeystore(java.lang.String clientCertificateKeystore)
Full path to the client certificate keystore


getClientCertificateKeystorePassword

public java.lang.String getClientCertificateKeystorePassword()
Password for the client certificate keystore


setClientCertificateKeystorePassword

public void setClientCertificateKeystorePassword(java.lang.String clientCertificateKeystorePassword)
Password for the client certificate keystore


isIgnoreSSLTrustErrors

public boolean isIgnoreSSLTrustErrors()
True if STSClient is to accept any certificates from the STS during interaction over SSL/TLS , false otherwise


setIgnoreSSLTrustErrors

public void setIgnoreSSLTrustErrors(boolean ignoreSSLTrustErrors)
If STSClient is to accept any certificates from the PingFederate Server during interaction over SSL/TLS , false otherwise


setRequestParameters

public void setRequestParameters(java.util.Map<java.lang.String,java.lang.String> requestParameters)
Sets the request parameters

Parameters:
requestParameters - a Map containing String entries ParameterName -> ParameterValue

getRequestParameters

public java.util.Map<java.lang.String,java.lang.String> getRequestParameters()
Retrieves the request parameters

Returns:
the requestParameters


Copyright © 2006-2009 Ping Identity Corporation. All Rights Reserved.