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 SAMLAssertingParty

All Superinterfaces:
  SAMLCommonPartner, SAMLPartner

    public interface SAMLAssertingParty

extends SAMLCommonPartner

Represents a SAML Asserting Party entry in the LDAP Asserting Party registry.

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

Fields inherited from interface weblogic.security.providers.saml.registry.SAMLCommonPartner
`PROFILE_ARTIFACT, PROFILE_HOK, PROFILE_POST, PROFILE_SV`

Method Summary
`String` | `getAssertionRetrievalURL()` Get the Assertion Retrieval URL for this partner.
`String` | `getAssertionSigningCertAlias()` Get the Assertion Signing Certificate Alias.
`String[]` | `getIntersiteTransferParams()` Get the Intersite Transfer Params.
`String` | `getIntersiteTransferURL()` Get the Intersite Transfer URL.
`String` | `getIssuerURI()` Get this partner's Issuer URI.
`String` | `getProtocolSigningCertAlias()` Get the Protocol Signing Certificate Alias.
`String[]` | `getRedirectURIs()` Get the Redirect URIs.
`String` | `getSourceId()` Get the partner's Source ID.
`boolean` | `isVirtualUserEnabled()` Get the Virtual User Enabled value.
`void` | `setAssertionRetrievalURL(String assertionRetrievalURL)` Set the Assertion Retrieval URL.
`void` | `setAssertionSigningCertAlias(String assertionSigningCertAlias)` Set the Assertion Signing Certificate Alias.
`void` | `setIntersiteTransferParams(String[] intersiteTransferParams)` Set the Intersite Transfer Params.
`void` | `setIntersiteTransferURL(String intersiteTransferURL)` Set the Intersite Transfer URL.
`void` | `setIssuerURI(String issuerURI)` Set the Issuer URI value for this partner.
`void` | `setProtocolSigningCertAlias(String protocolSigningCertAlias)` Set the Protocol Signing Certificate Alias.
`void` | `setRedirectURIs(String[] redirectURIs)` Set the Redirect URIs.
`void` | `setSourceId(String sourceId)` Set the partner's Source ID.
`void` | `setVirtualUserEnabled(boolean virtualUserEnabled)` Set the Virtual User Enabled value.

Methods inherited from interface weblogic.security.providers.saml.registry.SAMLCommonPartner
`getARSPasswordEncrypted, getARSUsername, getAudienceURI, getNameMapperClass, getProfile, getTargetURL, isARSPasswordSet, isGroupsAttributeEnabled, isSignedAssertions, setARSPassword, setARSUsername, setAudienceURI, setGroupsAttributeEnabled, setNameMapperClass, setProfile, setSignedAssertions, setTargetURL`

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

Method Detail

### getIssuerURI

    String getIssuerURI()

  Get this partner's Issuer URI.

  Returns:
    The Issuer URI.

### setIssuerURI

    void setIssuerURI(String issuerURI)

  Set the Issuer URI value for this partner.

  Parameters:
    `issuerURI` - The partner's Issuer URI.

### getSourceId

    String getSourceId()

  Get the partner's Source ID. Used with Browser/Artifact profile only.

  Returns:
    The Source ID.

### setSourceId

    void setSourceId(String sourceId)

  Set the partner's Source ID. May be specified as hexadecimal or a base-64 encoded binary value.

  Parameters:
    `sourceId` - The Source ID to set.

### getAssertionRetrievalURL

    String getAssertionRetrievalURL()

  Get the Assertion Retrieval URL for this partner. Used with Browser/Artifact profile only.

  Returns:
    The Assertion Retrieval URL.

### setAssertionRetrievalURL

    void setAssertionRetrievalURL(String assertionRetrievalURL)

  Set the Assertion Retrieval URL. Used with Browser/Artifact profile only.

  Parameters:
    `assertionRetrievalURL` - The Assertion Retrieval URL.

### getIntersiteTransferURL

    String getIntersiteTransferURL()

  Get the Intersite Transfer URL. Must be set if Redirect URIs is set.

  Returns:
    The Intersite Transfer URL.

### setIntersiteTransferURL

    void setIntersiteTransferURL(String intersiteTransferURL)

  Set the Intersite Transfer URL.

  Parameters:
    `intersiteTransferURL` - The Intersite Transfer URL to set.

### getIntersiteTransferParams

    String[] getIntersiteTransferParams()

  Get the Intersite Transfer Params. These parameters are added to the Intersite Transfer URL when redirecting to the partner's ITS.

  Returns:
    The Intersite Transfer Params.

### setIntersiteTransferParams

    void setIntersiteTransferParams(String[] intersiteTransferParams)

  Set the Intersite Transfer Params. Specified as an array of Strings of the form "name=value".

  Parameters:
    `intersiteTransferParams` - The Intersite Transfer Params to set.

### getRedirectURIs

    String[] getRedirectURIs()

  Get the Redirect URIs. Unauthenticated users accessing these URIs are redirected to the partner's Intersite Transfer URL.

  Returns:
    The Redirect URIs.

### setRedirectURIs

    void setRedirectURIs(String[] redirectURIs)

  Set the Redirect URIs. This is an array of URIs identifying resources on the server. The URIs must be included in the resource's application context. Unauthenticated users accessing these URIs will be redirected to the configured Intersite Transfer URL.

  Parameters:
    `redirectURIs` - The Redirect URIs to set.

### getAssertionSigningCertAlias

    String getAssertionSigningCertAlias()

  Get the Assertion Signing Certificate Alias. The certificate referenced by this alias is used to verify signatures on signed assertions.

  Returns:
    The Assertion Signing Certificate Alias.

### setAssertionSigningCertAlias

    void setAssertionSigningCertAlias(String assertionSigningCertAlias)

  Set the Assertion Signing Certificate Alias. The alias must be registered in the SAML Certificate Registry, or validation will fail when the Asserting Party is added to the registry or updated.

  Parameters:
    `assertionSigningCertAlias` - The Assertion Signing Certificate Alias to set.

### getProtocolSigningCertAlias

    String getProtocolSigningCertAlias()

  Get the Protocol Signing Certificate Alias. The certificate referenced by this alias is used to verify signatures on SAML protocol elements. Used for Browser/POST profile only (to verify signatures on SAML Response elements).

  Returns:
    The Protocol Signing Certificate Alias.

### setProtocolSigningCertAlias

    void setProtocolSigningCertAlias(String protocolSigningCertAlias)

  Set the Protocol Signing Certificate Alias. The alias must be registered in the SAML Certificate Registry, or validation will fail when the Asserting Party is added to the registry or updated.

  Parameters:
    `protocolSigningCertAlias` - The Protocol Signing Certificate Alias to set.

### isVirtualUserEnabled

    boolean isVirtualUserEnabled()

  Get the Virtual User Enabled value. If true, the SAML Authenticator will authenticate "virtual users" for names (user and group) obtained from this partner's assertions that are returned by the SAML Identity Assertion provider. If false, virtual users are not allowed, and the user names returned by the SAML Identity Assertion provider must be authenticated by another authentication provider, which will (probably) require that the user be registered in a user directory or database and that will create user principals based on the user's directory information.

  Returns:
    The Virtual User Enabled value.

### setVirtualUserEnabled

    void setVirtualUserEnabled(boolean virtualUserEnabled)

  Set the Virtual User Enabled value.

  Parameters:
    `virtualUserEnabled` - The Virtual user Enabled valuee 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