Package org.apache.juneau.marshall.jsonschema

Class JsonSchemaGeneratorSession

java.lang.Object

org.apache.juneau.marshall.ContextSession

org.apache.juneau.marshall.MarshallingSession

org.apache.juneau.marshall.MarshallingTraverseSession

org.apache.juneau.marshall.jsonschema.JsonSchemaGeneratorSession

All Implemented Interfaces:

BeanSession, ConverterSession

public class JsonSchemaGeneratorSession
extends MarshallingTraverseSession

Session object that lives for the duration of a single use of JsonSchemaSerializer.

Notes:

• This class is not thread safe and is typically discarded after one use.

See Also:

• JSON-Schema Support

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	JsonSchemaGeneratorSession.Builder	Builder class.

Nested classes/interfaces inherited from class org.apache.juneau.marshall.MarshallingSession

MarshallingSession.DefaultBuilder

Field Summary

Fields inherited from class org.apache.juneau.marshall.MarshallingTraverseSession

indent

Fields inherited from class org.apache.juneau.marshall.MarshallingSession

NAME_PROPERTY_NAME

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	JsonSchemaGeneratorSession(JsonSchemaGeneratorSession.Builder builder)	Constructor.

Method Summary

Modifier and Type	Method	Description
JsonSchemaGeneratorSession	addBeanDef(String id, JsonMap def)	Adds a schema definition to this session.
static JsonSchemaGeneratorSession.Builder	create(JsonSchemaGenerator ctx)	Creates a new builder for this object.
protected final Set<TypeCategory>	getAddDescriptionsTo()	Add descriptions to types.
protected final Set<TypeCategory>	getAddExamplesTo()	Add examples.
String	getBeanDefId(ClassMeta<?> cm)	Returns the definition ID for the specified class.
protected final MarshallingDefMapper	getBeanDefMapper()	Bean schema definition mapper.
Map<String,JsonMap>	getBeanDefs()	Returns the definitions that were gathered during this session.
URI	getBeanDefUri(String id)	Returns the definition URI for the specified class.
URI	getBeanDefUri(ClassMeta<?> cm)	Returns the definition URI for the specified class.
protected final List<Pattern>	getIgnoreTypes()	Ignore types from schema definitions.
JsonSchemaBeanPropertyMeta	getJsonSchemaBeanPropertyMeta(BeanPropertyMeta bpm)	Returns the language-specific metadata on the specified bean property.
JsonSchemaClassMeta	getJsonSchemaClassMeta(ClassMeta<?> cm)	Returns the language-specific metadata on the specified class.
JsonMap	getSchema(Object o)	Returns the JSON-schema for the specified object.
JsonMap	getSchema(Type type)	Returns the JSON-schema for the specified type.
JsonMap	getSchema(ClassMeta<?> cm)	Returns the JSON-schema for the specified type.
protected final boolean	isAllowNestedDescriptions()	Allow nested descriptions.
protected final boolean	isAllowNestedExamples()	Allow nested examples.
protected final boolean	isUseBeanDefs()	Use bean definitions.

Methods inherited from class org.apache.juneau.marshall.MarshallingTraverseSession

getInitialDepth, getLastLocation, getMaxDepth, getOptionalType, getOptionalValue, getStack, isDetectRecursions, isIgnoreRecursions, isOptional, isRoot, onError, pop, properties, push, setCurrentClass, setCurrentProperty, willExceedDepth, willRecurse

Methods inherited from class org.apache.juneau.marshall.MarshallingSession

addWarning, convertToMemberType, convertToMemberType, convertToMemberType, convertToType, convertToType, convertToType, convertToType, create, get, getActiveView, getAnnotationProvider, getArgsClassMeta, getBeanClassVisibility, getBeanConstructorVisibility, getBeanDictionary, getBeanFieldVisibility, getBeanMeta, getBeanMethodVisibility, getBeanRegistry, getBeanTypePropertyName, getBeanTypePropertyName, getClassLoader, getClassMeta, getClassMeta, getClassMetaForObject, getClassMetaForObject, getLocale, getMarshallingContext, getMediaType, getNotBeanClasses, getNotBeanPackagesNames, getPropertyNamer, getSwaps, getTimeZone, getTimeZoneId, isBean, isBean, isBeanMapPutReturnsOldValue, isBeansRequireDefaultConstructor, isBeansRequireSerializable, isBeansRequireSettersForGetters, isBeansRequireSomeProperties, isFindFluentSetters, isIgnoreInvocationExceptionsOnGetters, isIgnoreInvocationExceptionsOnSetters, isIgnoreMissingSetters, isIgnoreUnknownBeanProperties, isIgnoreUnknownNullBeanProperties, isPropertyInActiveView, isRecordComponentOrder, isUnsortedProperties, isUseInterfaceProxies, isUseJavaBeanIntrospector, isValidateSchema, newBean, newBean, newBeanMap, newBeanMap, newGenericList, newGenericMap, newGenericMap, object, parseToList, parseToMap, string, toArray, toBeanMap, toBeanMap, toBeanMap

Methods inherited from class org.apache.juneau.marshall.ContextSession

checkForWarnings, getContext, getSessionProperties, getWarnings, isDebug, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.juneau.commons.conversion.ConverterSession

get

Constructor Details

JsonSchemaGeneratorSession

protected JsonSchemaGeneratorSession(JsonSchemaGeneratorSession.Builder builder)

Constructor.

Parameters:

builder - The builder for this object. Cannot be null.

Method Details

create

public static JsonSchemaGeneratorSession.Builder create(JsonSchemaGenerator ctx)

Creates a new builder for this object.

Parameters:

ctx - The context creating this session.
Cannot be null.

Returns:

A new builder.

addBeanDef

public JsonSchemaGeneratorSession addBeanDef(String id,
 JsonMap def)

Adds a schema definition to this session.

Parameters:

id - The definition ID.
Cannot be null.

def - The definition schema.
Cannot be null.

Returns:

This object.

getBeanDefId

public String getBeanDefId(ClassMeta<?> cm)

Returns the definition ID for the specified class.

Parameters:

cm - The class to get the definition ID of. Must not be null.

Returns:

The definition ID for the specified class.

getBeanDefs

public Map<String,JsonMap> getBeanDefs()

Returns the definitions that were gathered during this session.

This map is modifiable and affects the map in the session.

Returns:

The definitions that were gathered during this session, or null if JsonSchemaGenerator.Builder.useBeanDefs() was not enabled.

getBeanDefUri

public URI getBeanDefUri(ClassMeta<?> cm)

Returns the definition URI for the specified class.

Parameters:

cm - The class to get the definition URI of. Must not be null.

Returns:

The definition URI for the specified class.

getBeanDefUri

public URI getBeanDefUri(String id)

Returns the definition URI for the specified class.

Parameters:

id - The definition ID to get the definition URI of.

Returns:

The definition URI for the specified class.

getJsonSchemaBeanPropertyMeta

public JsonSchemaBeanPropertyMeta getJsonSchemaBeanPropertyMeta(BeanPropertyMeta bpm)

Returns the language-specific metadata on the specified bean property.

Parameters:

bpm - The bean property to return the metadata on. Must not be null.

Returns:

The metadata.

getJsonSchemaClassMeta

public JsonSchemaClassMeta getJsonSchemaClassMeta(ClassMeta<?> cm)

Returns the language-specific metadata on the specified class.

Parameters:

cm - The class to return the metadata on. Must not be null.

Returns:

The metadata.

getSchema

public JsonMap getSchema(ClassMeta<?> cm)
                  throws MarshallingRecursionException,
SerializeException

Returns the JSON-schema for the specified type.

Parameters:

cm - The object type.

Returns:

The schema for the type, or null if the type is ignored (see JsonSchemaGenerator.Builder.ignoreTypes(String...)).

Throws:

MarshallingRecursionException - Bean recursion occurred.

SerializeException - Error occurred.

getSchema

public JsonMap getSchema(Object o)
                  throws MarshallingRecursionException,
SerializeException

Returns the JSON-schema for the specified object.

Parameters:

o - The object.
Can either be a POJO or a Class/Type.

Returns:

The schema for the type, or null if the type is ignored (see JsonSchemaGenerator.Builder.ignoreTypes(String...)).

Throws:

MarshallingRecursionException - Bean recursion occurred.

SerializeException - Error occurred.

getSchema

public JsonMap getSchema(Type type)
                  throws MarshallingRecursionException,
SerializeException

Returns the JSON-schema for the specified type.

Parameters:

type - The object type.

Returns:

The schema for the type, or null if the type is ignored (see JsonSchemaGenerator.Builder.ignoreTypes(String...)).

Throws:

MarshallingRecursionException - Bean recursion occurred.

SerializeException - Error occurred.

getAddDescriptionsTo

protected final Set<TypeCategory> getAddDescriptionsTo()

Add descriptions to types.

Returns:

Set of categories of types that descriptions should be automatically added to generated schemas.

See Also:

• JsonSchemaGenerator.Builder.addDescriptionsTo(TypeCategory...)

getAddExamplesTo

protected final Set<TypeCategory> getAddExamplesTo()

Add examples.

Returns:

Set of categories of types that examples should be automatically added to generated schemas.

See Also:

• JsonSchemaGenerator.Builder.addExamplesTo(TypeCategory...)

getBeanDefMapper

protected final MarshallingDefMapper getBeanDefMapper()

Bean schema definition mapper.

Returns:

Interface to use for converting Bean classes to definition IDs and URIs.

See Also:

• JsonSchemaGenerator.Builder.beanDefMapper(Class)

getIgnoreTypes

protected final List<Pattern> getIgnoreTypes()

Ignore types from schema definitions.

Returns:

Custom schema information for particular class types.

See Also:

• JsonSchemaGenerator.Builder.ignoreTypes(String...)

isAllowNestedDescriptions

protected final boolean isAllowNestedDescriptions()

Allow nested descriptions.

Returns:

true if nested descriptions are allowed in schema definitions.

See Also:

• JsonSchemaGenerator.Builder.allowNestedDescriptions()

isAllowNestedExamples

protected final boolean isAllowNestedExamples()

Allow nested examples.

Returns:

true if nested examples are allowed in schema definitions.

See Also:

• JsonSchemaGenerator.Builder.allowNestedExamples()

isUseBeanDefs

protected final boolean isUseBeanDefs()

Use bean definitions.

Returns:

true if schemas on beans will be serialized with '$ref' tags.

See Also:

• JsonSchemaGenerator.Builder.useBeanDefs()