weblogic.security.providers.saml.registry
Interface SAMLRelyingParty

All Superinterfaces:

SAMLCommonPartner, SAMLPartner

public interface SAMLRelyingParty
extends SAMLCommonPartner

Represents a SAML Relying Party entry in the SAML Relying 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.

getAssertionConsumerURL

String getAssertionConsumerURL()

Get the Assertion Consumer URL.

Returns:

The Assertion Consumer URL.

setAssertionConsumerURL

void setAssertionConsumerURL(String assertionConsumerURL)

Set the Assertion Consumer URL.

Parameters:

assertionConsumerURL - The assertion consumer URL.

getAssertionConsumerParams

String[] getAssertionConsumerParams()

Get the Assertion Consumer Parameters. These values are sent (as query parameters or form variables) to the Relying Party's ACS.

Returns:

The Assertion Consumer Parameters.

setAssertionConsumerParams

void setAssertionConsumerParams(String[] assertionConsumerParams)

Set the Assertion Consumer Parameters. Argument is an array of Strings, where each string is of the form "name=value".

Parameters:

assertionConsumerParams -

getPostForm

String getPostForm()

Gets the POST form. This form, if present, is used in place of the default POST form when POSTing to a Browser/POST Relying Party.

Returns:

The POST form.

setPostForm

void setPostForm(String postForm)

Sets the POST form. Parameter is a URI indicating the location, with full application context, of the form that should be used.

Parameters:

postForm - The URI of the POST form to set.

getSSLClientCertAlias

String getSSLClientCertAlias()

Get the SSL Client Certificate Alias. This is the alias of a certificate in the SAML Certificate Registry that is trusted as an SSL client certificate for retrieving assertions for the Browser/Artifact profile.

Returns:

The SSL client certificate alias.

setSSLClientCertAlias

void setSSLClientCertAlias(String sslClientCertAlias)

Set the SSL Client Certificate Alias. Validation will fail on save or update if alias is not found in the SAML Certificate Registry.

Parameters:

sslClientCertAlias - The SSL Client Certificate Alias.

getTimeToLive

int getTimeToLive()

Get the Time To Live value. This is the validity period for the partner's assertions -- the number of seconds between the NotBefore and NotOnOrAfter times.

Returns:

The Time To Live value.

setTimeToLive

void setTimeToLive(int timeToLive)

Set the Time To Live value, as a number of seconds. If non-zero, overrides the SAML Credential Mapping provider's default Time To Live setting.

Parameters:

timeToLive - The Time To Live value, in seconds.

getTimeToLiveOffset

int getTimeToLiveOffset()

Get the Time To Live Offset value. When generating an assertion, this value -- a positive or negative number of seconds -- is added the current time to arrive at the assertions NotBefore time.

Returns:

The Time To Live Offset.

setTimeToLiveOffset

void setTimeToLiveOffset(int timeToLiveOffset)

Set the Time To Live Offset value, as a positive or negative number of seconds. If non-zero, overrides the SAML Credential Mapping provider's default Time To Live Offset value.

Parameters:

timeToLiveOffset - The Time To Live Offset value to set.

isDoNotCacheCondition

boolean isDoNotCacheCondition()

Get the DoNotCacheCondition value. This is a boolean value that indicates whether a DoNotCache condition should be included in this partner's assertions.

setDoNotCacheCondition

void setDoNotCacheCondition(boolean doNotCacheCondition)

Set the DoNotCacheCondition value. If true, a DoNotCache condition will be added to this partner's assertions.

Parameters:

doNotCacheCondition - The DoNotCacheCondition value.

isKeyinfoIncluded

boolean isKeyinfoIncluded()

Get the Keyinfo Included value. If true, assertion signatures will include the signing certificate as a keyinfo element in the signature.

Returns:

The Keyinfo Included value.

setKeyinfoIncluded

void setKeyinfoIncluded(boolean keyinfoIncluded)

Set the Keyinfo Included value. If set to true, signed assertions will include the signing certificate as a keyinfo element in the signature.

Parameters:

keyinfoIncluded - The Keyinfo Included value to set.

isCredentialCacheEnabled

boolean isCredentialCacheEnabled()

setCredentialCacheEnabled

void setCredentialCacheEnabled(boolean enabled)