public class APIKeyHandler extends Object implements AuthenticationHandler, Handler<RoutingContext>
HTTP headers/query parameters/cookies.
By default this handler will extract the API key from an HTTP header named X-API-KEY.
NOTE: This class has been automatically generated from the original non RX-ified interface using Vert.x codegen.| Modifier and Type | Field and Description |
|---|---|
static io.vertx.lang.rx.TypeArg<APIKeyHandler> |
__TYPE_ARG |
| Constructor and Description |
|---|
APIKeyHandler(APIKeyHandler delegate) |
APIKeyHandler(Object delegate) |
| Modifier and Type | Method and Description |
|---|---|
APIKeyHandler |
cookie(String cookieName)
Specify the source for the api key extraction as an HTTP cookie with the given name.
|
static APIKeyHandler |
create(AuthenticationProvider authProvider)
Create an API Key authentication handler
|
boolean |
equals(Object o) |
APIKeyHandler |
getDelegate() |
void |
handle(RoutingContext event)
Something has happened, so handle it.
|
int |
hashCode() |
APIKeyHandler |
header(String headerName)
Specify the source for the api key extraction as an HTTP header with the given name.
|
static APIKeyHandler |
newInstance(APIKeyHandler arg) |
APIKeyHandler |
parameter(String paramName)
Specify the source for the api key extraction as an HTTP query parameter with the given name.
|
String |
toString() |
clone, finalize, getClass, notify, notifyAll, wait, wait, waitnewInstancepublic static final io.vertx.lang.rx.TypeArg<APIKeyHandler> __TYPE_ARG
public APIKeyHandler(APIKeyHandler delegate)
public APIKeyHandler(Object delegate)
public APIKeyHandler getDelegate()
getDelegate in interface AuthenticationHandlerpublic void handle(RoutingContext event)
handle in interface Handler<RoutingContext>handle in interface AuthenticationHandlerevent - the event to handlepublic static APIKeyHandler create(AuthenticationProvider authProvider)
authProvider - the auth provider to usepublic APIKeyHandler header(String headerName)
headerName - the header name containing the API keypublic APIKeyHandler parameter(String paramName)
paramName - the parameter name containing the API keypublic APIKeyHandler cookie(String cookieName)
cookieName - the cookie name containing the API keypublic static APIKeyHandler newInstance(APIKeyHandler arg)
Copyright © 2021 Eclipse. All rights reserved.