Package 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 Description DefaultIDP()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description voidaddSignatureValidationKey(PublicKey signatureValidationKey)intgetAllowedClockSkew()Returns allowed time difference (in milliseconds) between IdP and SPorg.apache.http.client.HttpClientgetClient()ReturnsHttpClientinstance that will be used for http communication with this IdP.StringgetEntityID()Returns entity identifier of this IdP.StringgetMetadataUrl()intgetMinTimeBetweenDescriptorRequests()Returns minimum time (in seconds) between issuing requests to IdP SAML descriptor.KeyLocatorgetSignatureValidationKeyLocator()ReturnsKeyLocatorlooking up public keys used for validation of IdP signatures.SamlDeployment.IDP.SingleLogoutServicegetSingleLogoutService()Returns Single logout service configuration for this IdP.SamlDeployment.IDP.SingleSignOnServicegetSingleSignOnService()Returns Single sign on service configuration for this IdP.voidrefreshKeyLocatorConfiguration()voidsetAllowedClockSkew(int allowedClockSkew)voidsetClient(org.apache.http.client.HttpClient client)voidsetEntityID(String entityID)voidsetMetadataUrl(String metadataUrl)voidsetMinTimeBetweenDescriptorRequests(int minTimeBetweenDescriptorRequests)voidsetSingleLogoutService(SamlDeployment.IDP.SingleLogoutService singleLogoutService)voidsetSingleSignOnService(SamlDeployment.IDP.SingleSignOnService singleSignOnService)
-
-
-
Method Detail
-
getEntityID
public String getEntityID()
Description copied from interface:SamlDeployment.IDPReturns entity identifier of this IdP.- Specified by:
getEntityIDin interfaceSamlDeployment.IDP- Returns:
- see description.
-
getSingleSignOnService
public SamlDeployment.IDP.SingleSignOnService getSingleSignOnService()
Description copied from interface:SamlDeployment.IDPReturns Single sign on service configuration for this IdP.- Specified by:
getSingleSignOnServicein interfaceSamlDeployment.IDP- Returns:
- see description.
-
getSingleLogoutService
public SamlDeployment.IDP.SingleLogoutService getSingleLogoutService()
Description copied from interface:SamlDeployment.IDPReturns Single logout service configuration for this IdP.- Specified by:
getSingleLogoutServicein interfaceSamlDeployment.IDP- Returns:
- see description.
-
getSignatureValidationKeyLocator
public KeyLocator getSignatureValidationKeyLocator()
Description copied from interface:SamlDeployment.IDPReturnsKeyLocatorlooking up public keys used for validation of IdP signatures.- Specified by:
getSignatureValidationKeyLocatorin interfaceSamlDeployment.IDP- Returns:
- see description.
-
getMinTimeBetweenDescriptorRequests
public int getMinTimeBetweenDescriptorRequests()
Description copied from interface:SamlDeployment.IDPReturns minimum time (in seconds) between issuing requests to IdP SAML descriptor. Used e.g. byKeyLocatorlooking up public keys for validation of IdP signatures to prevent too frequent requests.- Specified by:
getMinTimeBetweenDescriptorRequestsin interfaceSamlDeployment.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.IDPReturnsHttpClientinstance that will be used for http communication with this IdP.- Specified by:
getClientin interfaceSamlDeployment.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.IDPReturns allowed time difference (in milliseconds) between IdP and SP- Specified by:
getAllowedClockSkewin interfaceSamlDeployment.IDP- Returns:
- see description
-
setAllowedClockSkew
public void setAllowedClockSkew(int allowedClockSkew)
-
-