Package com.bea.security.saml2.providers.registry

Interface SPPartner

All Superinterfaces:

Partner, java.io.Serializable

All Known Subinterfaces:

WebSSOSPPartner, WSSSPPartner

public interface SPPartner
extends Partner

Abstract representation of a SAML 2.0 Service Provider partner.

Field Summary

Fields inherited from interface com.bea.security.saml2.providers.registry.Partner

ASSERTION_TYPE_BEARER, ASSERTION_TYPE_HOLDER_OF_KEY, ASSERTION_TYPE_SENDER_VOUCHES

Method Summary

Modifier and Type	Method	Description
java.lang.String	getServiceProviderNameMapperClassname()	Gets the qualified name of Java class that maps Assertion name information to Subjects.
int	getTimeToLive()	Gets the Time To Live value.
int	getTimeToLiveOffset()	Gets the Time To Live Offset value.
boolean	isGenerateAttributes()	Gets the flag that indicates whether to generate <AttributeStatment> in the assertion for this partner.
boolean	isIncludeOneTimeUseCondition()	Gets the Include OneTimeUse Condition value.
boolean	isKeyinfoIncluded()	Gets the Keyinfo Included value.
boolean	isWantAssertionsSigned()	Gets the flag that indicates if this partner expects to receive signed assertions.
void	setGenerateAttributes(boolean generateAttributes)	Sets the generate attribute flag.
void	setIncludeOneTimeUseCondition(boolean isIncludeOneTimeUseCondition)	Sets the Include OneTimeUse Condition value.
void	setKeyinfoIncluded(boolean keyinfoIncluded)	Sets the Keyinfo Included value.
void	setServiceProviderNameMapperClassname(java.lang.String nameMapperClassname)	Sets the qualified name of name mapper class.
void	setTimeToLive(int timeToLive)	Sets the Time To Live value, as a number of seconds.
void	setTimeToLiveOffset(int timeToLiveOffset)	Sets the Time To Live Offset value, as a positive or negative number of seconds.
void	setWantAssertionsSigned(boolean wantAssertionsSigned)	Sets the want assertion signed flag.

Methods inherited from interface com.bea.security.saml2.providers.registry.Partner

getAudienceURIs, getDescription, getName, isEnabled, isNameModified, setAudienceURIs, setDescription, setEnabled, setName

Method Detail

getServiceProviderNameMapperClassname

java.lang.String getServiceProviderNameMapperClassname()

Gets the qualified name of Java class that maps Assertion name information to Subjects.

Returns:

the qualified name of name mapper class

setServiceProviderNameMapperClassname

void setServiceProviderNameMapperClassname(java.lang.String nameMapperClassname)

Sets the qualified name of name mapper class.

Parameters:

nameMapperClassname - the qualified name of name mapper class to set

See Also:

getServiceProviderNameMapperClassname()

getTimeToLive

int getTimeToLive()

Gets the Time To Live value. This is the validity period of assertions for this partner -- the number of seconds between the NotBefore and NotOnOrAfter times.

Returns:

the Time To Live value

setTimeToLive

void setTimeToLive(int timeToLive)

Sets the Time To Live value, as a number of seconds. If non-zero, overrides the SAML Credential Mapper's default Time To Live setting.

Parameters:

timeToLive - the Time To Live value to set, in seconds.

See Also:

getTimeToLive()

getTimeToLiveOffset

int getTimeToLiveOffset()

Gets the Time To Live Offset value. When generating an assertion, this value -- a positive or negative number of seconds -- is added the current time to arrive at the assertions NotBefore time.

Returns:

the Time To Live Offset

setTimeToLiveOffset

void setTimeToLiveOffset(int timeToLiveOffset)

Sets the Time To Live Offset value, as a positive or negative number of seconds. If non-zero, overrides the SAML Credential Mapper's default Time To Live Offset value.

Parameters:

timeToLiveOffset - the Time To Live Offset value to set

See Also:

getTimeToLiveOffset()

isIncludeOneTimeUseCondition

boolean isIncludeOneTimeUseCondition()

Gets the Include OneTimeUse Condition value. This is a boolean value that indicates whether a OneTimeUse condition should be included in the assertions for this partner.

Returns:

the include one-time-use condition flag

See Also:

setIncludeOneTimeUseCondition(boolean)

setIncludeOneTimeUseCondition

void setIncludeOneTimeUseCondition(boolean isIncludeOneTimeUseCondition)

Sets the Include OneTimeUse Condition value. If set to true, an OneTimeUse condition will be added to this partner's assertions.

Parameters:

isIncludeOneTimeUseCondition - inlcude OneTimeUse Condition flag to set

isGenerateAttributes

boolean isGenerateAttributes()

Gets the flag that indicates whether to generate <AttributeStatment> in the assertion for this partner. If true, the default implementation will generate group information as an <Attributestatement> in the assertion if there is any.

Returns:

the generated attribute flag

setGenerateAttributes

void setGenerateAttributes(boolean generateAttributes)

Sets the generate attribute flag.

Parameters:

generateAttributes -

See Also:

isGenerateAttributes()

isKeyinfoIncluded

boolean isKeyinfoIncluded()

Gets the Keyinfo Included value. If true, assertion signatures will include the signing certificate as a keyinfo element in the signature.

Returns:

the Keyinfo Included value

setKeyinfoIncluded

void setKeyinfoIncluded(boolean keyinfoIncluded)

Sets the Keyinfo Included value. If set to true, signed assertions will include the signing certificate as a keyinfo element in the signature.

Parameters:

keyinfoIncluded - the Keyinfo Included value to set

isWantAssertionsSigned

boolean isWantAssertionsSigned()

Gets the flag that indicates if this partner expects to receive signed assertions.

At SAML2 Identity Provider site, <Assertion> issued to this partner will be signed if this flag is set to true.

Returns:

the want assertion signed flag

setWantAssertionsSigned

void setWantAssertionsSigned(boolean wantAssertionsSigned)

Sets the want assertion signed flag.

Parameters:

wantAssertionsSigned - the want assertion signed flag to set

See Also:

isWantAssertionsSigned()