io.swagger.jaxrs.config

Class SwaggerContextService

java.lang.Object

io.swagger.jaxrs.config.SwaggerContextService

public class SwaggerContextService
extends Object

Field Summary

Fields

Modifier and Type	Field and Description
static String	CONFIG_ID_DEFAULT
static String	CONFIG_ID_KEY
static String	CONFIG_ID_PREFIX
static String	CONTEXT_ID_KEY
static String	SCANNER_ID_DEFAULT
static String	SCANNER_ID_KEY
static String	SCANNER_ID_PREFIX
static String	USE_PATH_BASED_CONFIG

Constructor Summary

Constructors

Constructor and Description
SwaggerContextService()

Method Summary

Methods

Modifier and Type	Method and Description
String	getBasePath()
SwaggerConfig	getConfig()
static String	getConfigIdFromInitParam(javax.servlet.ServletConfig sc)
Scanner	getScanner()
static String	getScannerIdFromInitParam(javax.servlet.ServletConfig sc)
Swagger	getSwagger()
SwaggerContextService	initConfig()
SwaggerContextService	initConfig(Swagger swagger)
SwaggerContextService	initScanner()
static boolean	isConfigIdInitParamDefined(javax.servlet.ServletConfig sc)
static boolean	isScannerIdInitParamDefined(javax.servlet.ServletConfig sc)
static boolean	isServletConfigAvailable(javax.servlet.ServletConfig sc)
boolean	isUsePathBasedConfig()
static boolean	isUsePathBasedConfigInitParamDefined(javax.servlet.ServletConfig sc)
void	setBasePath(String basePath)
void	setConfigId(String configId)
void	setContextId(String contextId)
void	setSc(javax.servlet.ServletConfig sc)
void	setScanner(Scanner scanner)
void	setScannerId(String scannerId)
void	setSwaggerConfig(SwaggerConfig swaggerConfig)
void	setUsePathBasedConfig(boolean usePathBasedConfig)
SwaggerContextService	updateSwagger(Swagger swagger)
SwaggerContextService	withBasePath(String basePath)
SwaggerContextService	withConfigId(String configId)
SwaggerContextService	withContextId(String contextId)
SwaggerContextService	withPathBasedConfig(boolean usePathBasedConfig)
SwaggerContextService	withScanner(Scanner scanner)
SwaggerContextService	withScannerId(String scannerId)
SwaggerContextService	withServletConfig(javax.servlet.ServletConfig sc)
SwaggerContextService	withSwaggerConfig(SwaggerConfig swaggerConfig)

Methods inherited from class java.lang.Object

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

Field Detail

CONFIG_ID_KEY

public static final String CONFIG_ID_KEY

See Also:

Constant Field Values

CONFIG_ID_PREFIX

public static final String CONFIG_ID_PREFIX

See Also:

Constant Field Values

CONFIG_ID_DEFAULT

public static final String CONFIG_ID_DEFAULT

See Also:

Constant Field Values

SCANNER_ID_KEY

public static final String SCANNER_ID_KEY

See Also:

Constant Field Values

SCANNER_ID_PREFIX

public static final String SCANNER_ID_PREFIX

See Also:

Constant Field Values

SCANNER_ID_DEFAULT

public static final String SCANNER_ID_DEFAULT

See Also:

Constant Field Values

CONTEXT_ID_KEY

public static final String CONTEXT_ID_KEY

See Also:

Constant Field Values

USE_PATH_BASED_CONFIG

public static final String USE_PATH_BASED_CONFIG

See Also:

Constant Field Values

Constructor Detail

SwaggerContextService

public SwaggerContextService()

Method Detail

isUsePathBasedConfig

public boolean isUsePathBasedConfig()

setUsePathBasedConfig

public void setUsePathBasedConfig(boolean usePathBasedConfig)

setBasePath

public void setBasePath(String basePath)

getBasePath

public String getBasePath()

setScannerId

public void setScannerId(String scannerId)

setScanner

public void setScanner(Scanner scanner)

setConfigId

public void setConfigId(String configId)

setSwaggerConfig

public void setSwaggerConfig(SwaggerConfig swaggerConfig)

setContextId

public void setContextId(String contextId)

setSc

public void setSc(javax.servlet.ServletConfig sc)

withServletConfig

public SwaggerContextService withServletConfig(javax.servlet.ServletConfig sc)

isServletConfigAvailable

public static boolean isServletConfigAvailable(javax.servlet.ServletConfig sc)

withBasePath

public SwaggerContextService withBasePath(String basePath)

withPathBasedConfig

public SwaggerContextService withPathBasedConfig(boolean usePathBasedConfig)

withConfigId

public SwaggerContextService withConfigId(String configId)

withSwaggerConfig

public SwaggerContextService withSwaggerConfig(SwaggerConfig swaggerConfig)

withScannerId

public SwaggerContextService withScannerId(String scannerId)

withContextId

public SwaggerContextService withContextId(String contextId)

withScanner

public SwaggerContextService withScanner(Scanner scanner)

initConfig

public SwaggerContextService initConfig()

initConfig

public SwaggerContextService initConfig(Swagger swagger)

getConfig

public SwaggerConfig getConfig()

getSwagger

public Swagger getSwagger()

updateSwagger

public SwaggerContextService updateSwagger(Swagger swagger)

initScanner

public SwaggerContextService initScanner()

getScanner

public Scanner getScanner()

isUsePathBasedConfigInitParamDefined

public static boolean isUsePathBasedConfigInitParamDefined(javax.servlet.ServletConfig sc)

isScannerIdInitParamDefined

public static boolean isScannerIdInitParamDefined(javax.servlet.ServletConfig sc)

getScannerIdFromInitParam

public static String getScannerIdFromInitParam(javax.servlet.ServletConfig sc)

isConfigIdInitParamDefined

public static boolean isConfigIdInitParamDefined(javax.servlet.ServletConfig sc)

getConfigIdFromInitParam

public static String getConfigIdFromInitParam(javax.servlet.ServletConfig sc)