com.softwareag.security.jaas.login

Class SagCredentials

java.lang.Object

com.softwareag.security.jaas.login.SagCredentials

All Implemented Interfaces:

java.io.Serializable

public class SagCredentials
extends java.lang.Object
implements java.io.Serializable

Generic credentials queried by SagCallbackHandler, and evaluated by the LoginModules. All LoginModules derived from SagAbstractLoginModule get these SagCredentials.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	rcsId Version information in binary form.

Constructor Summary

Constructors

Constructor and Description
SagCredentials()

Method Summary

Modifier and Type	Method and Description
java.lang.String	getDomainName() Gets the domain name.
java.util.Map	getHeaderFields() Returns a Map of header fields.
byte[]	getIafToken() Gets the IAF token.
char[]	getPassword() Gets the password.
java.lang.String	getQualifiedName() Returns the qualified name of the principal.
byte[]	getSamlArtifact() Gets the SAML artifact.
java.lang.Object	getSamlAssertion() Gets a SAML assertion as an object.
java.lang.Object	getServletRequest() Gets the servlet request, which is being passed as Object.
java.lang.String	getUserName() Gets the user name.
java.security.cert.X509Certificate[]	getX509CertChain() Gets the X.509 certificate chain that includes the user certificate and the trust chain, but excludes the root certificate.
void	setDomainName(java.lang.String domainName) Sets the domain name for this object.
void	setHeaderFields(java.util.Map headerFields) Sets a Map of header fields.
void	setIafToken(byte[] iafToken) Sets the IAF token.
void	setPassword(char[] password) Sets the password.
void	setSamlArtifact(byte[] samlArtifact) Sets the SAML artifact.
void	setSamlAssertion(java.lang.Object samlAssertion) Initializes this SagCredentials object from the specified SAML assertion object.
void	setServletRequest(java.lang.Object aRequest) Sets the servlet request as an Object.
void	setUserName(java.lang.String userName) Sets the user name.
void	setX509CertChain(java.security.cert.X509Certificate[] certChain) Sets the X.509 certificate chain that includes the user certificate and the trust chain, but excludes the root certificate.
java.lang.String	toString() String representation of this class.

Methods inherited from class java.lang.Object

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

Field Detail

rcsId

public static final java.lang.String rcsId

Version information in binary form.

See Also:

Constant Field Values

Constructor Detail

SagCredentials

public SagCredentials()

Method Detail

getUserName

public java.lang.String getUserName()

Gets the user name.

Returns:

A String specifying the user name.

setUserName

public void setUserName(java.lang.String userName)

Sets the user name.
The user name can contain the domain name in the format domainname\username, but the recommended practice is to use setDomainName()

Parameters:

userName - The user name.

See Also:

setDomainName(String)

getDomainName

public java.lang.String getDomainName()

Gets the domain name.

Returns:

A String specifying the domain name.

setDomainName

public void setDomainName(java.lang.String domainName)

Sets the domain name for this object.

Parameters:

domainName - String specifying the domain name.

getQualifiedName

public java.lang.String getQualifiedName()

Returns the qualified name of the principal. This consists of a concatenation of the domain, the DOMAIN_SEPARATOR, and the name.

Returns:

A String specifying the qualified name of the principal.

getPassword

public char[] getPassword()

Gets the password.

Returns:

The password as a char array.

setPassword

public void setPassword(char[] password)

Sets the password.

Parameters:

password - A char array defining the password.

getIafToken

public byte[] getIafToken()

Gets the IAF token.

Returns:

The IAF token presented as a byte array.

setIafToken

public void setIafToken(byte[] iafToken)

Sets the IAF token.

Parameters:

iafToken - The IAF token presented as a byte array.

getSamlArtifact

public byte[] getSamlArtifact()

Gets the SAML artifact.

Returns:

The SAML artifact presented as a byte array.

setSamlArtifact

public void setSamlArtifact(byte[] samlArtifact)

Sets the SAML artifact.

Parameters:

samlArtifact - the SAML artifact presented as a byte array.

getSamlAssertion

public java.lang.Object getSamlAssertion()

Gets a SAML assertion as an object.

Returns:

The samlAssertion object.

setSamlAssertion

public void setSamlAssertion(java.lang.Object samlAssertion)

Initializes this SagCredentials object from the specified SAML assertion object.

Parameters:

samlAssertion - The samlAssertion object from which this object will be initialized.

getX509CertChain

public java.security.cert.X509Certificate[] getX509CertChain()

Gets the X.509 certificate chain that includes the user certificate and the trust chain, but excludes the root certificate.

Returns:

The X.509 certificate.

setX509CertChain

public void setX509CertChain(java.security.cert.X509Certificate[] certChain)

Sets the X.509 certificate chain that includes the user certificate and the trust chain, but excludes the root certificate.

Parameters:

certChain - The X.509 certificate chain.

getServletRequest

public java.lang.Object getServletRequest()

Gets the servlet request, which is being passed as Object.

Returns:

The servlet request as Object

setServletRequest

public void setServletRequest(java.lang.Object aRequest)

Sets the servlet request as an Object.

Parameters:

aRequest - The servlet request as an Object.

getHeaderFields

public java.util.Map getHeaderFields()

Returns a Map of header fields. These are name-value pairs which can be evaluated by the LoginModules.

Returns:

A Map of header fields.

setHeaderFields

public void setHeaderFields(java.util.Map headerFields)

Sets a Map of header fields. These are name-value pairs which can be evaluated by the LoginModules.

Parameters:

headerFields - A Map of header fields.

toString

public java.lang.String toString()

String representation of this class.

Overrides:

toString in class java.lang.Object

Returns:

The user name, domain name, and IAFToken, if available.