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 WebSSOPartner

All Superinterfaces:
  BindingClientPartner, MetadataPartner, Partner, Serializable

All Known Subinterfaces:
  WebSSOIdPPartner, WebSSOSPPartner

    public interface WebSSOPartner

extends MetadataPartner, BindingClientPartner

Abstract representation of a SAML 2.0 partner for Web SSO profile. It contains both metadata information and Binding Client information because it supports Artifact (SOAP) binding.

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`

Method Summary
`String` | `getArtifactBindingPostForm()` Gets the POST form for the HTTP/Artifact binding.
`IndexedEndpoint[]` | `getArtifactResolutionService()` Gets the Artifact Resolution Service end points for this partner.
`String` | `getPostBindingPostForm()` Gets the POST form for the HTTP/POST binding.
`X509Certificate` | `getSSOSigningCert()` Gets the SSO Signing Certificate.
`boolean` | `isArtifactBindingUsePOSTMethod()` Gets the flag that indicates whether to use POST when sending an artifact to the partner's HTTP/Artifact bindings.
`boolean` | `isWantArtifactRequestSigned()` Gets the flag that indicates if this partner expects to receive signed <ArtifactResolve> documents.
`void` | `setArtifactBindingPostForm(String postForm)` Sets the POST form for the HTTP/Artifact binding.
`void` | `setArtifactBindingUsePOSTMethod(boolean isPOSTArtifact)` Sets the artifact binding use POST method flag.
`void` | `setArtifactResolutionService(IndexedEndpoint[] endpoints)` Sets the Artifact Resolution Service end points for this partner.
`void` | `setPostBindingPostForm(String postForm)` Sets the POST form for the HTTP/POST binding.
`void` | `setSSOSigningCert(X509Certificate ssoSigningCert)` Sets the SSO Signing Certificate.
`void` | `setWantArtifactRequestSigned(boolean wantSigned)` Sets the want <ArtifactResolve> signed flag.

Methods inherited from interface com.bea.security.saml2.providers.registry.MetadataPartner
`getContactPersonCompany, getContactPersonEmailAddress, getContactPersonGivenName, getContactPersonSurName, getContactPersonTelephoneNumber, getContactPersonType, getEntityID, getErrorURL, getOrganizationName, getOrganizationURL, setContactPersonCompany, setContactPersonEmailAddress, setContactPersonGivenName, setContactPersonSurName, setContactPersonTelephoneNumber, setContactPersonType, setEntityID, setErrorURL, setOrganizationName, setOrganizationURL`

Methods inherited from interface com.bea.security.saml2.providers.registry.Partner
`getAudienceURIs, getDescription, getName, isEnabled, isNameModified, setAudienceURIs, setDescription, setEnabled, setName`

Methods inherited from interface com.bea.security.saml2.providers.registry.BindingClientPartner
`getClientPasswordEncrypted, getClientUsername, getTransportLayerClientCert, isClientPasswordSet, setClientPassword, setClientUsername, setTransportLayerClientCert`

Methods inherited from interface com.bea.security.saml2.providers.registry.Partner
`getAudienceURIs, getDescription, getName, isEnabled, isNameModified, setAudienceURIs, setDescription, setEnabled, setName`

Method Detail

### getArtifactResolutionService

    IndexedEndpoint[] getArtifactResolutionService()

  Gets the Artifact Resolution Service end points for this partner.

  Returns:
    the Artifact Resolution Service end points

### getSSOSigningCert

    X509Certificate getSSOSigningCert()

  Gets the SSO Signing Certificate. The certificate is used to verify signatures on all signed documents from this partner.

  Returns:
    the SSO Signing Certificate

### setSSOSigningCert

    void setSSOSigningCert(X509Certificate ssoSigningCert)

  Sets the SSO Signing Certificate.

  Parameters:
    `ssoSigningCert` - the SSO Signing Certificate to set
  See Also:
    `WebSSOPartner.getSSOSigningCert()`

### setArtifactResolutionService

    void setArtifactResolutionService(IndexedEndpoint[] endpoints)

  Sets the Artifact Resolution Service end points for this partner.

  Parameters:
    `endpoints` - the Artifact Resolution Service end points to set

### isArtifactBindingUsePOSTMethod

    boolean isArtifactBindingUsePOSTMethod()

  Gets the flag that indicates whether to use POST when sending an artifact to the partner's HTTP/Artifact bindings.

  Returns:
    true to use POST, false to use the GET method

### setArtifactBindingUsePOSTMethod

    void setArtifactBindingUsePOSTMethod(boolean isPOSTArtifact)

  Sets the artifact binding use POST method flag.

  Parameters:
    `isPOSTArtifact` - the flag to set
  See Also:
    `WebSSOPartner.isArtifactBindingUsePOSTMethod()`

### getArtifactBindingPostForm

    String getArtifactBindingPostForm()

  Gets the POST form for the HTTP/Artifact binding. This form, if present, is used in place of the default POST form when POSTing to a partner's HTTP/Artifact binding.

  Returns:
    the POST form

### setArtifactBindingPostForm

    void setArtifactBindingPostForm(String postForm)

  Sets the POST form for the HTTP/Artifact binding.

  Parameters:
    `postForm` - the URI indicating the location, with full application context, of the POST form that should be used
  See Also:
    `WebSSOPartner.getArtifactBindingPostForm()`

### isWantArtifactRequestSigned

    boolean isWantArtifactRequestSigned()

  Gets the flag that indicates if this partner expects to receive signed <ArtifactResolve> documents.

  If any Artifact Binding is enabled at local site, the <ArtifactResolve> sent to this partner will be signed if this flag is set to true. On the other hand, the signature of the received <ArtifactResolve> will be verified if:

  - the <ArtifactResolve> is signed
  - the local site `SingleSignOnServicesMBean.WantArtifactRequestsSigned` is set to true

  Unsigned <ArtifactResolve> will cause signature verification to fail if the local configuration indicates that signing is required.

  Returns:
    true if this partner expects <ArtifactResolve> documents to be signed

### setWantArtifactRequestSigned

    void setWantArtifactRequestSigned(boolean wantSigned)

  Sets the want <ArtifactResolve> signed flag.

  Parameters:
    `wantSigned` - the flag to set
  See Also:
    `WebSSOPartner.isWantArtifactRequestSigned()`

### getPostBindingPostForm

    String getPostBindingPostForm()

  Gets the POST form for the HTTP/POST binding. This form, if present, is used in place of the default POST form when POSTing to a partner's HTTP/POST binding.

  Returns:
    the POST form

### setPostBindingPostForm

    void setPostBindingPostForm(String postForm)

  Sets the POST form for the HTTP/POST binding.

  Parameters:
    `postForm` - the URI indicating the location, with full application context, of the POST form that should be used
  See Also:
    `WebSSOPartner.getPostBindingPostForm()`

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