com.softwareag.is.auth.saml.issuer

Class SAMLAssertionParams

java.lang.Object

com.softwareag.is.auth.saml.issuer.SAMLAssertionParams

public class SAMLAssertionParams
extends java.lang.Object

This class helps configure the parameters used by the SAML token generator.

Constructor Summary

Constructors

Constructor and Description
SAMLAssertionParams() Creates an empty instance of SAMLAssertionParams.

Method Summary

Modifier and Type	Method and Description
static SAMLAssertionParams	create(IDataMap pipe) Deprecated. Creates the SAMLAssertionParams object using the provided IDataMap.
java.util.Map<java.lang.String,java.lang.String>	getAttributes() Returns a map for the attributes of the assertion.
java.lang.String[]	getAudienceRestrictions() Returns audience restrictions.
java.lang.String	getAuthnSubjectLocality() Returns the authenticated subject locality.
java.lang.String[]	getGroups() Returns the groups to be part of the SAML assertion.
java.lang.String	getIssuerName() Returns the name of the configured issuer.
java.lang.String	getIssuerNameQualifier() Returns the issuer name qualifier.
java.lang.String	getKeyAlias() Returns the name of the key alias containing the signing key.
java.lang.String	getKeystoreAlias() Returns Integration Server keystore alias used for signing the assertion.
java.util.Map<java.lang.String,java.lang.String>	getRoles() Returns the roles to be included in the SAML assertion.
java.lang.String	getSubjectConfirmationRecipient() Returns subject confirmation recipient information.
java.lang.String	getSubjectNameId() Returns the subjent Name ID.
java.lang.String	getSubjectNameQualifier() Returns the name qualifier for the subject Name ID.
int	getTokenLifeInSeconds() Returns the token expiry as seconds.
void	setAttributes(java.util.Map<java.lang.String,java.lang.String> attributes) Configures the attributes to be included in the assertion.
void	setAudienceRestrictions(java.lang.String[] audienceRestrictions) Configures audience restrictions in the conditions.
void	setAuthnSubjectLocality(java.lang.String authnSubjectLocality) Configures locality for the authenticated subject.
void	setGroups(java.lang.String[] groups) Configures the list of groups (as String[]) to be part of the SAML assertion.
void	setIssuerName(java.lang.String issuerName) Configures the issuer name for the generated assertion.
void	setIssuerNameQualifier(java.lang.String issuerNameQualifier) Configures the name qualifier for the issuer.
void	setKeyAlias(java.lang.String keyAlias) Sets the name of the key alias containing the signing key.
void	setKeystoreAlias(java.lang.String keystoreAlias) Specifies the Integration Server keystore alias that contains the signing key.
void	setRoles(java.util.Map<java.lang.String,java.lang.String> roles) Configures the list of roles (as String[]) to be part of the SAML assertion.
void	setSubjectConfirmationRecipient(java.lang.String subjectConfirmationRecipient) Configures recipient information for the subject confirmation.
void	setSubjectNameId(java.lang.String subjectNameId) Configures the subject Name ID.
void	setSubjectNameQualifier(java.lang.String subjectNameQualifier) Configures a name qualifier for the subject Name ID.
void	setTokenLifeInSeconds(int tokenLifeInSeconds) Configures the number of seconds for token expiry.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SAMLAssertionParams

public SAMLAssertionParams()

Creates an empty instance of SAMLAssertionParams. Use the setters in this class to populate the parameters for the SAML token generator.

Method Detail

getIssuerName

public java.lang.String getIssuerName()

Returns the name of the configured issuer.

Returns:

The configured issuer name.

setIssuerName

public void setIssuerName(java.lang.String issuerName)

Configures the issuer name for the generated assertion.

Parameters:

issuerName - Name of the issuer to be used.

getIssuerNameQualifier

public java.lang.String getIssuerNameQualifier()

Returns the issuer name qualifier.

Returns:

Issuer name qualifier, if any; otherwise null.

setIssuerNameQualifier

public void setIssuerNameQualifier(java.lang.String issuerNameQualifier)

Configures the name qualifier for the issuer.

Parameters:

issuerNameQualifier - The name qualifier to be used for the issuer.

getSubjectNameId

public java.lang.String getSubjectNameId()

Returns the subjent Name ID.

Returns:

The Name ID of the subject.

setSubjectNameId

public void setSubjectNameId(java.lang.String subjectNameId)

Configures the subject Name ID.

Parameters:

subjectNameId - Name id of the subject.

getSubjectNameQualifier

public java.lang.String getSubjectNameQualifier()

Returns the name qualifier for the subject Name ID.

Returns:

Name qualifier of the subject Name ID

setSubjectNameQualifier

public void setSubjectNameQualifier(java.lang.String subjectNameQualifier)

Configures a name qualifier for the subject Name ID.

Parameters:

subjectNameQualifier - Name qualifier for the subject Name ID.

getAuthnSubjectLocality

public java.lang.String getAuthnSubjectLocality()

Returns the authenticated subject locality.

Returns:

Authenticated subject locality, if any; otherwise null.

setAuthnSubjectLocality

public void setAuthnSubjectLocality(java.lang.String authnSubjectLocality)

Configures locality for the authenticated subject.

Parameters:

authnSubjectLocality - Locality of the authetnicated subject.

getSubjectConfirmationRecipient

public java.lang.String getSubjectConfirmationRecipient()

Returns subject confirmation recipient information.

Returns:

Subject confirmation recipient information.

setSubjectConfirmationRecipient

public void setSubjectConfirmationRecipient(java.lang.String subjectConfirmationRecipient)

Configures recipient information for the subject confirmation.

Parameters:

subjectConfirmationRecipient - The recipient information for the subject confirmation.

getAudienceRestrictions

public java.lang.String[] getAudienceRestrictions()

Returns audience restrictions.

Returns:

Audience restrictions as String[], if any; otherwise null.

setAudienceRestrictions

public void setAudienceRestrictions(java.lang.String[] audienceRestrictions)

Configures audience restrictions in the conditions.

Parameters:

audienceRestrictions - String[] of audience restrictions

getKeystoreAlias

public java.lang.String getKeystoreAlias()

Returns Integration Server keystore alias used for signing the assertion.

Returns:

IS keystore alias configured for signing the assertion.

setKeystoreAlias

public void setKeystoreAlias(java.lang.String keystoreAlias)

Specifies the Integration Server keystore alias that contains the signing key.

Parameters:

keystoreAlias - an IS keystore alias that contains signing key

getKeyAlias

public java.lang.String getKeyAlias()

Returns the name of the key alias containing the signing key.

Returns:

Name of the key alias containing the signing key.

setKeyAlias

public void setKeyAlias(java.lang.String keyAlias)

Sets the name of the key alias containing the signing key.

Parameters:

keyAlias - Name of the key alias.

getGroups

public java.lang.String[] getGroups()

Returns the groups to be part of the SAML assertion.

Returns:

String[] of groups to be included in the SAML assertion

setGroups

public void setGroups(java.lang.String[] groups)

Configures the list of groups (as String[]) to be part of the SAML assertion.

Parameters:

groups - Sting[] of configured groups.

getRoles

public java.util.Map<java.lang.String,java.lang.String> getRoles()

Returns the roles to be included in the SAML assertion.

Returns:

String[] of roles to be included in the SAML assertion.

setRoles

public void setRoles(java.util.Map<java.lang.String,java.lang.String> roles)

Configures the list of roles (as String[]) to be part of the SAML assertion.

Parameters:

roles - Sting[] of configured roles.

getAttributes

public java.util.Map<java.lang.String,java.lang.String> getAttributes()

Returns a map for the attributes of the assertion.

Returns:

a Map representing the attributes of the assertion.

setAttributes

public void setAttributes(java.util.Map<java.lang.String,java.lang.String> attributes)

Configures the attributes to be included in the assertion.

Parameters:

attributes - Map containing name-value pair of the attributes to be included in the assertion.

getTokenLifeInSeconds

public int getTokenLifeInSeconds()

Returns the token expiry as seconds.

Returns:

Token expiry in seconds.

setTokenLifeInSeconds

public void setTokenLifeInSeconds(int tokenLifeInSeconds)

Configures the number of seconds for token expiry.

Parameters:

tokenLifeInSeconds - The token expiry in seconds.

create

public static SAMLAssertionParams create(IDataMap pipe)

Deprecated. Creates the SAMLAssertionParams object using the provided IDataMap.

Parameters:

pipe - IDataMap containing the issuer parameters to be used.

Returns:

Instance of SAMLAssertionParams @see com.softwareag.is.auth.saml.issuer.SAMLAssertionParams