Package org.opendaylight.netconf.sal.rest.doc.impl

Class BaseYangSwaggerGenerator

java.lang.Object

org.opendaylight.netconf.sal.rest.doc.impl.BaseYangSwaggerGenerator

Direct Known Subclasses:

BaseYangSwaggerGeneratorDraft02, BaseYangSwaggerGeneratorRFC8040

public abstract class BaseYangSwaggerGenerator
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected static interface	BaseYangSwaggerGenerator.ListPathBuilder

Field Summary

Fields

Modifier and Type	Field	Description
static String	BASE_PATH
static String	MODULE_NAME_SUFFIX

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	BaseYangSwaggerGenerator(Optional<org.opendaylight.mdsal.dom.api.DOMSchemaService> schemaService)

Method Summary

Modifier and Type	Method	Description
protected abstract void	appendPathKeyValue(StringBuilder builder, Object value)
String	createHostFromUriInfo(javax.ws.rs.core.UriInfo uriInfo)
ResourceList	createResourceList()
String	createSchemaFromUriInfo(javax.ws.rs.core.UriInfo uriInfo)
SwaggerObject	createSwaggerObject(String schema, String host, String basePath, String title)
void	fillDoc(SwaggerObject doc, Optional<com.google.common.collect.Range<Integer>> range, org.opendaylight.yangtools.yang.model.api.EffectiveModelContext schemaContext, String context, Optional<String> deviceName, ApiDocServiceImpl.URIType uriType, ApiDocServiceImpl.OAversion oaversion, DefinitionNames definitionNames)
String	generatePath(javax.ws.rs.core.UriInfo uriInfo, String name, String revision)
String	generateUrlPrefixFromInstanceID(org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier key, String moduleName)
SwaggerObject	getAllModulesDoc(javax.ws.rs.core.UriInfo uriInfo, Optional<com.google.common.collect.Range<Integer>> range, org.opendaylight.yangtools.yang.model.api.EffectiveModelContext schemaContext, Optional<String> deviceName, String context, DefinitionNames definitionNames, ApiDocServiceImpl.URIType uriType, ApiDocServiceImpl.OAversion oaversion)
SwaggerObject	getAllModulesDoc(javax.ws.rs.core.UriInfo uriInfo, DefinitionNames definitionNames, ApiDocServiceImpl.URIType uriType, ApiDocServiceImpl.OAversion oaversion)
CommonApiObject	getApiDeclaration(String module, String revision, javax.ws.rs.core.UriInfo uriInfo, ApiDocServiceImpl.URIType uriType, ApiDocServiceImpl.OAversion oaversion)
SwaggerObject	getApiDeclaration(String moduleName, String revision, javax.ws.rs.core.UriInfo uriInfo, org.opendaylight.yangtools.yang.model.api.EffectiveModelContext schemaContext, String context, ApiDocServiceImpl.URIType uriType, ApiDocServiceImpl.OAversion oaversion)
SwaggerObject	getApiDeclaration(org.opendaylight.yangtools.yang.model.api.Module module, javax.ws.rs.core.UriInfo uriInfo, String context, org.opendaylight.yangtools.yang.model.api.EffectiveModelContext schemaContext, ApiDocServiceImpl.URIType uriType, ApiDocServiceImpl.OAversion oaversion)
static CommonApiObject	getAppropriateDoc(SwaggerObject swaggerObject, ApiDocServiceImpl.OAversion oaversion)
protected abstract String	getPathVersion()
ResourceList	getResourceListing(javax.ws.rs.core.UriInfo uriInfo, org.opendaylight.yangtools.yang.model.api.EffectiveModelContext schemaContext, String context, int pageNum, boolean all, ApiDocServiceImpl.URIType uriType, ApiDocServiceImpl.OAversion oaversion)	Return list of modules converted to swagger compliant resource list.
ResourceList	getResourceListing(javax.ws.rs.core.UriInfo uriInfo, org.opendaylight.yangtools.yang.model.api.EffectiveModelContext schemaContext, String context, ApiDocServiceImpl.URIType uriType, ApiDocServiceImpl.OAversion oaversion)
abstract String	getResourcePath(String resourceType, String context)
abstract String	getResourcePathPart(String resourceType)
org.opendaylight.mdsal.dom.api.DOMSchemaService	getSchemaService()
SortedSet<org.opendaylight.yangtools.yang.model.api.Module>	getSortedModules(org.opendaylight.yangtools.yang.model.api.EffectiveModelContext schemaContext)
SwaggerObject	getSwaggerDocSpec(org.opendaylight.yangtools.yang.model.api.Module module, String schema, String host, String basePath, String context, org.opendaylight.yangtools.yang.model.api.EffectiveModelContext schemaContext, ApiDocServiceImpl.URIType uriType, ApiDocServiceImpl.OAversion oaversion)
SwaggerObject	getSwaggerDocSpec(org.opendaylight.yangtools.yang.model.api.Module module, String context, Optional<String> deviceName, org.opendaylight.yangtools.yang.model.api.EffectiveModelContext schemaContext, ApiDocServiceImpl.URIType uriType, ApiDocServiceImpl.OAversion oaversion, DefinitionNames definitionNames, SwaggerObject doc, boolean isForSingleModule)
protected abstract BaseYangSwaggerGenerator.ListPathBuilder	newListPathBuilder()

Methods inherited from class java.lang.Object

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

Field Detail

BASE_PATH

public static final String BASE_PATH

See Also:

Constant Field Values

MODULE_NAME_SUFFIX

public static final String MODULE_NAME_SUFFIX

See Also:

Constant Field Values

Constructor Detail

BaseYangSwaggerGenerator

protected BaseYangSwaggerGenerator(Optional<org.opendaylight.mdsal.dom.api.DOMSchemaService> schemaService)

Method Detail

getSchemaService

public org.opendaylight.mdsal.dom.api.DOMSchemaService getSchemaService()

getResourceListing

public ResourceList getResourceListing(javax.ws.rs.core.UriInfo uriInfo,
                                       org.opendaylight.yangtools.yang.model.api.EffectiveModelContext schemaContext,
                                       String context,
                                       ApiDocServiceImpl.URIType uriType,
                                       ApiDocServiceImpl.OAversion oaversion)

getResourceListing

public ResourceList getResourceListing(javax.ws.rs.core.UriInfo uriInfo,
                                       org.opendaylight.yangtools.yang.model.api.EffectiveModelContext schemaContext,
                                       String context,
                                       int pageNum,
                                       boolean all,
                                       ApiDocServiceImpl.URIType uriType,
                                       ApiDocServiceImpl.OAversion oaversion)

Return list of modules converted to swagger compliant resource list.

getAllModulesDoc

public SwaggerObject getAllModulesDoc(javax.ws.rs.core.UriInfo uriInfo,
                                      DefinitionNames definitionNames,
                                      ApiDocServiceImpl.URIType uriType,
                                      ApiDocServiceImpl.OAversion oaversion)

getAllModulesDoc

public SwaggerObject getAllModulesDoc(javax.ws.rs.core.UriInfo uriInfo,
                                      Optional<com.google.common.collect.Range<Integer>> range,
                                      org.opendaylight.yangtools.yang.model.api.EffectiveModelContext schemaContext,
                                      Optional<String> deviceName,
                                      String context,
                                      DefinitionNames definitionNames,
                                      ApiDocServiceImpl.URIType uriType,
                                      ApiDocServiceImpl.OAversion oaversion)

fillDoc

public void fillDoc(SwaggerObject doc,
                    Optional<com.google.common.collect.Range<Integer>> range,
                    org.opendaylight.yangtools.yang.model.api.EffectiveModelContext schemaContext,
                    String context,
                    Optional<String> deviceName,
                    ApiDocServiceImpl.URIType uriType,
                    ApiDocServiceImpl.OAversion oaversion,
                    DefinitionNames definitionNames)

createResourceList

public ResourceList createResourceList()

generatePath

public String generatePath(javax.ws.rs.core.UriInfo uriInfo,
                           String name,
                           String revision)

getApiDeclaration

public CommonApiObject getApiDeclaration(String module,
                                         String revision,
                                         javax.ws.rs.core.UriInfo uriInfo,
                                         ApiDocServiceImpl.URIType uriType,
                                         ApiDocServiceImpl.OAversion oaversion)

getApiDeclaration

public SwaggerObject getApiDeclaration(String moduleName,
                                       String revision,
                                       javax.ws.rs.core.UriInfo uriInfo,
                                       org.opendaylight.yangtools.yang.model.api.EffectiveModelContext schemaContext,
                                       String context,
                                       ApiDocServiceImpl.URIType uriType,
                                       ApiDocServiceImpl.OAversion oaversion)

getApiDeclaration

public SwaggerObject getApiDeclaration(org.opendaylight.yangtools.yang.model.api.Module module,
                                       javax.ws.rs.core.UriInfo uriInfo,
                                       String context,
                                       org.opendaylight.yangtools.yang.model.api.EffectiveModelContext schemaContext,
                                       ApiDocServiceImpl.URIType uriType,
                                       ApiDocServiceImpl.OAversion oaversion)

createHostFromUriInfo

public String createHostFromUriInfo(javax.ws.rs.core.UriInfo uriInfo)

createSchemaFromUriInfo

public String createSchemaFromUriInfo(javax.ws.rs.core.UriInfo uriInfo)

getSwaggerDocSpec

public SwaggerObject getSwaggerDocSpec(org.opendaylight.yangtools.yang.model.api.Module module,
                                       String schema,
                                       String host,
                                       String basePath,
                                       String context,
                                       org.opendaylight.yangtools.yang.model.api.EffectiveModelContext schemaContext,
                                       ApiDocServiceImpl.URIType uriType,
                                       ApiDocServiceImpl.OAversion oaversion)

getSwaggerDocSpec

public SwaggerObject getSwaggerDocSpec(org.opendaylight.yangtools.yang.model.api.Module module,
                                       String context,
                                       Optional<String> deviceName,
                                       org.opendaylight.yangtools.yang.model.api.EffectiveModelContext schemaContext,
                                       ApiDocServiceImpl.URIType uriType,
                                       ApiDocServiceImpl.OAversion oaversion,
                                       DefinitionNames definitionNames,
                                       SwaggerObject doc,
                                       boolean isForSingleModule)

createSwaggerObject

public SwaggerObject createSwaggerObject(String schema,
                                         String host,
                                         String basePath,
                                         String title)

getAppropriateDoc

public static CommonApiObject getAppropriateDoc(SwaggerObject swaggerObject,
                                                ApiDocServiceImpl.OAversion oaversion)

getPathVersion

protected abstract String getPathVersion()

getResourcePath

public abstract String getResourcePath(String resourceType,
                                       String context)

getResourcePathPart

public abstract String getResourcePathPart(String resourceType)

newListPathBuilder

protected abstract BaseYangSwaggerGenerator.ListPathBuilder newListPathBuilder()

getSortedModules

public SortedSet<org.opendaylight.yangtools.yang.model.api.Module> getSortedModules(org.opendaylight.yangtools.yang.model.api.EffectiveModelContext schemaContext)

appendPathKeyValue

protected abstract void appendPathKeyValue(StringBuilder builder,
                                           Object value)

generateUrlPrefixFromInstanceID

public String generateUrlPrefixFromInstanceID(org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier key,
                                              String moduleName)