Top Description Fields Constructors Methods
com.oracle.bmc.http.signing.internal

public Class DefaultRequestSignerFactory

extends Object
implements RequestSignerFactory
Class Inheritance
All Implemented Interfaces
com.oracle.bmc.http.signing.RequestSignerFactory
Imports
java.security.interfaces.RSAPrivateKey, java.util.Collections, .HashMap, .Map, .Optional, java.util.function.Supplier, com.oracle.bmc.InternalSdk, .Service, com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider, .AuthCachingPolicy, .BasicAuthenticationDetailsProvider, com.oracle.bmc.http.signing.RequestSigner, .RequestSignerFactory, .SigningStrategy
Factory class to create RequestSigner instances. Takes care of setting up the appropriate suppliers based on the cacheability of the credentials (indicated by AuthCachingPolicy. By default, all credentials are cacheable.

This factory supports authentication providers that inherit from BasicAuthenticationDetailsProvider.

Field Summary

Modifier and TypeField and Description
private final SigningStrategy
signingStrategy

Constructor Summary

AccessConstructor and Description
public
DefaultRequestSignerFactory(final SigningStrategy signingStrategy)

Method Summary

Modifier and TypeMethod and Description
public static Map<SigningStrategy, RequestSignerFactory>

Returns:

default request signer factories
createDefaultRequestSignerFactories()

Create the default request signer factories.

protected Supplier<String>
createKeyIdSupplier(final BasicAuthenticationDetailsProvider authenticationDetailsProvider, final AuthCachingPolicy policy)

public static KeySupplier<RSAPrivateKey>
createKeySupplier(final BasicAuthenticationDetailsProvider authenticationDetailsProvider, final AuthCachingPolicy policy)

public RequestSigner
createRequestSigner(Service
The service type.
service, AbstractAuthenticationDetailsProvider
The authentication details provider.
abstractAuthProvider)

Implements com.oracle.bmc.http.signing.RequestSignerFactory.createRequestSigner.

Creates a new RequestSigner instance from the given provider and type of service.

public static AuthCachingPolicy
getAuthCachingPolicy(final BasicAuthenticationDetailsProvider authenticationDetailsProvider)

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

signingStrategyback to summary
private final SigningStrategy signingStrategy

Constructor Detail

DefaultRequestSignerFactoryback to summary
public DefaultRequestSignerFactory(final SigningStrategy signingStrategy)
Annotations
@java.beans.ConstructorProperties
@InternalSdk
backwardCompatibilityRequired:true

Method Detail

createDefaultRequestSignerFactoriesback to summary
public static Map<SigningStrategy, RequestSignerFactory> createDefaultRequestSignerFactories()

Create the default request signer factories.

Returns:Map<SigningStrategy, RequestSignerFactory>

default request signer factories

createKeyIdSupplierback to summary
protected Supplier<String> createKeyIdSupplier(final BasicAuthenticationDetailsProvider authenticationDetailsProvider, final AuthCachingPolicy policy)
createKeySupplierback to summary
public static KeySupplier<RSAPrivateKey> createKeySupplier(final BasicAuthenticationDetailsProvider authenticationDetailsProvider, final AuthCachingPolicy policy)
createRequestSignerback to summary
public RequestSigner createRequestSigner(Service service, AbstractAuthenticationDetailsProvider abstractAuthProvider)

Implements com.oracle.bmc.http.signing.RequestSignerFactory.createRequestSigner.

Doc from com.oracle.bmc.http.signing.RequestSignerFactory.createRequestSigner.

Creates a new RequestSigner instance from the given provider and type of service.

Note, service parameter is not used by this factory.

Parameters
service:Service

The service type.

abstractAuthProvider:AbstractAuthenticationDetailsProvider

The authentication details provider.

Returns:RequestSigner

A new RequestSigner instance.

Annotations
@Override
getAuthCachingPolicyback to summary
public static AuthCachingPolicy getAuthCachingPolicy(final BasicAuthenticationDetailsProvider authenticationDetailsProvider)