com.oracle.bmc.http.signing

Class RequestSigningFilter

java.lang.Object

com.oracle.bmc.http.internal.AuthnClientFilter

com.oracle.bmc.http.signing.RequestSigningFilter

All Implemented Interfaces:

javax.ws.rs.client.ClientRequestFilter

@Priority(value=1000)
public class RequestSigningFilter
extends AuthnClientFilter

Filter that adds authentication and User-Agent headers to a request.

Field Summary

Fields inherited from class com.oracle.bmc.http.internal.AuthnClientFilter

SIGNING_STRATEGY_PROPERTY_NAME

Constructor Summary

Constructors

Constructor and Description
RequestSigningFilter(@NonNull RequestSigner requestSigner) Create a new RequestSigningFilter instance
RequestSigningFilter(@NonNull RequestSigner requestSigner, @NonNull Map<SigningStrategy,RequestSigner> requestSigners) Create a new RequestSigningFilter instance

Method Summary

Modifier and Type	Method and Description
void	filter(@NonNull javax.ws.rs.client.ClientRequestContext requestContext) Filter method called before a request has been dispatched to a client transport layer.
static RequestSigningFilter	fromAuthProvider(@NonNull BasicAuthenticationDetailsProvider authenticationDetailsProvider) Create a new RequestSigningFilter instance from an existing authentication details provider
static RequestSigningFilter	fromConfigFile(@NonNull String configurationFilePath, String profile) Create a new RequestSigningFilter instance from a config file

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

RequestSigningFilter

public RequestSigningFilter(@NonNull
                            @NonNull RequestSigner requestSigner,
                            @NonNull
                            @NonNull Map<SigningStrategy,RequestSigner> requestSigners)

Create a new RequestSigningFilter instance

Parameters:

requestSigner - the request signer instance

requestSigners - the strategies used to sign requests, per signing strategy

RequestSigningFilter

public RequestSigningFilter(@NonNull
                            @NonNull RequestSigner requestSigner)

Create a new RequestSigningFilter instance

Parameters:

requestSigner - the request signer instance

Method Detail

fromAuthProvider

public static RequestSigningFilter fromAuthProvider(@NonNull
                                                    @NonNull BasicAuthenticationDetailsProvider authenticationDetailsProvider)

Create a new RequestSigningFilter instance from an existing authentication details provider

Parameters:

authenticationDetailsProvider - the authentication details provider to use

Returns:

a new RequestSigningFilter instance

fromConfigFile

public static RequestSigningFilter fromConfigFile(@NonNull
                                                  @NonNull String configurationFilePath,
                                                  @Nullable
                                                  String profile)
                                           throws IOException

Create a new RequestSigningFilter instance from a config file

Parameters:

configurationFilePath - the path of the config file

profile - the profile to use

Returns:

a new RequestSigningFilter instance

Throws:

IOException - if the config file could not be read

filter

public void filter(@NonNull
                   @NonNull javax.ws.rs.client.ClientRequestContext requestContext)
            throws IOException

Filter method called before a request has been dispatched to a client transport layer.

Filters in the filter chain are ordered according to their javax.annotation.Priority class-level annotation value.

Specified by:

filter in interface javax.ws.rs.client.ClientRequestFilter

Overrides:

filter in class AuthnClientFilter

Parameters:

requestContext - request context.

Throws:

IOException - if an I/O exception occurs.