org.keycloak.adapters.saml

Class DefaultSamlDeployment.DefaultSingleSignOnService

java.lang.Object

org.keycloak.adapters.saml.DefaultSamlDeployment.DefaultSingleSignOnService

All Implemented Interfaces:

SamlDeployment.IDP.SingleSignOnService

Enclosing class:

DefaultSamlDeployment

public static class DefaultSamlDeployment.DefaultSingleSignOnService
extends Object
implements SamlDeployment.IDP.SingleSignOnService

Constructor Summary

Constructors

Constructor and Description
DefaultSingleSignOnService()

Method Summary

Modifier and Type	Method and Description
URI	getAssertionConsumerServiceUrl() Returns URI where the IdP should send the responses to.
SamlDeployment.Binding	getRequestBinding()
String	getRequestBindingUrl() Returns URL for the IDP login service that the client will send requests to.
SamlDeployment.Binding	getResponseBinding() SAML allows the client to request what binding type it wants authn responses to use.
void	setAssertionConsumerServiceUrl(URI assertionConsumerServiceUrl)
void	setRequestBinding(SamlDeployment.Binding requestBinding)
void	setRequestBindingUrl(String requestBindingUrl)
void	setResponseBinding(SamlDeployment.Binding responseBinding)
void	setSignRequest(boolean signRequest)
void	setValidateAssertionSignature(boolean validateAssertionSignature)
void	setValidateResponseSignature(boolean validateResponseSignature)
boolean	signRequest() Returns true if the requests to IdP need to be signed by SP key.
boolean	validateAssertionSignature() Returns true if individual assertions in response from IdP should be checked for valid signature.
boolean	validateResponseSignature() Returns true if the complete response message from IdP should be checked for valid signature.

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultSingleSignOnService

public DefaultSingleSignOnService()

Method Detail

signRequest

public boolean signRequest()

Description copied from interface: SamlDeployment.IDP.SingleSignOnService

Returns true if the requests to IdP need to be signed by SP key.

Specified by:

signRequest in interface SamlDeployment.IDP.SingleSignOnService

Returns:

see dscription

validateResponseSignature

public boolean validateResponseSignature()

Description copied from interface: SamlDeployment.IDP.SingleSignOnService

Returns true if the complete response message from IdP should be checked for valid signature.

Specified by:

validateResponseSignature in interface SamlDeployment.IDP.SingleSignOnService

Returns:

see dscription

validateAssertionSignature

public boolean validateAssertionSignature()

Description copied from interface: SamlDeployment.IDP.SingleSignOnService

Returns true if individual assertions in response from IdP should be checked for valid signature.

Specified by:

validateAssertionSignature in interface SamlDeployment.IDP.SingleSignOnService

Returns:

see dscription

getRequestBinding

public SamlDeployment.Binding getRequestBinding()

Specified by:

getRequestBinding in interface SamlDeployment.IDP.SingleSignOnService

getResponseBinding

public SamlDeployment.Binding getResponseBinding()

Description copied from interface: SamlDeployment.IDP.SingleSignOnService

SAML allows the client to request what binding type it wants authn responses to use. The default is that the client will not request a specific binding type for responses.

Specified by:

getResponseBinding in interface SamlDeployment.IDP.SingleSignOnService

Returns:

getRequestBindingUrl

public String getRequestBindingUrl()

Description copied from interface: SamlDeployment.IDP.SingleSignOnService

Returns URL for the IDP login service that the client will send requests to.

Specified by:

getRequestBindingUrl in interface SamlDeployment.IDP.SingleSignOnService

Returns:

getAssertionConsumerServiceUrl

public URI getAssertionConsumerServiceUrl()

Description copied from interface: SamlDeployment.IDP.SingleSignOnService

Returns URI where the IdP should send the responses to. The default is that the client will not request a specific assertion consumer service URL. This property is typically accompanied by the ProtocolBinding attribute.

Specified by:

getAssertionConsumerServiceUrl in interface SamlDeployment.IDP.SingleSignOnService

Returns:

setAssertionConsumerServiceUrl

public void setAssertionConsumerServiceUrl(URI assertionConsumerServiceUrl)

setSignRequest

public void setSignRequest(boolean signRequest)

setValidateResponseSignature

public void setValidateResponseSignature(boolean validateResponseSignature)

setValidateAssertionSignature

public void setValidateAssertionSignature(boolean validateAssertionSignature)

setRequestBinding

public void setRequestBinding(SamlDeployment.Binding requestBinding)

setResponseBinding

public void setResponseBinding(SamlDeployment.Binding responseBinding)

setRequestBindingUrl

public void setRequestBindingUrl(String requestBindingUrl)