org.glassfish.grizzly.thrift.client

Class GrizzlyThriftClient.Builder<T extends org.apache.thrift.TServiceClient>

java.lang.Object

org.glassfish.grizzly.thrift.client.GrizzlyThriftClient.Builder<T>

All Implemented Interfaces:

ThriftClientBuilder

Enclosing class:

GrizzlyThriftClient<T extends org.apache.thrift.TServiceClient>

public static class GrizzlyThriftClient.Builder<T extends org.apache.thrift.TServiceClient>
extends Object
implements ThriftClientBuilder

Constructor Summary

Constructors

Constructor and Description
Builder(String thriftClientName, GrizzlyThriftClientManager manager, org.glassfish.grizzly.nio.transport.TCPNIOTransport transport, org.apache.thrift.TServiceClientFactory<T> clientFactory)

Method Summary

Modifier and Type	Method and Description
GrizzlyThriftClient.Builder<T>	allowDisposableConnection(boolean allowDisposableConnection) Allow or disallow disposable connections
GrizzlyThriftClient.Builder<T>	borrowValidation(boolean borrowValidation) Enable or disable the connection validation when the connection is borrowed from the connection pool
GrizzlyThriftClient<T>	build() Create an instance of the named ThriftClient.
GrizzlyThriftClient.Builder<T>	connectTimeoutInMillis(long connectTimeoutInMillis) Set global connect-timeout
GrizzlyThriftClient.Builder<T>	failover(boolean failover) Enable or disable failover/failback
GrizzlyThriftClient.Builder<T>	healthMonitorIntervalInSecs(long healthMonitorIntervalInSecs) Set health monitor's interval
GrizzlyThriftClient.Builder<T>	httpHeader(org.glassfish.grizzly.http.util.Header header, String value)
GrizzlyThriftClient.Builder<T>	httpHeader(String name, String value)
GrizzlyThriftClient.Builder<T>	httpUriPath(String httpUriPath)
GrizzlyThriftClient.Builder<T>	keepAliveTimeoutInSecs(long keepAliveTimeoutInSecs) Set connection pool's KeepAliveTimeout
GrizzlyThriftClient.Builder<T>	maxConnectionPerServer(int maxConnectionPerServer) Set connection pool's max
GrizzlyThriftClient.Builder	maxThriftFrameLength(int maxThriftFrameLength) Set the max length of thrift frame
GrizzlyThriftClient.Builder<T>	minConnectionPerServer(int minConnectionPerServer) Set connection pool's min
GrizzlyThriftClient.Builder<T>	responseTimeoutInMillis(long responseTimeoutInMillis) Set global response-timeout
GrizzlyThriftClient.Builder<T>	retainLastServer(boolean retainLastServer) Enable or disable the keeping a server in the the round-robin list when the only one server is remained in the list.
GrizzlyThriftClient.Builder<T>	retryCount(int retryCount) Set retry count for connection or sending
GrizzlyThriftClient.Builder<T>	returnValidation(boolean returnValidation) Enable or disable the connection validation when the connection is returned to the connection pool
GrizzlyThriftClient.Builder<T>	servers(Set<SocketAddress> servers) Set initial servers
GrizzlyThriftClient.Builder<T>	thriftProtocol(ThriftProtocols thriftProtocol)
GrizzlyThriftClient.Builder<T>	validationCheckMethodName(String validationCheckMethodName)
GrizzlyThriftClient.Builder<T>	writeTimeoutInMillis(long writeTimeoutInMillis) Set global write-timeout

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder(String thriftClientName,
               GrizzlyThriftClientManager manager,
               org.glassfish.grizzly.nio.transport.TCPNIOTransport transport,
               org.apache.thrift.TServiceClientFactory<T> clientFactory)

Method Detail

build

public GrizzlyThriftClient<T> build()

Create an instance of the named ThriftClient.

Specified by:

build in interface ThriftClientBuilder

Returns:

a new instance of the named thrift client

See Also:

ThriftClientManager.createThriftClientBuilder(String, org.apache.thrift.TServiceClientFactory)

connectTimeoutInMillis

public GrizzlyThriftClient.Builder<T> connectTimeoutInMillis(long connectTimeoutInMillis)

Set global connect-timeout

If the given param is negative, the timeout is infite. Default is 5000.

Parameters:

connectTimeoutInMillis - connect-timeout in milli-seconds

Returns:

this builder

writeTimeoutInMillis

public GrizzlyThriftClient.Builder<T> writeTimeoutInMillis(long writeTimeoutInMillis)

Set global write-timeout

If the given param is negative, the timeout is infite. Default is 5000.

Parameters:

writeTimeoutInMillis - write-timeout in milli-seconds

Returns:

this builder

responseTimeoutInMillis

public GrizzlyThriftClient.Builder<T> responseTimeoutInMillis(long responseTimeoutInMillis)

Set global response-timeout

If the given param is negative, the timeout is infite. Default is 10000.

Parameters:

responseTimeoutInMillis - response-timeout in milli-seconds

Returns:

this builder

minConnectionPerServer

public GrizzlyThriftClient.Builder<T> minConnectionPerServer(int minConnectionPerServer)

Set connection pool's min

Default is 5.

Parameters:

minConnectionPerServer - connection pool's min

Returns:

this builder

See Also:

BaseObjectPool.Builder#min(int)

maxConnectionPerServer

public GrizzlyThriftClient.Builder<T> maxConnectionPerServer(int maxConnectionPerServer)

Set connection pool's max

Default is Integer.MAX_VALUE

Parameters:

maxConnectionPerServer - connection pool's max

Returns:

this builder

See Also:

BaseObjectPool.Builder#max(int)

keepAliveTimeoutInSecs

public GrizzlyThriftClient.Builder<T> keepAliveTimeoutInSecs(long keepAliveTimeoutInSecs)

Set connection pool's KeepAliveTimeout

Default is 1800.

Parameters:

keepAliveTimeoutInSecs - connection pool's KeepAliveTimeout in seconds

Returns:

this builder

See Also:

BaseObjectPool.Builder#keepAliveTimeoutInSecs(long)

healthMonitorIntervalInSecs

public GrizzlyThriftClient.Builder<T> healthMonitorIntervalInSecs(long healthMonitorIntervalInSecs)

Set health monitor's interval

This thrift client will schedule HealthMonitorTask with this interval. HealthMonitorTask will check the failure servers periodically and detect the revived server. If the given parameter is negative, this thrift client never schedules HealthMonitorTask so this behavior is similar to seting failover to be false. Default is 60.

Parameters:

healthMonitorIntervalInSecs - interval in seconds

Returns:

this builder

allowDisposableConnection

public GrizzlyThriftClient.Builder<T> allowDisposableConnection(boolean allowDisposableConnection)

Allow or disallow disposable connections

Default is false.

Parameters:

allowDisposableConnection - true if this thrift client allows disposable connections

Returns:

this builder

borrowValidation

public GrizzlyThriftClient.Builder<T> borrowValidation(boolean borrowValidation)

Enable or disable the connection validation when the connection is borrowed from the connection pool

Default is false.

Parameters:

borrowValidation - true if this thrift client should make sure the borrowed connection is valid

Returns:

this builder

returnValidation

public GrizzlyThriftClient.Builder<T> returnValidation(boolean returnValidation)

Enable or disable the connection validation when the connection is returned to the connection pool

Default is false.

Parameters:

returnValidation - true if this thrift client should make sure the returned connection is valid

Returns:

this builder

retainLastServer

public GrizzlyThriftClient.Builder<T> retainLastServer(boolean retainLastServer)

Enable or disable the keeping a server in the the round-robin list when the only one server is remained in the list.

Default is false

Parameters:

retainLastServer - true if this thrift client should make sure the retaining one server in the round-robin list.

Returns:

this builder

servers

public GrizzlyThriftClient.Builder<T> servers(Set<SocketAddress> servers)

Set initial servers

Parameters:

servers - server set

Returns:

this builder

failover

public GrizzlyThriftClient.Builder<T> failover(boolean failover)

Enable or disable failover/failback

Default is true.

Parameters:

failover - true if this thrift client should support failover/failback when the server is failed or revived

Returns:

this builder

retryCount

public GrizzlyThriftClient.Builder<T> retryCount(int retryCount)

Set retry count for connection or sending

Default is 1.

Parameters:

retryCount - the count for retrials

Returns:

this builder

thriftProtocol

public GrizzlyThriftClient.Builder<T> thriftProtocol(ThriftProtocols thriftProtocol)

maxThriftFrameLength

public GrizzlyThriftClient.Builder maxThriftFrameLength(int maxThriftFrameLength)

Set the max length of thrift frame

Parameters:

maxThriftFrameLength - max frame length

Returns:

this builder

httpUriPath

public GrizzlyThriftClient.Builder<T> httpUriPath(String httpUriPath)

httpHeader

public GrizzlyThriftClient.Builder<T> httpHeader(org.glassfish.grizzly.http.util.Header header,
                                                 String value)

httpHeader

public GrizzlyThriftClient.Builder<T> httpHeader(String name,
                                                 String value)

validationCheckMethodName

public GrizzlyThriftClient.Builder<T> validationCheckMethodName(String validationCheckMethodName)