Class Saml2AuthenticationRequest
- java.lang.Object
-
- org.springframework.security.saml2.provider.service.authentication.Saml2AuthenticationRequest
-
public final class Saml2AuthenticationRequest extends java.lang.Object
Data holder for information required to send anAuthNRequest
from the service provider to the identity provider https://www.oasis-open.org/committees/download.php/35711/sstc-saml-core-errata-2.0-wd-06-diff.pdf (line 2031)- Since:
- 5.2
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
Saml2AuthenticationRequest.Builder
A builder forSaml2AuthenticationRequest
.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static Saml2AuthenticationRequest.Builder
builder()
A builder forSaml2AuthenticationRequest
.java.lang.String
getAssertionConsumerServiceUrl()
Returns the desiredAssertionConsumerServiceUrl
that this SP wishes to receive the assertion on.java.util.List<Saml2X509Credential>
getCredentials()
Returns a list of credentials that can be used to sign theAuthNRequest
objectjava.lang.String
getDestination()
returns the destination, the WEB Single Sign On URI, for this authentication request.java.lang.String
getIssuer()
returns the issuer, the local SP entity ID, for this authentication request.
-
-
-
Method Detail
-
getIssuer
public java.lang.String getIssuer()
returns the issuer, the local SP entity ID, for this authentication request. This property should be used to populate theAuthNRequest.Issuer
XML element. This value typically is a URI, but can be an arbitrary string.- Returns:
- issuer
-
getDestination
public java.lang.String getDestination()
returns the destination, the WEB Single Sign On URI, for this authentication request. This property populates theAuthNRequest#Destination
XML attribute.- Returns:
- destination
-
getAssertionConsumerServiceUrl
public java.lang.String getAssertionConsumerServiceUrl()
Returns the desiredAssertionConsumerServiceUrl
that this SP wishes to receive the assertion on. The IDP may or may not honor this request. This property populates theAuthNRequest#AssertionConsumerServiceURL
XML attribute.- Returns:
- the AssertionConsumerServiceURL value
-
getCredentials
public java.util.List<Saml2X509Credential> getCredentials()
Returns a list of credentials that can be used to sign theAuthNRequest
object- Returns:
- signing credentials
-
builder
public static Saml2AuthenticationRequest.Builder builder()
A builder forSaml2AuthenticationRequest
. returns a builder object
-
-