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

public Class RequestSigningFilter

extends AuthnClientFilter
Class Inheritance
Imports
com.oracle.bmc.ClientRuntime, com.oracle.bmc.auth.BasicAuthenticationDetailsProvider, .ConfigFileAuthenticationDetailsProvider, com.oracle.bmc.http.client.HttpRequest, com.oracle.bmc.http.internal.AuthnClientFilter, jakarta.annotation.Nonnull, .Nullable, java.io.IOException, java.util.Collections, .HashMap, .Map
Filter that adds authentication and User-Agent headers to a request.

Field Summary

Inherited from com.oracle.bmc.http.internal.AuthnClientFilter:
SIGNING_STRATEGY_PROPERTY_NAME

Constructor Summary

AccessConstructor and Description
public
RequestSigningFilter(final RequestSigner
the request signer instance
requestSigner, final Map<SigningStrategy, RequestSigner>
the strategies used to sign requests, per signing strategy
requestSigners)

Create a new RequestSigningFilter instance

public
RequestSigningFilter(final RequestSigner
the request signer instance
requestSigner)

Create a new RequestSigningFilter instance

Method Summary

Modifier and TypeMethod and Description
public static RequestSigningFilter

Returns:

a new RequestSigningFilter instance
fromAuthProvider(final BasicAuthenticationDetailsProvider
the authentication details provider to use
authenticationDetailsProvider)

Create a new RequestSigningFilter instance from an existing authentication details provider

public static RequestSigningFilter

Returns:

a new RequestSigningFilter instance
fromConfigFile(final String
the path of the config file
configurationFilePath, final String
the profile to use
profile)

Create a new RequestSigningFilter instance from a config file

public void
intercept(HttpRequest request)

Overrides com.oracle.bmc.http.internal.AuthnClientFilter.intercept.

Implements com.oracle.bmc.http.client.RequestInterceptor.intercept.

Constructor Detail

RequestSigningFilterback to summary
public RequestSigningFilter(final RequestSigner requestSigner, final Map<SigningStrategy, RequestSigner> requestSigners)

Create a new RequestSigningFilter instance

Parameters
requestSigner:RequestSigner

the request signer instance

requestSigners:Map<SigningStrategy, RequestSigner>

the strategies used to sign requests, per signing strategy

RequestSigningFilterback to summary
public RequestSigningFilter(final RequestSigner requestSigner)

Create a new RequestSigningFilter instance

Parameters
requestSigner:RequestSigner

the request signer instance

Method Detail

fromAuthProviderback to summary
public static RequestSigningFilter fromAuthProvider(final BasicAuthenticationDetailsProvider authenticationDetailsProvider)

Create a new RequestSigningFilter instance from an existing authentication details provider

Parameters
authenticationDetailsProvider:BasicAuthenticationDetailsProvider

the authentication details provider to use

Returns:RequestSigningFilter

a new RequestSigningFilter instance

fromConfigFileback to summary
public static RequestSigningFilter fromConfigFile(final String configurationFilePath, final String profile) throws IOException

Create a new RequestSigningFilter instance from a config file

Parameters
configurationFilePath:String

the path of the config file

profile:String

the profile to use

Returns:RequestSigningFilter

a new RequestSigningFilter instance

Exceptions
IOException:
if the config file could not be read
interceptback to summary
public void intercept(HttpRequest request)

Overrides com.oracle.bmc.http.internal.AuthnClientFilter.intercept.

Implements com.oracle.bmc.http.client.RequestInterceptor.intercept.

Annotations
@Override