Package io.helidon.security

Class QueryParamMapping

java.lang.Object

io.helidon.security.QueryParamMapping

public final class QueryParamMapping
extends java.lang.Object

Definition of a map to bind a query param to a header. Uses the TokenHandler.setHeader(Map, String) to create a new header for the extracted parameter.

Method Summary

Modifier and Type	Method	Description
static QueryParamMapping	create(java.lang.String queryParamName, TokenHandler tokenHandler)	Create a new mapping for a query parameter and TokenHandler to extract the parameter and store it as a new header with possible transformation.
static QueryParamMapping	create(java.lang.String queryParamName, java.lang.String headerName)	Create a new mapping for a query parameter and a header name.
static QueryParamMapping	from(Config config)	Read a new instance from configuration.
java.lang.String	getQueryParamName()
TokenHandler	getTokenHandler()

Methods inherited from class java.lang.Object

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

Method Detail

create

public static QueryParamMapping create(java.lang.String queryParamName,
                                       TokenHandler tokenHandler)

Create a new mapping for a query parameter and TokenHandler to extract the parameter and store it as a new header with possible transformation.

Parameters:

queryParamName - name of parameter

tokenHandler - handler to extract and store the header value

Returns:

a new mapping

create

public static QueryParamMapping create(java.lang.String queryParamName,
                                       java.lang.String headerName)

Create a new mapping for a query parameter and a header name.

Parameters:

queryParamName - name of parameter

headerName - name of a header to store the value of the parameter in

Returns:

a new mapping

from

public static QueryParamMapping from(Config config)

Read a new instance from configuration. The current node should contain a "name" and configuration for TokenHandler

Parameters:

config - configuration instance

Returns:

new query parameter handler instance

getQueryParamName

public java.lang.String getQueryParamName()

getTokenHandler

public TokenHandler getTokenHandler()