Interface JwtLocationOrBuilder (2.48.0)

Version latest

• 2.48.0 (latest)
• 2.46.0
• 2.45.1
• 2.44.0
• 2.43.0
• 2.42.0
• 2.41.0
• 2.40.0
• 2.39.1
• 2.38.0
• 2.37.1
• 2.36.0
• 2.34.0
• 2.33.0
• 2.32.0
• 2.30.0
• 2.29.0
• 2.28.0
• 2.27.0
• 2.26.0
• 2.25.1
• 2.24.0
• 2.23.1
• 2.22.1
• 2.21.1
• 2.15.0
• 2.14.3
• 2.13.0
• 2.12.0
• 2.11.0
• 2.10.0
• 2.9.6
• 2.8.4
• 2.7.4

public interface JwtLocationOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getCookie()

public abstract String getCookie()

Specifies cookie name to extract JWT token.

string cookie = 4;

Returns
Type	Description
String	The cookie.

getCookieBytes()

public abstract ByteString getCookieBytes()

Specifies cookie name to extract JWT token.

string cookie = 4;

Returns
Type	Description
ByteString	The bytes for cookie.

getHeader()

public abstract String getHeader()

Specifies HTTP header name to extract JWT token.

string header = 1;

Returns
Type	Description
String	The header.

getHeaderBytes()

public abstract ByteString getHeaderBytes()

Specifies HTTP header name to extract JWT token.

string header = 1;

Returns
Type	Description
ByteString	The bytes for header.

getInCase()

public abstract JwtLocation.InCase getInCase()

Returns
Type	Description
JwtLocation.InCase

getQuery()

public abstract String getQuery()

Specifies URL query parameter name to extract JWT token.

string query = 2;

Returns
Type	Description
String	The query.

getQueryBytes()

public abstract ByteString getQueryBytes()

Specifies URL query parameter name to extract JWT token.

string query = 2;

Returns
Type	Description
ByteString	The bytes for query.

getValuePrefix()

public abstract String getValuePrefix()

The value prefix. The value format is "value_prefix{token}" Only applies to "in" header type. Must be empty for "in" query type. If not empty, the header value has to match (case sensitive) this prefix. If not matched, JWT will not be extracted. If matched, JWT will be extracted after the prefix is removed.

For example, for "Authorization: Bearer {JWT}", value_prefix="Bearer " with a space at the end.

string value_prefix = 3;

Returns
Type	Description
String	The valuePrefix.

getValuePrefixBytes()

public abstract ByteString getValuePrefixBytes()

The value prefix. The value format is "value_prefix{token}" Only applies to "in" header type. Must be empty for "in" query type. If not empty, the header value has to match (case sensitive) this prefix. If not matched, JWT will not be extracted. If matched, JWT will be extracted after the prefix is removed.

For example, for "Authorization: Bearer {JWT}", value_prefix="Bearer " with a space at the end.

string value_prefix = 3;

Returns
Type	Description
ByteString	The bytes for valuePrefix.

hasCookie()

public abstract boolean hasCookie()

Specifies cookie name to extract JWT token.

string cookie = 4;

Returns
Type	Description
boolean	Whether the cookie field is set.

hasHeader()

public abstract boolean hasHeader()

Specifies HTTP header name to extract JWT token.

string header = 1;

Returns
Type	Description
boolean	Whether the header field is set.

hasQuery()

public abstract boolean hasQuery()

Specifies URL query parameter name to extract JWT token.

string query = 2;

Returns
Type	Description
boolean	Whether the query field is set.