org.forgerock.api.annotations

Annotation Type PropertyPolicies

@Retention(value=RUNTIME)
 @Target(value={FIELD,METHOD})
public @interface PropertyPolicies

An annotation to declare the policies for property access in the CREST API Descriptor schema elements.

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
boolean	errorOnWritePolicyFailure Whether breaking the declared policy will result in an error from the service.
ReadPolicy	read The read policy for the property.
boolean	returnOnDemand true when a field is available, but must be explicitly requested, or false (default) when always returned.
WritePolicy	write The write policy for the property.

Element Detail

write

public abstract WritePolicy write

The write policy for the property. Defaults to WRITABLE.

Default:

org.forgerock.api.enums.WritePolicy.WRITABLE

read

public abstract ReadPolicy read

The read policy for the property. Defaults to USER.

Default:

org.forgerock.api.enums.ReadPolicy.USER

errorOnWritePolicyFailure

public abstract boolean errorOnWritePolicyFailure

Whether breaking the declared policy will result in an error from the service. Only required when PropertyPolicies.write() is not set to WRITABLE. Defaults to false.

Default:

false

returnOnDemand

public abstract boolean returnOnDemand

true when a field is available, but must be explicitly requested, or false (default) when always returned.

Default:

false