org.picketlink.identity.federation.core.saml.v2.common

Class SAMLProtocolContext

java.lang.Object

org.picketlink.identity.federation.core.saml.v2.common.SAMLProtocolContext

All Implemented Interfaces:

ProtocolContext

public class SAMLProtocolContext
extends Object
implements ProtocolContext

A SAML2 specification based instance of ProtocolContext

This instance is used to pass information from the IDP to the Core STS.

Since:

Dec 30, 2010

Author:

Anil.Saldhana@redhat.com

Field Summary

Fields

Modifier and Type	Field and Description
protected ConditionsType	conditions
protected AssertionType	issuedAssertion
protected NameIDType	issuerID
protected List<StatementAbstractType>	statements
protected SubjectType	subjectType

Constructor Summary

Constructors

Constructor and Description
SAMLProtocolContext()

Method Summary

Methods

Modifier and Type	Method and Description
String	family() What family the context belongs to..
ConditionsType	getConditions() Get the conditions
AssertionType	getIssuedAssertion() Get the previously issued assertion by the STS
NameIDType	getIssuerID() Get the Issuer ID
QName	getQName() Return the QName of the token
List<StatementAbstractType>	getStatements() Get the statements as a read-only list
SubjectType	getSubjectType() Get the subject
String	serviceName() An optional service name
void	setConditions(ConditionsType conditions) Set the conditions
void	setIssuedAssertion(AssertionType issuedAssertion) Set the assertion issued by the STS
void	setIssuerID(NameIDType issuerID) Set the Issuer ID
void	setStatements(List<StatementAbstractType> statements) Add a list of statements
void	setSubjectType(SubjectType subjectType) Set the subject
String	tokenType() A String that represents the token type

Methods inherited from class java.lang.Object

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

Field Detail

issuerID

protected NameIDType issuerID

subjectType

protected SubjectType subjectType

conditions

protected ConditionsType conditions

statements

protected List<StatementAbstractType> statements

issuedAssertion

protected AssertionType issuedAssertion

Constructor Detail

SAMLProtocolContext

public SAMLProtocolContext()

Method Detail

getIssuerID

public NameIDType getIssuerID()

Get the Issuer ID

Returns:

instance of NameIDType

setIssuerID

public void setIssuerID(NameIDType issuerID)

Set the Issuer ID

Parameters:

issuerID - NameIDType

getSubjectType

public SubjectType getSubjectType()

Get the subject

Returns:

SubjectType

setSubjectType

public void setSubjectType(SubjectType subjectType)

Set the subject

Parameters:

subjectType - SubjectType

getConditions

public ConditionsType getConditions()

Get the conditions

Returns:

ConditionsType

setConditions

public void setConditions(ConditionsType conditions)

Set the conditions

Parameters:

conditions - ConditionsType

getStatements

public List<StatementAbstractType> getStatements()

Get the statements as a read-only list

Returns:

StatementAbstractType

setStatements

public void setStatements(List<StatementAbstractType> statements)

Add a list of statements

Parameters:

statements - List

getIssuedAssertion

public AssertionType getIssuedAssertion()

Get the previously issued assertion by the STS

Returns:

AssertionType

setIssuedAssertion

public void setIssuedAssertion(AssertionType issuedAssertion)

Set the assertion issued by the STS

Parameters:

issuedAssertion - AssertionType

serviceName

public String serviceName()

Description copied from interface: ProtocolContext

An optional service name

Specified by:

serviceName in interface ProtocolContext

Returns:

See Also:

ProtocolContext.serviceName()

tokenType

public String tokenType()

Description copied from interface: ProtocolContext

A String that represents the token type

Specified by:

tokenType in interface ProtocolContext

Returns:

See Also:

ProtocolContext.tokenType()

getQName

public QName getQName()

Description copied from interface: ProtocolContext

Return the QName of the token

Specified by:

getQName in interface ProtocolContext

Returns:

See Also:

ProtocolContext.getQName()

family

public String family()

Description copied from interface: ProtocolContext

What family the context belongs to..

Specified by:

family in interface ProtocolContext

Returns:

See Also:

ProtocolContext.family()