Package org.apache.accumulo.core.client.admin

Interface InstanceOperations

All Known Implementing Classes:

InstanceOperationsImpl

public interface InstanceOperations

Method Summary

Modifier and Type	Method	Description
List<ActiveCompaction>	getActiveCompactions(String tserver)	List the active compaction running on a tablet server
List<ActiveScan>	getActiveScans(String tserver)	List the active scans on tablet server.
String	getInstanceID()	Returns a unique string that identifies this instance of accumulo.
Map<String,String>	getSiteConfiguration()
Map<String,String>	getSystemConfiguration()
List<String>	getTabletServers()	List the currently active tablet servers participating in the accumulo instance
void	ping(String tserver)	Throws an exception if a tablet server can not be contacted.
void	removeProperty(String property)	Removes a system property from zookeeper.
void	setProperty(String property, String value)	Sets an system property in zookeeper.
boolean	testClassLoad(String className, String asTypeName)	Test to see if the instance can load the given class as the given type.
void	waitForBalance()	Waits for the tablet balancer to run and return no migrations.

Method Detail

setProperty

void setProperty(String property,
                 String value)
          throws AccumuloException,
                 AccumuloSecurityException

Sets an system property in zookeeper. Tablet servers will pull this setting and override the equivalent setting in accumulo.properties. Changes can be seen using getSystemConfiguration().

Only some properties can be changed by this method, an IllegalArgumentException will be thrown if a read-only property is set.

Parameters:

property - the name of a per-table property

value - the value to set a per-table property to

Throws:

AccumuloException - if a general error occurs

AccumuloSecurityException - if the user does not have permission

removeProperty

void removeProperty(String property)
             throws AccumuloException,
                    AccumuloSecurityException

Removes a system property from zookeeper. Changes can be seen using getSystemConfiguration()

Parameters:

property - the name of a per-table property

Throws:

AccumuloException - if a general error occurs

AccumuloSecurityException - if the user does not have permission

getSystemConfiguration

Map<String,String> getSystemConfiguration()
                                         throws AccumuloException,
                                                AccumuloSecurityException

Returns:

A map of system properties set in zookeeper. If a property is not set in zookeeper, then it will return the value set in accumulo.properties on some server. If nothing is set in an accumulo.properties file it will return the default value for each property.

Throws:

AccumuloException

AccumuloSecurityException

getSiteConfiguration

Map<String,String> getSiteConfiguration()
                                       throws AccumuloException,
                                              AccumuloSecurityException

Returns:

A map of system properties set in accumulo.properties on some server. If nothing is set in an accumulo.properties file it will return the default value for each property.

Throws:

AccumuloException

AccumuloSecurityException

getTabletServers

List<String> getTabletServers()

List the currently active tablet servers participating in the accumulo instance

Returns:

A list of currently active tablet servers.

getActiveScans

List<ActiveScan> getActiveScans(String tserver)
                         throws AccumuloException,
                                AccumuloSecurityException

List the active scans on tablet server.

Parameters:

tserver - The tablet server address should be of the form <ip address>:<port>

Returns:

A list of active scans on tablet server.

Throws:

AccumuloException

AccumuloSecurityException

getActiveCompactions

List<ActiveCompaction> getActiveCompactions(String tserver)
                                     throws AccumuloException,
                                            AccumuloSecurityException

List the active compaction running on a tablet server

Parameters:

tserver - The tablet server address should be of the form <ip address>:<port>

Returns:

the list of active compactions

Throws:

AccumuloException

AccumuloSecurityException

Since:

1.5.0

ping

void ping(String tserver)
   throws AccumuloException

Throws an exception if a tablet server can not be contacted.

Parameters:

tserver - The tablet server address should be of the form <ip address>:<port>

Throws:

AccumuloException

Since:

1.5.0

testClassLoad

boolean testClassLoad(String className,
                      String asTypeName)
               throws AccumuloException,
                      AccumuloSecurityException

Test to see if the instance can load the given class as the given type. This check does not consider per table classpaths, see TableOperations.testClassLoad(String, String, String)

Returns:

true if the instance can load the given class as the given type, false otherwise

Throws:

AccumuloException

AccumuloSecurityException

waitForBalance

void waitForBalance()
             throws AccumuloException

Waits for the tablet balancer to run and return no migrations.

Throws:

AccumuloException

Since:

1.7.0

getInstanceID

String getInstanceID()

Returns a unique string that identifies this instance of accumulo.

Returns:

a String

Since:

2.0.0