com.oracle.bmc.apigateway.model

Class CustomAuthenticationPolicy

java.lang.Object

com.oracle.bmc.apigateway.model.AuthenticationPolicy

com.oracle.bmc.apigateway.model.CustomAuthenticationPolicy

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

Use a function to validate a custom header or query parameter sent with the request authentication. A valid policy must specify either tokenHeader or tokenQueryParam.

Note: Objects should always be created or deserialized using the CustomAuthenticationPolicy.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 CustomAuthenticationPolicy.Builder, which maintain a set of all explicitly set fields called __explicitlySet__. The hashCode() and equals(Object) methods are implemented to take __explicitlySet__ into account. The constructor, on the other hand, does not set __explicitlySet__ (since the constructor cannot distinguish explicit null from unset null).

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CustomAuthenticationPolicy.Builder

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

AuthenticationPolicy.Type

Constructor Summary

Constructors

Constructor and Description
CustomAuthenticationPolicy(Boolean isAnonymousAccessAllowed, String functionId, String tokenHeader, String tokenQueryParam) Deprecated.

Method Summary

Modifier and Type	Method and Description
static CustomAuthenticationPolicy.Builder	builder() Create a new builder.
protected boolean	canEqual(Object other)
boolean	equals(Object o)
Set<String>	get__explicitlySet__()
String	getFunctionId() The OCID of the Oracle Functions function resource.
String	getTokenHeader() The name of the header containing the authentication token.
String	getTokenQueryParam() The name of the query parameter containing the authentication token.
int	hashCode()
CustomAuthenticationPolicy.Builder	toBuilder()
String	toString()

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

getIsAnonymousAccessAllowed

Methods inherited from class java.lang.Object

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

Constructor Detail

CustomAuthenticationPolicy

@Deprecated
public CustomAuthenticationPolicy(Boolean isAnonymousAccessAllowed,
                                              String functionId,
                                              String tokenHeader,
                                              String tokenQueryParam)

Deprecated.

Method Detail

builder

public static CustomAuthenticationPolicy.Builder builder()

Create a new builder.

toBuilder

public CustomAuthenticationPolicy.Builder toBuilder()

getFunctionId

public String getFunctionId()

The OCID of the Oracle Functions function resource.

getTokenHeader

public String getTokenHeader()

The name of the header containing the authentication token.

getTokenQueryParam

public String getTokenQueryParam()

The name of the query parameter containing the authentication token.

get__explicitlySet__

public Set<String> get__explicitlySet__()

toString

public String toString()

Overrides:

toString in class AuthenticationPolicy

equals

public boolean equals(Object o)

Overrides:

equals in class AuthenticationPolicy

canEqual

protected boolean canEqual(Object other)

Overrides:

canEqual in class AuthenticationPolicy

hashCode

public int hashCode()

Overrides:

hashCode in class AuthenticationPolicy