org.apache.hadoop.hbase.rest.client

Class RemoteAdmin

java.lang.Object

org.apache.hadoop.hbase.rest.client.RemoteAdmin

@InterfaceAudience.Private
public class RemoteAdmin
extends Object

Field Summary

Fields

Modifier and Type	Field and Description
(package private) String	accessToken
(package private) org.apache.hadoop.hbase.rest.client.Client	client
(package private) org.apache.hadoop.conf.Configuration	conf
(package private) int	maxRetries
(package private) long	sleepTime
private static Unmarshaller	versionClusterUnmarshaller

Constructor Summary

Constructors

Constructor and Description
RemoteAdmin(org.apache.hadoop.hbase.rest.client.Client client, org.apache.hadoop.conf.Configuration conf) Constructor
RemoteAdmin(org.apache.hadoop.hbase.rest.client.Client client, org.apache.hadoop.conf.Configuration conf, String accessToken) Constructor

Method Summary

Modifier and Type	Method and Description
void	createTable(org.apache.hadoop.hbase.HTableDescriptor desc) Creates a new table.
void	deleteTable(byte[] tableName) Deletes a table.
void	deleteTable(String tableName) Deletes a table.
org.apache.hadoop.hbase.rest.model.StorageClusterStatusModel	getClusterStatus()
org.apache.hadoop.hbase.rest.model.StorageClusterVersionModel	getClusterVersion()
private XMLStreamReader	getInputStream(org.apache.hadoop.hbase.rest.client.Response response) Convert the REST server's response to an XML reader.
org.apache.hadoop.hbase.rest.model.VersionModel	getRestVersion()
org.apache.hadoop.hbase.rest.model.TableListModel	getTableList()
(package private) static Unmarshaller	getUnmarsheller()
boolean	isTableAvailable(byte[] tableName)
boolean	isTableAvailable(String tableName)

Methods inherited from class java.lang.Object

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

Field Detail

client

final org.apache.hadoop.hbase.rest.client.Client client

conf

final org.apache.hadoop.conf.Configuration conf

accessToken

final String accessToken

maxRetries

final int maxRetries

sleepTime

final long sleepTime

versionClusterUnmarshaller

private static volatile Unmarshaller versionClusterUnmarshaller

Constructor Detail

RemoteAdmin

public RemoteAdmin(org.apache.hadoop.hbase.rest.client.Client client,
                   org.apache.hadoop.conf.Configuration conf)

Constructor

Parameters:

client -

conf -

RemoteAdmin

public RemoteAdmin(org.apache.hadoop.hbase.rest.client.Client client,
                   org.apache.hadoop.conf.Configuration conf,
                   String accessToken)

Constructor

Parameters:

client -

conf -

accessToken -

Method Detail

getUnmarsheller

static Unmarshaller getUnmarsheller()
                             throws JAXBException

Throws:

JAXBException

isTableAvailable

public boolean isTableAvailable(String tableName)
                         throws IOException

Parameters:

tableName - name of table to check

Returns:

true if all regions of the table are available

Throws:

IOException - if a remote or network exception occurs

getRestVersion

public org.apache.hadoop.hbase.rest.model.VersionModel getRestVersion()
                                                               throws IOException

Returns:

string representing the rest api's version

Throws:

IOException - if the endpoint does not exist, there is a timeout, or some other general failure mode

getClusterStatus

public org.apache.hadoop.hbase.rest.model.StorageClusterStatusModel getClusterStatus()
                                                                              throws IOException

Returns:

string representing the cluster's version

Throws:

IOException - if the endpoint does not exist, there is a timeout, or some other general failure mode

getClusterVersion

public org.apache.hadoop.hbase.rest.model.StorageClusterVersionModel getClusterVersion()
                                                                                throws IOException

Returns:

string representing the cluster's version

Throws:

IOException - if the endpoint does not exist, there is a timeout, or some other general failure mode

isTableAvailable

public boolean isTableAvailable(byte[] tableName)
                         throws IOException

Parameters:

tableName - name of table to check

Returns:

true if all regions of the table are available

Throws:

IOException - if a remote or network exception occurs

createTable

public void createTable(org.apache.hadoop.hbase.HTableDescriptor desc)
                 throws IOException

Creates a new table.

Parameters:

desc - table descriptor for table

Throws:

IOException - if a remote or network exception occurs

deleteTable

public void deleteTable(String tableName)
                 throws IOException

Deletes a table.

Parameters:

tableName - name of table to delete

Throws:

IOException - if a remote or network exception occurs

deleteTable

public void deleteTable(byte[] tableName)
                 throws IOException

Deletes a table.

Parameters:

tableName - name of table to delete

Throws:

IOException - if a remote or network exception occurs

getTableList

public org.apache.hadoop.hbase.rest.model.TableListModel getTableList()
                                                               throws IOException

Returns:

string representing the cluster's version

Throws:

IOException - if the endpoint does not exist, there is a timeout, or some other general failure mode

getInputStream

private XMLStreamReader getInputStream(org.apache.hadoop.hbase.rest.client.Response response)
                                throws IOException

Convert the REST server's response to an XML reader.

Parameters:

response - The REST server's response.

Returns:

A reader over the parsed XML document.

Throws:

IOException - If the document fails to parse