com.oracle.bmc.apigateway.model

Class JwtAuthenticationPolicy

java.lang.Object

com.oracle.bmc.http.internal.ExplicitlySetBmcModel

com.oracle.bmc.apigateway.model.AuthenticationPolicy

com.oracle.bmc.apigateway.model.JwtAuthenticationPolicy

@Generated(value="OracleSDKGenerator",
           comments="API Version: 20190501")
public final class JwtAuthenticationPolicy
extends AuthenticationPolicy

Validate a JWT token present in the header or query parameter. A valid policy must specify either tokenHeader or tokenQueryParam.

Note: Objects should always be created or deserialized using the JwtAuthenticationPolicy.Builder. This model distinguishes fields that are null because they are unset from fields that are explicitly set to null. This is done in the setter methods of the JwtAuthenticationPolicy.Builder, which maintain a set of all explicitly set fields called ExplicitlySetBmcModel.__explicitlySet__. The hashCode() and equals(Object) methods are implemented to take ExplicitlySetBmcModel.__explicitlySet__ into account. The constructor, on the other hand, does not set ExplicitlySetBmcModel.__explicitlySet__ (since the constructor cannot distinguish explicit null from unset null).

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	JwtAuthenticationPolicy.Builder

Nested classes/interfaces inherited from class com.oracle.bmc.apigateway.model.AuthenticationPolicy

AuthenticationPolicy.Type

Constructor Summary

Constructors

Constructor and Description
JwtAuthenticationPolicy(Boolean isAnonymousAccessAllowed, String tokenHeader, String tokenQueryParam, String tokenAuthScheme, Float maxClockSkewInSeconds, List<String> issuers, List<String> audiences, List<JsonWebTokenClaim> verifyClaims, PublicKeySet publicKeys) Deprecated.

Method Summary

Modifier and Type	Method and Description
static JwtAuthenticationPolicy.Builder	builder() Create a new builder.
boolean	equals(Object o)
List<String>	getAudiences() The list of intended recipients for the token.
List<String>	getIssuers() A list of parties that could have issued the token.
Float	getMaxClockSkewInSeconds() The maximum expected time difference between the system clocks of the token issuer and the API Gateway.
PublicKeySet	getPublicKeys()
String	getTokenAuthScheme() The authentication scheme that is to be used when authenticating the token.
String	getTokenHeader() The name of the header containing the authentication token.
String	getTokenQueryParam() The name of the query parameter containing the authentication token.
List<JsonWebTokenClaim>	getVerifyClaims() A list of claims which should be validated to consider the token valid.
int	hashCode()
JwtAuthenticationPolicy.Builder	toBuilder()
String	toString()
String	toString(boolean includeByteArrayContents) Return a string representation of the object.

Methods inherited from class com.oracle.bmc.apigateway.model.AuthenticationPolicy

getIsAnonymousAccessAllowed

Methods inherited from class com.oracle.bmc.http.internal.ExplicitlySetBmcModel

markPropertyAsExplicitlySet, wasPropertyExplicitlySet

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

JwtAuthenticationPolicy

@Deprecated
public JwtAuthenticationPolicy(Boolean isAnonymousAccessAllowed,
                                           String tokenHeader,
                                           String tokenQueryParam,
                                           String tokenAuthScheme,
                                           Float maxClockSkewInSeconds,
                                           List<String> issuers,
                                           List<String> audiences,
                                           List<JsonWebTokenClaim> verifyClaims,
                                           PublicKeySet publicKeys)

Deprecated.

Method Detail

builder

public static JwtAuthenticationPolicy.Builder builder()

Create a new builder.

toBuilder

public JwtAuthenticationPolicy.Builder toBuilder()

getTokenHeader

public String getTokenHeader()

The name of the header containing the authentication token.

Returns:

the value

getTokenQueryParam

public String getTokenQueryParam()

The name of the query parameter containing the authentication token.

Returns:

the value

getTokenAuthScheme

public String getTokenAuthScheme()

The authentication scheme that is to be used when authenticating the token. This must to be provided if “tokenHeader” is specified.

Returns:

the value

getMaxClockSkewInSeconds

public Float getMaxClockSkewInSeconds()

The maximum expected time difference between the system clocks of the token issuer and the API Gateway.

Returns:

the value

getIssuers

public List<String> getIssuers()

A list of parties that could have issued the token.

Returns:

the value

getAudiences

public List<String> getAudiences()

The list of intended recipients for the token.

Returns:

the value

getVerifyClaims

public List<JsonWebTokenClaim> getVerifyClaims()

A list of claims which should be validated to consider the token valid.

Returns:

the value

getPublicKeys

public PublicKeySet getPublicKeys()

toString

public String toString()

Overrides:

toString in class AuthenticationPolicy

toString

public String toString(boolean includeByteArrayContents)

Return a string representation of the object.

Overrides:

toString in class AuthenticationPolicy

Parameters:

includeByteArrayContents - true to include the full contents of byte arrays

Returns:

string representation

equals

public boolean equals(Object o)

Overrides:

equals in class AuthenticationPolicy

hashCode

public int hashCode()

Overrides:

hashCode in class AuthenticationPolicy