org.springframework.security.saml2.provider.service.registration

Class RelyingPartyRegistration.ProviderDetails.Builder

java.lang.Object

org.springframework.security.saml2.provider.service.registration.RelyingPartyRegistration.ProviderDetails.Builder

Enclosing class:

RelyingPartyRegistration.ProviderDetails

public static final class RelyingPartyRegistration.ProviderDetails.Builder
extends java.lang.Object

Builder for IDP SSO endpoint configuration

Since:

5.3

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
RelyingPartyRegistration.ProviderDetails.Builder	binding(Saml2MessageBinding binding) Sets the message binding to be used when sending an AuthNRequest message
RelyingPartyRegistration.ProviderDetails	build() Creates an immutable ProviderDetails object representing the configuration for an Identity Provider, IDP
RelyingPartyRegistration.ProviderDetails.Builder	entityId(java.lang.String entityId) Sets the EntityID for the remote asserting party, the Identity Provider.
RelyingPartyRegistration.ProviderDetails.Builder	signAuthNRequest(boolean signAuthNRequest) Set to true if the AuthNRequest message should be signed
RelyingPartyRegistration.ProviderDetails.Builder	webSsoUrl(java.lang.String url) Sets the SSO URL for the remote asserting party, the Identity Provider.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Builder

public Builder()

Method Detail

entityId

public RelyingPartyRegistration.ProviderDetails.Builder entityId(java.lang.String entityId)

Sets the EntityID for the remote asserting party, the Identity Provider.

Parameters:

entityId - - the EntityID of the IDP. May be a URL.

Returns:

this object

webSsoUrl

public RelyingPartyRegistration.ProviderDetails.Builder webSsoUrl(java.lang.String url)

Sets the SSO URL for the remote asserting party, the Identity Provider.

Parameters:

url - - a URL that accepts authentication requests via REDIRECT or POST bindings

Returns:

this object

signAuthNRequest

public RelyingPartyRegistration.ProviderDetails.Builder signAuthNRequest(boolean signAuthNRequest)

Set to true if the AuthNRequest message should be signed

Parameters:

signAuthNRequest - true if the message should be signed

Returns:

this object

binding

public RelyingPartyRegistration.ProviderDetails.Builder binding(Saml2MessageBinding binding)

Sets the message binding to be used when sending an AuthNRequest message

Parameters:

binding - either Saml2MessageBinding.POST or Saml2MessageBinding.REDIRECT

Returns:

this object

build

public RelyingPartyRegistration.ProviderDetails build()

Creates an immutable ProviderDetails object representing the configuration for an Identity Provider, IDP

Returns:

immutable ProviderDetails object