eu.dnetlib.data.hadoop.rmi

Interface HadoopService

All Superinterfaces:

eu.dnetlib.common.rmi.BaseService

public interface HadoopService
extends eu.dnetlib.common.rmi.BaseService

The Interface HadoopService.

Method Summary

Modifier and Type	Method and Description
void	addHBaseColumn(String clusterName, String tableName, String rowKey, String columnFamily, String qualifier, String value) Add to an HBase table the value into the cell identified by coordinates rowKey, columnFamily and qualifier.
boolean	createConfiguredHbaseTable(String clusterName, String tableName, String tableConfiguration) Creates the hbase table.
boolean	createHbaseTable(String clusterName, String tableName, Set<String> columns) Creates the hbase table.
boolean	createHdfsDirectory(String clusterName, String path, boolean force) Creates a directory on HDFS, eventually deleteing its content.
boolean	deleteHBaseColumn(String clusterName, String tableName, HBaseRowDescriptor column) Remove from an HBase table the values identified by a row descriptor.
boolean	deleteHBaseColumns(String clusterName, String tableName, List<HBaseRowDescriptor> column) Remove from an HBase table the values identified by the given row descriptors.
boolean	deleteHdfsPath(String clusterName, String path) Deletes a path on HDFS
HBaseRowDescriptor	describeHBaseColumn(String clusterName, String tableName, String rowKey) Get the columns defined in a given row
Map<String,HBaseRowDescriptor>	describeHBaseColumns(String clusterName, String tableName, List<String> rowKeys) Get the columns defined in a given set of row
List<String>	describeHbaseTable(String clusterName, String tableName) Describe hbase table.
String	describeHBaseTableConfiguration(String clusterName, String tableName) Get the HBase table schema and the region splits configuration
boolean	dropHbaseTable(String clusterName, String tableName) Drop hbase table.
boolean	ensureHbaseTable(String clusterName, String tableName, Set<String> columns) Ensure hbase table.
boolean	existHbaseTable(String clusterName, String tableName) Exist hbase table.
boolean	existHdfsPath(String clusterName, String path) Check if path on HDFS exists
Map<String,String>	getClusterConfiguration(String clusterName) Gets the cluster configuration.
boolean	killJob(String jobId) Kill job.
List<String>	listAvailableJobs() List available jobs.
List<String>	listClusters() List the configured cluster names.
List<String>	listHbaseTables(String clusterName) List hbase tables.
List<HadoopJobDescriptor>	listJobs(String clusterName) List jobs.
boolean	truncateHbaseTable(String clusterName, String tableName) Truncate hbase table.

Methods inherited from interface eu.dnetlib.common.rmi.BaseService

identify, notify, start

Method Detail

listAvailableJobs

List<String> listAvailableJobs()
                        throws HadoopServiceException

List available jobs.

Returns:

the list

Throws:

HadoopServiceException - the hadoop service exception

listJobs

List<HadoopJobDescriptor> listJobs(String clusterName)
                            throws HadoopServiceException

List jobs.

Parameters:

clusterName - the cluster name

Returns:

the list

Throws:

HadoopServiceException - the hadoop service exception

killJob

boolean killJob(String jobId)
         throws HadoopServiceException

Kill job.

Parameters:

jobId - the job id

Returns:

true, if successful

Throws:

HadoopServiceException - the hadoop service exception

listHbaseTables

List<String> listHbaseTables(String clusterName)
                      throws HadoopServiceException

List hbase tables.

Parameters:

clusterName - the cluster name

Returns:

the list

Throws:

HadoopServiceException - the hadoop service exception

ensureHbaseTable

boolean ensureHbaseTable(String clusterName,
                         String tableName,
                         Set<String> columns)
                  throws HadoopServiceException

Ensure hbase table.

Parameters:

clusterName - the cluster name

tableName - the table name

columns - the columns

Returns:

true, if successful

Throws:

HadoopServiceException - the hadoop service exception

createHbaseTable

boolean createHbaseTable(String clusterName,
                         String tableName,
                         Set<String> columns)
                  throws HadoopServiceException

Creates the hbase table.

Parameters:

clusterName - the cluster name

tableName - the table name

columns - the columns

Returns:

true, if successful

Throws:

HadoopServiceException - the hadoop service exception

createConfiguredHbaseTable

boolean createConfiguredHbaseTable(String clusterName,
                                   String tableName,
                                   String tableConfiguration)
                            throws HadoopServiceException

Creates the hbase table.

Parameters:

clusterName - the cluster name

tableName - the table name

tableConfiguration - the table configuration: columns and region splits

Returns:

true, if successful

Throws:

HadoopServiceException - the hadoop service exception

truncateHbaseTable

boolean truncateHbaseTable(String clusterName,
                           String tableName)
                    throws HadoopServiceException

Truncate hbase table.

Parameters:

clusterName - the cluster name

tableName - the table name

Returns:

true, if successful

Throws:

HadoopServiceException - the hadoop service exception

dropHbaseTable

boolean dropHbaseTable(String clusterName,
                       String tableName)
                throws HadoopServiceException

Drop hbase table.

Parameters:

clusterName - the cluster name

tableName - the table name

Returns:

true, if successful

Throws:

HadoopServiceException - the hadoop service exception

existHbaseTable

boolean existHbaseTable(String clusterName,
                        String tableName)
                 throws HadoopServiceException

Exist hbase table.

Parameters:

clusterName - the cluster name

tableName - the table name

Returns:

true, if successful

Throws:

HadoopServiceException - the hadoop service exception

describeHbaseTable

List<String> describeHbaseTable(String clusterName,
                                String tableName)
                         throws HadoopServiceException

Describe hbase table.

Parameters:

clusterName - the cluster name

tableName - the table name

Returns:

the list of columns defined for that table.

Throws:

HadoopServiceException - the hadoop service exception

getClusterConfiguration

Map<String,String> getClusterConfiguration(String clusterName)
                                    throws HadoopServiceException

Gets the cluster configuration.

Parameters:

clusterName - the cluster name

Returns:

the cluster configuration

Throws:

HadoopServiceException - the hadoop service exception

deleteHdfsPath

boolean deleteHdfsPath(String clusterName,
                       String path)
                throws HadoopServiceException

Deletes a path on HDFS

Parameters:

clusterName - the cluster name

path - the path to be deleted

Returns:

true in case of success

Throws:

HadoopServiceException

existHdfsPath

boolean existHdfsPath(String clusterName,
                      String path)
               throws HadoopServiceException

Check if path on HDFS exists

Parameters:

clusterName - the cluster name

path - the path to be deleted

Returns:

true in case the path exists

Throws:

HadoopServiceException

createHdfsDirectory

boolean createHdfsDirectory(String clusterName,
                            String path,
                            boolean force)
                     throws HadoopServiceException

Creates a directory on HDFS, eventually deleteing its content.

Parameters:

clusterName - the cluster name

path - the path to be created

force - force delete before create

Returns:

true in case of success

Throws:

HadoopServiceException

listClusters

List<String> listClusters()
                   throws HadoopServiceException

List the configured cluster names.

Returns:

the list of configured cluster names.

Throws:

HadoopServiceException - shouldn't happen

describeHBaseColumn

HBaseRowDescriptor describeHBaseColumn(String clusterName,
                                       String tableName,
                                       String rowKey)
                                throws HadoopServiceException

Get the columns defined in a given row

Parameters:

clusterName -

tableName -

rowKey -

Returns:

Throws:

HadoopServiceException

describeHBaseColumns

Map<String,HBaseRowDescriptor> describeHBaseColumns(String clusterName,
                                                    String tableName,
                                                    List<String> rowKeys)
                                             throws HadoopServiceException

Get the columns defined in a given set of row

Parameters:

clusterName -

tableName -

rowKeys -

Returns:

Throws:

HadoopServiceException

describeHBaseTableConfiguration

String describeHBaseTableConfiguration(String clusterName,
                                       String tableName)
                                throws HadoopServiceException

Get the HBase table schema and the region splits configuration

Parameters:

clusterName -

tableName -

Returns:

Throws:

HadoopServiceException

deleteHBaseColumn

boolean deleteHBaseColumn(String clusterName,
                          String tableName,
                          HBaseRowDescriptor column)
                   throws HadoopServiceException

Remove from an HBase table the values identified by a row descriptor.

Parameters:

clusterName -

tableName -

column -

Returns:

Throws:

HadoopServiceException

deleteHBaseColumns

boolean deleteHBaseColumns(String clusterName,
                           String tableName,
                           List<HBaseRowDescriptor> column)
                    throws HadoopServiceException

Remove from an HBase table the values identified by the given row descriptors.

Parameters:

clusterName -

tableName -

column -

Returns:

Throws:

HadoopServiceException

addHBaseColumn

void addHBaseColumn(String clusterName,
                    String tableName,
                    String rowKey,
                    String columnFamily,
                    String qualifier,
                    String value)
             throws HadoopServiceException

Add to an HBase table the value into the cell identified by coordinates rowKey, columnFamily and qualifier.

Parameters:

clusterName -

tableName -

rowKey -

columnFamily -

qualifier -

value: - base64 encoding of the protobuffer value

Throws:

HadoopServiceException