Package io.vertigo.vega.plugins.webservice.handler

Class ApiKeyWebServiceHandlerPlugin

java.lang.Object

io.vertigo.vega.plugins.webservice.handler.ApiKeyWebServiceHandlerPlugin

All Implemented Interfaces:

io.vertigo.core.node.component.CoreComponent, io.vertigo.core.node.component.Plugin, WebServiceHandlerPlugin

public final class ApiKeyWebServiceHandlerPlugin
extends Object
implements WebServiceHandlerPlugin

Security handler. Check Api Key, throw VSecurityException if not equals to configured Key.

Author:

skerdudou

Field Summary

Fields

Modifier and Type	Field	Description
static final int	STACK_INDEX	Stack index of the handler for sorting at startup

Constructor Summary

Constructors

Constructor	Description
ApiKeyWebServiceHandlerPlugin(String apiKey, Optional<String> headerNameOpt)	Constructor.

Method Summary

Modifier and Type	Method	Description
boolean	accept(WebServiceDefinition webServiceDefinition)
int	getStackIndex()	Return an index to compute the order of the handlers stack.
Object	handle(jakarta.servlet.http.HttpServletRequest request, jakarta.servlet.http.HttpServletResponse response, WebServiceCallContext webServiceCallContext, HandlerChain chain)	Do handle of this route.

Methods inherited from class java.lang.Object

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

Field Details

STACK_INDEX

public static final int STACK_INDEX

Stack index of the handler for sorting at startup

See Also:

• Constant Field Values

Constructor Details

ApiKeyWebServiceHandlerPlugin

@Inject
public ApiKeyWebServiceHandlerPlugin(String apiKey,
 Optional<String> headerNameOpt)

Constructor.

Method Details

accept

public boolean accept(WebServiceDefinition webServiceDefinition)

Specified by:

accept in interface WebServiceHandlerPlugin

Parameters:

webServiceDefinition - WebServiceDefinition

Returns:

If this handler should be use for this webService

handle

public Object handle(jakarta.servlet.http.HttpServletRequest request,
 jakarta.servlet.http.HttpServletResponse response,
 WebServiceCallContext webServiceCallContext,
 HandlerChain chain)
              throws SessionException

Description copied from interface: WebServiceHandlerPlugin

Do handle of this route.

Specified by:

handle in interface WebServiceHandlerPlugin

Parameters:

request - Request

response - Response

webServiceCallContext - Context of this request

chain - current HandlerChain.

Returns:

Response body

Throws:

SessionException - Session expired exception

getStackIndex

public int getStackIndex()

Description copied from interface: WebServiceHandlerPlugin

Return an index to compute the order of the handlers stack. Please check the index of the provided handlers by vertigo and choose the index for yours accordingly. Vertigo's handlers start à 10 and leave a space of 10 between each. The last handler must be RestfulServiceWebServiceHandlerPlugin which has the index 120. Therefore the provided index must be between 0 and 119

Specified by:

getStackIndex in interface WebServiceHandlerPlugin

Returns:

the index (between 0 and 119)