org.apache.accumulo.core.client.mock

Class MockInstance

java.lang.Object

org.apache.accumulo.core.client.mock.MockInstance

All Implemented Interfaces:

Instance

public class MockInstance
extends Object
implements Instance

Mock Accumulo provides an in memory implementation of the Accumulo client API. It is possible that the behavior of this implementation may differ subtly from the behavior of Accumulo. This could result in unit tests that pass on Mock Accumulo and fail on Accumulo or visa-versa. Documenting the differences would be difficult and is not done.

An alternative to Mock Accumulo called MiniAccumuloCluster was introduced in Accumulo 1.5. MiniAccumuloCluster spins up actual Accumulo server processes, can be used for unit testing, and its behavior should match Accumulo. The drawback of MiniAccumuloCluster is that it starts more slowly than Mock Accumulo.

Constructor Summary

Constructors

Constructor and Description
MockInstance()
MockInstance(String instanceName)
MockInstance(String instanceName, org.apache.hadoop.fs.FileSystem fs)

Method Summary

Methods

Modifier and Type	Method and Description
AccumuloConfiguration	getConfiguration() Returns the AccumuloConfiguration to use when interacting with this instance.
Connector	getConnector(AuthInfo auth) Deprecated.
Connector	getConnector(String principal, AuthenticationToken token) Returns a connection to this instance of accumulo.
Connector	getConnector(String user, byte[] pass) Deprecated.
Connector	getConnector(String user, ByteBuffer pass) Deprecated.
Connector	getConnector(String user, CharSequence pass) Deprecated.
String	getInstanceID() Returns a unique string that identifies this instance of accumulo.
String	getInstanceName() Returns the instance name given at system initialization time.
List<String>	getMasterLocations() Returns the location(s) of the accumulo master and any redundant servers.
String	getRootTabletLocation() Returns the location of the tablet server that is serving the root tablet.
String	getZooKeepers() Returns a comma-separated list of zookeeper servers the instance is using.
int	getZooKeepersSessionTimeOut() Returns the zookeeper connection timeout.
void	setConfiguration(AccumuloConfiguration conf) Set the AccumuloConfiguration to use when interacting with this instance.

Methods inherited from class java.lang.Object

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

Constructor Detail

MockInstance

public MockInstance()

MockInstance

public MockInstance(String instanceName)

MockInstance

public MockInstance(String instanceName,
            org.apache.hadoop.fs.FileSystem fs)

Method Detail

getRootTabletLocation

public String getRootTabletLocation()

Description copied from interface: Instance

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

Specified by:

getRootTabletLocation in interface Instance

Returns:

location in "hostname:port" form

getMasterLocations

public List<String> getMasterLocations()

Description copied from interface: Instance

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

Specified by:

getMasterLocations in interface Instance

Returns:

a list of locations in "hostname:port" form

getInstanceID

public String getInstanceID()

Description copied from interface: Instance

Returns a unique string that identifies this instance of accumulo.

Specified by:

getInstanceID in interface Instance

Returns:

a UUID

getInstanceName

public String getInstanceName()

Description copied from interface: Instance

Returns the instance name given at system initialization time.

Specified by:

getInstanceName in interface Instance

Returns:

current instance name

getZooKeepers

public String getZooKeepers()

Description copied from interface: Instance

Returns a comma-separated list of zookeeper servers the instance is using.

Specified by:

getZooKeepers in interface Instance

Returns:

the zookeeper servers this instance is using in "hostname:port" form

getZooKeepersSessionTimeOut

public int getZooKeepersSessionTimeOut()

Description copied from interface: Instance

Returns the zookeeper connection timeout.

Specified by:

getZooKeepersSessionTimeOut in interface Instance

Returns:

the configured timeout to connect to zookeeper

getConnector

@Deprecated
public Connector getConnector(String user,
                                byte[] pass)
                       throws AccumuloException,
                              AccumuloSecurityException

Deprecated.

Description copied from interface: Instance

Returns a connection to accumulo.

Specified by:

getConnector in interface Instance

Parameters:

user - a valid accumulo user

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

Returns:

the accumulo Connector

Throws:

AccumuloException - when a generic exception occurs

AccumuloSecurityException - when a user's credentials are invalid

getConnector

@Deprecated
public Connector getConnector(String user,
                                ByteBuffer pass)
                       throws AccumuloException,
                              AccumuloSecurityException

Deprecated.

Description copied from interface: Instance

Returns a connection to accumulo.

Specified by:

getConnector in interface Instance

Parameters:

user - a valid accumulo user

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

Returns:

the accumulo Connector

Throws:

AccumuloException - when a generic exception occurs

AccumuloSecurityException - when a user's credentials are invalid

getConnector

@Deprecated
public Connector getConnector(String user,
                                CharSequence pass)
                       throws AccumuloException,
                              AccumuloSecurityException

Deprecated.

Description copied from interface: Instance

Returns a connection to this instance of accumulo.

Specified by:

getConnector in interface Instance

Parameters:

user - a valid accumulo user

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

Returns:

the accumulo Connector

Throws:

AccumuloException - when a generic exception occurs

AccumuloSecurityException - when a user's credentials are invalid

getConfiguration

public AccumuloConfiguration getConfiguration()

Description copied from interface: Instance

Returns the AccumuloConfiguration to use when interacting with this instance.

Specified by:

getConfiguration in interface Instance

Returns:

the AccumuloConfiguration that specifies properties related to interacting with this instance

setConfiguration

public void setConfiguration(AccumuloConfiguration conf)

Description copied from interface: Instance

Set the AccumuloConfiguration to use when interacting with this instance.

Specified by:

setConfiguration in interface Instance

Parameters:

conf - accumulo configuration

getConnector

@Deprecated
public Connector getConnector(AuthInfo auth)
                       throws AccumuloException,
                              AccumuloSecurityException

Deprecated.

Description copied from interface: Instance

Returns a connection to accumulo.

Specified by:

getConnector in interface Instance

Parameters:

auth - An Credentials object.

Returns:

the accumulo Connector

Throws:

AccumuloException - when a generic exception occurs

AccumuloSecurityException - when a user's credentials are invalid

getConnector

public Connector getConnector(String principal,
                     AuthenticationToken token)
                       throws AccumuloException,
                              AccumuloSecurityException

Description copied from interface: Instance

Returns a connection to this instance of accumulo.

Specified by:

getConnector in interface Instance

Parameters:

principal - a valid accumulo user

token - Use the token type configured for the Accumulo instance you are connecting to. An Accumulo instance with default configurations will use PasswordToken

Throws:

AccumuloException

AccumuloSecurityException