Package org.keycloak.saml
Class SAML2LogoutRequestBuilder
- java.lang.Object
-
- org.keycloak.saml.SAML2LogoutRequestBuilder
-
- All Implemented Interfaces:
SamlProtocolExtensionsAwareBuilder<SAML2LogoutRequestBuilder>
public class SAML2LogoutRequestBuilder extends Object implements SamlProtocolExtensionsAwareBuilder<SAML2LogoutRequestBuilder>
- Version:
- $Revision: 1 $
- Author:
- Bill Burke
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from interface org.keycloak.saml.SamlProtocolExtensionsAwareBuilder
SamlProtocolExtensionsAwareBuilder.NodeGenerator
-
-
Field Summary
Fields Modifier and Type Field Description protected long
assertionExpiration
protected String
destination
protected List<SamlProtocolExtensionsAwareBuilder.NodeGenerator>
extensions
protected NameIDType
issuer
protected NameIDType
nameId
protected String
sessionIndex
-
Constructor Summary
Constructors Constructor Description SAML2LogoutRequestBuilder()
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description SAML2LogoutRequestBuilder
addExtension(SamlProtocolExtensionsAwareBuilder.NodeGenerator extension)
Adds a given node subtree as a SAML protocol extension into the SAML protocol message.SAML2LogoutRequestBuilder
assertionExpiration(int assertionExpiration)
Length of time in seconds the assertion is valid for See SAML core specification 2.5.1.2 NotOnOrAfterDocument
buildDocument()
LogoutRequestType
createLogoutRequest()
SAML2LogoutRequestBuilder
destination(String destination)
SAML2LogoutRequestBuilder
issuer(String issuer)
SAML2LogoutRequestBuilder
issuer(NameIDType issuer)
SAML2LogoutRequestBuilder
nameId(NameIDType nameId)
SAML2LogoutRequestBuilder
sessionIndex(String index)
SAML2LogoutRequestBuilder
userPrincipal(String userPrincipal, String userPrincipalFormat)
Deprecated.
-
-
-
Field Detail
-
nameId
protected NameIDType nameId
-
sessionIndex
protected String sessionIndex
-
assertionExpiration
protected long assertionExpiration
-
destination
protected String destination
-
issuer
protected NameIDType issuer
-
extensions
protected final List<SamlProtocolExtensionsAwareBuilder.NodeGenerator> extensions
-
-
Method Detail
-
destination
public SAML2LogoutRequestBuilder destination(String destination)
-
issuer
public SAML2LogoutRequestBuilder issuer(NameIDType issuer)
-
issuer
public SAML2LogoutRequestBuilder issuer(String issuer)
-
addExtension
public SAML2LogoutRequestBuilder addExtension(SamlProtocolExtensionsAwareBuilder.NodeGenerator extension)
Description copied from interface:SamlProtocolExtensionsAwareBuilder
Adds a given node subtree as a SAML protocol extension into the SAML protocol message.- Specified by:
addExtension
in interfaceSamlProtocolExtensionsAwareBuilder<SAML2LogoutRequestBuilder>
- Returns:
-
assertionExpiration
public SAML2LogoutRequestBuilder assertionExpiration(int assertionExpiration)
Length of time in seconds the assertion is valid for See SAML core specification 2.5.1.2 NotOnOrAfter- Parameters:
assertionExpiration
- Number of seconds the assertion should be valid- Returns:
-
userPrincipal
@Deprecated public SAML2LogoutRequestBuilder userPrincipal(String userPrincipal, String userPrincipalFormat)
Deprecated.- Parameters:
userPrincipal
-userPrincipalFormat
-- Returns:
-
nameId
public SAML2LogoutRequestBuilder nameId(NameIDType nameId)
-
sessionIndex
public SAML2LogoutRequestBuilder sessionIndex(String index)
-
buildDocument
public Document buildDocument() throws ProcessingException, ConfigurationException, ParsingException
-
createLogoutRequest
public LogoutRequestType createLogoutRequest() throws ConfigurationException
- Throws:
ConfigurationException
-
-