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

## weblogic.security.providers.saml.registry
Interface SAMLCommonPartner

All Superinterfaces:
  SAMLPartner

All Known Subinterfaces:
  SAMLAssertingParty, SAMLRelyingParty

    public interface SAMLCommonPartner

extends SAMLPartner

Abstract representation of attributes common to a SAML 1.1 Partner.

Note that this Javadoc is being made available for the purposes of using the WebLogic Scripting Tool (WLST) to configure SAML 1.1 partners. This interface does not have a supported Java programming interface.

Field Summary
`static String` | `PROFILE_ARTIFACT`
`static String` | `PROFILE_HOK`
`static String` | `PROFILE_POST`
`static String` | `PROFILE_SV`

Method Summary
`String` | `getARSPasswordEncrypted()` Return the encrypted password if available.
`String` | `getARSUsername()` The username to use when accessing the source site Assertion Retrieval Service for this partner.
`String` | `getAudienceURI()` Get the Audience URI.
`String` | `getNameMapperClass()` Get the Name Mapper Class Name used for this partner.
`String` | `getProfile()` Get the SAML Profile used by this partner.
`String` | `getTargetURL()` Get the Target URL for this partner.
`boolean` | `isARSPasswordSet()` Check whether the ARSPassword is set
`boolean` | `isGroupsAttributeEnabled()` Get the Groups Attribute Enabled value.
`boolean` | `isSignedAssertions()` Get the Signed Assertions value.
`void` | `setARSPassword(String arsPassword)` Set the password to use when accessing the source site Assertion Retrieval Service for this partner.
`void` | `setARSUsername(String arsUsername)` Set the ARS Username.
`void` | `setAudienceURI(String audienceURI)` Set the Audience URI.
`void` | `setGroupsAttributeEnabled(boolean groupsAttributeEnabled)` Set the Groups Attribute Enabled value.
`void` | `setNameMapperClass(String nameMapperClass)` Set the Name Mapper Class Name for this partner.
`void` | `setProfile(String profile)` Set the SAML Profile used by this partner.
`void` | `setSignedAssertions(boolean signedAssertions)` Set the Signed Assertions value.
`void` | `setTargetURL(String targetURL)` Set the Target URL for this partner.

Methods inherited from interface weblogic.security.providers.saml.registry.SAMLPartner
`getDescription, getPartnerId, isEnabled, setDescription, setEnabled, validate`

Field Detail

### PROFILE_POST

    static final String PROFILE_POST

### PROFILE_ARTIFACT

    static final String PROFILE_ARTIFACT

### PROFILE_SV

    static final String PROFILE_SV

### PROFILE_HOK

    static final String PROFILE_HOK

Method Detail

### getProfile

    String getProfile()

  Get the SAML Profile used by this partner.

  Returns:
    The profile.

### setProfile

    void setProfile(String profile)

  Set the SAML Profile used by this partner.

  Parameters:
    `profile` - The Profile to set.

### getTargetURL

    String getTargetURL()

  Get the Target URL for this partner. Used by the WSS/Sender-Vouches and WSS/Holder-of-Key profiles. (Can actually be a URI -- method should be renamed.)

  Returns:
    The Target URL.

### setTargetURL

    void setTargetURL(String targetURL)

  Set the Target URL for this partner.

  Parameters:
    `targetURL` - The Target URL to set.

### getARSUsername

    String getARSUsername()

  The username to use when accessing the source site Assertion Retrieval Service for this partner.

  Returns:
    The ARS Username.

### setARSUsername

    void setARSUsername(String arsUsername)

  Set the ARS Username.

  Parameters:
    `arsUsername` - The ARS Username to set.

### getARSPasswordEncrypted

    String getARSPasswordEncrypted()

  Return the encrypted password if available.

  Returns:
    the encrypted ARSPassword if the ARSPassword is set and the encrypted value is available

### isARSPasswordSet

    boolean isARSPasswordSet()

  Check whether the ARSPassword is set

  Returns:
    true if ARSPassword attribute is set (not NULL and not Empty String)

### setARSPassword

    void setARSPassword(String arsPassword)

  Set the password to use when accessing the source site Assertion Retrieval Service for this partner.

  Parameters:
    `arsPassword` - The ARS Password to set.

### getAudienceURI

    String getAudienceURI()

  Get the Audience URI. If set, specifies the Audience URI that will be sent in assertions. For Relying Parties, specifies the Audience URI to include in assertions. For Asserting Parties, specifies an Audience URI that must be present in received assertions.

  Returns:
    The Audience URI.

### setAudienceURI

    void setAudienceURI(String audienceURI)

  Set the Audience URI.

  Parameters:
    `audienceURI` - The Audience URI to set.

### isSignedAssertions

    boolean isSignedAssertions()

  Get the Signed Assertions value. For Relying Parties, indicates whether generated assertions are signed. For Asserting Parties, indicates whether a signature is required on incoming assertions.

  Returns:
    The Signed Assertions value.

### setSignedAssertions

    void setSignedAssertions(boolean signedAssertions)

  Set the Signed Assertions value.

  Parameters:
    `signedAssertions` - The Signed Assertions value to set.

### getNameMapperClass

    String getNameMapperClass()

  Get the Name Mapper Class Name used for this partner. If set, overrides the default Name Mapper set on the SAML Credential Mapping provider or SAML Identity Assertion provider.

  Returns:
    The Name Mapper Class Name.

### setNameMapperClass

    void setNameMapperClass(String nameMapperClass)

  Set the Name Mapper Class Name for this partner.

  Parameters:
    `nameMapperClass` - The Name Mapper Class Name to set.

### isGroupsAttributeEnabled

    boolean isGroupsAttributeEnabled()

  Get the Groups Attribute Enabled value. For Relying Parties, indicates whether a groups attribute will be included in generated assertions. For Asserting Parties, indicates whether to process groups attributes in received assertions.

  Returns:
    The Groups Attribute Enabled value.

### setGroupsAttributeEnabled

    void setGroupsAttributeEnabled(boolean groupsAttributeEnabled)

  Set the Groups Attribute Enabled value.

  Parameters:
    `groupsAttributeEnabled` - The Groups Attribute Enabled Value to set.

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