Package com.networknt.handler

Interface LightHttpHandler

All Superinterfaces:

io.undertow.server.HttpHandler

All Known Subinterfaces:

MiddlewareHandler

All Known Implementing Classes:

OrchestrationHandler

public interface LightHttpHandler
extends io.undertow.server.HttpHandler

This is an extension of HttpHandler that provides a default method to handle error status. All API handler should extend from this interface.

Author:

Steve Hu

Field Summary

Fields

Modifier and Type	Field	Description
static String	AUDIT_CONFIG_NAME
static String	AUDIT_ON_ERROR
static String	AUDIT_STACK_TRACE
static Map<String,Object>	auditConfig
static boolean	auditOnError
static boolean	auditStackTrace
static HandlerConfig	config
static String	CONFIG_NAME
static String	ERROR_NOT_DEFINED
static org.slf4j.Logger	logger

Method Summary

Modifier and Type	Method	Description
default void	setExchangeStatus(io.undertow.server.HttpServerExchange exchange, Status status)	There are situations that the downstream service returns an error status response and we just want to bubble up to the caller and eventually to the original caller.
default void	setExchangeStatus(io.undertow.server.HttpServerExchange exchange, String code, Object... args)	This method is used to construct a standard error status in JSON format from an error code.
default void	setExchangeStatus(io.undertow.server.HttpServerExchange exchange, String code, Map<String,Object> metadata, Object... args)	This method is used to construct a standard error status with metadata in JSON format from an error code.

Methods inherited from interface io.undertow.server.HttpHandler

handleRequest

Field Detail

logger

static final org.slf4j.Logger logger

ERROR_NOT_DEFINED

static final String ERROR_NOT_DEFINED

See Also:

Constant Field Values

CONFIG_NAME

static final String CONFIG_NAME

See Also:

Constant Field Values

AUDIT_CONFIG_NAME

static final String AUDIT_CONFIG_NAME

See Also:

Constant Field Values

AUDIT_ON_ERROR

static final String AUDIT_ON_ERROR

See Also:

Constant Field Values

AUDIT_STACK_TRACE

static final String AUDIT_STACK_TRACE

See Also:

Constant Field Values

config

static final HandlerConfig config

auditConfig

static final Map<String,Object> auditConfig

auditOnError

static final boolean auditOnError

auditStackTrace

static final boolean auditStackTrace

Method Detail

setExchangeStatus

default void setExchangeStatus(io.undertow.server.HttpServerExchange exchange,
                               String code,
                               Object... args)

This method is used to construct a standard error status in JSON format from an error code.

Parameters:

exchange - HttpServerExchange

code - error code

args - arguments for error description

setExchangeStatus

default void setExchangeStatus(io.undertow.server.HttpServerExchange exchange,
                               String code,
                               Map<String,Object> metadata,
                               Object... args)

This method is used to construct a standard error status with metadata in JSON format from an error code.

Parameters:

exchange - HttpServerExchange

code - error code

metadata - additional metadata info

args - arguments for error description

setExchangeStatus

default void setExchangeStatus(io.undertow.server.HttpServerExchange exchange,
                               Status status)

There are situations that the downstream service returns an error status response and we just want to bubble up to the caller and eventually to the original caller.

Parameters:

exchange - HttpServerExchange

status - error status