Package org.keycloak.services.clientpolicy.condition

Class ClientProtocolCondition

java.lang.Object

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

org.keycloak.services.clientpolicy.condition.ClientProtocolCondition

All Implemented Interfaces:

Provider, ClientPolicyConditionProvider<ClientProtocolCondition.Configuration>

public class ClientProtocolCondition
extends AbstractClientPolicyConditionProvider<ClientProtocolCondition.Configuration>

Author:

rmartinc

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ClientProtocolCondition.Configuration

Field Summary

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

configuration, session

Constructor Summary

Constructors

Constructor	Description
ClientProtocolCondition(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<ClientProtocolCondition.Configuration>	getConditionConfigurationClass()
String	getProviderId()
boolean	isCorrectProtocolFromContext()
boolean	isCorrectProtocolFromRepresentation(ClientCRUDContext context)

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

ClientProtocolCondition

public ClientProtocolCondition(KeycloakSession session)

Method Details

getProviderId

public String getProviderId()

getConditionConfigurationClass

public Class<ClientProtocolCondition.Configuration> getConditionConfigurationClass()

Returns:

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

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

isCorrectProtocolFromContext

public boolean isCorrectProtocolFromContext()

isCorrectProtocolFromRepresentation

public boolean isCorrectProtocolFromRepresentation(ClientCRUDContext context)