org.forgerock.api.jackson

Class CrestObjectSchema

java.lang.Object

com.fasterxml.jackson.module.jsonSchema.JsonSchema

com.fasterxml.jackson.module.jsonSchema.types.SimpleTypeSchema

com.fasterxml.jackson.module.jsonSchema.types.ContainerTypeSchema

com.fasterxml.jackson.module.jsonSchema.types.ObjectSchema

org.forgerock.api.jackson.CrestObjectSchema

All Implemented Interfaces:

WithExampleSchema<Map<String,Object>>

public class CrestObjectSchema
extends com.fasterxml.jackson.module.jsonSchema.types.ObjectSchema
implements WithExampleSchema<Map<String,Object>>

An extension to the Jackson ObjectSchema that includes the custom CREST JSON Schema attributes.

Nested Class Summary

Nested classes/interfaces inherited from class com.fasterxml.jackson.module.jsonSchema.types.ObjectSchema

com.fasterxml.jackson.module.jsonSchema.types.ObjectSchema.AdditionalProperties, com.fasterxml.jackson.module.jsonSchema.types.ObjectSchema.Dependency, com.fasterxml.jackson.module.jsonSchema.types.ObjectSchema.NoAdditionalProperties, com.fasterxml.jackson.module.jsonSchema.types.ObjectSchema.SchemaAdditionalProperties, com.fasterxml.jackson.module.jsonSchema.types.ObjectSchema.SchemaDependency, com.fasterxml.jackson.module.jsonSchema.types.ObjectSchema.SimpleDependency

Field Summary

Fields inherited from class com.fasterxml.jackson.module.jsonSchema.types.ContainerTypeSchema

enums, oneOf

Fields inherited from class com.fasterxml.jackson.module.jsonSchema.types.SimpleTypeSchema

defaultdefault, links, pathStart, title

Constructor Summary

Constructors

Constructor and Description
CrestObjectSchema()

Method Summary

Modifier and Type	Method and Description
Boolean	getErrorOnWritePolicyFailure() Get the error indicator for failed write policy.
Map<String,Object>	getExample() Gets example JSON Schema field.
Integer	getPropertyOrder() Get the property order number.
Boolean	getReadonly() Gets read-only property.
ReadPolicy	getReadPolicy() Get the read policy for the property.
Set<String>	getRequiredFields() Get required field names.
Boolean	getReturnOnDemand() Set the return-on-demand field.
WritePolicy	getWritePolicy() Get the write policy for the property.
void	setErrorOnWritePolicyFailure(Boolean errorOnWritePolicyFailure) Set the error indicator for failed write policy.
void	setExample(String example) Sets example JSON Schema field.
void	setPropertyOrder(Integer order) Set the property order number.
void	setReadPolicy(ReadPolicy readPolicy) Set the read policy for the property.
void	setRequiredFields(Set<String> requiredFields) Set required field names.
void	setReturnOnDemand(Boolean returnOnDemand) Get the return-on-demand field.
void	setWritePolicy(WritePolicy policy) Set the write policy for the property.
void	validate(JsonValue object) Validates JsonSchema according to some set of validation rules.

Methods inherited from class com.fasterxml.jackson.module.jsonSchema.types.ObjectSchema

_equals, addSchemaDependency, addSimpleDependency, asObjectSchema, equals, getAdditionalProperties, getDependencies, getPatternProperties, getProperties, getType, isObjectSchema, putOptionalProperty, putOptionalProperty, putPatternProperty, putProperty, putProperty, rejectAdditionalProperties, setAdditionalProperties, setDependencies, setPatternProperties, setProperties

Methods inherited from class com.fasterxml.jackson.module.jsonSchema.types.ContainerTypeSchema

_equals, asContainerSchema, asContainerTypeSchema, getEnums, getOneOf, isContainerTypeSchema, setEnums, setOneOf

Methods inherited from class com.fasterxml.jackson.module.jsonSchema.types.SimpleTypeSchema

_equals, asSimpleTypeSchema, getDefault, getLinks, getPathStart, getTitle, isSimpleTypeSchema, setDefault, setLinks, setPathStart, setTitle

Methods inherited from class com.fasterxml.jackson.module.jsonSchema.JsonSchema

_equals, arraysEqual, asAnySchema, asArraySchema, asBooleanSchema, asIntegerSchema, asNullSchema, asNumberSchema, asStringSchema, asUnionTypeSchema, asValueSchemaSchema, asValueTypeSchema, enrichWithBeanProperty, equals, get$ref, get$schema, getDescription, getDisallow, getExtends, getId, getRequired, isAnySchema, isArraySchema, isBooleanSchema, isIntegerSchema, isNullSchema, isNumberSchema, isStringSchema, isUnionTypeSchema, isValueTypeSchema, minimalForFormat, set$ref, set$schema, setDescription, setDisallow, setExtends, setId, setReadonly, setRequired

Methods inherited from class java.lang.Object

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

Constructor Detail

CrestObjectSchema

public CrestObjectSchema()

Method Detail

getWritePolicy

public WritePolicy getWritePolicy()

Get the write policy for the property.

Returns:

The write policy.

setWritePolicy

public void setWritePolicy(WritePolicy policy)

Set the write policy for the property.

Parameters:

policy - The write policy.

getReadPolicy

public ReadPolicy getReadPolicy()

Get the read policy for the property.

Returns:

The read policy.

setReadPolicy

public void setReadPolicy(ReadPolicy readPolicy)

Set the read policy for the property.

Parameters:

readPolicy - The read policy.

getErrorOnWritePolicyFailure

public Boolean getErrorOnWritePolicyFailure()

Get the error indicator for failed write policy.

Returns:

Whether errors will be returned.

setErrorOnWritePolicyFailure

public void setErrorOnWritePolicyFailure(Boolean errorOnWritePolicyFailure)

Set the error indicator for failed write policy.

Parameters:

errorOnWritePolicyFailure - Whether errors will be returned.

getReturnOnDemand

public Boolean getReturnOnDemand()

Set the return-on-demand field.

Returns:

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

setReturnOnDemand

public void setReturnOnDemand(Boolean returnOnDemand)

Get the return-on-demand field.

Parameters:

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

getPropertyOrder

public Integer getPropertyOrder()

Get the property order number.

Returns:

The property order.

setPropertyOrder

public void setPropertyOrder(Integer order)

Set the property order number.

Parameters:

order - The property order.

validate

public void validate(JsonValue object)
              throws javax.validation.ValidationException

Validates JsonSchema according to some set of validation rules.

Parameters:

object - JSON to validate

Throws:

javax.validation.ValidationException - Indicates that JSON does not conform to a known JSON Schema format.

getReadonly

public Boolean getReadonly()

Gets read-only property. This method overrides the superclass' definition of "readOnly" being all lower-case, via the JsonProperty annotation.

Overrides:

getReadonly in class com.fasterxml.jackson.module.jsonSchema.JsonSchema

Returns:

true if property is read-only, otherwise false or null

getRequiredFields

public Set<String> getRequiredFields()

Get required field names.

Returns:

Required field-names or null

setRequiredFields

public void setRequiredFields(Set<String> requiredFields)

Set required field names.

Parameters:

requiredFields - Required field-names or null

getExample

public Map<String,Object> getExample()

Description copied from interface: WithExampleSchema

Gets example JSON Schema field.

Specified by:

getExample in interface WithExampleSchema<Map<String,Object>>

Returns:

The example value, or null if not defined.

setExample

public void setExample(String example)
                throws IOException

Description copied from interface: WithExampleSchema

Sets example JSON Schema field.

Specified by:

setExample in interface WithExampleSchema<Map<String,Object>>

Parameters:

example - The example value.

Throws:

IOException - When the type of schema cannot be parsed from the String value.