SamlProviderConfig.UpdateRequest

public static final class SamlProviderConfig.UpdateRequest extends ProviderConfig.AbstractUpdateRequest<T extends AbstractUpdateRequest<T>>

A specification class for updating an existing SAML Auth provider.

An instance of this class can be obtained via a SamlProviderConfig object, or from a provider ID string. Specify the changes to be made to the provider config by calling the various setter methods available in this class.

Public Constructor Summary

UpdateRequest(String providerId)
Creates a new SamlProviderConfig.UpdateRequest, which can be used to updates an existing SAML Auth provider.

Public Method Summary

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

Inherited Method Summary

Public Constructors

public UpdateRequest (String providerId)

Creates a new SamlProviderConfig.UpdateRequest, which can be used to updates an existing SAML Auth provider.

The returned object should be passed to updateSamlProviderConfig(UpdateRequest) to update the provider information persistently.

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 Methods

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

Adds a collection of x509 certificates to the existing 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.UpdateRequest addX509Certificate (String x509Certificate)

Adds a x509 certificate to the existing provider.

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

public SamlProviderConfig.UpdateRequest setCallbackUrl (String callbackUrl)

Sets the callback URL for the exising 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.UpdateRequest setIdpEntityId (String idpEntityId)

Sets the IDP entity ID for the existing 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.UpdateRequest setRpEntityId (String rpEntityId)

Sets the RP entity ID for the existing 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.UpdateRequest setSsoUrl (String ssoUrl)

Sets the SSO URL for the existing 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.