com.sun.identity.authentication.spi
Class SAMLCallback

java.lang.Object
  com.sun.identity.authentication.spi.SAMLCallback

All Implemented Interfaces:

javax.security.auth.callback.Callback

public class SAMLCallback

extends java.lang.Object

implements javax.security.auth.callback.Callback

This SAMLCallback class implements Callback and used for passing either Web artifact or SAML POST response from SAML service to the SAML authentication module when this module requests for the respective credentials. This authentication module behaves as SAML recipient for both (Web artifact or SAML POST response) and retrieves / validates SAML assertions.

Field Summary

static int	ARTIFACT Credential type for SAML Web Artifact
static int	RESPONSE Credential type for SAML POST Response

Constructor Summary

SAMLCallback(java.lang.String prompt)
Constructs a SAMLCallback with a prompt.

Method Summary

java.lang.String[]	getArtifact() Returns the SAML web artifact.
boolean	getCheckSignature() Returns the flag indicating whether signature verification is required for SAML POST response.
java.lang.String	getPrompt() Returns the prompt.
Response	getSamlResponse() Returns the SAML POST response.
int	getType() Returns the type of credential requested.
void	setArtifact(java.lang.String[] arti) Sets the SAML web artifact.
void	setCheckSignature(boolean checkSignature) Sets the flag indicating whether signature verification is required for SAML POST response.
void	setSamlResponse(Response samlResponse) Sets the SAML POST response.
void	setType(int type) Sets the type of credential requested.

Methods inherited from class java.lang.Object

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

Field Detail

ARTIFACT

public static final int ARTIFACT

Credential type for SAML Web Artifact

See Also:

Constant Field Values

RESPONSE

public static final int RESPONSE

Credential type for SAML POST Response

See Also:

Constant Field Values

Constructor Detail

SAMLCallback

public SAMLCallback(java.lang.String prompt)

Constructs a SAMLCallback with a prompt.

Parameters:

prompt - The prompt.

Method Detail

getSamlResponse

public Response getSamlResponse()

Returns the SAML POST response.

Returns:

the SAML POST response.

getArtifact

public java.lang.String[] getArtifact()

Returns the SAML web artifact.

Returns:

the String array of SAML web artifact.

getType

public int getType()

Returns the type of credential requested.

Returns:

the type of credential requested.

getPrompt

public java.lang.String getPrompt()

Returns the prompt.

Returns:

the prompt.

getCheckSignature

public boolean getCheckSignature()

Returns the flag indicating whether signature verification is required for SAML POST response. If this flag is set to 'true' then the signature verification is required for SAML POST response.

Returns:

the flag indicating whether signature verification is required for SAML POST response.

setSamlResponse

public void setSamlResponse(Response samlResponse)

Sets the SAML POST response.

Parameters:

samlResponse - the SAML POST response.

setArtifact

public void setArtifact(java.lang.String[] arti)

Sets the SAML web artifact.

Parameters:

arti - the String array of SAML web artifact.

setType

public void setType(int type)

Sets the type of credential requested.

Parameters:

type - the type of credential requested.

setCheckSignature

public void setCheckSignature(boolean checkSignature)

Sets the flag indicating whether signature verification is required for SAML POST response. If this flag is set to 'true' then the signature verification is required for SAML POST response.

Parameters:

checkSignature - the boolean flag indicating whether signature verification is required for SAML POST response.