io.helidon.integrations.oci.sdk.cdi.SessionTokenAdpSupplier Maven / Gradle / Ivy
/*
* Copyright (c) 2024 Oracle and/or its affiliates.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package io.helidon.integrations.oci.sdk.cdi;
import java.io.IOException;
import java.io.UncheckedIOException;
import java.util.Objects;
import java.util.Optional;
import java.util.function.Supplier;
import com.oracle.bmc.ConfigFileReader.ConfigFile;
import com.oracle.bmc.auth.SessionTokenAuthenticationDetailsProvider;
import com.oracle.bmc.auth.SessionTokenAuthenticationDetailsProvider.SessionTokenAuthenticationDetailsProviderBuilder;
/**
* An {@link AdpSupplier} of {@link SessionTokenAuthenticationDetailsProvider} instances.
*
* @see #get()
*
* @see #ofConfigFileSupplier(Supplier)
*
* @see #ofBuilderSupplier(Supplier)
*
* @see SessionTokenAuthenticationDetailsProvider#SessionTokenAuthenticationDetailsProvider(ConfigFile)
*
* @see SessionTokenAuthenticationDetailsProvider.SessionTokenAuthenticationDetailsProviderBuilder
*/
class SessionTokenAdpSupplier implements AdpSupplier {
/*
* Instance fields.
*/
private final Supplier> s;
/*
* Constructors.
*/
private SessionTokenAdpSupplier(Supplier> s) {
this.s = Objects.requireNonNull(s, "s");
}
/*
* Instance methods.
*/
/**
* Returns an {@link Optional} {@linkplain Optional#get() housing} a {@link
* SessionTokenAuthenticationDetailsProvider} instance.
*
* An {@linkplain Optional#isEmpty() empty Optional} return value indicates only that at the moment
* of invocation minimal requirements were not met. It implies no further semantics of any kind.
*
* Note that for unknown reasons the requirements for creating a {@link
* SessionTokenAuthenticationDetailsProvider} instance using a {@link
* SessionTokenAuthenticationDetailsProviderBuilder SessionTokenAuthenticationDetailsProviderBuilder} instance are
* different from those for creating {@link SessionTokenAuthenticationDetailsProvider} from a {@link ConfigFile
* ConfigFile}. Neither set of requirements is documented. The following requirements are subject to change without
* notice as the OCI Java SDK changes its assumptions and requirements in subsequent versions.
*
* If this {@link SessionTokenAdpSupplier} was created using the {@link #ofBuilderSupplier(Supplier)} factory
* method, then:
*
*
*
* - if the builder's {@link SessionTokenAuthenticationDetailsProviderBuilder#tenantId(String) tenantId(String)}
* method was never called or was called with a {@code null} value, or
*
* - if the builder's {@link SessionTokenAuthenticationDetailsProviderBuilder#privateKeyFilePath(String)
* privateKeyFilePath(String)} method was never called or was called with a {@code null} value, or
*
* - if either the builder's {@link SessionTokenAuthenticationDetailsProviderBuilder#region(String)
* region(String)} or {@link SessionTokenAuthenticationDetailsProviderBuilder#region(com.oracle.bmc.Region)
* region(Region)} method was never called or was called with a {@code null} value, or
*
*
- if either the builder's {@link SessionTokenAuthenticationDetailsProviderBuilder#sessionToken(String)
* sessionToken(String)} or {@link SessionTokenAuthenticationDetailsProviderBuilder#sessionTokenFilePath(String)
* sessionTokenFilePath(String)} method was never called or was called with a {@code null} value
*
*
*
* …this method will return an {@linkplain Optional#isEmpty() empty Optional}.
*
* If this {@link SessionTokenAdpSupplier} was created using the {@link #ofConfigFileSupplier(Supplier)} factory
* method, then:
*
*
*
* - if an invocation of {@link #containsRequiredValues(ConfigFile)} returns {@code false}
*
*
*
* …this method will return an {@linkplain Optional#isEmpty() empty Optional}.
*
* @return an {@link Optional} {@linkplain Optional#get() housing} a {@link
* SessionTokenAuthenticationDetailsProvider} instance, never {@code null}
*
* @see #ofBuilderSupplier(Supplier)
*
* @see #ofConfigFileSupplier(Supplier)
*
* @see #containsRequiredValues(ConfigFile)
*
* @see SessionTokenAuthenticationDetailsProvider
*/
@Override
public final Optional get() {
return this.s.get();
}
/*
* Static methods.
*/
/**
* Returns a {@link SessionTokenAdpSupplier} backed by the supplied {@link Supplier} of {@link
* SessionTokenAuthenticationDetailsProviderBuilder SessionTokenAuthenticationDetailsProviderBuilder} instances.
*
* @param bs a {@link Supplier} of {@link SessionTokenAuthenticationDetailsProviderBuilder} instances; must not be
* {@code null}
*
* @return a {@link SessionTokenAdpSupplier}; never {@code null}
*
* @exception NullPointerException if {@code bs} is {@code null}
*
* @see #ofSupplier(Supplier)
*/
public static SessionTokenAdpSupplier
ofBuilderSupplier(Supplier bs) {
Objects.requireNonNull(bs, "bs");
return ofSupplier(() -> produce(bs.get()));
}
/**
* Returns a {@link SessionTokenAdpSupplier} backed by the supplied {@link Supplier} of {@link
* SessionTokenAuthenticationDetailsProvider} instances.
*
* @param s a {@link Supplier} of {@link SessionTokenAuthenticationDetailsProvider} instances; must not be {@code null}
*
* @return a {@link SessionTokenAdpSupplier}; never {@code null}
*
* @exception NullPointerException if {@code s} is {@code null}
*/
public static SessionTokenAdpSupplier ofSupplier(Supplier s) {
return new SessionTokenAdpSupplier(fromSupplier(s));
}
/**
* Returns a {@link SessionTokenAdpSupplier} backed by the supplied {@link Supplier} of {@link ConfigFile
* ConfigFile} instances.
*
* @param cfs a {@link Supplier} of {@link ConfigFile ConfigFile} instances; must not be {@code null}
*
* @return a {@link SessionTokenAdpSupplier}; never {@code null}
*
* @exception NullPointerException if {@code cfs} is {@code null}
*/
public static SessionTokenAdpSupplier ofConfigFileSupplier(Supplier cfs) {
return new SessionTokenAdpSupplier(fromConfigFileSupplier(cfs));
}
/**
* Returns {@code true} if and only if the supplied {@link ConfigFile ConfigFile} contains enough information to
* {@linkplain SessionTokenAuthenticationDetailsProvider#SessionTokenAuthenticationDetailsProvider(ConfigFile)
* create a SessionTokenAuthenticationDetailsProvider}.
*
* Specifically:
*
*
*
* - if the supplied {@link ConfigFile ConfigFile} returns {@code null} from a {@link ConfigFile#get(String)
* get("security_token_file")} invocation, or
*
* - if the supplied {@link ConfigFile ConfigFile} returns {@code null} from a {@link ConfigFile#get(String)
* get("key_file")} invocation, or
*
* - if the supplied {@link ConfigFile ConfigFile} returns {@code null} from a {@link ConfigFile#get(String)
* get("tenancy")} invocation
*
*
*
* …then {@code false} will be returned.
*
* @param cf a {@link ConfigFile}; must not be {@code null}
*
* @return {@code true} if and only if the supplied {@link ConfigFile ConfigFile} contains enough information to
* {@linkplain SessionTokenAuthenticationDetailsProvider#SessionTokenAuthenticationDetailsProvider(ConfigFile)
* create a SessionTokenAuthenticationDetailsProvider}
*
* @exception NullPointerException if {@code cf} is {@code null}
*
* @see ConfigFiles#containsRequiredValues(ConfigFile)
*/
public static boolean containsRequiredValues(ConfigFile cf) {
// Rule out ConfigFileAuthenticationDetailsProvider usage up front. Interestingly, when you build a
// SessionTokenAuthenticationDetailsProvider from a builder, region is required. When you build it from a
// ConfigFile it is not, even though this will lead to a NullPointerException later. This class is not in the
// business of policing the innards of the OCI Java SDK so we just let it fly.
return cf.get("security_token_file") != null && ConfigFiles.containsRequiredValues(cf);
}
private static Supplier>
fromConfigFileSupplier(Supplier cfs) {
Objects.requireNonNull(cfs, "cfs");
return () -> ConfigFiles.configFile(cfs)
.filter(SessionTokenAdpSupplier::containsRequiredValues)
.map(SessionTokenAdpSupplier::produce);
}
private static Supplier>
fromSupplier(Supplier s) {
Objects.requireNonNull(s, "s");
return () -> {
try {
return Optional.ofNullable(s.get());
} catch (RuntimeException e) {
if (indicatesMissingRequirement(e)) {
return Optional.empty();
}
throw e;
}
};
}
private static boolean indicatesMissingRequirement(RuntimeException e) {
// There is no way to check if a SessionTokenAuthenticationDetailsProviderBuilder contains the information
// required for building before attempting a build. You just have to try the build, and then interpret the
// resulting NullPointerException's message to see which requirement was missing, and repeat as necessary.
if (e instanceof NullPointerException) {
String message = e.getMessage();
if (message != null && message.startsWith("SessionTokenAuthenticationDetailsProvider: ")) {
// See
// https://github.com/oracle/oci-java-sdk/blob/v3.34.1/bmc-common/src/main/java/com/oracle/bmc/auth/SessionTokenAuthenticationDetailsProvider.java#L112-L138
//
// Requirements were not supplied, but this isn't really an error, per se, just a reflection of the fact
// that the builder is missing requirements, so this strategy isn't available.
//
// Chop off the text that is common to all messages indicating (undocumented) requirements violations to
// preclude substring operations.
message = message.substring("SessionTokenAuthenticationDetailsProvider: ".length());
return message.startsWith("privateKeyFilePath ")
|| message.startsWith("Set either region ") // region is required here, but not (!) in a ConfigFile
|| message.startsWith("Set either sessionToken ")
|| message.startsWith("tenantId ");
}
}
return false;
}
/**
* A convenience method that invokes the {@link SessionTokenAuthenticationDetailsProviderBuilder#build()} method on
* the supplied {@link SessionTokenAuthenticationDetailsProviderBuilder} and returns its results, wrapping any
* {@link IOException}s encountered in {@link UncheckedIOException}s instead.
*
* @param b a {@link SessionTokenAuthenticationDetailsProviderBuilder}; must not be {@code null}
*
* @return the result of invoking the {@link SessionTokenAuthenticationDetailsProviderBuilder#build()} method on the
* supplied {@link SessionTokenAuthenticationDetailsProviderBuilder}
*
* @exception NullPointerException if {@code b} was {@code null}
*
* @exception UncheckedIOException if an {@link IOException} was thrown by the {@link
* SessionTokenAuthenticationDetailsProviderBuilder#build()} method; its {@linkplain Throwable#getCause() cause}
* will be the original {@link IOException}
*
* @see SessionTokenAuthenticationDetailsProviderBuilder#build()
*/
private static SessionTokenAuthenticationDetailsProvider produce(SessionTokenAuthenticationDetailsProviderBuilder b) {
try {
return b.build();
} catch (IOException e) {
throw new UncheckedIOException(e.getMessage(), e);
}
}
/**
* A convenience method that invokes the {@link
* SessionTokenAuthenticationDetailsProvider#SessionTokenAuthenticationDetailsProvider(ConfigFile)} constructor with
* the supplied {@link ConfigFile} and returns the new {@link SessionTokenAuthenticationDetailsProvider}, wrapping
* any {@link IOException}s encountered in {@link UncheckedIOException}s instead.
*
* @param cf a {@link ConfigFile}; must not be {@code null}
*
* @return the result of invoking the {@link
* SessionTokenAuthenticationDetailsProvider#SessionTokenAuthenticationDetailsProvider(ConfigFile)} constructor with
* the supplied {@link ConfigFile}
*
* @exception NullPointerException if {@code cf} was {@code null}
*
* @exception UncheckedIOException if an {@link IOException} was thrown by the {@link
* SessionTokenAuthenticationDetailsProvider#SessionTokenAuthenticationDetailsProvider(ConfigFile)} method; its
* {@linkplain Throwable#getCause() cause} will be the original {@link IOException}
*
* @see SessionTokenAuthenticationDetailsProvider#SessionTokenAuthenticationDetailsProvider(ConfigFile)
*/
private static SessionTokenAuthenticationDetailsProvider produce(ConfigFile cf) {
try {
return new SessionTokenAuthenticationDetailsProvider(cf);
} catch (IOException e) {
throw new UncheckedIOException(e.getMessage(), e);
}
}
}