org.jolokia.client

Class J4pClientBuilder

java.lang.Object

org.jolokia.client.J4pClientBuilder

public class J4pClientBuilder
extends Object

A builder for a J4pClient.

Since:

26.11.10

Author:

roland

Constructor Summary

Constructors

Constructor and Description
J4pClientBuilder() Package access constructor, use static method on J4pClient for creating the builder.

Method Summary

Methods

Modifier and Type	Method and Description
J4pClientBuilder	authenticator(J4pAuthenticator pAuthenticator) Set the authenticator for this client
J4pClient	build() Build the agent with the information given before
J4pClientBuilder	connectionTimeout(int pTimeOut) Determines the timeout in milliseconds until a connection is established.
J4pClientBuilder	contentCharset(Charset pContentCharset) Defines the charset to be used per default for encoding content body.
J4pClientBuilder	contentCharset(String pContentCharset) Defines the charset to be used per default for encoding content body.
J4pClientBuilder	cookieStore(org.apache.http.client.CookieStore pCookieStore) Use the given cookie store.
org.apache.http.client.HttpClient	createHttpClient()
J4pClientBuilder	expectContinue(boolean pUse) Activates 'Expect: 100-Continue' handshake for the entity enclosing methods.
J4pClientBuilder	maxConnectionPoolTimeout(int pConnectionPoolTimeout) Sets the timeout in milliseconds used when retrieving a connection from the connection manager.
J4pClientBuilder	maxTotalConnections(int pConnections) Sets the maximum number of connections allowed when using pooledConnections().
J4pClientBuilder	password(String pPassword) Password for authentication
J4pClientBuilder	pooledConnections() Use a pooled connection manager for connecting to the agent, which uses a pool of connections (see and {@link #maxConnectionPoolTimeout(int)} for tuning the pool
J4pClientBuilder	proxy(String pProxy) Set the proxy for this client
J4pClientBuilder	proxy(String pProxyHost, int pProxyPort) Set the proxy for this client
J4pClientBuilder	proxy(String pProxyHost, int pProxyPort, String pProxyUser, String pProxyPass) Set the proxy for this client
J4pClientBuilder	responseExtractor(J4pResponseExtractor pResponseExtractor) Set the response extractor to use for handling single responses.
J4pClientBuilder	singleConnection() Use a single threaded client for connecting to the agent.
J4pClientBuilder	socketBufferSize(int pSize) Determines the size of the internal socket buffer used to buffer data while receiving / transmitting HTTP messages.
J4pClientBuilder	socketTimeout(int pTimeOut) Defines the socket timeout (SO_TIMEOUT) in milliseconds, which is the timeout for waiting for data or, put differently, a maximum period inactivity between two consecutive data packets).
J4pClientBuilder	sslConnectionSocketFactory(org.apache.http.conn.socket.ConnectionSocketFactory pSslConnectionSocketFactory) Set the SSL connection factory to use when connecting via SSL.
J4pClientBuilder	target(String pUrl) Target service URL when using the agent as a JSR-160 proxy
J4pClientBuilder	targetPassword(String pPassword) Target password for proxy mode.
J4pClientBuilder	targetUser(String pUser) Target user for proxy mode.
J4pClientBuilder	tcpNoDelay(boolean pUse) Determines whether Nagle's algorithm is to be used.
J4pClientBuilder	url(String pUrl) The Agent URL to connect to
J4pClientBuilder	useProxyFromEnvironment() Set the proxy for this client based on http_proxy system environment variable
J4pClientBuilder	user(String pUser) User to use for authentication

Methods inherited from class java.lang.Object

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

Constructor Detail

J4pClientBuilder

public J4pClientBuilder()

Package access constructor, use static method on J4pClient for creating the builder.

Method Detail

url

public final J4pClientBuilder url(String pUrl)

The Agent URL to connect to

Parameters:

pUrl - agent URL

user

public final J4pClientBuilder user(String pUser)

User to use for authentication

Parameters:

pUser - user name

password

public final J4pClientBuilder password(String pPassword)

Password for authentication

Parameters:

pPassword - password to use

target

public final J4pClientBuilder target(String pUrl)

Target service URL when using the agent as a JSR-160 proxy

Parameters:

pUrl - JMX service URL for the 'real' target (that gets contacted by the agent)

targetUser

public final J4pClientBuilder targetUser(String pUser)

Target user for proxy mode. This parameter takes only effect when a target is set.

Parameters:

pUser - User to be used for authentication in JSR-160 proxy communication

targetPassword

public final J4pClientBuilder targetPassword(String pPassword)

Target password for proxy mode. This parameter takes only effect when a target is set and the target user is not null

Parameters:

pPassword - Password to be used for authentication in JSR-160 proxy communication

singleConnection

public final J4pClientBuilder singleConnection()

Use a single threaded client for connecting to the agent. This is not very suitable in multithreaded environments

pooledConnections

public final J4pClientBuilder pooledConnections()

Use a pooled connection manager for connecting to the agent, which uses a pool of connections (see and {@link #maxConnectionPoolTimeout(int)} for tuning the pool

connectionTimeout

public final J4pClientBuilder connectionTimeout(int pTimeOut)

Determines the timeout in milliseconds until a connection is established. A timeout value of zero is interpreted as an infinite timeout. Default is 20 seconds.

Parameters:

pTimeOut - timeout in milliseconds

socketTimeout

public final J4pClientBuilder socketTimeout(int pTimeOut)

Defines the socket timeout (SO_TIMEOUT) in milliseconds, which is the timeout for waiting for data or, put differently, a maximum period inactivity between two consecutive data packets). A timeout value of zero is interpreted as an infinite timeout, a negative value means the system default.

Parameters:

pTimeOut - SO_TIMEOUT value in milliseconds, 0 mean no timeout at all.

maxTotalConnections

public final J4pClientBuilder maxTotalConnections(int pConnections)

Sets the maximum number of connections allowed when using pooledConnections().

Parameters:

pConnections - number of max. simultaneous connections.

maxConnectionPoolTimeout

public final J4pClientBuilder maxConnectionPoolTimeout(int pConnectionPoolTimeout)

Sets the timeout in milliseconds used when retrieving a connection from the connection manager. Default is 500ms, if set to -1 the system default is used. Use 0 for an infinite timeout.

Parameters:

pConnectionPoolTimeout - timeout in milliseconds

contentCharset

public final J4pClientBuilder contentCharset(String pContentCharset)

Defines the charset to be used per default for encoding content body.

Parameters:

pContentCharset - the charset to use

contentCharset

public final J4pClientBuilder contentCharset(Charset pContentCharset)

Defines the charset to be used per default for encoding content body.

Parameters:

pContentCharset - the charset to use

expectContinue

public final J4pClientBuilder expectContinue(boolean pUse)

Activates 'Expect: 100-Continue' handshake for the entity enclosing methods. The purpose of the 'Expect: 100-Continue' handshake to allow a client that is sending a request message with a request body to determine if the origin server is willing to accept the request (based on the request headers) before the client sends the request body. The use of the 'Expect: 100-continue' handshake can result in noticable peformance improvement for entity enclosing requests that require the target server's authentication.

Parameters:

pUse - whether to use this algorithm or not

tcpNoDelay

public final J4pClientBuilder tcpNoDelay(boolean pUse)

Determines whether Nagle's algorithm is to be used. The Nagle's algorithm tries to conserve bandwidth by minimizing the number of segments that are sent. When applications wish to decrease network latency and increase performance, they can disable Nagle's algorithm (that is enable TCP_NODELAY). Data will be sent earlier, at the cost of an increase in bandwidth consumption.

Parameters:

pUse - whether to use NO_DELAY or not

socketBufferSize

public final J4pClientBuilder socketBufferSize(int pSize)

Determines the size of the internal socket buffer used to buffer data while receiving / transmitting HTTP messages.

Parameters:

pSize - size of socket buffer

cookieStore

public final J4pClientBuilder cookieStore(org.apache.http.client.CookieStore pCookieStore)

Use the given cookie store. This useful is some form baed authentication had to be performed.

Parameters:

pCookieStore - cookiestore containing the cookies to send for requests.

authenticator

public final J4pClientBuilder authenticator(J4pAuthenticator pAuthenticator)

Set the authenticator for this client

Parameters:

pAuthenticator - authenticator used for checking the given user and password (if any).

proxy

public final J4pClientBuilder proxy(String pProxy)

Set the proxy for this client

Parameters:

pProxy - proxy definition in the format http://user:pass@host:port or http://host:port Example: http://tom:sEcReT@my.proxy.com:8080

proxy

public final J4pClientBuilder proxy(String pProxyHost,
                     int pProxyPort)

Set the proxy for this client

Parameters:

pProxyHost - proxy hostname

pProxyPort - proxy port number

proxy

public final J4pClientBuilder proxy(String pProxyHost,
                     int pProxyPort,
                     String pProxyUser,
                     String pProxyPass)

Set the proxy for this client

Parameters:

pProxyHost - proxy hostname

pProxyPort - proxy port number

pProxyUser - proxy authentication username

pProxyPass - proxy authentication password

useProxyFromEnvironment

public final J4pClientBuilder useProxyFromEnvironment()

Set the proxy for this client based on http_proxy system environment variable

responseExtractor

public final J4pClientBuilder responseExtractor(J4pResponseExtractor pResponseExtractor)

Set the response extractor to use for handling single responses. By default the JSON answer from the agent is parsed and only considered as successful if the status code returned is 200. In all other cases an exception is thrown. An alternative extractor e.g. could silently ignored non existent MBeans (which might be considered optional.

Parameters:

pResponseExtractor - response extractor to use.

sslConnectionSocketFactory

public final J4pClientBuilder sslConnectionSocketFactory(org.apache.http.conn.socket.ConnectionSocketFactory pSslConnectionSocketFactory)

Set the SSL connection factory to use when connecting via SSL. This can be used to tune the SSL setup (SSLv3, TLSv1.2...),

Parameters:

pSslConnectionSocketFactory - the SSL connection factory to use

Returns:

this builder object

build

public J4pClient build()

Build the agent with the information given before

Returns:

a new J4pClient

createHttpClient

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