Class RelyingPartyRegistration.Builder
- Direct Known Subclasses:
OpenSamlRelyingPartyRegistration.Builder
- Enclosing class:
- RelyingPartyRegistration
-
Constructor Summary
ConstructorsModifierConstructorDescriptionprotected
Builder
(String registrationId, RelyingPartyRegistration.AssertingPartyDetails.Builder assertingPartyDetailsBuilder) -
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.build()
Constructs a RelyingPartyRegistration object based on the builder configurationsdecryptionX509Credentials
(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)
-
Constructor Details
-
Builder
protected Builder(String registrationId, RelyingPartyRegistration.AssertingPartyDetails.Builder assertingPartyDetailsBuilder)
-
-
Method Details
-
registrationId
Sets theregistrationId
template. Often be used in URL paths- Parameters:
id
- registrationId for this object, should be unique- Returns:
- this object
-
entityId
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
.- Parameters:
entityId
- the relying party's EntityID- Returns:
- the
RelyingPartyRegistration.Builder
for further configuration - Since:
- 5.4
-
signingX509Credentials
public RelyingPartyRegistration.Builder signingX509Credentials(Consumer<Collection<Saml2X509Credential>> credentialsConsumer) Apply thisConsumer
to theCollection
ofSaml2X509Credential
s for the purposes of modifying theCollection
- Parameters:
credentialsConsumer
- - theConsumer
for modifying theCollection
- Returns:
- the
RelyingPartyRegistration.Builder
for further configuration - Since:
- 5.4
-
decryptionX509Credentials
public RelyingPartyRegistration.Builder decryptionX509Credentials(Consumer<Collection<Saml2X509Credential>> credentialsConsumer) Apply thisConsumer
to theCollection
ofSaml2X509Credential
s for the purposes of modifying theCollection
- Parameters:
credentialsConsumer
- - theConsumer
for modifying theCollection
- Returns:
- the
RelyingPartyRegistration.Builder
for further configuration - Since:
- 5.4
-
assertionConsumerServiceLocation
public RelyingPartyRegistration.Builder assertionConsumerServiceLocation(String assertionConsumerServiceLocation) 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
.- Parameters:
assertionConsumerServiceLocation
- the AssertionConsumerService location- Returns:
- the
RelyingPartyRegistration.Builder
for further configuration - Since:
- 5.4
-
assertionConsumerServiceBinding
public RelyingPartyRegistration.Builder assertionConsumerServiceBinding(Saml2MessageBinding assertionConsumerServiceBinding) Set the AssertionConsumerService Binding.Equivalent to the value found in <AssertionConsumerService Binding="..."/> in the relying party's <SPSSODescriptor>
- Parameters:
assertionConsumerServiceBinding
- the AssertionConsumerService binding- Returns:
- the
RelyingPartyRegistration.Builder
for further configuration - Since:
- 5.4
-
singleLogoutServiceBinding
public RelyingPartyRegistration.Builder singleLogoutServiceBinding(Saml2MessageBinding singleLogoutServiceBinding) Set the SingleLogoutService BindingEquivalent to the value found in <SingleLogoutService Binding="..."/> in the relying party's <SPSSODescriptor>.
- Parameters:
singleLogoutServiceBinding
- the SingleLogoutService Binding- Returns:
- the
RelyingPartyRegistration.Builder
for further configuration - Since:
- 5.6
-
singleLogoutServiceBindings
public RelyingPartyRegistration.Builder singleLogoutServiceBindings(Consumer<Collection<Saml2MessageBinding>> bindingsConsumer) 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>.
- Parameters:
bindingsConsumer
- - theConsumer
for modifying theCollection
- Returns:
- the
RelyingPartyRegistration.Builder
for further configuration - Since:
- 5.8
-
singleLogoutServiceLocation
public RelyingPartyRegistration.Builder singleLogoutServiceLocation(String singleLogoutServiceLocation) Set the SingleLogoutService LocationEquivalent to the value found in <SingleLogoutService Location="..."/> in the relying party's <SPSSODescriptor>.
- Parameters:
singleLogoutServiceLocation
- the SingleLogoutService Location- Returns:
- the
RelyingPartyRegistration.Builder
for further configuration - Since:
- 5.6
-
singleLogoutServiceResponseLocation
public RelyingPartyRegistration.Builder singleLogoutServiceResponseLocation(String singleLogoutServiceResponseLocation) Set the SingleLogoutService Response LocationEquivalent to the value found in <SingleLogoutService ResponseLocation="..."/> in the relying party's <SPSSODescriptor>.
- Parameters:
singleLogoutServiceResponseLocation
- the SingleLogoutService Response Location- Returns:
- the
RelyingPartyRegistration.Builder
for further configuration - Since:
- 5.6
-
nameIdFormat
Set the NameID format- Parameters:
nameIdFormat
-- Returns:
- the
RelyingPartyRegistration.Builder
for further configuration - Since:
- 5.7
-
assertingPartyDetails
public RelyingPartyRegistration.Builder assertingPartyDetails(Consumer<RelyingPartyRegistration.AssertingPartyDetails.Builder> assertingPartyDetails) Apply thisConsumer
to further configure the Asserting Party details- Parameters:
assertingPartyDetails
- TheConsumer
to apply- Returns:
- the
RelyingPartyRegistration.Builder
for further configuration - Since:
- 5.4
-
build
Constructs a RelyingPartyRegistration object based on the builder configurations- Returns:
- a RelyingPartyRegistration instance
-