org.opencastproject.security.api

Interface TrustedHttpClient

All Known Implementing Classes:

StandAloneTrustedHttpClientImpl

public interface TrustedHttpClient

Provides secured http client components to access to protected resources.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	TrustedHttpClient.RequestRunner<A> Request runner encapsulating request resource management.

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) Deprecated. use runner(org.apache.http.client.methods.HttpUriRequest)
<A> TrustedHttpClient.RequestRunner<A>	runner(org.apache.http.client.methods.HttpUriRequest req) Create a request runner to execute the request.

Method Detail

run

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

Deprecated. use runner(org.apache.http.client.methods.HttpUriRequest)

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

Parameters:

httpUriRequest - The http request

Returns:

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

runner

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

Create a request runner to execute the request.

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

execute

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

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

Parameters:

httpUriRequest - The http request

Returns:

the http response returned by the server

Throws:

TrustedHttpClientException

execute

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

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

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

<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.

Parameters:

httpUriRequest - The http request

Returns:

the http response returned by the server

Throws:

TrustedHttpClientException

execute

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

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

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

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

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

Parameters:

response - The response to close