org.apache.juneau.jsonschema

Class JsonSchemaGeneratorSession

java.lang.Object

org.apache.juneau.Session

org.apache.juneau.BeanSession

org.apache.juneau.BeanTraverseSession

org.apache.juneau.jsonschema.JsonSchemaGeneratorSession

public class JsonSchemaGeneratorSession
extends BeanTraverseSession

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

This class is NOT thread safe. It is typically discarded after one-time use although it can be reused within the same thread.

Field Summary

Fields inherited from class org.apache.juneau.BeanTraverseSession

indent

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	JsonSchemaGeneratorSession(JsonSchemaGenerator ctx, BeanSessionArgs args) Create a new session using properties specified in the context.

Method Summary

Modifier and Type	Method and Description
JsonSchemaGeneratorSession	addBeanDef(String id, ObjectMap def) Adds a schema definition to this session.
protected Set<TypeCategory>	getAddDescriptionsTo() Configuration property: Add descriptions to types.
protected Set<TypeCategory>	getAddExamplesTo() Configuration property: Add examples.
String	getBeanDefId(ClassMeta<?> cm) Returns the definition ID for the specified class.
protected BeanDefMapper	getBeanDefMapper() Configuration property: Bean schema definition mapper.
Map<String,ObjectMap>	getBeanDefs() Returns the definitions that were gathered during this session.
URI	getBeanDefUri(ClassMeta<?> cm) Returns the definition URI for the specified class.
URI	getBeanDefUri(String id) Returns the definition URI for the specified class.
protected Map<String,ObjectMap>	getDefaultSchemas() Configuration property: Default schemas.
protected Set<Pattern>	getIgnoreTypes() Configuration property: Ignore types from schema definitions.
ObjectMap	getSchema(ClassMeta<?> cm) Returns the JSON-schema for the specified type.
ObjectMap	getSchema(Object o) Returns the JSON-schema for the specified object.
ObjectMap	getSchema(Type type) Returns the JSON-schema for the specified type.
protected boolean	isAllowNestedDescriptions() Configuration property: Allow nested descriptions.
protected boolean	isAllowNestedExamples() Configuration property: Allow nested examples.
protected boolean	isUseBeanDefs() Configuration property: Use bean definitions.
ObjectMap	toMap() Returns the properties defined on this bean context as a simple map for debugging purposes.

Methods inherited from class org.apache.juneau.BeanTraverseSession

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

Methods inherited from class org.apache.juneau.BeanSession

_class, checkForWarnings, convertToMemberType, convertToMemberType, convertToType, convertToType, convertToType, getArgsClassMeta, getBeanClassVisibility, getBeanConstructorVisibility, getBeanDictionaryClasses, getBeanFieldVisibility, getBeanFilters, getBeanMeta, getBeanMethodVisibility, getBeanRegistry, getBeanTypePropertyName, getBeanTypePropertyName, getBpi, getBpro, getBpwo, getBpx, getClassMeta, getClassMeta, getClassMetaForObject, getClassMetaForObject, getExamples, getImplClasses, getLocale, getMediaType, getNotBeanClasses, getNotBeanPackagesNames, getNotBeanPackagesPrefixes, getPojoSwaps, getPropertyNamer, getSchema, getStringBuilder, getTimeZone, getTimeZoneId, isBean, isBean, isBeanMapPutReturnsOldValue, isBeansRequireDefaultConstructor, isBeansRequireSerializable, isBeansRequireSettersForGetters, isBeansRequireSomeProperties, isDebug, isFluentSetters, isIgnoreInvocationExceptionsOnGetters, isIgnoreInvocationExceptionsOnSetters, isIgnorePropertiesWithoutSetters, isIgnoreUnknownBeanProperties, isIgnoreUnknownNullBeanProperties, isSortProperties, isUseEnumNames, isUseInterfaceProxies, isUseJavaBeanIntrospector, newBean, newBean, newBeanMap, newBeanMap, object, returnStringBuilder, string, toArray, toBeanMap, toBeanMap

Methods inherited from class org.apache.juneau.Session

addToCache, addToCache, addWarning, getClassProperty, getFromCache, getInstanceArrayProperty, getInstanceProperty, getLogger, getProperties, getProperty, getProperty, getProperty, getPropertyKeys, getWarnings, hasProperty, hasWarnings, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

JsonSchemaGeneratorSession

protected JsonSchemaGeneratorSession(JsonSchemaGenerator ctx,
                                     BeanSessionArgs args)

Create a new session using properties specified in the context.

Parameters:

ctx - The context creating this session object. The context contains all the configuration settings for this object.

args - Runtime arguments. These specify session-level information such as locale and URI context. It also include session-level properties that override the properties defined on the bean and serializer contexts.

Method Detail

getSchema

public ObjectMap getSchema(Object o)
                    throws BeanRecursionException,
                           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.

Throws:

BeanRecursionException - Bean recursion occurred.

SerializeException - Error occurred.

getSchema

public ObjectMap getSchema(Type type)
                    throws BeanRecursionException,
                           SerializeException

Returns the JSON-schema for the specified type.

Parameters:

type - The object type.

Returns:

The schema for the type.

Throws:

BeanRecursionException - Bean recursion occurred.

SerializeException - Error occurred.

getSchema

public ObjectMap getSchema(ClassMeta<?> cm)
                    throws BeanRecursionException,
                           SerializeException

Returns the JSON-schema for the specified type.

Parameters:

cm - The object type.

Returns:

The schema for the type.

Throws:

BeanRecursionException - Bean recursion occurred.

SerializeException - Error occurred.

getBeanDefId

public String getBeanDefId(ClassMeta<?> cm)

Returns the definition ID for the specified class.

Parameters:

cm - The class to get the definition ID of.

Returns:

The definition ID for the specified class.

getBeanDefUri

public URI getBeanDefUri(ClassMeta<?> cm)

Returns the definition URI for the specified class.

Parameters:

cm - The class to get the definition URI of.

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.

getBeanDefs

public Map<String,ObjectMap> 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.JSONSCHEMA_useBeanDefs was not enabled.

addBeanDef

public JsonSchemaGeneratorSession addBeanDef(String id,
                                             ObjectMap def)

Adds a schema definition to this session.

Parameters:

id - The definition ID.

def - The definition schema.

Returns:

This object (for method chaining).

getAddDescriptionsTo

protected final Set<TypeCategory> getAddDescriptionsTo()

Configuration property: Add descriptions to types.

Returns:

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

See Also:

JsonSchemaGenerator.JSONSCHEMA_addDescriptionsTo

getAddExamplesTo

protected final Set<TypeCategory> getAddExamplesTo()

Configuration property: Add examples.

Returns:

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

See Also:

JsonSchemaGenerator.JSONSCHEMA_addExamplesTo

isAllowNestedDescriptions

protected final boolean isAllowNestedDescriptions()

Configuration property: Allow nested descriptions.

Returns:

true if nested descriptions are allowed in schema definitions.

See Also:

JsonSchemaGenerator.JSONSCHEMA_allowNestedDescriptions

isAllowNestedExamples

protected final boolean isAllowNestedExamples()

Configuration property: Allow nested examples.

Returns:

true if nested examples are allowed in schema definitions.

See Also:

JsonSchemaGenerator.JSONSCHEMA_allowNestedExamples

getBeanDefMapper

protected final BeanDefMapper getBeanDefMapper()

Configuration property: Bean schema definition mapper.

Returns:

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

See Also:

JsonSchemaGenerator.JSONSCHEMA_beanDefMapper

getDefaultSchemas

protected final Map<String,ObjectMap> getDefaultSchemas()

Configuration property: Default schemas.

Returns:

Custom schema information for particular class types.

See Also:

JsonSchemaGenerator.JSONSCHEMA_defaultSchemas

getIgnoreTypes

protected final Set<Pattern> getIgnoreTypes()

Configuration property: Ignore types from schema definitions.

Returns:

Custom schema information for particular class types.

See Also:

JsonSchemaGenerator.JSONSCHEMA_ignoreTypes

isUseBeanDefs

protected final boolean isUseBeanDefs()

Configuration property: Use bean definitions.

Returns:

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

See Also:

JsonSchemaGenerator.JSONSCHEMA_useBeanDefs

toMap

public ObjectMap toMap()

Description copied from class: Session

Returns the properties defined on this bean context as a simple map for debugging purposes.

Overrides:

toMap in class BeanTraverseSession

Returns:

A new map containing the properties defined on this context.