All Classes

Class	Description
AbstractAuthenticationDetailsProvider	Root interface for classes providing some information needed to authenticate requests.
AbstractFederationClient	This class gets a security token from the auth service by signing the request with a PKI issued leaf certificate, passing along a temporary public key that is bounded to the the security token, and the leaf certificate.
AbstractFederationClientAuthenticationDetailsProviderBuilder<B extends AbstractFederationClientAuthenticationDetailsProviderBuilder<B,P>,P extends AbstractAuthenticationDetailsProvider>	Abstract builder base class for authentication details provider extending AbstractRequestingAuthenticationDetailsProvider
AbstractRequestingAuthenticationDetailsProvider	Base class for authentication details providers that make remote requests.
AbstractRequestingAuthenticationDetailsProvider.Builder<B extends AbstractRequestingAuthenticationDetailsProvider.Builder<B>>	Base class for builders.
AbstractRequestingAuthenticationDetailsProvider.CachingSessionKeySupplier	Helper class to cache the private key as bytes so we don’t have to parse it every time.
AbstractResponseIterator<REQUESTBUILDER,REQUEST,RESPONSE>	Contains common functionality for classes which will iterate over the results of paginated list operations in a service.
AbstractServiceAccountTokenSupplier
AbstractTemplateRptPathProvider	This abstract path provider has a string template with placeholders like {id}, and provides a way to get a mapping of substitutions to fill in.
Algorithm	Supported signing algorithms for signed request.
Alloy
ApacheConfigurator	Deprecated. use ApacheClientProperties instead.
ApacheConnectionPoolConfig	Deprecated. instead, use com.oracle.bmc.http.client.jersey.apacheconfigurator.ApacheConnectionPoolConfig or com.oracle.bmc.http.client.jersey3.apacheconfigurator.ApacheConnectionPoolConfig
ApacheConnectorProperties	Deprecated. instead, use com.oracle.bmc.http.client.jersey.apacheconfigurator.ApacheConnectorProperties or com.oracle.bmc.http.client.jersey3.apacheconfigurator.ApacheConnectorProperties
ApacheProxyConfig	Deprecated. use ProxyConfiguration instead
ApacheProxyConfigDecorator	Deprecated. use ProxyConfiguration instead
AsyncHandler<REQUEST,RESPONSE>	Callback for asynchronous requests.
AuthCachingPolicy	AuthCachingPolicy provides the ability to annotation basic auth providers with what level of caching a request signer should try to follow.
AuthClientException	Authentication client exception.
AuthClientForbiddenException	Exception thrown when the client failed to authorize to the auth service using configured key suppliers
AuthClientNotAuthorizedException	Exception thrown when the client failed to authenticate to the auth service using configured key suppliers.
AuthenticationDetailsProvider	Interface defining a BasicAuthenticationDetailsProvider that also provides the individual components used to create the keyId.
AuthnClientFilter	Filter that injects authentication headers into the request.
AuthServerException	Exception thrown when something goes wrong on the authentication server.
AuthServerUnavailableException	Exception thrown when the authentication server is unavailable.
AuthUtils	Utilities dealing with authorization.
BaseAsyncClient
BaseSyncClient
BasicAuthenticationDetailsProvider	Base interface used provide required information to sign requests to Oracle Cloud Infrastructure.
BasicConfigFileAuthenticationProvider	Interface defining AuthenticationDetailsProvider that also returns PEM file path and a list of ClientConfigurators
BmcEnum
BmcException
BmcGenericRetrier	A generic retrier that can be used to implement custom retry behavior for specific types of calls.
BmcGenericWaiter	BmcGenericWaiter is a Waiter that provides a generic foundation to build more custom waiters for specific types of calls.
BmcGenericWaiter.WaitConditionFailedException	Exception indicating the the condition being waited on was not met before the termination condition was satisfied.
BmcRequest<B>	Request base class.
BmcRequest.Builder<T extends BmcRequest<B>,B>	Builder interface for requests.
BmcResponse
BmcResponse.Builder<T extends BmcResponse>
CircuitBreakerHelper
CircuitBreakerUtils
ClientBuilderBase<B extends ClientBuilderBase,C>	Base client builder.
ClientCall<REQ extends BmcRequest<?>,RESP extends BmcResponse,RESP_BUILDER extends BmcResponse.Builder<RESP>>
ClientCompatibilityChecker
ClientCompatibilityChecker.VersionCompatibilityCheckMode
ClientConfiguration	This class provides configuration options for client requests.
ClientConfiguration.ClientConfigurationBuilder
ClientConfigurator	Configurator allowing SDK users to customize the underlying REST client.
ClientIdFilter	Filter that adds the client identifier headers to every request.
ClientRuntime	This class provides client info that will be sent to the servers as part of each request.
ClientThreadFactory	A thread factory for use in clients.
ClientThreadFactory.Builder
CollectionFormatType	For list collections that we send in the query string, describes the different ways we can encode it in the query string.
ComparableVersion
CompositeClientConfigurator	A client configurator composed of other client configurators.
ConfigFileAuthenticationDetailsProvider	Implementation of AuthenticationDetailsProvider that uses a standard OCI configuration file as an input.
ConfigFileAuthenticationDetailsProvider.ConfigFileInstancePrincipalAuthenticationDetailsProvider
ConfigFileAuthenticationDetailsProvider.ConfigFileResourcePrincipalAuthenticationDetailsProvider
ConfigFileAuthenticationDetailsProvider.ConfigFileSimpleAuthenticationDetailsProvider
ConfigFileDelegationTokenUtils	This class allows users to load delegation token from the config file
ConfigFileReader	Simple implementation to read OCI configuration files.
ConfigFileReader.ConfigFile	ConfigFile represents a simple lookup mechanism for a OCI config file.
ConfigurableRefreshOnNotAuthenticatedProvider<T>	For authentication providers with refreshable authentication data (e.g.
Constants
CrossTenancyRequestClientFilter	Filter that injects authentication headers into the request.
CrossTenancyRequestConfigurator	A configurator that causes the client to set the cross-tenancy request header.
CustomerAuthenticationDetailsProvider
CustomerKeyIdFormatter	Formatter used to create the correct ‘keyId’ needed for signing requests.
DefaultConfigurator	DefaultConfigurator handles basic configuration of clients under different environments.
DefaultConfigurator.NonBuffering	A ClientConfigurator for a client that does not buffer requests in memory.
DefaultConnectorConfigurator	DefaultConnectorConfigurator represents the basic behavior of the transport layer.
DefaultEndpointConfiguration	DefaultEndpointConfiguration provides a way to construct the host endpoint for a service given a template and some variables based on the default Oracle Cloud Infrastructure naming convention.
DefaultLeafRptPathProvider	This path provider makes sure the behavior happens with the correct fallback.
DefaultRequestSigner	Class that exposes a way to create a RequestSigner for use with OCI.
DefaultRequestSignerFactory	Factory class to create RequestSigner instances.
DefaultRetryCondition	Class that represents the conditions documented in https://docs.oracle.com/iaas/Content/API/References/apierrors.htm for which the operation may be retried.
DefaultRptPathProvider	This path provider makes sure the behavior happens with the correct fallback.
DefaultServiceAccountTokenProvider	Implementation of ServiceAccountTokenSupplier that allows to pass in a token path to read kubernetes service account token If not set, then use default service account token path /var/run/secrets/kubernetes.io/serviceaccount/toke
DelayStrategy	Interface that defines how long to wait between poll attempts.
DelegationTokenConfigurator	Configurator that injects a delegation token on every request.
EndpointBuilder	EndpointBuilder provides a wrapper to construct the appropriate endpoint for a service.
EndpointTemplateForOptionsUtils
EnvironmentRptPathProvider	This path provider reads the path and resource id from environment variables
EnvironmentRptPathProvider.LeafResourceRptPathProvider	This path provider reads the path and resource id for leaf resource from environment variables
EnvironmentVariablesHelper
ErrorConsumer<REQUEST>	Basic Consumer type to handle failed calls.
ExponentialBackoffDelayStrategy	Delay strategy that increases the wait time exponentially until a max time has been reached.
ExponentialBackoffDelayStrategyWithJitter	Delay strategy that increases the wait time exponentially until a max time has been reached.
FederationClient	Defines a basic interface for a federation endpoint that provides a security token for authentication.
FileBasedKeySupplier
FileBasedResourcePrincipalFederationClient	This class gets a security token from file.
FileUtils	Utilities for interacting with files.
FixedContentKeySupplier	This is a SessionKeySupplier which fakes the ability to refresh its contained key.
FixedContentResourcePrincipalFederationClient	This class returns a security token, supplied as a fixed value.
FixedTimeDelayStrategy	Delay strategy that waits a constant amount of time between poll attempts.
ForwardingAsyncHandler<REQUEST,RESPONSE>
ForwardingX509Certificate	Simple forwarding X509Cerficate class.
GenericWaiter	Provides a basic waiter that will periodically poll for an update until a desired condition is met.
GetResourcePrincipalSessionTokenRequest	Class is immutable.
GetResourcePrincipalTokenResponse
HasContentLength	Interface implemented by requests that have a getter for contentLength
HasEffectiveClientConfigurator	Interface implemented by classes that provide an effective ClientConfigurator
HeaderUtils	Utilities to deal with header values.
HttpDateUtils	Date parsing utils.
ImdsRptPathProvider	This path provider is used as a fallback when environment variables are not set.
InstancePrincipalsAuthenticationDetailsProvider	Implementation of BasicAuthenticationDetailsProvider that integrates with instance principal authentication endpoints to generate service tokens used for actual signing.
InstancePrincipalsAuthenticationDetailsProvider.InstancePrincipalsAuthenticationDetailsProviderBuilder	Builder for InstancePrincipalsAuthenticationDetailsProviderBuilder.
InstancePrincipalUnavailableException	Failed to fetch Instance Principal cert from the Instance Metadata Service.
InternalBuilderAccess
InternalSdk	Annotation to indicate a class or method is only meant for internal SDK usage, and may break/change without notice.
JavaRuntimeUtils	Various runtime utils.
JavaRuntimeUtils.JreVersion	JRE version as interpreted by the SDK.
JerseyLoggingClientConfigurator	Deprecated. use {@link com.oracle.bmc.http.client.HttpClientBuilder#}
JsonConverter	A helper class to support json related operations
JWK	Representation of a RSA public key in JSON Web Key (JWK) format.
JwtClaimsSet	JSON Web Token Claim Set.
KeepOpenInputStream	A wrapper around an InputStream that turns the close method into a no-op, and requires the calling of the doClose method instead.
KeyIdType	An enum for KeyId types and associated patterns
KeyPairAuthenticationDetailProvider	Resource Principals V2 using public/private key to sign the request.
KeySupplier<T>	Interface for anything that can get supply a Key of type T given a keyId
LogHeadersFilter	Filter that logs all of the outbound and inbound headers at debug level.
MaxAttemptsTerminationStrategy	Termination strategy that allows up to X attempts before terminating.
MaxTimeTerminationStrategy	Termination strategy that allows up to X milliseconds to have elapsed before terminating.
NameUtils	Utility functions related to naming
NoOpAsyncHandler<REQUEST,RESPONSE>	An async handler that doesn’t do anything.
OCID	Oracle Cloud Infrastructure unique ID.
ParamEncoder
PEMFileRSAPrivateKeySupplier	An implementation of KeySupplier that supplies a RSA private key from a PEM file.
PEMFileRSAPrivateKeySupplier.PEMFileRSAPrivateKeySupplierException	An exception in the PEMFileRSAPrivateKeySupplier.
Priorities
ProvidesClientConfigurators	An interface that has the API to return a list of ClientConfigurators
ProvidesConfigurableRefresh	An interface that has the API to return refresh security token after if the token expires within a configurable time
ProvidesCustomRequestSigner
Range	Class specifying a range-request is being made.
Realm	Class containing all Identity realms.
RefreshableOnNotAuthenticatedProvider<T>	For authentication providers with refreshable authentication data (e.g.
RefreshAuthTokenTransformingFuture<FROM,TO>	Deprecated. in favor of RefreshAuthTokenWrapper – versions after 1.25.1 do not use RefreshAuthTokenTransformingFuture anymore
RefreshAuthTokenWrapper<REQUEST extends BmcRequest<?>,RESPONSE>	Combined future and callbacks for asynchronous requests intended to work with some authenticated calls, like instance principals.
RefreshAuthTokenWrappingAsyncHandler<REQUEST,RESPONSE>	Deprecated. in favor of RefreshAuthTokenWrapper – versions after 1.25.1 do not use RefreshAuthTokenWrappingAsyncHandler anymore
Region	Class containing all of the known Regions that can be contacted.
RegionalClientBuilder<B extends RegionalClientBuilder,C>	A builder for clients that can be configured to target a certain region
RegionAlloySchema
RegionProvider	A region provider has the API to return the region.
RegionSchema	Class representing RegionSchema blob that can be used for parsing out region info details.
RequestBuilderAndToken<T>	A container class for a request builder and next page token.
RequestSigner	Main entry point for signing a request
RequestSignerException
RequestSignerFactory	Factory class to create RequestSigner instances.
RequestSignerImpl	Implementation of the RequestSigner interface
RequestSignerImpl.SigningConfiguration	Basic configuration of what headers to sign.
RequestSigningFilter	Filter that adds authentication and User-Agent headers to a request.
ResettableFileInputStream	A wrapper around a FileInputStream that provides mark-and-reset capabilities.
ResourcePrincipalAuthenticationDetailsProvider	This constructs a default implementation of the ResourcePrincipalAuthenticationDetailsProvider, constructed in accordance with the following environment variable settings: OCI_RESOURCE_PRINCIPAL_VERSION:
ResourcePrincipalAuthenticationDetailsProvider.ClaimKeys
ResourcePrincipalAuthenticationDetailsProvider.ResourcePrincipalAuthenticationDetailsProviderBuilder	Builder for ResourcePrincipalAuthenticationDetailsProvider that understands the V2.2 configuration
ResourcePrincipalsFederationClient	This class gets a security token from the auth service by signing the request with a PKI issued leaf certificate, passing along a temporary public key that is bounded to the the security token, and the leaf certificate.
ResourcePrincipalsV3AuthenticationDetailsProvider	This constructs a default implementation of the ResourcePrincipalAuthenticationDetailsProvider, integrates principal authentication services to generate resource principal session token used for actual signing.
ResourcePrincipalsV3AuthenticationDetailsProvider.ResourcePrincipalsV3AuthenticationDetailsProviderBuilder	Builder for ResourcePrincipalsAuthenticationDetailsProviderBuilder.
ResourcePrincipalsV3FederationClient	This class gets a security token from the auth service by fetching the RPST1 and then passing along the RPST1 to get RPT2 and further get security token RPST2 from the auth service, this nested fetching of security token continues for 10 levels or when the opc-parent-url header in the rpt response is the same as the rpt endpoint
ResourcePrincipalV2FederationClient	This class gets a security token from the auth service by signing the request with the provided private key.
ResponseErrorBmcExceptionFactory	Default ResponseErrorRuntimeExceptionFactory implementation that knows how to deserialize error responses using the ResponseHelper.ErrorCodeAndMessage model.
ResponseErrorRuntimeExceptionFactory<ERRMODEL,E extends SdkRuntimeException>	Factory interface that defines the model type of a response error (used for deserializing a response error), as well as how to create a SdkRuntimeException that allows access to that deserialized error.
ResponseHelper	A BmcException exception is thrown in response to failures from a REST endpoint.
ResponseHelper.ErrorCodeAndMessage
ResponseHelper.ErrorCodeAndMessage.Builder
ResponseIterable<REQUESTBUILDER,REQUEST,RESPONSE>	An iterable which can be used to iterate over responses returned from calling a list operation.
ResponseIterator<REQUESTBUILDER,REQUEST,RESPONSE>	An iterator for iterating over response objects returned from a list operation.
ResponseRecordIterable<REQUESTBUILDER,REQUEST,RESPONSE,ITEMTYPE>	An iterable which can be used to iterate over the models/resources returned by a list operation.
ResponseRecordIterator<REQUESTBUILDER,REQUEST,RESPONSE,ITEMTYPE>	An iterator for iterating over response objects returned from a list operation.
Retriers	Group of utility methods to configure the SDK retry behavior
RetryCondition	Interface that defines the condition for which a retry may be attempted.
RetryConfiguration	Configuration used for retrying.
RetryConfiguration.Builder	Builder class for retry configuration.
RetryOnOpenCircuitBreakerDefaultRetryCondition	Class that may retry for the conditions documented in https://docs.oracle.com/iaas/Content/API/References/apierrors.htm and when the CircuitBreaker is OPEN.
RetryOptions	Defines the options when retrying
RetryTokenUtils	Utility class that adds the opc-retry-token header to the request
RptPathProvider	Root interface for classes providing the complete path for resource principal token.
SdkClients	Internal Annotation to trigger the creation of SDK clients.
SdkRuntimeException	Parent class of BmcException, as well as any RuntimeException that is defined for use by the ResponseErrorRuntimeExceptionFactory injected into ClientCall.
SecurityTokenAdapter
Service	Interface representing a service definition.
ServiceAccountTokenSupplier	A ServiceAccountTokenSupplier is responsible for providing kubernetes service account token used for oke workload identity
ServiceDetails	Class representing details of the service
Services	Factory class to create new Service instances.
Services.ServiceBuilder
SessionKeySupplier	A session key supplier is responsible for providing public/private key pairs that will be used to both fetch federated service tokens and to sign individual requests to OCI.
SessionTokenAuthenticationDetailsProvider	Implementation of AuthenticationDetailsProvider that uses a session token for authentication.
SessionTokenAuthenticationDetailsProvider.SessionToken
SessionTokenAuthenticationDetailsProvider.SessionToken.Builder
SessionTokenAuthenticationDetailsProvider.SessionTokenAuthenticationDetailsProviderBuilder	Builder for SessionTokenAuthenticationDetailsProvider.
SessionTokenAuthenticationDetailsProvider.SessionTokenRefreshRequest
SessionTokenAuthenticationDetailsProvider.SessionTokenRefreshRequest.SessionTokenRequest
SignatureSigner	The SignatureSigner is used to actually sign a message with a private key.
SignedRequestException	Generic exception exposed to callers of the HTTP Signature code
SignedRequestVersion	List of supported signed request versions with associated version rules.
SigningStrategy	Enum for the various signing strategies used by OCI.
SimpleAuthenticationDetailsProvider	Basic implementation of AuthenticationDetailsProvider that just returns configured values.
SimpleAuthenticationDetailsProvider.SimpleAuthenticationDetailsProviderBuilder
SimplePrivateKeySupplier	Simple Supplier for the private key that handles missing files.
SimpleWaiterImpl<REQUEST,RESPONSE>	SimpleWaiterImpl is a basic wrapper around a Callable that executes an action, and provides methods to either execute it synchronously or asynchronously.
SpiClientConfigurator	Configurator allowing internal SDK users to enable downstream propagation of opc-request-id.
StreamClosingAsyncHandler<REQUEST extends BmcRequest<?>,RESPONSE>	A wrapper around an async handler that closes the stream at the end of a request, if the body is a stream.
StreamUtils	Utility methods to work with streams.
StringPrivateKeySupplier	Supplier for private key in String format
StringRptPathProvider	This path provider directly takes a string and returns it.
StringUtils	String manipulation utilities.
SuppliedServiceAccountTokenProvider	Implementation of ServiceAccountTokenSupplier that allows to pass in a token to be used as a kubernetes service account token.
SyncFutureWaiter	Helper class that can wait for the result of some future, and do some work registered through the Executor interface while waiting.
TerminationStrategy	Defines the strategy that determines when no more poll attempts should be made.
TokenRefreshRetrier	A custom retrier that refreshes tokens and retries the operation in case of authentication failures.
TransformingFuture<FROM,TO>	Future that both delegates to another one and provides the ability to transform the response to another type.
URLBasedX509CertificateSupplier	X509CertificateSupplier implementation that reads both certificate and private key off of URL.
URLBasedX509CertificateSupplier.ResourceDetails
URLBasedX509CertificateSupplier.ResourceDetails.ResourceDetailsBuilder
Validate	Argument validation.
Version	The rules for a signed request version, i.e., supported algorithms, supported keyId formats.
Version.Error
VisibleForTesting
Waiter<REQUEST,RESPONSE>	Waiter provides a standard interface for waiting on some condition in either a blocking or asynchronous manner.
WaiterConfiguration	Configuration used when invoking a waiter loop.
WaiterConfiguration.WaitContext	The context that should be maintained by the wait loop.
Waiters
WaiterScheduler	Abstraction for GenericWaiter to implement the “schedule” functionality to implement asynchronous waiting.
WrappedByteArrayInputStream	Basic extension to ByteArrayInputStream that lets you create duplicate streams from the same underlying byte buffer.
WrappedFileInputStream	Simple wrapper over FileInputStream that also exposes the File used to create the stream.
X509CertificateSupplier	An interface to provide X509 certificate for a federated client.
X509CertificateSupplier.CertificateAndPrivateKeyPair
X509CertificateWithOriginalPem	X509CertificateWithOriginalPem is specifically used so that we can keep track of the original PEM encoded certificate, along with the parsed X509Certificate that it creates.
X509FederationClient	This class gets a security token from the auth service by signing the request with a PKI issued leaf certificate, passing along a temporary public key that is bounded to the the security token, and the leaf certificate.
X509FederationClient.SecurityToken
X509FederationClient.X509FederationRequest	Class is immutable.