Package org.keycloak.protocol.oauth2.cimd.clientpolicy.condition

Class ClientIdUriSchemeCondition

java.lang.Object

org.keycloak.services.clientpolicy.condition.AbstractClientPolicyConditionProvider<ClientIdUriSchemeCondition.Configuration>

org.keycloak.protocol.oauth2.cimd.clientpolicy.condition.ClientIdUriSchemeCondition

All Implemented Interfaces:

Provider, ClientPolicyConditionProvider<ClientIdUriSchemeCondition.Configuration>

public class ClientIdUriSchemeCondition
extends AbstractClientPolicyConditionProvider<ClientIdUriSchemeCondition.Configuration>

The class is a condition of client policies. On PRE_AUTHORIZATION_REQUEST event, it checks if the value of client_id parameter is URI and the scheme part of the URI is the one defined in its configuration.

Author:

Takashi Norimatsu

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ClientIdUriSchemeCondition.Configuration

Field Summary

Fields inherited from class org.keycloak.services.clientpolicy.condition.AbstractClientPolicyConditionProvider

configuration, session

Constructor Summary

Constructors

Constructor	Description
ClientIdUriSchemeCondition(KeycloakSession session)

Method Summary

Modifier and Type	Method	Description
ClientPolicyVote	applyPolicy(ClientPolicyContext context)	returns ABSTAIN if this condition is not evaluated due to its nature.
Class<ClientIdUriSchemeCondition.Configuration>	getConditionConfigurationClass()
String	getProviderId()

Methods inherited from class org.keycloak.services.clientpolicy.condition.AbstractClientPolicyConditionProvider

isNegativeLogic, setupConfiguration

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.keycloak.services.clientpolicy.condition.ClientPolicyConditionProvider

close, getName

Constructor Details

ClientIdUriSchemeCondition

public ClientIdUriSchemeCondition(KeycloakSession session)

Method Details

getConditionConfigurationClass

public Class<ClientIdUriSchemeCondition.Configuration> getConditionConfigurationClass()

Returns:

Class, which should match the "config" argument of the ClientPolicyConditionProvider.setupConfiguration(ClientPolicyConditionConfigurationRepresentation)

getProviderId

public String getProviderId()

applyPolicy

public ClientPolicyVote applyPolicy(ClientPolicyContext context)
                             throws ClientPolicyException

Description copied from interface: ClientPolicyConditionProvider

returns ABSTAIN if this condition is not evaluated due to its nature. returns YES if the client satisfies this condition on the event defined in ClientPolicyEvent. If not, returns NO.

Parameters:

context - - the context of the event.

Returns:

returns ABSTAIN if this condition is not evaluated due to its nature.

Throws:

ClientPolicyException