SamlProviderConfig.CreateRequest

public static final class SamlProviderConfig.CreateRequest extends ProviderConfig.AbstractCreateRequest<T extends AbstractCreateRequest<T>>

A specification class for creating a new SAML Auth provider.

Set the initial attributes of the new provider by calling various setter methods available in this class.

Public Constructor Summary

CreateRequest()
Creates a new SamlProviderConfig.CreateRequest, which can be used to create a new SAML Auth provider.

Public Method Summary

SamlProviderConfig.CreateRequest
addAllX509Certificates(Collection<String> x509Certificates)
Adds a collection of x509 certificates to the new provider.
SamlProviderConfig.CreateRequest
addX509Certificate(String x509Certificate)
Adds a x509 certificate to the new provider.
SamlProviderConfig.CreateRequest
setCallbackUrl(String callbackUrl)
Sets the callback URL for the new provider.
SamlProviderConfig.CreateRequest
setIdpEntityId(String idpEntityId)
Sets the IDP entity ID for the new provider.
SamlProviderConfig.CreateRequest
setProviderId(String providerId)
Sets the ID for the new provider.
SamlProviderConfig.CreateRequest
setRpEntityId(String rpEntityId)
Sets the RP entity ID for the new provider.
SamlProviderConfig.CreateRequest
setSsoUrl(String ssoUrl)
Sets the SSO URL for the new provider.

Inherited Method Summary

Public Constructors

public CreateRequest ()

Creates a new SamlProviderConfig.CreateRequest, which can be used to create a new SAML Auth provider.

The returned object should be passed to createSamlProviderConfig(CreateRequest) to register the provider information persistently.

Public Methods

public SamlProviderConfig.CreateRequest addAllX509Certificates (Collection<String> x509Certificates)

Adds a collection of x509 certificates to the new provider.

Parameters
x509Certificates A non-null, non-empty collection of x509 certificate strings.
Throws
IllegalArgumentException If the collection is null or empty, or if any x509 certificates are null or empty.

public SamlProviderConfig.CreateRequest addX509Certificate (String x509Certificate)

Adds a x509 certificate to the new provider.

Parameters
x509Certificate A non-null, non-empty x509 certificate string.
Throws
IllegalArgumentException If the x509 certificate is null or empty.

public SamlProviderConfig.CreateRequest setCallbackUrl (String callbackUrl)

Sets the callback URL for the new provider.

Parameters
callbackUrl A non-null, non-empty callback URL string.
Throws
IllegalArgumentException If the callback URL is null or empty, or if the format is invalid.

public SamlProviderConfig.CreateRequest setIdpEntityId (String idpEntityId)

Sets the IDP entity ID for the new provider.

Parameters
idpEntityId A non-null, non-empty IDP entity ID string.
Throws
IllegalArgumentException If the IDP entity ID is null or empty.

public SamlProviderConfig.CreateRequest setProviderId (String providerId)

Sets the ID for the new provider.

Parameters
providerId A non-null, non-empty provider ID string.
Throws
IllegalArgumentException If the provider ID is null or empty, or is not prefixed with 'saml.'.

public SamlProviderConfig.CreateRequest setRpEntityId (String rpEntityId)

Sets the RP entity ID for the new provider.

Parameters
rpEntityId A non-null, non-empty RP entity ID string.
Throws
IllegalArgumentException If the RP entity ID is null or empty.

public SamlProviderConfig.CreateRequest setSsoUrl (String ssoUrl)

Sets the SSO URL for the new provider.

Parameters
ssoUrl A non-null, non-empty SSO URL string.
Throws
IllegalArgumentException If the SSO URL is null or empty, or if the format is invalid.