com.bea.security.saml2.providers.registry
Interface SPPartner

All Superinterfaces:

Partner, Serializable

All Known Subinterfaces:

WebSSOSPPartner, WSSSPPartner

All Known Implementing Classes:

WebSSOSPPartnerImpl, WSSSPPartnerImpl

public interface SPPartner
extends Partner

The generic Service Provider partner.

getServiceProviderNameMapperClassname

String getServiceProviderNameMapperClassname()

Returns classname of SP Provider name mapper for the conversion from SAML2 attributes to JAAS Subject principals

Returns:

SP Provider name mapper classname

setServiceProviderNameMapperClassname

void setServiceProviderNameMapperClassname(String nameMapperClassname)

Sets SP Provider name mapper classname

Parameters:

nameMapperClassname - Name mapper classname

See Also:

SPPartner.getServiceProviderNameMapperClassname()

getTimeToLive

int getTimeToLive()

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

Returns:

The Time To Live value.

setTimeToLive

void setTimeToLive(int timeToLive)

Set 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, in seconds.

getTimeToLiveOffset

int getTimeToLiveOffset()

Get 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)

Set 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.

isIncludeOneTimeUseCondition

boolean isIncludeOneTimeUseCondition()

Get the IncludeOneTimeUseCondition value. This is a boolean value that indicates whether a OneTimeUse condition should be included in this partner's assertions.

Returns:

the include one-time-use condition flag

setIncludeOneTimeUseCondition

void setIncludeOneTimeUseCondition(boolean isIncludeOneTimeUseCondition)

Set the IncludeOneTimeUseCondition value. If true, a OneTimeUse condition will be added to this partner's assertions.

Parameters:

isIncludeOneTimeUseCondition - inlcude OneTimeUse Condition flag

isGenerateAttributes

boolean isGenerateAttributes()

The flag of whether to generate <AttributeStatment> in the assertion for this partner. if set, the default implementation will generate group infrormation as an Attributestatement in the assertion if there is any.

Returns:

the generated attribute flag.

setGenerateAttributes

void setGenerateAttributes(boolean generateAttributes)

set the generate attribute flag.

Parameters:

generateAttributes -

See Also:

SPPartner.isGenerateAttributes()

isKeyinfoIncluded

boolean isKeyinfoIncluded()

Get 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)

Set 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()

Indicates if this partner want assertion signed. if true, the assertion for this partner will be signed.

Returns:

the want assertion signed flag.

setWantAssertionsSigned

void setWantAssertionsSigned(boolean wantAssertionsSigned)

set the want assertion signed flag.

Parameters:

wantAssertionsSigned -

See Also:

SPPartner.isWantAssertionsSigned()