Package org.keycloak.adapters.saml

Class DefaultSamlDeployment

java.lang.Object

org.keycloak.adapters.saml.DefaultSamlDeployment

All Implemented Interfaces:

SamlDeployment

public class DefaultSamlDeployment
extends Object
implements SamlDeployment

Version:

$Revision: 1 $

Author:

Bill Burke

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	DefaultSamlDeployment.DefaultIDP
static class	DefaultSamlDeployment.DefaultSingleLogoutService
static class	DefaultSamlDeployment.DefaultSingleSignOnService

Nested classes/interfaces inherited from interface org.keycloak.adapters.saml.SamlDeployment

SamlDeployment.Binding, SamlDeployment.IDP, SamlDeployment.PrincipalNamePolicy

Constructor Summary

Constructors

Constructor	Description
DefaultSamlDeployment()

Method Summary

Modifier and Type	Method	Description
PrivateKey	getDecryptionKey()
String	getEntityID()	Returns entity identifier of this SP.
SamlDeployment.IDP	getIDP()	Returns Identity Provider configuration for this SAML deployment.
String	getLogoutPage()
String	getNameIDPolicyFormat()
String	getPrincipalAttributeName()
SamlDeployment.PrincipalNamePolicy	getPrincipalNamePolicy()
Set<String>	getRoleAttributeNames()
RoleMappingsProvider	getRoleMappingsProvider()	Obtains the RoleMappingsProvider that was configured for the SP.
SignatureAlgorithm	getSignatureAlgorithm()
String	getSignatureCanonicalizationMethod()
KeyPair	getSigningKeyPair()
SslRequired	getSslRequired()
boolean	isAutodetectBearerOnly()
boolean	isConfigured()
boolean	isForceAuthentication()
boolean	isIsPassive()
boolean	isKeepDOMAssertion()
void	setAutodetectBearerOnly(boolean autodetectBearerOnly)
void	setConfigured(boolean configured)
void	setDecryptionKey(PrivateKey decryptionKey)
void	setEntityID(String entityID)
void	setForceAuthentication(boolean forceAuthentication)
void	setIdp(SamlDeployment.IDP idp)
void	setIsPassive(boolean isPassive)
void	setKeepDOMAssertion(Boolean keepDOMAssertion)
void	setLogoutPage(String logoutPage)
void	setNameIDPolicyFormat(String nameIDPolicyFormat)
void	setPrincipalAttributeName(String principalAttributeName)
void	setPrincipalNamePolicy(SamlDeployment.PrincipalNamePolicy principalNamePolicy)
void	setRoleAttributeNames(Set<String> roleAttributeNames)
void	setRoleMappingsProvider(RoleMappingsProvider provider)
void	setSignatureAlgorithm(SignatureAlgorithm signatureAlgorithm)
void	setSignatureCanonicalizationMethod(String signatureCanonicalizationMethod)
void	setSigningKeyPair(KeyPair signingKeyPair)
void	setSslRequired(SslRequired sslRequired)
void	setTurnOffChangeSessionIdOnLogin(boolean turnOffChangeSessionIdOnLogin)
boolean	turnOffChangeSessionIdOnLogin()

Methods inherited from class java.lang.Object

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

Constructor Details

DefaultSamlDeployment

public DefaultSamlDeployment()

Method Details

turnOffChangeSessionIdOnLogin

public boolean turnOffChangeSessionIdOnLogin()

Specified by:

turnOffChangeSessionIdOnLogin in interface SamlDeployment

setTurnOffChangeSessionIdOnLogin

public void setTurnOffChangeSessionIdOnLogin(boolean turnOffChangeSessionIdOnLogin)

getIDP

public SamlDeployment.IDP getIDP()

Description copied from interface: SamlDeployment

Returns Identity Provider configuration for this SAML deployment.

Specified by:

getIDP in interface SamlDeployment

Returns:

see description.

isConfigured

public boolean isConfigured()

Specified by:

isConfigured in interface SamlDeployment

getSslRequired

public SslRequired getSslRequired()

Specified by:

getSslRequired in interface SamlDeployment

getEntityID

public String getEntityID()

Description copied from interface: SamlDeployment

Returns entity identifier of this SP.

Specified by:

getEntityID in interface SamlDeployment

Returns:

see description.

getNameIDPolicyFormat

public String getNameIDPolicyFormat()

Specified by:

getNameIDPolicyFormat in interface SamlDeployment

isForceAuthentication

public boolean isForceAuthentication()

Specified by:

isForceAuthentication in interface SamlDeployment

isIsPassive

public boolean isIsPassive()

Specified by:

isIsPassive in interface SamlDeployment

getDecryptionKey

public PrivateKey getDecryptionKey()

Specified by:

getDecryptionKey in interface SamlDeployment

getSigningKeyPair

public KeyPair getSigningKeyPair()

Specified by:

getSigningKeyPair in interface SamlDeployment

getRoleAttributeNames

public Set<String> getRoleAttributeNames()

Specified by:

getRoleAttributeNames in interface SamlDeployment

getRoleMappingsProvider

public RoleMappingsProvider getRoleMappingsProvider()

Description copied from interface: SamlDeployment

Obtains the RoleMappingsProvider that was configured for the SP.

Specified by:

getRoleMappingsProvider in interface SamlDeployment

Returns:

a reference to the configured RoleMappingsProvider.

getPrincipalNamePolicy

public SamlDeployment.PrincipalNamePolicy getPrincipalNamePolicy()

Specified by:

getPrincipalNamePolicy in interface SamlDeployment

getPrincipalAttributeName

public String getPrincipalAttributeName()

Specified by:

getPrincipalAttributeName in interface SamlDeployment

setIdp

public void setIdp(SamlDeployment.IDP idp)

setConfigured

public void setConfigured(boolean configured)

setSslRequired

public void setSslRequired(SslRequired sslRequired)

setEntityID

public void setEntityID(String entityID)

setNameIDPolicyFormat

public void setNameIDPolicyFormat(String nameIDPolicyFormat)

setForceAuthentication

public void setForceAuthentication(boolean forceAuthentication)

setIsPassive

public void setIsPassive(boolean isPassive)

setDecryptionKey

public void setDecryptionKey(PrivateKey decryptionKey)

setSigningKeyPair

public void setSigningKeyPair(KeyPair signingKeyPair)

setRoleAttributeNames

public void setRoleAttributeNames(Set<String> roleAttributeNames)

setRoleMappingsProvider

public void setRoleMappingsProvider(RoleMappingsProvider provider)

setPrincipalNamePolicy

public void setPrincipalNamePolicy(SamlDeployment.PrincipalNamePolicy principalNamePolicy)

setPrincipalAttributeName

public void setPrincipalAttributeName(String principalAttributeName)

getLogoutPage

public String getLogoutPage()

Specified by:

getLogoutPage in interface SamlDeployment

setLogoutPage

public void setLogoutPage(String logoutPage)

getSignatureCanonicalizationMethod

public String getSignatureCanonicalizationMethod()

Specified by:

getSignatureCanonicalizationMethod in interface SamlDeployment

setSignatureCanonicalizationMethod

public void setSignatureCanonicalizationMethod(String signatureCanonicalizationMethod)

getSignatureAlgorithm

public SignatureAlgorithm getSignatureAlgorithm()

Specified by:

getSignatureAlgorithm in interface SamlDeployment

setSignatureAlgorithm

public void setSignatureAlgorithm(SignatureAlgorithm signatureAlgorithm)

isAutodetectBearerOnly

public boolean isAutodetectBearerOnly()

Specified by:

isAutodetectBearerOnly in interface SamlDeployment

setAutodetectBearerOnly

public void setAutodetectBearerOnly(boolean autodetectBearerOnly)

isKeepDOMAssertion

public boolean isKeepDOMAssertion()

Specified by:

isKeepDOMAssertion in interface SamlDeployment

setKeepDOMAssertion

public void setKeepDOMAssertion(Boolean keepDOMAssertion)