Package com.networknt.aws.lambda.handler.middleware.security

Class ApiKeyMiddleware

java.lang.Object

com.networknt.aws.lambda.handler.middleware.security.ApiKeyMiddleware

All Implemented Interfaces:

LambdaHandler, MiddlewareHandler

public class ApiKeyMiddleware
extends Object
implements MiddlewareHandler

Field Summary

Fields inherited from interface com.networknt.aws.lambda.handler.LambdaHandler

DISABLED_LAMBDA_HANDLER_RETURN, SUCCESS_LAMBDA_HANDLER_RETURN

Constructor Summary

Constructors

Constructor	Description
ApiKeyMiddleware()
ApiKeyMiddleware(com.networknt.apikey.ApiKeyConfig cfg)	Deprecated.

Method Summary

Modifier and Type	Method	Description
com.networknt.status.Status	execute(LightLambdaExchange exchange)
void	getCachedConfigurations()
com.networknt.status.Status	handleApiKey(LightLambdaExchange exchange, String requestPath)
boolean	isAsynchronous()	Indicate if this middleware handler is asynchronous or not.
boolean	isAudited()	Indicate if this middleware handler is audited or not.
boolean	isContinueOnFailure()	Indicate if this middleware handler will continue on failure or not.
boolean	isEnabled()	Indicate if this handler is enabled or not.
void	register()	Register this handler to the handler registration.
void	reload()	Reload config values in case the config values changed by config server.

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.networknt.aws.lambda.handler.LambdaHandler

disabledMiddlewareStatus, isResponseMiddleware, successMiddlewareStatus

Constructor Details

ApiKeyMiddleware

public ApiKeyMiddleware()

ApiKeyMiddleware

@Deprecated
public ApiKeyMiddleware(com.networknt.apikey.ApiKeyConfig cfg)

Deprecated.

This is a constructor for test cases only. Please don't use it.

Parameters:

cfg - ApiKeyConfig

Method Details

execute

public com.networknt.status.Status execute(LightLambdaExchange exchange)

Specified by:

execute in interface LambdaHandler

handleApiKey

public com.networknt.status.Status handleApiKey(LightLambdaExchange exchange,
 String requestPath)

isEnabled

public boolean isEnabled()

Description copied from interface: LambdaHandler

Indicate if this handler is enabled or not.

Specified by:

isEnabled in interface LambdaHandler

Returns:

boolean true if enabled

register

public void register()

Description copied from interface: LambdaHandler

Register this handler to the handler registration.

Specified by:

register in interface LambdaHandler

reload

public void reload()

Description copied from interface: LambdaHandler

Reload config values in case the config values changed by config server.

Specified by:

reload in interface LambdaHandler

isAsynchronous

public boolean isAsynchronous()

Description copied from interface: LambdaHandler

Indicate if this middleware handler is asynchronous or not.

Specified by:

isAsynchronous in interface LambdaHandler

Returns:

boolean true if asynchronous

isContinueOnFailure

public boolean isContinueOnFailure()

Description copied from interface: MiddlewareHandler

Indicate if this middleware handler will continue on failure or not.

Specified by:

isContinueOnFailure in interface MiddlewareHandler

Returns:

boolean true if continue on failure

isAudited

public boolean isAudited()

Description copied from interface: MiddlewareHandler

Indicate if this middleware handler is audited or not.

Specified by:

isAudited in interface MiddlewareHandler

Returns:

boolean true if audited

getCachedConfigurations

public void getCachedConfigurations()

Specified by:

getCachedConfigurations in interface MiddlewareHandler