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

Class ValueOperation

java.lang.Object

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

All Implemented Interfaces:

BooleanConfiguration, NumberConfiguration, PolicyConfiguration, PolicyOperation, StringConfiguration, StringListConfiguration, UntypedOperation

public class ValueOperation
extends Object
implements PolicyOperation, BooleanConfiguration, NumberConfiguration, StringConfiguration, StringListConfiguration, UntypedOperation

Values set (value) operation.

Example policy:

 "require_auth_time" : { "value": true }
 

Input:

 "require_auth_time" : false
 

Result:

 "require_auth_time" : true
 

Related specifications:

• OpenID Connect Federation 1.0, section 4.1.5.

Field Summary

Fields

Modifier and Type	Field	Description
static OperationName	NAME

Constructor Summary

Constructors

Constructor	Description
ValueOperation()

Method Summary

Modifier and Type	Method	Description
Object	apply(Object value)	Applies an untyped operation.
void	configure(boolean parameter)	Configures.
void	configure(Number parameter)	Configures.
void	configure(String parameter)	Configure.
void	configure(List<String> parameter)	Configures.
boolean	getBooleanConfiguration()	Gets the boolean configuration.
Number	getNumberConfiguration()	Gets the number configuration.
OperationName	getOperationName()	Returns the name identifying the policy operation.
String	getStringConfiguration()	Gets the string configuration.
List<String>	getStringListConfiguration()	Gets the string list configuration.
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

ValueOperation

public ValueOperation()

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 parameter)

Description copied from interface: BooleanConfiguration

Configures.

Specified by:

configure in interface BooleanConfiguration

Parameters:

parameter - The parameter.

configure

public void configure(Number parameter)

Description copied from interface: NumberConfiguration

Configures.

Specified by:

configure in interface NumberConfiguration

Parameters:

parameter - The parameter.

configure

public void configure(String parameter)

Description copied from interface: StringConfiguration

Configure.

Specified by:

configure in interface StringConfiguration

Parameters:

parameter - The string configuration parameter. Must not be null.

configure

public void configure(List<String> parameter)

Description copied from interface: StringListConfiguration

Configures.

Specified by:

configure in interface StringListConfiguration

Parameters:

parameter - The string list configuration parameter. Must not be null.

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.

getNumberConfiguration

public Number getNumberConfiguration()

Description copied from interface: NumberConfiguration

Gets the number configuration.

Specified by:

getNumberConfiguration in interface NumberConfiguration

Returns:

The number configuration parameter.

getStringConfiguration

public String getStringConfiguration()

Description copied from interface: StringConfiguration

Gets the string configuration.

Specified by:

getStringConfiguration in interface StringConfiguration

Returns:

The string configuration parameter.

getStringListConfiguration

public List<String> getStringListConfiguration()

Description copied from interface: StringListConfiguration

Gets the string list configuration.

Specified by:

getStringListConfiguration in interface StringListConfiguration

Returns:

The string list 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)

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.