org.apache.accumulo.server.rpc

Class TServerUtils

java.lang.Object

org.apache.accumulo.server.rpc.TServerUtils

public class TServerUtils
extends Object

Factory methods for creating Thrift server objects

Field Summary

Fields

Modifier and Type	Field and Description
static ThreadLocal<String>	clientAddress Static instance, passed to ClientInfoProcessorFactory, which will contain the client address of any incoming RPC.

Constructor Summary

Constructors

Constructor and Description
TServerUtils()

Method Summary

Methods

Modifier and Type	Method and Description
static ServerAddress	createBlockingServer(com.google.common.net.HostAndPort address, org.apache.thrift.TProcessor processor, org.apache.thrift.protocol.TProtocolFactory protocolFactory, long maxMessageSize, String serverName, int numThreads, int numSimpleTimerThreads, long timeBetweenThreadChecks) Creates a TTheadPoolServer for normal unsecure operation.
static ServerAddress	createNonBlockingServer(com.google.common.net.HostAndPort address, org.apache.thrift.TProcessor processor, org.apache.thrift.protocol.TProtocolFactory protocolFactory, String serverName, String threadName, int numThreads, int numSTThreads, long timeBetweenThreadChecks, long maxMessageSize) Create a NonBlockingServer with a custom thread pool that can dynamically resize itself.
static ServerAddress	createSaslThreadPoolServer(com.google.common.net.HostAndPort address, org.apache.thrift.TProcessor processor, org.apache.thrift.protocol.TProtocolFactory protocolFactory, long socketTimeout, SaslServerConnectionParams params, String serverName, String threadName, int numThreads, int numSTThreads, long timeBetweenThreadChecks)
static ThreadPoolExecutor	createSelfResizingThreadPool(String serverName, int executorThreads, int simpleTimerThreads, long timeBetweenThreadChecks) Creates a SimpleThreadPool which uses SimpleTimer to inspect the core pool size and number of active threads of the ThreadPoolExecutor and increase or decrease the core pool size based on activity (excessive or lack thereof).
static ServerAddress	createSslThreadPoolServer(com.google.common.net.HostAndPort address, org.apache.thrift.TProcessor processor, org.apache.thrift.protocol.TProtocolFactory protocolFactory, long socketTimeout, SslConnectionParams sslParams, String serverName, int numThreads, int numSimpleTimerThreads, long timeBetweenThreadChecks) Create a Thrift SSL server.
static org.apache.thrift.server.TThreadPoolServer	createTThreadPoolServer(org.apache.thrift.transport.TServerTransport transport, org.apache.thrift.TProcessor processor, org.apache.thrift.transport.TTransportFactory transportFactory, org.apache.thrift.protocol.TProtocolFactory protocolFactory) Create a TThreadPoolServer with the provided transport, processor and transport factory.
static org.apache.thrift.server.TThreadPoolServer	createTThreadPoolServer(org.apache.thrift.transport.TServerTransport transport, org.apache.thrift.TProcessor processor, org.apache.thrift.transport.TTransportFactory transportFactory, org.apache.thrift.protocol.TProtocolFactory protocolFactory, ExecutorService service) Create a TThreadPoolServer with the provided server transport, processor and transport factory.
static org.apache.thrift.transport.TServerSocket	getSslServerSocket(int port, int timeout, InetAddress address, SslConnectionParams params) Create the Thrift server socket for RPC running over SSL.
static ServerAddress	startServer(AccumuloServerContext service, String hostname, Property portHintProperty, org.apache.thrift.TProcessor processor, String serverName, String threadName, Property portSearchProperty, Property minThreadProperty, Property timeBetweenThreadChecksProperty, Property maxMessageSizeProperty) Start a server, at the given port, or higher, if that port is not available.
static ServerAddress	startTServer(AccumuloConfiguration conf, com.google.common.net.HostAndPort address, ThriftServerType serverType, org.apache.thrift.TProcessor processor, String serverName, String threadName, int numThreads, int numSTThreads, long timeBetweenThreadChecks, long maxMessageSize, SslConnectionParams sslParams, SaslServerConnectionParams saslParams, long serverSocketTimeout)
static ServerAddress	startTServer(com.google.common.net.HostAndPort address, ThriftServerType serverType, TimedProcessor processor, String serverName, String threadName, int numThreads, int numSTThreads, long timeBetweenThreadChecks, long maxMessageSize, SslConnectionParams sslParams, SaslServerConnectionParams saslParams, long serverSocketTimeout)
static ServerAddress	startTServer(com.google.common.net.HostAndPort address, ThriftServerType serverType, TimedProcessor processor, org.apache.thrift.protocol.TProtocolFactory protocolFactory, String serverName, String threadName, int numThreads, int numSTThreads, long timeBetweenThreadChecks, long maxMessageSize, SslConnectionParams sslParams, SaslServerConnectionParams saslParams, long serverSocketTimeout) Start the appropriate Thrift server (SSL or non-blocking server) for the given parameters.
static void	stopTServer(org.apache.thrift.server.TServer s) Stop a Thrift TServer.

Methods inherited from class java.lang.Object

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

Field Detail

clientAddress

public static final ThreadLocal<String> clientAddress

Static instance, passed to ClientInfoProcessorFactory, which will contain the client address of any incoming RPC.

Constructor Detail

TServerUtils

public TServerUtils()

Method Detail

startServer

public static ServerAddress startServer(AccumuloServerContext service,
                        String hostname,
                        Property portHintProperty,
                        org.apache.thrift.TProcessor processor,
                        String serverName,
                        String threadName,
                        Property portSearchProperty,
                        Property minThreadProperty,
                        Property timeBetweenThreadChecksProperty,
                        Property maxMessageSizeProperty)
                                 throws UnknownHostException

Start a server, at the given port, or higher, if that port is not available.

Parameters:

service - RPC configuration

portHintProperty - the port to attempt to open, can be zero, meaning "any available port"

processor - the service to be started

serverName - the name of the class that is providing the service

threadName - name this service's thread for better debugging

portSearchProperty - A boolean Property to control if port-search should be used, or null to disable

minThreadProperty - A Property to control the minimum number of threads in the pool

timeBetweenThreadChecksProperty - A Property to control the amount of time between checks to resize the thread pool

maxMessageSizeProperty - A Property to control the maximum Thrift message size accepted

Returns:

the server object created, and the port actually used

Throws:

UnknownHostException - when we don't know our own address

createNonBlockingServer

public static ServerAddress createNonBlockingServer(com.google.common.net.HostAndPort address,
                                    org.apache.thrift.TProcessor processor,
                                    org.apache.thrift.protocol.TProtocolFactory protocolFactory,
                                    String serverName,
                                    String threadName,
                                    int numThreads,
                                    int numSTThreads,
                                    long timeBetweenThreadChecks,
                                    long maxMessageSize)
                                             throws org.apache.thrift.transport.TTransportException

Create a NonBlockingServer with a custom thread pool that can dynamically resize itself.

Throws:

org.apache.thrift.transport.TTransportException

createSelfResizingThreadPool

public static ThreadPoolExecutor createSelfResizingThreadPool(String serverName,
                                              int executorThreads,
                                              int simpleTimerThreads,
                                              long timeBetweenThreadChecks)

Creates a SimpleThreadPool which uses SimpleTimer to inspect the core pool size and number of active threads of the ThreadPoolExecutor and increase or decrease the core pool size based on activity (excessive or lack thereof).

Parameters:

serverName - A name to describe the thrift server this executor will service

executorThreads - The maximum number of threads for the executor

simpleTimerThreads - The numbers of threads used to get the SimpleTimer instance

timeBetweenThreadChecks - The amount of time, in millis, between attempts to resize the executor thread pool

Returns:

A ThreadPoolExecutor which will resize itself automatically

createBlockingServer

public static ServerAddress createBlockingServer(com.google.common.net.HostAndPort address,
                                 org.apache.thrift.TProcessor processor,
                                 org.apache.thrift.protocol.TProtocolFactory protocolFactory,
                                 long maxMessageSize,
                                 String serverName,
                                 int numThreads,
                                 int numSimpleTimerThreads,
                                 long timeBetweenThreadChecks)
                                          throws org.apache.thrift.transport.TTransportException

Creates a TTheadPoolServer for normal unsecure operation. Useful for comparing performance against SSL or SASL transports.

Parameters:

address - Address to bind to

processor - TProcessor for the server

maxMessageSize - Maximum size of a Thrift message allowed

Returns:

A configured TThreadPoolServer and its bound address information

Throws:

org.apache.thrift.transport.TTransportException

createTThreadPoolServer

public static org.apache.thrift.server.TThreadPoolServer createTThreadPoolServer(org.apache.thrift.transport.TServerTransport transport,
                                                                 org.apache.thrift.TProcessor processor,
                                                                 org.apache.thrift.transport.TTransportFactory transportFactory,
                                                                 org.apache.thrift.protocol.TProtocolFactory protocolFactory)

Create a TThreadPoolServer with the provided transport, processor and transport factory.

Parameters:

transport - Server transport

processor - Processor implementation

transportFactory - Transport factory

Returns:

A configured TThreadPoolServer

createTThreadPoolServer

public static org.apache.thrift.server.TThreadPoolServer createTThreadPoolServer(org.apache.thrift.transport.TServerTransport transport,
                                                                 org.apache.thrift.TProcessor processor,
                                                                 org.apache.thrift.transport.TTransportFactory transportFactory,
                                                                 org.apache.thrift.protocol.TProtocolFactory protocolFactory,
                                                                 ExecutorService service)

Create a TThreadPoolServer with the provided server transport, processor and transport factory.

Parameters:

transport - TServerTransport for the server

processor - TProcessor for the server

transportFactory - TTransportFactory for the server

getSslServerSocket

public static org.apache.thrift.transport.TServerSocket getSslServerSocket(int port,
                                                           int timeout,
                                                           InetAddress address,
                                                           SslConnectionParams params)
                                                                    throws org.apache.thrift.transport.TTransportException

Create the Thrift server socket for RPC running over SSL.

Parameters:

port - Port of the server socket to bind to

timeout - Socket timeout

address - Address to bind the socket to

params - SSL parameters

Returns:

A configured TServerSocket configured to use SSL

Throws:

org.apache.thrift.transport.TTransportException

createSslThreadPoolServer

public static ServerAddress createSslThreadPoolServer(com.google.common.net.HostAndPort address,
                                      org.apache.thrift.TProcessor processor,
                                      org.apache.thrift.protocol.TProtocolFactory protocolFactory,
                                      long socketTimeout,
                                      SslConnectionParams sslParams,
                                      String serverName,
                                      int numThreads,
                                      int numSimpleTimerThreads,
                                      long timeBetweenThreadChecks)
                                               throws org.apache.thrift.transport.TTransportException

Create a Thrift SSL server.

Parameters:

address - host and port to bind to

processor - TProcessor for the server

socketTimeout - Socket timeout

sslParams - SSL parameters

Returns:

A ServerAddress with the bound-socket information and the Thrift server

Throws:

org.apache.thrift.transport.TTransportException

createSaslThreadPoolServer

public static ServerAddress createSaslThreadPoolServer(com.google.common.net.HostAndPort address,
                                       org.apache.thrift.TProcessor processor,
                                       org.apache.thrift.protocol.TProtocolFactory protocolFactory,
                                       long socketTimeout,
                                       SaslServerConnectionParams params,
                                       String serverName,
                                       String threadName,
                                       int numThreads,
                                       int numSTThreads,
                                       long timeBetweenThreadChecks)
                                                throws org.apache.thrift.transport.TTransportException

Throws:

org.apache.thrift.transport.TTransportException

startTServer

public static ServerAddress startTServer(AccumuloConfiguration conf,
                         com.google.common.net.HostAndPort address,
                         ThriftServerType serverType,
                         org.apache.thrift.TProcessor processor,
                         String serverName,
                         String threadName,
                         int numThreads,
                         int numSTThreads,
                         long timeBetweenThreadChecks,
                         long maxMessageSize,
                         SslConnectionParams sslParams,
                         SaslServerConnectionParams saslParams,
                         long serverSocketTimeout)
                                  throws org.apache.thrift.transport.TTransportException

Throws:

org.apache.thrift.transport.TTransportException

startTServer

public static ServerAddress startTServer(com.google.common.net.HostAndPort address,
                         ThriftServerType serverType,
                         TimedProcessor processor,
                         String serverName,
                         String threadName,
                         int numThreads,
                         int numSTThreads,
                         long timeBetweenThreadChecks,
                         long maxMessageSize,
                         SslConnectionParams sslParams,
                         SaslServerConnectionParams saslParams,
                         long serverSocketTimeout)
                                  throws org.apache.thrift.transport.TTransportException

Throws:

org.apache.thrift.transport.TTransportException

See Also:

startTServer(HostAndPort, ThriftServerType, TimedProcessor, TProtocolFactory, String, String, int, int, long, long, SslConnectionParams, SaslServerConnectionParams, long)

startTServer

public static ServerAddress startTServer(com.google.common.net.HostAndPort address,
                         ThriftServerType serverType,
                         TimedProcessor processor,
                         org.apache.thrift.protocol.TProtocolFactory protocolFactory,
                         String serverName,
                         String threadName,
                         int numThreads,
                         int numSTThreads,
                         long timeBetweenThreadChecks,
                         long maxMessageSize,
                         SslConnectionParams sslParams,
                         SaslServerConnectionParams saslParams,
                         long serverSocketTimeout)
                                  throws org.apache.thrift.transport.TTransportException

Start the appropriate Thrift server (SSL or non-blocking server) for the given parameters. Non-null SSL parameters will cause an SSL server to be started.

Returns:

A ServerAddress encapsulating the Thrift server created and the host/port which it is bound to.

Throws:

org.apache.thrift.transport.TTransportException

stopTServer

public static void stopTServer(org.apache.thrift.server.TServer s)

Stop a Thrift TServer. Existing connections will keep our thread running; use reflection to forcibly shut down the threadpool.

Parameters:

s - The TServer to stop