org.opencastproject.security.util

Class StandAloneTrustedHttpClientImpl

java.lang.Object

org.opencastproject.security.util.StandAloneTrustedHttpClientImpl

All Implemented Interfaces:

TrustedHttpClient

public final class StandAloneTrustedHttpClientImpl
extends Object
implements TrustedHttpClient

An http client that executes secure (though not necessarily encrypted) http requests. Unlike the original TrustedHttpClientImpl this version is not bound to an OSGi environment.

Nested Class Summary

Nested classes/interfaces inherited from interface org.opencastproject.security.api.TrustedHttpClient

TrustedHttpClient.RequestRunner<A>

Field Summary

Fields

Modifier and Type	Field and Description
static String	AUTHORIZATION_HEADER_NAME Header name used to request a new nonce from a server a request is sent to.
static int	DEFAULT_CONNECTION_TIMEOUT The default time until a connection attempt fails
static int	DEFAULT_NONCE_TIMEOUT_RETRIES The default number of times to attempt a request after it has failed due to a nonce expiring.
static int	DEFAULT_RETRY_BASE_DELAY The default amount of time to wait after a nonce timeout.
static int	DEFAULT_RETRY_MAXIMUM_VARIABLE_TIME Default maximum amount of time in a random range between 0 and this value to add to the base time.
static int	DEFAULT_SOCKET_TIMEOUT The default time between packets that causes a connection to fail
static String	DIGEST_AUTH
static String	REQUESTED_AUTH_HEADER

Constructor Summary

Constructors

Constructor and Description
StandAloneTrustedHttpClientImpl(String user, String pass, Option<Integer> nonceTimeoutRetries, Option<Integer> retryBaseDelay, Option<Integer> retryMaximumVariableTime)

Method Summary

Modifier and Type	Method and Description
void	close(org.apache.http.HttpResponse response) Closes this response.
org.apache.http.HttpResponse	execute(org.apache.http.client.methods.HttpUriRequest httpUriRequest) Executes an HttpRequest using a secure, but not necessarily encrypted, http connection.
org.apache.http.HttpResponse	execute(org.apache.http.client.methods.HttpUriRequest httpUriRequest, int connectionTimeout, int socketTimeout) Executes an HttpRequest using a secure, but not necessarily encrypted, http connection, waiting for the specified timeouts.
<T> T	execute(org.apache.http.client.methods.HttpUriRequest httpUriRequest, org.apache.http.client.ResponseHandler<T> responseHandler) Executes an HttpRequest using a secure, but not necessarily encrypted, http connection.
<T> T	execute(org.apache.http.client.methods.HttpUriRequest httpUriRequest, org.apache.http.client.ResponseHandler<T> responseHandler, int connectionTimeout, int socketTimeout) Executes an HttpRequest using a secure, but not necessarily encrypted, http connection, waiting for the specified timeouts.
<A> Function<Function<org.apache.http.HttpResponse,A>,Either<Exception,A>>	run(org.apache.http.client.methods.HttpUriRequest httpUriRequest) Create a function that takes a function to handle the response of the given request returning either a result or any occurred exception.
static <A> Function<Function<org.apache.http.HttpResponse,A>,Either<Exception,A>>	run(TrustedHttpClient client, org.apache.http.client.methods.HttpUriRequest httpUriRequest)
<A> TrustedHttpClient.RequestRunner<A>	runner(org.apache.http.client.methods.HttpUriRequest req) Create a request runner to execute the request.
static <A> TrustedHttpClient.RequestRunner<A>	runner(TrustedHttpClient client, org.apache.http.client.methods.HttpUriRequest req)

Methods inherited from class java.lang.Object

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

Field Detail

AUTHORIZATION_HEADER_NAME

public static final String AUTHORIZATION_HEADER_NAME

Header name used to request a new nonce from a server a request is sent to.

See Also:

Constant Field Values

REQUESTED_AUTH_HEADER

public static final String REQUESTED_AUTH_HEADER

See Also:

Constant Field Values

DIGEST_AUTH

public static final String DIGEST_AUTH

See Also:

Constant Field Values

DEFAULT_CONNECTION_TIMEOUT

public static final int DEFAULT_CONNECTION_TIMEOUT

The default time until a connection attempt fails

See Also:

Constant Field Values

DEFAULT_SOCKET_TIMEOUT

public static final int DEFAULT_SOCKET_TIMEOUT

The default time between packets that causes a connection to fail

See Also:

Constant Field Values

DEFAULT_NONCE_TIMEOUT_RETRIES

public static final int DEFAULT_NONCE_TIMEOUT_RETRIES

The default number of times to attempt a request after it has failed due to a nonce expiring.

See Also:

Constant Field Values

DEFAULT_RETRY_BASE_DELAY

public static final int DEFAULT_RETRY_BASE_DELAY

The default amount of time to wait after a nonce timeout.

See Also:

Constant Field Values

DEFAULT_RETRY_MAXIMUM_VARIABLE_TIME

public static final int DEFAULT_RETRY_MAXIMUM_VARIABLE_TIME

Default maximum amount of time in a random range between 0 and this value to add to the base time.

See Also:

Constant Field Values

Constructor Detail

StandAloneTrustedHttpClientImpl

public StandAloneTrustedHttpClientImpl(String user,
                                       String pass,
                                       Option<Integer> nonceTimeoutRetries,
                                       Option<Integer> retryBaseDelay,
                                       Option<Integer> retryMaximumVariableTime)

Method Detail

run

public <A> Function<Function<org.apache.http.HttpResponse,A>,Either<Exception,A>> run(org.apache.http.client.methods.HttpUriRequest httpUriRequest)

Description copied from interface: TrustedHttpClient

Create a function that takes a function to handle the response of the given request returning either a result or any occurred exception.

Specified by:

run in interface TrustedHttpClient

Parameters:

httpUriRequest - The http request

Returns:

HttpUriRequest -> (HttpResponse -> A) -> Either Exception A

run

public static <A> Function<Function<org.apache.http.HttpResponse,A>,Either<Exception,A>> run(TrustedHttpClient client,
                                                                                             org.apache.http.client.methods.HttpUriRequest httpUriRequest)

runner

public <A> TrustedHttpClient.RequestRunner<A> runner(org.apache.http.client.methods.HttpUriRequest req)

Description copied from interface: TrustedHttpClient

Create a request runner to execute the request.

This method replaces TrustedHttpClient.run(org.apache.http.client.methods.HttpUriRequest) to avoid type annotation mess. To actually run the request call the runners run method.

Specified by:

runner in interface TrustedHttpClient

runner

public static <A> TrustedHttpClient.RequestRunner<A> runner(TrustedHttpClient client,
                                                            org.apache.http.client.methods.HttpUriRequest req)

execute

public org.apache.http.HttpResponse execute(org.apache.http.client.methods.HttpUriRequest httpUriRequest)
                                     throws TrustedHttpClientException

Description copied from interface: TrustedHttpClient

Executes an HttpRequest using a secure, but not necessarily encrypted, http connection.

Specified by:

execute in interface TrustedHttpClient

Parameters:

httpUriRequest - The http request

Returns:

the http response returned by the server

Throws:

TrustedHttpClientException

execute

public org.apache.http.HttpResponse execute(org.apache.http.client.methods.HttpUriRequest httpUriRequest,
                                            int connectionTimeout,
                                            int socketTimeout)
                                     throws TrustedHttpClientException

Description copied from interface: TrustedHttpClient

Executes an HttpRequest using a secure, but not necessarily encrypted, http connection, waiting for the specified timeouts.

Specified by:

execute in interface TrustedHttpClient

Parameters:

httpUriRequest - The http request

connectionTimeout - the wait time in milliseconds at which a connection attempt will throw

socketTimeout - the maximum time in milliseconds allowed between packets before this method will throw

Returns:

the http response returned by the server

Throws:

TrustedHttpClientException

execute

public <T> T execute(org.apache.http.client.methods.HttpUriRequest httpUriRequest,
                     org.apache.http.client.ResponseHandler<T> responseHandler,
                     int connectionTimeout,
                     int socketTimeout)
              throws TrustedHttpClientException

Description copied from interface: TrustedHttpClient

Executes an HttpRequest using a secure, but not necessarily encrypted, http connection, waiting for the specified timeouts.

Specified by:

execute in interface TrustedHttpClient

Parameters:

httpUriRequest - The http request

responseHandler - the response handler

connectionTimeout - the wait time in milliseconds at which a connection attempt will throw

socketTimeout - the maximum time in milliseconds allowed between packets before this method will throw

Returns:

the http response returned by the server

Throws:

TrustedHttpClientException

close

public void close(org.apache.http.HttpResponse response)

Closes this response. The caller must call close() once finished reading the response.

Specified by:

close in interface TrustedHttpClient

Parameters:

response - The response to close

See Also:

TrustedHttpClient.close(org.apache.http.HttpResponse)

execute

public <T> T execute(org.apache.http.client.methods.HttpUriRequest httpUriRequest,
                     org.apache.http.client.ResponseHandler<T> responseHandler)
              throws TrustedHttpClientException

Executes an HttpRequest using a secure, but not necessarily encrypted, http connection.

Specified by:

execute in interface TrustedHttpClient

Parameters:

httpUriRequest - The http request

Returns:

the http response returned by the server

Throws:

TrustedHttpClientException

See Also:

TrustedHttpClient.execute(org.apache.http.client.methods.HttpUriRequest, org.apache.http.client.ResponseHandler)