com.oracle.bmc.apigateway.model.JwtAuthenticationPolicy Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of oci-java-sdk-apigateway Show documentation
Show all versions of oci-java-sdk-apigateway Show documentation
This project contains the SDK used for Oracle Cloud Infrastructure Apigateway
/**
* Copyright (c) 2016, 2024, Oracle and/or its affiliates. All rights reserved.
* This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license.
*/
package com.oracle.bmc.apigateway.model;
/**
* 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 {@link Builder}. This model
* distinguishes fields that are {@code null} because they are unset from fields that are explicitly
* set to {@code null}. This is done in the setter methods of the {@link Builder}, which maintain a
* set of all explicitly set fields called {@link Builder#__explicitlySet__}. The {@link
* #hashCode()} and {@link #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 {@code null} from unset {@code
* null}).
*/
@jakarta.annotation.Generated(value = "OracleSDKGenerator", comments = "API Version: 20190501")
@com.fasterxml.jackson.databind.annotation.JsonDeserialize(
builder = JwtAuthenticationPolicy.Builder.class)
@com.fasterxml.jackson.annotation.JsonTypeInfo(
use = com.fasterxml.jackson.annotation.JsonTypeInfo.Id.NAME,
include = com.fasterxml.jackson.annotation.JsonTypeInfo.As.PROPERTY,
property = "type")
@com.fasterxml.jackson.annotation.JsonFilter(
com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel.EXPLICITLY_SET_FILTER_NAME)
public final class JwtAuthenticationPolicy extends AuthenticationPolicy {
@com.fasterxml.jackson.databind.annotation.JsonPOJOBuilder(withPrefix = "")
public static class Builder {
@com.fasterxml.jackson.annotation.JsonProperty("isAnonymousAccessAllowed")
private Boolean isAnonymousAccessAllowed;
public Builder isAnonymousAccessAllowed(Boolean isAnonymousAccessAllowed) {
this.isAnonymousAccessAllowed = isAnonymousAccessAllowed;
this.__explicitlySet__.add("isAnonymousAccessAllowed");
return this;
}
/** The name of the header containing the authentication token. */
@com.fasterxml.jackson.annotation.JsonProperty("tokenHeader")
private String tokenHeader;
/**
* The name of the header containing the authentication token.
*
* @param tokenHeader the value to set
* @return this builder
*/
public Builder tokenHeader(String tokenHeader) {
this.tokenHeader = tokenHeader;
this.__explicitlySet__.add("tokenHeader");
return this;
}
/** The name of the query parameter containing the authentication token. */
@com.fasterxml.jackson.annotation.JsonProperty("tokenQueryParam")
private String tokenQueryParam;
/**
* The name of the query parameter containing the authentication token.
*
* @param tokenQueryParam the value to set
* @return this builder
*/
public Builder tokenQueryParam(String tokenQueryParam) {
this.tokenQueryParam = tokenQueryParam;
this.__explicitlySet__.add("tokenQueryParam");
return this;
}
/**
* The authentication scheme that is to be used when authenticating the token. This must to
* be provided if "tokenHeader" is specified.
*/
@com.fasterxml.jackson.annotation.JsonProperty("tokenAuthScheme")
private String tokenAuthScheme;
/**
* The authentication scheme that is to be used when authenticating the token. This must to
* be provided if "tokenHeader" is specified.
*
* @param tokenAuthScheme the value to set
* @return this builder
*/
public Builder tokenAuthScheme(String tokenAuthScheme) {
this.tokenAuthScheme = tokenAuthScheme;
this.__explicitlySet__.add("tokenAuthScheme");
return this;
}
/**
* The maximum expected time difference between the system clocks of the token issuer and
* the API Gateway.
*/
@com.fasterxml.jackson.annotation.JsonProperty("maxClockSkewInSeconds")
private Float maxClockSkewInSeconds;
/**
* The maximum expected time difference between the system clocks of the token issuer and
* the API Gateway.
*
* @param maxClockSkewInSeconds the value to set
* @return this builder
*/
public Builder maxClockSkewInSeconds(Float maxClockSkewInSeconds) {
this.maxClockSkewInSeconds = maxClockSkewInSeconds;
this.__explicitlySet__.add("maxClockSkewInSeconds");
return this;
}
/** A list of parties that could have issued the token. */
@com.fasterxml.jackson.annotation.JsonProperty("issuers")
private java.util.List issuers;
/**
* A list of parties that could have issued the token.
*
* @param issuers the value to set
* @return this builder
*/
public Builder issuers(java.util.List issuers) {
this.issuers = issuers;
this.__explicitlySet__.add("issuers");
return this;
}
/** The list of intended recipients for the token. */
@com.fasterxml.jackson.annotation.JsonProperty("audiences")
private java.util.List audiences;
/**
* The list of intended recipients for the token.
*
* @param audiences the value to set
* @return this builder
*/
public Builder audiences(java.util.List audiences) {
this.audiences = audiences;
this.__explicitlySet__.add("audiences");
return this;
}
/** A list of claims which should be validated to consider the token valid. */
@com.fasterxml.jackson.annotation.JsonProperty("verifyClaims")
private java.util.List verifyClaims;
/**
* A list of claims which should be validated to consider the token valid.
*
* @param verifyClaims the value to set
* @return this builder
*/
public Builder verifyClaims(java.util.List verifyClaims) {
this.verifyClaims = verifyClaims;
this.__explicitlySet__.add("verifyClaims");
return this;
}
@com.fasterxml.jackson.annotation.JsonProperty("publicKeys")
private PublicKeySet publicKeys;
public Builder publicKeys(PublicKeySet publicKeys) {
this.publicKeys = publicKeys;
this.__explicitlySet__.add("publicKeys");
return this;
}
@com.fasterxml.jackson.annotation.JsonIgnore
private final java.util.Set __explicitlySet__ = new java.util.HashSet();
public JwtAuthenticationPolicy build() {
JwtAuthenticationPolicy model =
new JwtAuthenticationPolicy(
this.isAnonymousAccessAllowed,
this.tokenHeader,
this.tokenQueryParam,
this.tokenAuthScheme,
this.maxClockSkewInSeconds,
this.issuers,
this.audiences,
this.verifyClaims,
this.publicKeys);
for (String explicitlySetProperty : this.__explicitlySet__) {
model.markPropertyAsExplicitlySet(explicitlySetProperty);
}
return model;
}
@com.fasterxml.jackson.annotation.JsonIgnore
public Builder copy(JwtAuthenticationPolicy model) {
if (model.wasPropertyExplicitlySet("isAnonymousAccessAllowed")) {
this.isAnonymousAccessAllowed(model.getIsAnonymousAccessAllowed());
}
if (model.wasPropertyExplicitlySet("tokenHeader")) {
this.tokenHeader(model.getTokenHeader());
}
if (model.wasPropertyExplicitlySet("tokenQueryParam")) {
this.tokenQueryParam(model.getTokenQueryParam());
}
if (model.wasPropertyExplicitlySet("tokenAuthScheme")) {
this.tokenAuthScheme(model.getTokenAuthScheme());
}
if (model.wasPropertyExplicitlySet("maxClockSkewInSeconds")) {
this.maxClockSkewInSeconds(model.getMaxClockSkewInSeconds());
}
if (model.wasPropertyExplicitlySet("issuers")) {
this.issuers(model.getIssuers());
}
if (model.wasPropertyExplicitlySet("audiences")) {
this.audiences(model.getAudiences());
}
if (model.wasPropertyExplicitlySet("verifyClaims")) {
this.verifyClaims(model.getVerifyClaims());
}
if (model.wasPropertyExplicitlySet("publicKeys")) {
this.publicKeys(model.getPublicKeys());
}
return this;
}
}
/** Create a new builder. */
public static Builder builder() {
return new Builder();
}
public Builder toBuilder() {
return new Builder().copy(this);
}
@Deprecated
public JwtAuthenticationPolicy(
Boolean isAnonymousAccessAllowed,
String tokenHeader,
String tokenQueryParam,
String tokenAuthScheme,
Float maxClockSkewInSeconds,
java.util.List issuers,
java.util.List audiences,
java.util.List verifyClaims,
PublicKeySet publicKeys) {
super(isAnonymousAccessAllowed);
this.tokenHeader = tokenHeader;
this.tokenQueryParam = tokenQueryParam;
this.tokenAuthScheme = tokenAuthScheme;
this.maxClockSkewInSeconds = maxClockSkewInSeconds;
this.issuers = issuers;
this.audiences = audiences;
this.verifyClaims = verifyClaims;
this.publicKeys = publicKeys;
}
/** The name of the header containing the authentication token. */
@com.fasterxml.jackson.annotation.JsonProperty("tokenHeader")
private final String tokenHeader;
/**
* The name of the header containing the authentication token.
*
* @return the value
*/
public String getTokenHeader() {
return tokenHeader;
}
/** The name of the query parameter containing the authentication token. */
@com.fasterxml.jackson.annotation.JsonProperty("tokenQueryParam")
private final String tokenQueryParam;
/**
* The name of the query parameter containing the authentication token.
*
* @return the value
*/
public String getTokenQueryParam() {
return tokenQueryParam;
}
/**
* The authentication scheme that is to be used when authenticating the token. This must to be
* provided if "tokenHeader" is specified.
*/
@com.fasterxml.jackson.annotation.JsonProperty("tokenAuthScheme")
private final String tokenAuthScheme;
/**
* The authentication scheme that is to be used when authenticating the token. This must to be
* provided if "tokenHeader" is specified.
*
* @return the value
*/
public String getTokenAuthScheme() {
return tokenAuthScheme;
}
/**
* The maximum expected time difference between the system clocks of the token issuer and the
* API Gateway.
*/
@com.fasterxml.jackson.annotation.JsonProperty("maxClockSkewInSeconds")
private final Float maxClockSkewInSeconds;
/**
* The maximum expected time difference between the system clocks of the token issuer and the
* API Gateway.
*
* @return the value
*/
public Float getMaxClockSkewInSeconds() {
return maxClockSkewInSeconds;
}
/** A list of parties that could have issued the token. */
@com.fasterxml.jackson.annotation.JsonProperty("issuers")
private final java.util.List issuers;
/**
* A list of parties that could have issued the token.
*
* @return the value
*/
public java.util.List getIssuers() {
return issuers;
}
/** The list of intended recipients for the token. */
@com.fasterxml.jackson.annotation.JsonProperty("audiences")
private final java.util.List audiences;
/**
* The list of intended recipients for the token.
*
* @return the value
*/
public java.util.List getAudiences() {
return audiences;
}
/** A list of claims which should be validated to consider the token valid. */
@com.fasterxml.jackson.annotation.JsonProperty("verifyClaims")
private final java.util.List verifyClaims;
/**
* A list of claims which should be validated to consider the token valid.
*
* @return the value
*/
public java.util.List getVerifyClaims() {
return verifyClaims;
}
@com.fasterxml.jackson.annotation.JsonProperty("publicKeys")
private final PublicKeySet publicKeys;
public PublicKeySet getPublicKeys() {
return publicKeys;
}
@Override
public String toString() {
return this.toString(true);
}
/**
* Return a string representation of the object.
*
* @param includeByteArrayContents true to include the full contents of byte arrays
* @return string representation
*/
public String toString(boolean includeByteArrayContents) {
java.lang.StringBuilder sb = new java.lang.StringBuilder();
sb.append("JwtAuthenticationPolicy(");
sb.append("super=").append(super.toString(includeByteArrayContents));
sb.append(", tokenHeader=").append(String.valueOf(this.tokenHeader));
sb.append(", tokenQueryParam=").append(String.valueOf(this.tokenQueryParam));
sb.append(", tokenAuthScheme=").append(String.valueOf(this.tokenAuthScheme));
sb.append(", maxClockSkewInSeconds=").append(String.valueOf(this.maxClockSkewInSeconds));
sb.append(", issuers=").append(String.valueOf(this.issuers));
sb.append(", audiences=").append(String.valueOf(this.audiences));
sb.append(", verifyClaims=").append(String.valueOf(this.verifyClaims));
sb.append(", publicKeys=").append(String.valueOf(this.publicKeys));
sb.append(")");
return sb.toString();
}
@Override
public boolean equals(Object o) {
if (this == o) {
return true;
}
if (!(o instanceof JwtAuthenticationPolicy)) {
return false;
}
JwtAuthenticationPolicy other = (JwtAuthenticationPolicy) o;
return java.util.Objects.equals(this.tokenHeader, other.tokenHeader)
&& java.util.Objects.equals(this.tokenQueryParam, other.tokenQueryParam)
&& java.util.Objects.equals(this.tokenAuthScheme, other.tokenAuthScheme)
&& java.util.Objects.equals(this.maxClockSkewInSeconds, other.maxClockSkewInSeconds)
&& java.util.Objects.equals(this.issuers, other.issuers)
&& java.util.Objects.equals(this.audiences, other.audiences)
&& java.util.Objects.equals(this.verifyClaims, other.verifyClaims)
&& java.util.Objects.equals(this.publicKeys, other.publicKeys)
&& super.equals(other);
}
@Override
public int hashCode() {
final int PRIME = 59;
int result = super.hashCode();
result = (result * PRIME) + (this.tokenHeader == null ? 43 : this.tokenHeader.hashCode());
result =
(result * PRIME)
+ (this.tokenQueryParam == null ? 43 : this.tokenQueryParam.hashCode());
result =
(result * PRIME)
+ (this.tokenAuthScheme == null ? 43 : this.tokenAuthScheme.hashCode());
result =
(result * PRIME)
+ (this.maxClockSkewInSeconds == null
? 43
: this.maxClockSkewInSeconds.hashCode());
result = (result * PRIME) + (this.issuers == null ? 43 : this.issuers.hashCode());
result = (result * PRIME) + (this.audiences == null ? 43 : this.audiences.hashCode());
result = (result * PRIME) + (this.verifyClaims == null ? 43 : this.verifyClaims.hashCode());
result = (result * PRIME) + (this.publicKeys == null ? 43 : this.publicKeys.hashCode());
return result;
}
}
© 2015 - 2024 Weber Informatics LLC | Privacy Policy