com.networknt.openapi

Class OpenApiHandler

java.lang.Object

com.networknt.openapi.OpenApiHandler

All Implemented Interfaces:

com.networknt.handler.LightHttpHandler, com.networknt.handler.MiddlewareHandler, io.undertow.server.HttpHandler

public class OpenApiHandler
extends Object
implements com.networknt.handler.MiddlewareHandler

This is the handler that parses the OpenApi object based on uri and method of the request and attached the operation to the request so that security and validator can use it without parsing it.

Author:

Steve Hu

Field Summary

Fields

Modifier and Type	Field and Description
static String	CONFIG_NAME
static io.undertow.util.AttachmentKey<Map<String,Object>>	DESERIALIZED_COOKIE_PARAMETERS
static io.undertow.util.AttachmentKey<Map<String,Object>>	DESERIALIZED_HEADER_PARAMETERS
static io.undertow.util.AttachmentKey<Map<String,Object>>	DESERIALIZED_PATH_PARAMETERS
static io.undertow.util.AttachmentKey<Map<String,Object>>	DESERIALIZED_QUERY_PARAMETERS

Fields inherited from interface com.networknt.handler.LightHttpHandler

AUDIT_ON_ERROR, AUDIT_STACK_TRACE, auditOnError, auditStackTrace, config, ERROR_NOT_DEFINED

Constructor Summary

Constructors

Constructor and Description
OpenApiHandler()

Method Summary

Modifier and Type	Method and Description
static Map<String,?>	getCookieParameters(io.undertow.server.HttpServerExchange exchange)
static Map<String,?>	getCookieParameters(io.undertow.server.HttpServerExchange exchange, boolean deserializedValueOnly)
static Map<String,?>	getHeaderParameters(io.undertow.server.HttpServerExchange exchange)
static Map<String,?>	getHeaderParameters(io.undertow.server.HttpServerExchange exchange, boolean deserializedValueOnly)
io.undertow.server.HttpHandler	getNext()
static Map<String,?>	getPathParameters(io.undertow.server.HttpServerExchange exchange)
static Map<String,?>	getPathParameters(io.undertow.server.HttpServerExchange exchange, boolean deserializedValueOnly)
static Map<String,?>	getQueryParameters(io.undertow.server.HttpServerExchange exchange)
static Map<String,?>	getQueryParameters(io.undertow.server.HttpServerExchange exchange, boolean deserializedValueOnly)
void	handleRequest(io.undertow.server.HttpServerExchange exchange)
boolean	isEnabled()
protected static Map<String,?>	mergeMaps(Map preferredMap, Map alternativeMap) merge two maps.
protected static Map<String,Object>	nonNullMap(Map<String,Object> map)
void	register()
com.networknt.handler.MiddlewareHandler	setNext(io.undertow.server.HttpHandler next)

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.networknt.handler.LightHttpHandler

setExchangeStatus, setExchangeStatus

Field Detail

CONFIG_NAME

public static final String CONFIG_NAME

See Also:

Constant Field Values

DESERIALIZED_QUERY_PARAMETERS

public static final io.undertow.util.AttachmentKey<Map<String,Object>> DESERIALIZED_QUERY_PARAMETERS

DESERIALIZED_PATH_PARAMETERS

public static final io.undertow.util.AttachmentKey<Map<String,Object>> DESERIALIZED_PATH_PARAMETERS

DESERIALIZED_HEADER_PARAMETERS

public static final io.undertow.util.AttachmentKey<Map<String,Object>> DESERIALIZED_HEADER_PARAMETERS

DESERIALIZED_COOKIE_PARAMETERS

public static final io.undertow.util.AttachmentKey<Map<String,Object>> DESERIALIZED_COOKIE_PARAMETERS

Constructor Detail

OpenApiHandler

public OpenApiHandler()

Method Detail

handleRequest

public void handleRequest(io.undertow.server.HttpServerExchange exchange)
                   throws Exception

Specified by:

handleRequest in interface io.undertow.server.HttpHandler

Throws:

Exception

getNext

public io.undertow.server.HttpHandler getNext()

Specified by:

getNext in interface com.networknt.handler.MiddlewareHandler

setNext

public com.networknt.handler.MiddlewareHandler setNext(io.undertow.server.HttpHandler next)

Specified by:

setNext in interface com.networknt.handler.MiddlewareHandler

isEnabled

public boolean isEnabled()

Specified by:

isEnabled in interface com.networknt.handler.MiddlewareHandler

register

public void register()

Specified by:

register in interface com.networknt.handler.MiddlewareHandler

mergeMaps

protected static Map<String,?> mergeMaps(Map preferredMap,
                                         Map alternativeMap)

merge two maps. The values in preferredMap take priority.

Parameters:

preferredMap -

alternativeMap -

Returns:

nonNullMap

protected static Map<String,Object> nonNullMap(Map<String,Object> map)

getQueryParameters

public static Map<String,?> getQueryParameters(io.undertow.server.HttpServerExchange exchange)

getQueryParameters

public static Map<String,?> getQueryParameters(io.undertow.server.HttpServerExchange exchange,
                                               boolean deserializedValueOnly)

getPathParameters

public static Map<String,?> getPathParameters(io.undertow.server.HttpServerExchange exchange)

getPathParameters

public static Map<String,?> getPathParameters(io.undertow.server.HttpServerExchange exchange,
                                              boolean deserializedValueOnly)

getHeaderParameters

public static Map<String,?> getHeaderParameters(io.undertow.server.HttpServerExchange exchange)

getHeaderParameters

public static Map<String,?> getHeaderParameters(io.undertow.server.HttpServerExchange exchange,
                                                boolean deserializedValueOnly)

getCookieParameters

public static Map<String,?> getCookieParameters(io.undertow.server.HttpServerExchange exchange)

getCookieParameters

public static Map<String,?> getCookieParameters(io.undertow.server.HttpServerExchange exchange,
                                                boolean deserializedValueOnly)