org.jolokia.client

Class J4pClient

java.lang.Object

org.jolokia.client.J4pClientBuilderFactory

org.jolokia.client.J4pClient

public class J4pClient
extends J4pClientBuilderFactory

Client class for accessing the j4p agent

Since:

Apr 24, 2010

Author:

roland

Constructor Summary

Constructors

Constructor and Description
J4pClient(String pJ4pServerUrl) Construct a new client for a given server url
J4pClient(String pJ4pServerUrl, org.apache.http.client.HttpClient pHttpClient) Constructor for a given agent URl and a given HttpClient
J4pClient(String pJ4pServerUrl, org.apache.http.client.HttpClient pHttpClient, J4pTargetConfig pTargetConfig) Constructor using a given Agent URL, HttpClient and a proxy target config.
J4pClient(String pJ4pServerUrl, org.apache.http.client.HttpClient pHttpClient, J4pTargetConfig pTargetConfig, J4pResponseExtractor pExtractor) Constructor using a given Agent URL, HttpClient and a proxy target config.

Method Summary

Methods

Modifier and Type	Method and Description
<RESP extends J4pResponse<REQ>,REQ extends J4pRequest> List<RESP>	execute(List<REQ> pRequests) Execute multiple requests at once.
<RESP extends J4pResponse<REQ>,REQ extends J4pRequest> List<RESP>	execute(List<REQ> pRequests, Map<J4pQueryParameter,String> pProcessingOptions) Execute multiple requests at once.
<RESP extends J4pResponse<REQ>,REQ extends J4pRequest> List<RESP>	execute(List<REQ> pRequests, Map<J4pQueryParameter,String> pProcessingOptions, J4pResponseExtractor pResponseExtractor) Execute multiple requests at once.
<RESP extends J4pResponse<REQ>,REQ extends J4pRequest> RESP	execute(REQ pRequest) Execute a single J4pRequest returning a single response.
<RESP extends J4pResponse<REQ>,REQ extends J4pRequest> RESP	execute(REQ pRequest, Map<J4pQueryParameter,String> pProcessingOptions) Execute a single J4pRequest returning a single response.
<RESP extends J4pResponse<REQ>,REQ extends J4pRequest> RESP	execute(REQ pRequest, String pMethod) Execute a single J4pRequest which returns a single response.
<RESP extends J4pResponse<REQ>,REQ extends J4pRequest> RESP	execute(REQ pRequest, String pMethod, Map<J4pQueryParameter,String> pProcessingOptions) Execute a single J4pRequest which returns a single response.
<RESP extends J4pResponse<REQ>,REQ extends J4pRequest> RESP	execute(REQ pRequest, String pMethod, Map<J4pQueryParameter,String> pProcessingOptions, J4pResponseExtractor pExtractor) Execute a single J4pRequest which returns a single response.
<R extends J4pResponse<T>,T extends J4pRequest> List<R>	execute(T... pRequests) Execute multiple requests at once.
org.apache.http.client.HttpClient	getHttpClient() Expose the embedded HttpClient for tuning connection parameters.
URI	getUri() Get base URL for Jolokia requests

Methods inherited from class org.jolokia.client.J4pClientBuilderFactory

authenticator, connectionTimeout, contentCharset, cookieStore, expectContinue, maxConnectionPoolTimeout, maxTotalConnections, password, pooledConnections, responseExtractor, singleConnection, socketBufferSize, socketTimeout, tcpNoDelay, url, user

Methods inherited from class java.lang.Object

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

Constructor Detail

J4pClient

public J4pClient(String pJ4pServerUrl)

Construct a new client for a given server url

Parameters:

pJ4pServerUrl - the agent URL for how to contact the server.

J4pClient

public J4pClient(String pJ4pServerUrl,
         org.apache.http.client.HttpClient pHttpClient)

Constructor for a given agent URl and a given HttpClient

Parameters:

pJ4pServerUrl - the agent URL for how to contact the server.

pHttpClient - HTTP client to use for the connecting to the agent

J4pClient

public J4pClient(String pJ4pServerUrl,
         org.apache.http.client.HttpClient pHttpClient,
         J4pTargetConfig pTargetConfig)

Constructor using a given Agent URL, HttpClient and a proxy target config. If the HttpClient is null, a default client is used. If no target config is given, a plain request is performed

Parameters:

pJ4pServerUrl - the agent URL for how to contact the server.

pHttpClient - HTTP client to use for the connecting to the agent

pTargetConfig - optional target

J4pClient

public J4pClient(String pJ4pServerUrl,
         org.apache.http.client.HttpClient pHttpClient,
         J4pTargetConfig pTargetConfig,
         J4pResponseExtractor pExtractor)

Constructor using a given Agent URL, HttpClient and a proxy target config. If the HttpClient is null, a default client is used. If no target config is given, a plain request is performed

Parameters:

pJ4pServerUrl - the agent URL for how to contact the server.

pHttpClient - HTTP client to use for the connecting to the agent

pTargetConfig - optional target

pExtractor - response extractor to use

Method Detail

execute

public <RESP extends J4pResponse<REQ>,REQ extends J4pRequest> RESP execute(REQ pRequest)
                                 throws J4pException

Execute a single J4pRequest returning a single response. The HTTP Method used is determined automatically.

Type Parameters:

RESP - response type

REQ - request type

Parameters:

pRequest - request to execute

Returns:

the response as returned by the server

Throws:

J4pException

execute

public <RESP extends J4pResponse<REQ>,REQ extends J4pRequest> RESP execute(REQ pRequest,
                                                                  Map<J4pQueryParameter,String> pProcessingOptions)
                                 throws J4pException

Execute a single J4pRequest returning a single response. The HTTP Method used is determined automatically.

Type Parameters:

RESP - response type

REQ - request type

Parameters:

pRequest - request to execute

pProcessingOptions - optional map of processing options

Returns:

the response as returned by the server

Throws:

IOException - when the execution fails

org.json.simple.parser.ParseException - if parsing of the JSON answer fails

J4pException

execute

public <RESP extends J4pResponse<REQ>,REQ extends J4pRequest> RESP execute(REQ pRequest,
                                                                  String pMethod)
                                 throws J4pException

Execute a single J4pRequest which returns a single response.

Type Parameters:

RESP - response type

REQ - request type

Parameters:

pRequest - request to execute

pMethod - method to use which should be either "GET" or "POST"

Returns:

response object

Throws:

J4pException - if something's wrong (e.g. connection failed or read timeout)

execute

public <RESP extends J4pResponse<REQ>,REQ extends J4pRequest> RESP execute(REQ pRequest,
                                                                  String pMethod,
                                                                  Map<J4pQueryParameter,String> pProcessingOptions)
                                 throws J4pException

Execute a single J4pRequest which returns a single response.

Type Parameters:

RESP - response type

REQ - request type

Parameters:

pRequest - request to execute

pMethod - method to use which should be either "GET" or "POST"

pProcessingOptions - optional map of processing options

Returns:

response object

Throws:

J4pException - if something's wrong (e.g. connection failed or read timeout)

execute

public <RESP extends J4pResponse<REQ>,REQ extends J4pRequest> RESP execute(REQ pRequest,
                                                                  String pMethod,
                                                                  Map<J4pQueryParameter,String> pProcessingOptions,
                                                                  J4pResponseExtractor pExtractor)
                                 throws J4pException

Execute a single J4pRequest which returns a single response.

Type Parameters:

RESP - response type

REQ - request type

Parameters:

pRequest - request to execute

pMethod - method to use which should be either "GET" or "POST"

pProcessingOptions - optional map of processing options

pExtractor - extractor for actually creating the response

Returns:

response object

Throws:

J4pException - if something's wrong (e.g. connection failed or read timeout)

execute

public <RESP extends J4pResponse<REQ>,REQ extends J4pRequest> List<RESP> execute(List<REQ> pRequests)
                                            throws J4pException

Execute multiple requests at once. All given request will result in a single HTTP request where it gets dispatched on the agent side. The results are given back in the same order as the arguments provided.

Type Parameters:

RESP - response type

REQ - request type

Parameters:

pRequests - requests to execute

Returns:

list of responses, one response for each request

Throws:

J4pException - when an communication error occurs

execute

public <RESP extends J4pResponse<REQ>,REQ extends J4pRequest> List<RESP> execute(List<REQ> pRequests,
                                                                        Map<J4pQueryParameter,String> pProcessingOptions)
                                            throws J4pException

Execute multiple requests at once. All given request will result in a single HTTP request where it gets dispatched on the agent side. The results are given back in the same order as the arguments provided.

Type Parameters:

RESP - response type

REQ - request type

Parameters:

pRequests - requests to execute

pProcessingOptions - processing options to use

Returns:

list of responses, one response for each request

Throws:

J4pException - when an communication error occurs

execute

public <RESP extends J4pResponse<REQ>,REQ extends J4pRequest> List<RESP> execute(List<REQ> pRequests,
                                                                        Map<J4pQueryParameter,String> pProcessingOptions,
                                                                        J4pResponseExtractor pResponseExtractor)
                                            throws J4pException

Execute multiple requests at once. All given request will result in a single HTTP request where it gets dispatched on the agent side. The results are given back in the same order as the arguments provided.

Type Parameters:

RESP - response type

REQ - request type

Parameters:

pRequests - requests to execute

pProcessingOptions - processing options to use

pResponseExtractor - use this for custom extraction handling

Returns:

list of responses, one response for each request

Throws:

J4pException - when an communication error occurs

execute

public <R extends J4pResponse<T>,T extends J4pRequest> List<R> execute(T... pRequests)
                                       throws J4pException

Execute multiple requests at once. All given request will result in a single HTTP request where it gets dispatched on the agent side. The results are given back in the same order as the arguments provided.

Type Parameters:

R - response typex

T - request type

Parameters:

pRequests - requests to execute

Returns:

list of responses, one response for each request

Throws:

J4pException - when an communication error occurs

getHttpClient

public org.apache.http.client.HttpClient getHttpClient()

Expose the embedded HttpClient for tuning connection parameters.

Returns:

the http client used for HTTP communications

getUri

public URI getUri()

Get base URL for Jolokia requests

Returns:

the Jolokia URL