org.glassfish.grizzly.thrift.client

Interface ThriftClientManager

All Known Implementing Classes:

GrizzlyThriftClientManager

public interface ThriftClientManager

The interface for managing thrift clients

Author:

Bongjae Chang

Method Summary

Modifier and Type	Method and Description
<T extends org.apache.thrift.TServiceClient> ThriftClientBuilder	createThriftClientBuilder(String thriftClientName, org.apache.thrift.TServiceClientFactory<T> thriftClientFactory) Creates a new ThriftClientBuilder for the named thrift client to be managed by this thrift client manager.
<T extends org.apache.thrift.TServiceClient> ThriftClient<T>	getThriftClient(String thriftClientName) Looks up a named thrift client.
boolean	removeThriftClient(String thriftClientName) Remove a thrift client from the ThriftClientManager.
void	shutdown() Shuts down the ThriftClientManager.

Method Detail

createThriftClientBuilder

<T extends org.apache.thrift.TServiceClient> ThriftClientBuilder createThriftClientBuilder(String thriftClientName,
                                                                                           org.apache.thrift.TServiceClientFactory<T> thriftClientFactory)

Creates a new ThriftClientBuilder for the named thrift client to be managed by this thrift client manager.

The returned ThriftClientBuilder is associated with this ThriftClientManager. The ThriftClient will be created, added to this ThriftClientManager and started when ThriftClientBuilder.build() is called.

Parameters:

thriftClientName - the name of the thrift client to build. A thrift client name must consist of at least one non-whitespace character.

thriftClientFactory - thrift client factory

Returns:

the ThriftClientBuilder for the named thrift client

getThriftClient

<T extends org.apache.thrift.TServiceClient> ThriftClient<T> getThriftClient(String thriftClientName)

Looks up a named thrift client.

Parameters:

thriftClientName - the name of the thrift client to look for

Returns:

the ThriftClient or null if it does exist

removeThriftClient

boolean removeThriftClient(String thriftClientName)

Remove a thrift client from the ThriftClientManager. The thrift client will be stopped.

Parameters:

thriftClientName - the thrift client name

Returns:

true if the thrift client was removed

shutdown

void shutdown()

Shuts down the ThriftClientManager.