com.bigdata.service
Class EmbeddedClient<T>

java.lang.Object
  com.bigdata.service.AbstractClient<T>
      com.bigdata.service.AbstractScaleOutClient<T>
          com.bigdata.service.EmbeddedClient<T>

All Implemented Interfaces:

IBigdataClient<T>

public class EmbeddedClient<T>
extends AbstractScaleOutClient<T>

A client for an embedded federation (the client and the data services all run in the same process).

Version:

$Id: EmbeddedClient.java 2265 2009-10-26 12:51:06Z thompsonbry $

Author:

Bryan Thompson

See Also:

EmbeddedFederation

Nested Class Summary

static interface

EmbeddedClient.Options Options for the embedded (in process) federation.

Nested classes/interfaces inherited from class com.bigdata.service.AbstractScaleOutClient

AbstractScaleOutClient.MetadataIndexCachePolicy

Field Summary

Fields inherited from class com.bigdata.service.AbstractClient

log

Constructor Summary

EmbeddedClient(Properties properties)

Method Summary

EmbeddedFederation<T>	connect() Connect to a bigdata federation.
void	disconnect(boolean immediateShutdown) Disconnect from the bigdata federation.
IBigdataFederation<T>	getFederation() Return the connected federation,
boolean	isConnected() Return true iff the client is connected to a federation.

Methods inherited from class com.bigdata.service.AbstractClient

finalize, getBatchApiOnly, getCollectPlatformStatistics, getCollectQueueStatistics, getDefaultRangeQueryCapacity, getDelegate, getHttpdPort, getIndexCacheCapacity, getIndexCacheTimeout, getLocatorCacheCapacity, getLocatorCacheTimeout, getMaxParallelTasksPerRequest, getMaxStaleLocatorRetries, getProperties, getTaskTimeout, getThreadPoolSize, setDelegate

Methods inherited from class java.lang.Object

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

Constructor Detail

EmbeddedClient

public EmbeddedClient(Properties properties)

Parameters:

properties - See EmbeddedFederation.Options.

Method Detail

isConnected

public boolean isConnected()

Description copied from interface: IBigdataClient

Return true iff the client is connected to a federation.

disconnect

public void disconnect(boolean immediateShutdown)

Description copied from interface: IBigdataClient

Disconnect from the bigdata federation.

Normal shutdown allows any existing client requests to federation services to complete but does not schedule new requests, and then terminates any background processing that is being performed on the behalf of the client (service discovery, etc).

Immediate shutdown terminates any client requests to federation services, and then terminate any background processing that is being performed on the behalf of the client (service discovery, etc).

Note: Immediate shutdown can cause odd exceptions to be logged. Normal shutdown is recommended unless there is a reason to force immediate shutdown.

Parameters:

immediateShutdown - When true an immediate shutdown will be performed as described above. Otherwise a normal shutdown will be performed.

getFederation

public IBigdataFederation<T> getFederation()

Description copied from interface: IBigdataClient

Return the connected federation,

connect

public EmbeddedFederation<T> connect()

Description copied from interface: IBigdataClient

Connect to a bigdata federation. If the client is already connected, then the existing connection is returned.

Returns:

The object used to access the federation services.