org.attribyte.api.http

Interface Client

All Known Subinterfaces:

AsyncClient

All Known Implementing Classes:

Commons3Client, Commons4Client, JettyClient, NingClient

public interface Client

Defines the HTTP client interface.

Implementation must support concurrent use.

Method Summary

Modifier and Type	Method and Description
void	init(java.lang.String prefix, java.util.Properties props, Logger logger) Initializes the client.
Response	send(Request request) Sends a request with default options.
Response	send(Request request, RequestOptions options) Sends a request with specified options.
void	shutdown() Releases resources, interrupts threads, etc.

Method Detail

init

void init(java.lang.String prefix,
          java.util.Properties props,
          Logger logger)
   throws InitializationException

Initializes the client. Must be called before first use.

Parameters:

prefix - A prefix applied to all property names.

props - A properties file.

logger - A logger for messages.

Throws:

InitializationException - on initialization error.

send

Response send(Request request)
       throws java.io.IOException

Sends a request with default options.

Parameters:

request - The request.

Returns:

The response.

Throws:

java.io.IOException - on I/O error.

send

Response send(Request request,
              RequestOptions options)
       throws java.io.IOException

Sends a request with specified options.

Parameters:

request - The request.

options - The request options.

Returns:

The response.

Throws:

java.io.IOException - on I/O error.

shutdown

void shutdown()
       throws java.lang.Exception

Releases resources, interrupts threads, etc. Called when application using the client is terminated.

Throws:

java.lang.Exception - on shutdown exception.