org.apache.accumulo.core.client
Interface Instance

All Known Implementing Classes:

HdfsZooInstance, MockInstance, ZooKeeperInstance

public interface Instance

This class represents the information a client needs to know to connect to an instance of accumulo.

Method Summary

AccumuloConfiguration	getConfiguration() get the AccumuloConfiguration to use when interacting with this instance
Connector	getConnector(java.lang.String user, byte[] pass)
Connector	getConnector(java.lang.String user, java.lang.CharSequence pass)
java.lang.String	getInstanceID() Get a unique string that identifies this instance of accumulo.
java.lang.String	getInstanceName() Returns the instance name given at system initialization time.
java.util.List<java.lang.String>	getMasterLocations() Get the location(s) of the accumulo master and any redundant servers.
java.lang.String	getRootTabletLocation() Get the location of the tablet server that is serving the root tablet.
java.lang.String	getZooKeepers()
int	getZooKeepersSessionTimeOut()
void	setConfiguration(AccumuloConfiguration conf) set the AccumuloConfiguration to use when interacting with this instance

Method Detail

getRootTabletLocation

java.lang.String getRootTabletLocation()

Get the location of the tablet server that is serving the root tablet.

Returns:

location in "hostname:port" form.

getMasterLocations

java.util.List<java.lang.String> getMasterLocations()

Get the location(s) of the accumulo master and any redundant servers.

Returns:

a list of locations in "hostname:port" form.

getInstanceID

java.lang.String getInstanceID()

Get a unique string that identifies this instance of accumulo.

Returns:

a UUID

getInstanceName

java.lang.String getInstanceName()

Returns the instance name given at system initialization time.

Returns:

current instance name

getZooKeepers

java.lang.String getZooKeepers()

Returns:

the zoo keepers this instance is using

getZooKeepersSessionTimeOut

int getZooKeepersSessionTimeOut()

Returns:

the configured timeout to connect to zookeeper

getConnector

Connector getConnector(java.lang.String user,
                       byte[] pass)
                       throws AccumuloException,
                              AccumuloSecurityException

Parameters:

user -

pass - A UTF-8 encoded password. The password may be cleared after making this call.

Returns:

Throws:

AccumuloException

AccumuloSecurityException

getConnector

Connector getConnector(java.lang.String user,
                       java.lang.CharSequence pass)
                       throws AccumuloException,
                              AccumuloSecurityException

Parameters:

user -

pass - If a mutable CharSequence is passed in, it may be cleared after this call.

Returns:

Throws:

AccumuloException

AccumuloSecurityException

getConfiguration

AccumuloConfiguration getConfiguration()

get the AccumuloConfiguration to use when interacting with this instance

Returns:

the AccumuloConfiguration that specifies properties related to interacting with this instance

setConfiguration

void setConfiguration(AccumuloConfiguration conf)

set the AccumuloConfiguration to use when interacting with this instance

Parameters:

conf -