BEA Systems, Inc.

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

All Superinterfaces:
Serializable
All Known Subinterfaces:
BindingClientPartner, IdPPartner, MetadataPartner, SPPartner, WebSSOIdPPartner, WebSSOPartner, WebSSOSPPartner, WSSIdPPartner, WSSPartner, WSSSPPartner
All Known Implementing Classes:
WebSSOIdPPartnerImpl, WebSSOSPPartnerImpl, WSSIdPPartnerImpl, WSSSPPartnerImpl

public interface Partner
extends Serializable

The general partner interface that contains madatory information for a partner.


Field Summary
static String ASSERTION_TYPE_BEARER
           
static String ASSERTION_TYPE_HOLDER_OF_KEY
           
static String ASSERTION_TYPE_SENDER_VOUCHES
           
 
Method Summary
 String[] getAudienceURIs()
          Returns an array of <Audience> URI values for the <AudienceRestriction> condition of SAML assertions.
 String getDescription()
          Returns the description for this partner.
 String getName()
          Returns this partner's name.
 boolean isEnabled()
          Returns the enabled flag for this partner.
 boolean isNameModified()
          Returns the nameModified flag for this partner.
 void setAudienceURIs(String[] audienceURIs)
          Sets the <Audience> URI values for this partner.
 void setDescription(String desc)
          Set the description for this partner.
 void setEnabled(boolean enabled)
          Set the enabled flag for this partner.
 void setName(String name)
          Set the partner's name.
 

Field Detail

ASSERTION_TYPE_BEARER

static final String ASSERTION_TYPE_BEARER
See Also:
Constant Field Values

ASSERTION_TYPE_HOLDER_OF_KEY

static final String ASSERTION_TYPE_HOLDER_OF_KEY
See Also:
Constant Field Values

ASSERTION_TYPE_SENDER_VOUCHES

static final String ASSERTION_TYPE_SENDER_VOUCHES
See Also:
Constant Field Values
Method Detail

setName

void setName(String name)
Set the partner's name. Name is required for a partner.

Parameters:
name -

getName

String getName()
Returns this partner's name.

Returns:
partner name

isEnabled

boolean isEnabled()
Returns the enabled flag for this partner. This value indicates whether or not the partner is enabled.

Returns:
enabled flag.

isNameModified

boolean isNameModified()
Returns the nameModified flag for this partner. This value indicates whether or not the partner name is modified.

Returns:
nameModified flag.

setEnabled

void setEnabled(boolean enabled)
Set the enabled flag for this partner.

Parameters:
enabled - The enabled flag to set.

getDescription

String getDescription()
Returns the description for this partner.

Returns:
description.

setDescription

void setDescription(String desc)
Set the description for this partner.

Parameters:
desc - The description value to set.

getAudienceURIs

String[] getAudienceURIs()
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.

Returns:
<Audience> URI values
See Also:
MetadataPartner.getEntityID()

setAudienceURIs

void setAudienceURIs(String[] audienceURIs)
Sets the <Audience> URI values for this partner.

Parameters:
audienceURIs - <Audience> URI values
See Also:
Partner.getAudienceURIs()

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.