com.google.api.server.spi.config.jsonwriter

Class JsonConfigWriter

java.lang.Object

com.google.api.server.spi.config.jsonwriter.JsonConfigWriter

All Implemented Interfaces:

ApiConfigWriter

public class JsonConfigWriter
extends java.lang.Object
implements ApiConfigWriter

Writer of legacy Endpoints API configurations.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	ANY_SCHEMA_NAME
static java.lang.String	MAP_SCHEMA_NAME

Constructor Summary

Constructors

Constructor and Description
JsonConfigWriter()
JsonConfigWriter(java.lang.ClassLoader classLoader, ApiConfigValidator validator)

Method Summary

Modifier and Type	Method and Description
protected void	addBeanProperties(com.fasterxml.jackson.databind.node.ObjectNode schemasNode, com.fasterxml.jackson.databind.node.ObjectNode node, java.lang.reflect.Type beanType, ApiConfig apiConfig, java.util.List<ApiParameterConfig> parameterConfigs) Iterates over the given JavaBean class and adds the following to the given config object (the value of "properties" of a schema object): "<name>": {"type": "<type>"}, where "name" is the name of the JavaBean property and "type" the type of its value.
protected java.lang.String	addTypeToNode(com.fasterxml.jackson.databind.node.ObjectNode schemasNode, java.lang.reflect.Type type, java.lang.reflect.Type enclosingType, com.fasterxml.jackson.databind.node.ObjectNode node, ApiConfig apiConfig, java.util.List<ApiParameterConfig> parameterConfigs) Adds a schema for a type into an output node.
java.lang.String	getFileExtension() The file extension associated with this writer.
protected java.lang.String	getParentApiFile() Returns the name of the file the config should extend.
java.util.Map<ApiKey,java.lang.String>	writeConfig(java.lang.Iterable<? extends ApiConfig> configs) Generate wire-formatted configuration strings for the given configs.

Methods inherited from class java.lang.Object

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

Field Detail

MAP_SCHEMA_NAME

public static final java.lang.String MAP_SCHEMA_NAME

See Also:

Constant Field Values

ANY_SCHEMA_NAME

public static final java.lang.String ANY_SCHEMA_NAME

See Also:

Constant Field Values

Constructor Detail

JsonConfigWriter

public JsonConfigWriter()
                 throws java.lang.ClassNotFoundException

Throws:

java.lang.ClassNotFoundException

JsonConfigWriter

public JsonConfigWriter(java.lang.ClassLoader classLoader,
                        ApiConfigValidator validator)
                 throws java.lang.ClassNotFoundException

Throws:

java.lang.ClassNotFoundException

Method Detail

writeConfig

public java.util.Map<ApiKey,java.lang.String> writeConfig(java.lang.Iterable<? extends ApiConfig> configs)
                                                   throws ApiConfigException

Description copied from interface: ApiConfigWriter

Generate wire-formatted configuration strings for the given configs.

Specified by:

writeConfig in interface ApiConfigWriter

Returns:

A map from ApiKeys to wire-formatted configuration strings.

Throws:

ApiConfigException

getFileExtension

public java.lang.String getFileExtension()

Description copied from interface: ApiConfigWriter

The file extension associated with this writer.

Specified by:

getFileExtension in interface ApiConfigWriter

getParentApiFile

protected java.lang.String getParentApiFile()

Returns the name of the file the config should extend. Subclasses may override to use their own api file.

addBeanProperties

protected void addBeanProperties(com.fasterxml.jackson.databind.node.ObjectNode schemasNode,
                                 com.fasterxml.jackson.databind.node.ObjectNode node,
                                 java.lang.reflect.Type beanType,
                                 ApiConfig apiConfig,
                                 java.util.List<ApiParameterConfig> parameterConfigs)
                          throws ApiConfigException

Iterates over the given JavaBean class and adds the following to the given config object (the value of "properties" of a schema object): "<name>": {"type": "<type>"}, where "name" is the name of the JavaBean property and "type" the type of its value.

Throws:

ApiConfigException

addTypeToNode

protected java.lang.String addTypeToNode(com.fasterxml.jackson.databind.node.ObjectNode schemasNode,
                                         java.lang.reflect.Type type,
                                         java.lang.reflect.Type enclosingType,
                                         com.fasterxml.jackson.databind.node.ObjectNode node,
                                         ApiConfig apiConfig,
                                         java.util.List<ApiParameterConfig> parameterConfigs)
                                  throws ApiConfigException

Adds a schema for a type into an output node. For arrays, this generates nested schemas inline for however many dimensions are necessary.

Returns:

an appropriate name for the schema if one isn't already assigned

Throws:

ApiConfigException