Package 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	Description
CrestObjectSchema()

Method Summary

Modifier and Type	Method	Description
Boolean	getErrorOnWritePolicyFailure()
Map<String,Object>	getExample()	Gets example JSON Schema field.
Integer	getPropertyOrder()
Boolean	getReadonly()	Gets read-only property.
ReadPolicy	getReadPolicy()
Set<String>	getRequiredFields()
Boolean	getReturnOnDemand()
WritePolicy	getWritePolicy()
void	setErrorOnWritePolicyFailure(Boolean errorOnWritePolicyFailure)
void	setExample(String example)	Sets example JSON Schema field.
void	setPropertyOrder(Integer order)
void	setReadPolicy(ReadPolicy readPolicy)
void	setRequiredFields(Set<String> requiredFields)
void	setReturnOnDemand(Boolean returnOnDemand)
void	setWritePolicy(WritePolicy policy)
void	validate(JsonValue object)

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

setWritePolicy

public void setWritePolicy(WritePolicy policy)

getReadPolicy

public ReadPolicy getReadPolicy()

setReadPolicy

public void setReadPolicy(ReadPolicy readPolicy)

getErrorOnWritePolicyFailure

public Boolean getErrorOnWritePolicyFailure()

setErrorOnWritePolicyFailure

public void setErrorOnWritePolicyFailure(Boolean errorOnWritePolicyFailure)

getReturnOnDemand

public Boolean getReturnOnDemand()

setReturnOnDemand

public void setReturnOnDemand(Boolean returnOnDemand)

getPropertyOrder

public Integer getPropertyOrder()

setPropertyOrder

public void setPropertyOrder(Integer order)

validate

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

Throws:

javax.validation.ValidationException

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

setRequiredFields

public void setRequiredFields(Set<String> requiredFields)

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.