Class OpenSamlRelyingPartyRegistration.Builder
- Enclosing class:
- OpenSamlRelyingPartyRegistration
RelyingPartyRegistration.AssertingPartyDetails.Builder
that contains the underlying EntityDescriptor
-
Method Summary
Modifier and TypeMethodDescriptionassertingPartyDetails
(Consumer<RelyingPartyRegistration.AssertingPartyDetails.Builder> assertingPartyDetails) Apply thisConsumer
to further configure the Asserting Party detailsassertionConsumerServiceBinding
(Saml2MessageBinding assertionConsumerServiceBinding) Set the AssertionConsumerService Binding.assertionConsumerServiceLocation
(String assertionConsumerServiceLocation) Set the AssertionConsumerService Location.authnRequestsSigned
(Boolean authnRequestsSigned) Set the AuthnRequestsSigned setting.build()
decryptionX509Credentials
(Consumer<Collection<Saml2X509Credential>> credentialsConsumer) Apply thisConsumer
to theCollection
ofSaml2X509Credential
s for the purposes of modifying theCollection
Set the relying party's EntityID.nameIdFormat
(String nameIdFormat) Set the NameID formatregistrationId
(String id) Sets theregistrationId
template.signingX509Credentials
(Consumer<Collection<Saml2X509Credential>> credentialsConsumer) Apply thisConsumer
to theCollection
ofSaml2X509Credential
s for the purposes of modifying theCollection
singleLogoutServiceBinding
(Saml2MessageBinding singleLogoutServiceBinding) Set the SingleLogoutService BindingsingleLogoutServiceBindings
(Consumer<Collection<Saml2MessageBinding>> bindingsConsumer) Apply thisConsumer
to theCollection
ofSaml2MessageBinding
s for the purposes of modifying the SingleLogoutService BindingCollection
.singleLogoutServiceLocation
(String singleLogoutServiceLocation) Set the SingleLogoutService LocationsingleLogoutServiceResponseLocation
(String singleLogoutServiceResponseLocation)
-
Method Details
-
registrationId
Description copied from class:RelyingPartyRegistration.Builder
Sets theregistrationId
template. Often be used in URL paths- Overrides:
registrationId
in classRelyingPartyRegistration.Builder
- Parameters:
id
- registrationId for this object, should be unique- Returns:
- this object
-
entityId
Description copied from class:RelyingPartyRegistration.Builder
Set the relying party's EntityID. Equivalent to the value found in the relying party's <EntityDescriptor EntityID="..."/> This value may contain a number of placeholders. They arebaseUrl
,registrationId
,baseScheme
,baseHost
, andbasePort
.- Overrides:
entityId
in classRelyingPartyRegistration.Builder
- Parameters:
entityId
- the relying party's EntityID- Returns:
- the
RelyingPartyRegistration.Builder
for further configuration
-
signingX509Credentials
public OpenSamlRelyingPartyRegistration.Builder signingX509Credentials(Consumer<Collection<Saml2X509Credential>> credentialsConsumer) Description copied from class:RelyingPartyRegistration.Builder
Apply thisConsumer
to theCollection
ofSaml2X509Credential
s for the purposes of modifying theCollection
- Overrides:
signingX509Credentials
in classRelyingPartyRegistration.Builder
- Parameters:
credentialsConsumer
- - theConsumer
for modifying theCollection
- Returns:
- the
RelyingPartyRegistration.Builder
for further configuration
-
decryptionX509Credentials
public OpenSamlRelyingPartyRegistration.Builder decryptionX509Credentials(Consumer<Collection<Saml2X509Credential>> credentialsConsumer) Description copied from class:RelyingPartyRegistration.Builder
Apply thisConsumer
to theCollection
ofSaml2X509Credential
s for the purposes of modifying theCollection
- Overrides:
decryptionX509Credentials
in classRelyingPartyRegistration.Builder
- Parameters:
credentialsConsumer
- - theConsumer
for modifying theCollection
- Returns:
- the
RelyingPartyRegistration.Builder
for further configuration
-
assertionConsumerServiceLocation
public OpenSamlRelyingPartyRegistration.Builder assertionConsumerServiceLocation(String assertionConsumerServiceLocation) Description copied from class:RelyingPartyRegistration.Builder
Set the AssertionConsumerService Location.Equivalent to the value found in <AssertionConsumerService Location="..."/> in the relying party's <SPSSODescriptor>
This value may contain a number of placeholders. They are
baseUrl
,registrationId
,baseScheme
,baseHost
, andbasePort
.- Overrides:
assertionConsumerServiceLocation
in classRelyingPartyRegistration.Builder
- Parameters:
assertionConsumerServiceLocation
- the AssertionConsumerService location- Returns:
- the
RelyingPartyRegistration.Builder
for further configuration
-
assertionConsumerServiceBinding
public OpenSamlRelyingPartyRegistration.Builder assertionConsumerServiceBinding(Saml2MessageBinding assertionConsumerServiceBinding) Description copied from class:RelyingPartyRegistration.Builder
Set the AssertionConsumerService Binding.Equivalent to the value found in <AssertionConsumerService Binding="..."/> in the relying party's <SPSSODescriptor>
- Overrides:
assertionConsumerServiceBinding
in classRelyingPartyRegistration.Builder
- Parameters:
assertionConsumerServiceBinding
- the AssertionConsumerService binding- Returns:
- the
RelyingPartyRegistration.Builder
for further configuration
-
singleLogoutServiceBinding
public OpenSamlRelyingPartyRegistration.Builder singleLogoutServiceBinding(Saml2MessageBinding singleLogoutServiceBinding) Description copied from class:RelyingPartyRegistration.Builder
Set the SingleLogoutService BindingEquivalent to the value found in <SingleLogoutService Binding="..."/> in the relying party's <SPSSODescriptor>.
- Overrides:
singleLogoutServiceBinding
in classRelyingPartyRegistration.Builder
- Parameters:
singleLogoutServiceBinding
- the SingleLogoutService Binding- Returns:
- the
RelyingPartyRegistration.Builder
for further configuration
-
singleLogoutServiceBindings
public OpenSamlRelyingPartyRegistration.Builder singleLogoutServiceBindings(Consumer<Collection<Saml2MessageBinding>> bindingsConsumer) Description copied from class:RelyingPartyRegistration.Builder
Apply thisConsumer
to theCollection
ofSaml2MessageBinding
s for the purposes of modifying the SingleLogoutService BindingCollection
.Equivalent to the value found in <SingleLogoutService Binding="..."/> in the relying party's <SPSSODescriptor>.
- Overrides:
singleLogoutServiceBindings
in classRelyingPartyRegistration.Builder
- Parameters:
bindingsConsumer
- - theConsumer
for modifying theCollection
- Returns:
- the
RelyingPartyRegistration.Builder
for further configuration
-
singleLogoutServiceLocation
public OpenSamlRelyingPartyRegistration.Builder singleLogoutServiceLocation(String singleLogoutServiceLocation) Description copied from class:RelyingPartyRegistration.Builder
Set the SingleLogoutService LocationEquivalent to the value found in <SingleLogoutService Location="..."/> in the relying party's <SPSSODescriptor>.
- Overrides:
singleLogoutServiceLocation
in classRelyingPartyRegistration.Builder
- Parameters:
singleLogoutServiceLocation
- the SingleLogoutService Location- Returns:
- the
RelyingPartyRegistration.Builder
for further configuration
-
singleLogoutServiceResponseLocation
public OpenSamlRelyingPartyRegistration.Builder singleLogoutServiceResponseLocation(String singleLogoutServiceResponseLocation) Description copied from class:RelyingPartyRegistration.Builder
Set the SingleLogoutService Response LocationEquivalent to the value found in <SingleLogoutService ResponseLocation="..."/> in the relying party's <SPSSODescriptor>.
- Overrides:
singleLogoutServiceResponseLocation
in classRelyingPartyRegistration.Builder
- Parameters:
singleLogoutServiceResponseLocation
- the SingleLogoutService Response Location- Returns:
- the
RelyingPartyRegistration.Builder
for further configuration
-
nameIdFormat
Description copied from class:RelyingPartyRegistration.Builder
Set the NameID format- Overrides:
nameIdFormat
in classRelyingPartyRegistration.Builder
- Returns:
- the
RelyingPartyRegistration.Builder
for further configuration
-
authnRequestsSigned
Description copied from class:RelyingPartyRegistration.Builder
Set the AuthnRequestsSigned setting. Iftrue
, the relying party will sign all AuthnRequests, 301 asserting party preference.Note that Spring Security will sign the request if either
RelyingPartyRegistration.isAuthnRequestsSigned()
istrue
orRelyingPartyRegistration.AssertingPartyDetails.getWantAuthnRequestsSigned()
istrue
.- Overrides:
authnRequestsSigned
in classRelyingPartyRegistration.Builder
- Returns:
- the
RelyingPartyRegistration.Builder
for further configuration
-
assertingPartyDetails
public OpenSamlRelyingPartyRegistration.Builder assertingPartyDetails(Consumer<RelyingPartyRegistration.AssertingPartyDetails.Builder> assertingPartyDetails) Description copied from class:RelyingPartyRegistration.Builder
Apply thisConsumer
to further configure the Asserting Party details- Overrides:
assertingPartyDetails
in classRelyingPartyRegistration.Builder
- Parameters:
assertingPartyDetails
- TheConsumer
to apply- Returns:
- the
RelyingPartyRegistration.Builder
for further configuration
-
build
- Overrides:
build
in classRelyingPartyRegistration.Builder
- Returns:
- an
OpenSamlRelyingPartyRegistration
-