com.oracle.bmc.apigateway.model

Class TokenAuthenticationPolicy

java.lang.Object

com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

com.oracle.bmc.apigateway.model.AuthenticationPolicy

com.oracle.bmc.apigateway.model.TokenAuthenticationPolicy

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

Validate a 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 TokenAuthenticationPolicy.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 TokenAuthenticationPolicy.Builder, which maintain a set of all explicitly set fields called TokenAuthenticationPolicy.Builder.__explicitlySet__. The hashCode() and equals(Object) methods are implemented to take the explicitly set fields into account. The constructor, on the other hand, does not take the explicitly set fields into account (since the constructor cannot distinguish explicit null from unset null).

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	TokenAuthenticationPolicy.Builder

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

AuthenticationPolicy.Type

Field Summary

Fields inherited from class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

EXPLICITLY_SET_FILTER_NAME, EXPLICITLY_SET_PROPERTY_NAME

Constructor Summary

Constructors

Constructor and Description
TokenAuthenticationPolicy(Boolean isAnonymousAccessAllowed, String tokenHeader, String tokenQueryParam, String tokenAuthScheme, Float maxClockSkewInSeconds, TokenAuthenticationValidationPolicy validationPolicy, ValidationFailurePolicy validationFailurePolicy) Deprecated.

Method Summary

Modifier and Type	Method and Description
static TokenAuthenticationPolicy.Builder	builder() Create a new builder.
boolean	equals(Object o)
Float	getMaxClockSkewInSeconds() The maximum expected time difference between the system clocks of the token issuer and the API Gateway.
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.
ValidationFailurePolicy	getValidationFailurePolicy()
TokenAuthenticationValidationPolicy	getValidationPolicy()
int	hashCode()
TokenAuthenticationPolicy.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.client.internal.ExplicitlySetBmcModel

markPropertyAsExplicitlySet, wasPropertyExplicitlySet

Methods inherited from class java.lang.Object

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

Constructor Detail

TokenAuthenticationPolicy

@Deprecated
public TokenAuthenticationPolicy(Boolean isAnonymousAccessAllowed,
                                             String tokenHeader,
                                             String tokenQueryParam,
                                             String tokenAuthScheme,
                                             Float maxClockSkewInSeconds,
                                             TokenAuthenticationValidationPolicy validationPolicy,
                                             ValidationFailurePolicy validationFailurePolicy)

Deprecated.

Method Detail

builder

public static TokenAuthenticationPolicy.Builder builder()

Create a new builder.

toBuilder

public TokenAuthenticationPolicy.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

getValidationPolicy

public TokenAuthenticationValidationPolicy getValidationPolicy()

getValidationFailurePolicy

public ValidationFailurePolicy getValidationFailurePolicy()

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