Package com.nimbusds.openid.connect.sdk.federation.policy.operations

Class EssentialOperation

java.lang.Object

com.nimbusds.openid.connect.sdk.federation.policy.operations.EssentialOperation

All Implemented Interfaces:

BooleanConfiguration, PolicyConfiguration, PolicyOperation, UntypedOperation

public class EssentialOperation
extends Object
implements PolicyOperation, BooleanConfiguration, UntypedOperation

Default (default) value operation.

Example policy:

 "tos_uri" : { "essential" : true }
 

Related specifications:

• OpenID Connect Federation 1.0, section 5.1.2.

Field Summary

Fields

Modifier and Type	Field	Description
static OperationName	NAME

Constructor Summary

Constructors

Constructor	Description
EssentialOperation()

Method Summary

Modifier and Type	Method	Description
Object	apply(Object value)	Applies an untyped operation.
void	configure(boolean enable)	Configures.
boolean	getBooleanConfiguration()	Gets the boolean configuration.
OperationName	getOperationName()	Returns the name identifying the policy operation.
PolicyOperation	merge(PolicyOperation other)	Merges a policy operation.
void	parseConfiguration(Object jsonEntity)	Parses a federation policy operation configuration from the specified JSON entity.
Map.Entry<String,Object>	toJSONObjectEntry()	Returns a JSON object entry representation of the policy operation.

Methods inherited from class java.lang.Object

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

Field Detail

NAME

public static final OperationName NAME

Constructor Detail

EssentialOperation

public EssentialOperation()

Method Detail

getOperationName

public OperationName getOperationName()

Description copied from interface: PolicyOperation

Returns the name identifying the policy operation.

Specified by:

getOperationName in interface PolicyOperation

Returns:

The operation name.

configure

public void configure(boolean enable)

Description copied from interface: BooleanConfiguration

Configures.

Specified by:

configure in interface BooleanConfiguration

Parameters:

enable - The parameter.

parseConfiguration

public void parseConfiguration(Object jsonEntity)
                        throws ParseException

Description copied from interface: PolicyOperation

Parses a federation policy operation configuration from the specified JSON entity.

Specified by:

parseConfiguration in interface PolicyOperation

Parameters:

jsonEntity - The JSON entity, must represent a boolean, number, string, array or object. null if not specified.

Throws:

ParseException - On a parse exception.

toJSONObjectEntry

public Map.Entry<String,Object> toJSONObjectEntry()

Description copied from interface: PolicyOperation

Returns a JSON object entry representation of the policy operation.

Specified by:

toJSONObjectEntry in interface PolicyOperation

Returns:

The JSON object entry, with a boolean, number, string, array or object value.

getBooleanConfiguration

public boolean getBooleanConfiguration()

Description copied from interface: BooleanConfiguration

Gets the boolean configuration.

Specified by:

getBooleanConfiguration in interface BooleanConfiguration

Returns:

The boolean configuration parameter.

merge

public PolicyOperation merge(PolicyOperation other)
                      throws PolicyViolationException

Description copied from interface: PolicyOperation

Merges a policy operation.

Specified by:

merge in interface PolicyOperation

Parameters:

other - The policy to merge. Must be of the same type and not null.

Returns:

The resulting new policy operation.

Throws:

PolicyViolationException - On a merge exception.

apply

public Object apply(Object value)
             throws PolicyViolationException

Description copied from interface: UntypedOperation

Applies an untyped operation.

Specified by:

apply in interface UntypedOperation

Parameters:

value - The value, null if not specified.

Returns:

The resulting value, must represent a valid JSON entity such as boolean, number, string, array or object.

Throws:

PolicyViolationException - On a policy violation.