Overview | Package | Class | Use | Tree | Deprecated | Index | Help
|  | Oracle
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

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

All Superinterfaces:
  Serializable

All Known Subinterfaces:
  BindingClientPartner, IdPPartner, MetadataPartner, SPPartner, WebSSOIdPPartner, WebSSOPartner, WebSSOSPPartner, WSSIdPPartner, WSSPartner, WSSSPPartner

    public interface Partner

extends Serializable

Abstract representation of a SAML 2.0 partner. This interface defines mandatory information for a partner.

Field Summary
`static String` | `ASSERTION_TYPE_BEARER` the URI of the `bearer` confirmation method identifier.
`static String` | `ASSERTION_TYPE_HOLDER_OF_KEY` the URI of the `hold of key` confirmation method identifier.
`static String` | `ASSERTION_TYPE_SENDER_VOUCHES` the URI of the `sender vouches` confirmation method identifier.

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 the name of this partner.
`boolean` | `isEnabled()` Returns the flag that indicates if this partner is enabled.
`boolean` | `isNameModified()` Returns the flag that indicates if this partner's name was modified.
`void` | `setAudienceURIs(String[] audienceURIs)` Sets the <Audience> URI values for this partner.
`void` | `setDescription(String desc)` Sets the description for this partner.
`void` | `setEnabled(boolean enabled)` Sets the enabled flag for this partner.
`void` | `setName(String name)` Sets the name of this partner.

Field Detail

### ASSERTION_TYPE_BEARER

    static final String ASSERTION_TYPE_BEARER

  the URI of the `bearer` confirmation method identifier.

  See Also:
    Constant Field Values

### ASSERTION_TYPE_HOLDER_OF_KEY

    static final String ASSERTION_TYPE_HOLDER_OF_KEY

  the URI of the `hold of key` confirmation method identifier.

  See Also:
    Constant Field Values

### ASSERTION_TYPE_SENDER_VOUCHES

    static final String ASSERTION_TYPE_SENDER_VOUCHES

  the URI of the `sender vouches` confirmation method identifier.

  See Also:
    Constant Field Values

Method Detail

### setName

    void setName(String name)

  Sets the name of this partner.

  Parameters:
    `name` - the partner name to set
  See Also:
    `Partner.setName(String)`

### getName

    String getName()

  Returns the name of this partner. The name is used as lookup key for this partner at runtime and can not be changed once set.

  Returns:
    the partner name

### isEnabled

    boolean isEnabled()

  Returns the flag that indicates if this partner is enabled. If true, interactions with this partner are permitted. Otherwise, runtime behaves as if the partner is not defined.

  Returns:
    true if this partner is enabled

### isNameModified

    boolean isNameModified()

  Returns the flag that indicates if this partner's name was modified.

  Returns:
    true if the partner's name was modified
  See Also:
    `Partner.getName()`

### setEnabled

    void setEnabled(boolean enabled)

  Sets the enabled flag for this partner.

  Parameters:
    `enabled` - the enabled flag to set
  See Also:
    `Partner.isEnabled()`

### getDescription

    String getDescription()

  Returns the description for this partner.

  Returns:
    the description

### setDescription

    void setDescription(String desc)

  Sets 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 be included 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()`

Overview | Package | Class | Use | Tree | Deprecated | Index | Help
| Documentation is available at http://edocs.bea.com/wls/docs103 Copyright 1996,2008, Oracle and/or its affiliates. All rights reserved. Oracle is a registered trademark of Oracle Corporation and/or its affiliates. Other names may be trademarks of their respective owners.
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD