BEA Systems, Inc.

com.bea.security.saml2.providers.registry
Class WSSSPPartnerImpl

java.lang.Object
  extended by com.bea.security.saml2.providers.registry.WSSSPPartnerImpl
All Implemented Interfaces:
Partner, SPPartner, WSSPartner, WSSSPPartner, Serializable

public class WSSSPPartnerImpl
extends Object
implements WSSSPPartner, Serializable

See Also:
Serialized Form

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
 
Fields inherited from interface com.bea.security.saml2.providers.registry.Partner
ASSERTION_TYPE_BEARER, ASSERTION_TYPE_HOLDER_OF_KEY, ASSERTION_TYPE_SENDER_VOUCHES
 
Constructor Summary
WSSSPPartnerImpl()
           
 
Method Summary
 String[] getAudienceURIs()
          Returns an array of <Audience> URI values for the <AudienceRestriction> condition of SAML assertions.
 String getConfirmationMethod()
          get the subject confirmation method for this partner.
 String getDescription()
          Returns the description for this partner.
 String getName()
          Returns this partner's name.
 String getServiceProviderNameMapperClassname()
          Returns classname of SP Provider name mapper for the conversion from SAML2 attributes to JAAS Subject principals
 int getTimeToLive()
          Get the Time To Live value.
 int getTimeToLiveOffset()
          Get the Time To Live Offset value.
 boolean isEnabled()
          Returns the enabled flag for this partner.
 boolean isGenerateAttributes()
          The flag of whether to generate <AttributeStatment> in the assertion for this partner.
 boolean isIncludeOneTimeUseCondition()
          Get the IncludeOneTimeUseCondition value.
 boolean isKeyinfoIncluded()
          Get the Keyinfo Included value.
 boolean isNameModified()
          Returns the nameModified flag for this partner.
 boolean isWantAssertionsSigned()
          Indicates if this partner want assertion signed.
 void setAudienceURIs(String[] audienceURIs)
          Sets the <Audience> URI values for this partner.
 void setConfirmationMethod(String confirmationMethod)
          set the confirmation method.
 void setDescription(String description)
          Set the description for this partner.
 void setEnabled(boolean enabled)
          Set the enabled flag for this partner.
 void setGenerateAttributes(boolean generateAttributes)
          set the generate attribute flag.
 void setIncludeOneTimeUseCondition(boolean includeOneTimeUseCondition)
          Set the IncludeOneTimeUseCondition value.
 void setKeyinfoIncluded(boolean keyinfoIncluded)
          Set the Keyinfo Included value.
 void setName(String name)
          Set the partner's name.
 void setServiceProviderNameMapperClassname(String serviceProviderNameMapperClassname)
          Sets SP Provider name mapper classname
 void setTimeToLive(int timeToLive)
          Set the Time To Live value, as a number of seconds.
 void setTimeToLiveOffset(int timeToLiveOffset)
          Set the Time To Live Offset value, as a positive or negative number of seconds.
 void setWantAssertionsSigned(boolean wantAssertionsSigned)
          set the want assertion signed flag.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

WSSSPPartnerImpl

public WSSSPPartnerImpl()
Method Detail

getAudienceURIs

public String[] getAudienceURIs()
Description copied from interface: Partner
Returns an array of <Audience> URI values for the <AudienceRestriction> condition of SAML assertions. In General cases, for IdP partners, this configuration specifies a list of audiences of the local site, one of which must be in each assertion from the IdP. For SP partners, this configuration specifies the audience list to include in generated assertions.

Note that for Web SSO cases, this value is not honored. The only Audience URI for Web SSO is the IdP's Entity ID.

Specified by:
getAudienceURIs in interface Partner
Returns:
<Audience> URI values
See Also:
MetadataPartner.getEntityID()

setAudienceURIs

public void setAudienceURIs(String[] audienceURIs)
Description copied from interface: Partner
Sets the <Audience> URI values for this partner.

Specified by:
setAudienceURIs in interface Partner
Parameters:
audienceURIs - <Audience> URI values
See Also:
Partner.getAudienceURIs()

getConfirmationMethod

public String getConfirmationMethod()
Description copied from interface: WSSPartner
get the subject confirmation method for this partner. the confirmation method could be one of: Partner.ASSERTION_TYPE_BEARER Partner.ASSERTION_TYPE_HOLDER_OF_KEY and Partner.ASSERTION_TYPE_SENDER_VOUCHES. hold-of-key, sender-vouches and bearer.

Specified by:
getConfirmationMethod in interface WSSPartner
Returns:
the conformation method

setConfirmationMethod

public void setConfirmationMethod(String confirmationMethod)
Description copied from interface: WSSPartner
set the confirmation method.

Specified by:
setConfirmationMethod in interface WSSPartner

getDescription

public String getDescription()
Description copied from interface: Partner
Returns the description for this partner.

Specified by:
getDescription in interface Partner
Returns:
description.

setDescription

public void setDescription(String description)
Description copied from interface: Partner
Set the description for this partner.

Specified by:
setDescription in interface Partner
Parameters:
description - The description value to set.

isEnabled

public boolean isEnabled()
Description copied from interface: Partner
Returns the enabled flag for this partner. This value indicates whether or not the partner is enabled.

Specified by:
isEnabled in interface Partner
Returns:
enabled flag.

setEnabled

public void setEnabled(boolean enabled)
Description copied from interface: Partner
Set the enabled flag for this partner.

Specified by:
setEnabled in interface Partner
Parameters:
enabled - The enabled flag to set.

isWantAssertionsSigned

public boolean isWantAssertionsSigned()
Description copied from interface: SPPartner
Indicates if this partner want assertion signed. if true, the assertion for this partner will be signed.

Specified by:
isWantAssertionsSigned in interface SPPartner
Returns:
the want assertion signed flag.

setWantAssertionsSigned

public void setWantAssertionsSigned(boolean wantAssertionsSigned)
Description copied from interface: SPPartner
set the want assertion signed flag.

Specified by:
setWantAssertionsSigned in interface SPPartner
See Also:
SPPartner.isWantAssertionsSigned()

isGenerateAttributes

public boolean isGenerateAttributes()
Description copied from interface: SPPartner
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.

Specified by:
isGenerateAttributes in interface SPPartner
Returns:
the generated attribute flag.

setGenerateAttributes

public void setGenerateAttributes(boolean generateAttributes)
Description copied from interface: SPPartner
set the generate attribute flag.

Specified by:
setGenerateAttributes in interface SPPartner
See Also:
SPPartner.isGenerateAttributes()

isIncludeOneTimeUseCondition

public boolean isIncludeOneTimeUseCondition()
Description copied from interface: SPPartner
Get the IncludeOneTimeUseCondition value. This is a boolean value that indicates whether a OneTimeUse condition should be included in this partner's assertions.

Specified by:
isIncludeOneTimeUseCondition in interface SPPartner
Returns:
the include one-time-use condition flag

setIncludeOneTimeUseCondition

public void setIncludeOneTimeUseCondition(boolean includeOneTimeUseCondition)
Description copied from interface: SPPartner
Set the IncludeOneTimeUseCondition value. If true, a OneTimeUse condition will be added to this partner's assertions.

Specified by:
setIncludeOneTimeUseCondition in interface SPPartner
Parameters:
includeOneTimeUseCondition - inlcude OneTimeUse Condition flag

isKeyinfoIncluded

public boolean isKeyinfoIncluded()
Description copied from interface: SPPartner
Get the Keyinfo Included value. If true, assertion signatures will include the signing certificate as a keyinfo element in the signature.

Specified by:
isKeyinfoIncluded in interface SPPartner
Returns:
The Keyinfo Included value.

setKeyinfoIncluded

public void setKeyinfoIncluded(boolean keyinfoIncluded)
Description copied from interface: SPPartner
Set the Keyinfo Included value. If set to true, signed assertions will include the signing certificate as a keyinfo element in the signature.

Specified by:
setKeyinfoIncluded in interface SPPartner
Parameters:
keyinfoIncluded - The Keyinfo Included value to set.

getServiceProviderNameMapperClassname

public String getServiceProviderNameMapperClassname()
Description copied from interface: SPPartner
Returns classname of SP Provider name mapper for the conversion from SAML2 attributes to JAAS Subject principals

Specified by:
getServiceProviderNameMapperClassname in interface SPPartner
Returns:
SP Provider name mapper classname

setServiceProviderNameMapperClassname

public void setServiceProviderNameMapperClassname(String serviceProviderNameMapperClassname)
Description copied from interface: SPPartner
Sets SP Provider name mapper classname

Specified by:
setServiceProviderNameMapperClassname in interface SPPartner
Parameters:
serviceProviderNameMapperClassname - Name mapper classname
See Also:
SPPartner.getServiceProviderNameMapperClassname()

getTimeToLive

public int getTimeToLive()
Description copied from interface: SPPartner
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.

Specified by:
getTimeToLive in interface SPPartner
Returns:
The Time To Live value.

setTimeToLive

public void setTimeToLive(int timeToLive)
Description copied from interface: SPPartner
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.

Specified by:
setTimeToLive in interface SPPartner
Parameters:
timeToLive - The Time To Live value, in seconds.

getTimeToLiveOffset

public int getTimeToLiveOffset()
Description copied from interface: SPPartner
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.

Specified by:
getTimeToLiveOffset in interface SPPartner
Returns:
The Time To Live Offset.

setTimeToLiveOffset

public void setTimeToLiveOffset(int timeToLiveOffset)
Description copied from interface: SPPartner
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.

Specified by:
setTimeToLiveOffset in interface SPPartner
Parameters:
timeToLiveOffset - The Time To Live Offset value to set.

isNameModified

public boolean isNameModified()
Description copied from interface: Partner
Returns the nameModified flag for this partner. This value indicates whether or not the partner name is modified.

Specified by:
isNameModified in interface Partner
Returns:
nameModified flag.

setName

public void setName(String name)
Description copied from interface: Partner
Set the partner's name. Name is required for a partner.

Specified by:
setName in interface Partner

getName

public String getName()
Description copied from interface: Partner
Returns this partner's name.

Specified by:
getName in interface Partner
Returns:
partner name

Because this information documents a Tech Preview of a BEA product, it may be incomplete and is subject to change. Documentation is available at
http://download.oracle.com/docs/cd/E13222_01/wls/essex/TechPreview
Copyright 2007 BEA Systems Inc.