org.keycloak.adapters.saml

Class DefaultSamlDeployment.DefaultIDP

java.lang.Object

org.keycloak.adapters.saml.DefaultSamlDeployment.DefaultIDP

All Implemented Interfaces:

SamlDeployment.IDP

Enclosing class:

DefaultSamlDeployment

public static class DefaultSamlDeployment.DefaultIDP
extends Object
implements SamlDeployment.IDP

Nested Class Summary

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

SamlDeployment.IDP.SingleLogoutService, SamlDeployment.IDP.SingleSignOnService

Constructor Summary

Constructors

Constructor and Description
DefaultIDP()

Method Summary

Modifier and Type	Method and Description
void	addSignatureValidationKey(PublicKey signatureValidationKey)
int	getAllowedClockSkew() Returns allowed time difference (in milliseconds) between IdP and SP
org.apache.http.client.HttpClient	getClient() Returns HttpClient instance that will be used for http communication with this IdP.
String	getEntityID() Returns entity identifier of this IdP.
String	getMetadataUrl()
int	getMinTimeBetweenDescriptorRequests() Returns minimum time (in seconds) between issuing requests to IdP SAML descriptor.
KeyLocator	getSignatureValidationKeyLocator() Returns KeyLocator looking up public keys used for validation of IdP signatures.
SamlDeployment.IDP.SingleLogoutService	getSingleLogoutService() Returns Single logout service configuration for this IdP.
SamlDeployment.IDP.SingleSignOnService	getSingleSignOnService() Returns Single sign on service configuration for this IdP.
void	refreshKeyLocatorConfiguration()
void	setAllowedClockSkew(int allowedClockSkew)
void	setClient(org.apache.http.client.HttpClient client)
void	setEntityID(String entityID)
void	setMetadataUrl(String metadataUrl)
void	setMinTimeBetweenDescriptorRequests(int minTimeBetweenDescriptorRequests)
void	setSingleLogoutService(SamlDeployment.IDP.SingleLogoutService singleLogoutService)
void	setSingleSignOnService(SamlDeployment.IDP.SingleSignOnService singleSignOnService)

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultIDP

public DefaultIDP()

Method Detail

getEntityID

public String getEntityID()

Description copied from interface: SamlDeployment.IDP

Returns entity identifier of this IdP.

Specified by:

getEntityID in interface SamlDeployment.IDP

Returns:

see description.

getSingleSignOnService

public SamlDeployment.IDP.SingleSignOnService getSingleSignOnService()

Description copied from interface: SamlDeployment.IDP

Returns Single sign on service configuration for this IdP.

Specified by:

getSingleSignOnService in interface SamlDeployment.IDP

Returns:

see description.

getSingleLogoutService

public SamlDeployment.IDP.SingleLogoutService getSingleLogoutService()

Description copied from interface: SamlDeployment.IDP

Returns Single logout service configuration for this IdP.

Specified by:

getSingleLogoutService in interface SamlDeployment.IDP

Returns:

see description.

getSignatureValidationKeyLocator

public KeyLocator getSignatureValidationKeyLocator()

Description copied from interface: SamlDeployment.IDP

Returns KeyLocator looking up public keys used for validation of IdP signatures.

Specified by:

getSignatureValidationKeyLocator in interface SamlDeployment.IDP

Returns:

see description.

getMinTimeBetweenDescriptorRequests

public int getMinTimeBetweenDescriptorRequests()

Description copied from interface: SamlDeployment.IDP

Returns minimum time (in seconds) between issuing requests to IdP SAML descriptor. Used e.g. by KeyLocator looking up public keys for validation of IdP signatures to prevent too frequent requests.

Specified by:

getMinTimeBetweenDescriptorRequests in interface SamlDeployment.IDP

Returns:

see description.

setMinTimeBetweenDescriptorRequests

public void setMinTimeBetweenDescriptorRequests(int minTimeBetweenDescriptorRequests)

setEntityID

public void setEntityID(String entityID)

addSignatureValidationKey

public void addSignatureValidationKey(PublicKey signatureValidationKey)

setSingleSignOnService

public void setSingleSignOnService(SamlDeployment.IDP.SingleSignOnService singleSignOnService)

setSingleLogoutService

public void setSingleLogoutService(SamlDeployment.IDP.SingleLogoutService singleLogoutService)

refreshKeyLocatorConfiguration

public void refreshKeyLocatorConfiguration()

getClient

public org.apache.http.client.HttpClient getClient()

Description copied from interface: SamlDeployment.IDP

Returns HttpClient instance that will be used for http communication with this IdP.

Specified by:

getClient in interface SamlDeployment.IDP

Returns:

see description

setClient

public void setClient(org.apache.http.client.HttpClient client)

getMetadataUrl

public String getMetadataUrl()

setMetadataUrl

public void setMetadataUrl(String metadataUrl)

getAllowedClockSkew

public int getAllowedClockSkew()

Description copied from interface: SamlDeployment.IDP

Returns allowed time difference (in milliseconds) between IdP and SP

Specified by:

getAllowedClockSkew in interface SamlDeployment.IDP

Returns:

see description

setAllowedClockSkew

public void setAllowedClockSkew(int allowedClockSkew)