Server (Hive 1.2.2 API)

java.lang.Object
- org.apache.hive.hcatalog.templeton.Server

```
public class Server
extends Object
```
The Templeton Web API server.

Field Summary

Fields
Modifier and Type	Field and Description
`static Pattern`	`DDL_ID`
`static String`	`DO_AS_PARAM`
`protected static ExecService`	`execService`
`static Map<String,String>`	`STATUS_OK` The status message.
`static Map<String,Object>`	`SUPPORTED_FORMATS` The list of supported return formats.
`static Map<String,Object>`	`SUPPORTED_VERSIONS` The list of supported api versions.
`static String`	`VERSION`

Constructor Summary

Constructors
Constructor and Description

Server()

Constructors
Constructor and Description
`Server()`

Method Summary

Methods
Modifier and Type	Method and Description
`javax.ws.rs.core.Response`	`addOneColumn(String db, String table, String column, ColumnDesc desc)` Create a column in an hcat table.
`javax.ws.rs.core.Response`	`addOnePartition(String db, String table, String partition, PartitionDesc desc)` Create a partition in an hcat table.
`javax.ws.rs.core.Response`	`addOneTableProperty(String db, String table, String property, TablePropertyDesc desc)` Add a single property on an hcat table.
`CompleteBean`	`completeJob(String jobid, String jobStatus)` Notify on a completed job.
`javax.ws.rs.core.Response`	`createDatabase(String db, DatabaseDesc desc)` Create a database
`javax.ws.rs.core.Response`	`createTable(String db, String table, TableDesc desc)` Create a new table.
`javax.ws.rs.core.Response`	`createTableLike(String db, String existingTable, String newTable, TableLikeDesc desc)` Create a new table like another table.
`ExecBean`	`ddl(String exec, String group, String permissions)` Execute an hcat ddl expression on the local box.
`QueueStatusBean`	`deleteJobId(String jobid)` Kill a job in the queue.
`javax.ws.rs.core.Response`	`descColumn(String db, String table, String column)` Describe a single column in an hcat table.
`javax.ws.rs.core.Response`	`descDatabase(String db, String format)` Describe a database
`javax.ws.rs.core.Response`	`descOneTableProperty(String db, String table, String property)` Describe a single property on an hcat table.
`javax.ws.rs.core.Response`	`descPartition(String db, String table, String partition)` Describe a single partition in an hcat table.
`javax.ws.rs.core.Response`	`descTable(String db, String table, String format)` Describe an hcat table.
`javax.ws.rs.core.Response`	`dropDatabase(String db, boolean ifExists, String option, String group, String permissions)` Drop a database
`javax.ws.rs.core.Response`	`dropPartition(String db, String table, String partition, boolean ifExists, String group, String permissions)` Drop a partition in an hcat table.
`javax.ws.rs.core.Response`	`dropTable(String db, String table, boolean ifExists, String group, String permissions)` Drop an hcat table.
`String`	`getCompletedUrl()` The callback url on this server when a task is completed.
`javax.ws.rs.core.Response`	`hadoopVersion()` Get version of hadoop software being run by this WebHCat server
`EnqueueBean`	`hive(String execute, String srcFile, List<String> hiveArgs, String otherFiles, List<String> defines, String statusdir, String callback, boolean enablelog, Boolean enablejobreconnect)` Run a Hive job.
`javax.ws.rs.core.Response`	`hiveVersion()` Get version of hive software being run by this WebHCat server
`javax.ws.rs.core.Response`	`listColumns(String db, String table)` List the columns in an hcat table.
`javax.ws.rs.core.Response`	`listDatabases(String dbPattern)` List all databases, or those that match a pattern.
`javax.ws.rs.core.Response`	`listPartitions(String db, String table)` List all the partitions in an hcat table.
`javax.ws.rs.core.Response`	`listTableProperties(String db, String table)` List all the properties on an hcat table.
`javax.ws.rs.core.Response`	`listTables(String db, String tablePattern)` List all the tables in an hcat database.
`EnqueueBean`	`mapReduceJar(String jar, String mainClass, String libjars, String files, List<String> args, List<String> defines, String statusdir, String callback, boolean usesHcatalog, boolean enablelog, Boolean enablejobreconnect)` Run a MapReduce Jar job.
`EnqueueBean`	`mapReduceStreaming(List<String> inputs, String inputreader, String output, String mapper, String reducer, String combiner, List<String> fileList, String files, List<String> defines, List<String> cmdenvs, List<String> args, String statusdir, String callback, boolean enablelog, Boolean enablejobreconnect)` Run a MapReduce Streaming job.
`EnqueueBean`	`pig(String execute, String srcFile, List<String> pigArgs, String otherFiles, String statusdir, String callback, boolean usesHcatalog, boolean enablelog, Boolean enablejobreconnect)` Run a Pig job.
`javax.ws.rs.core.Response`	`pigVersion()` Get version of pig software being run by this WebHCat server
`javax.ws.rs.core.Response`	`renameTable(String db, String oldTable, String newTable, String group, String permissions)` Rename an hcat table.
`Map<String,Object>`	`requestFormats()` Check the supported request formats of this server.
`QueueStatusBean`	`showJobId(String jobid)` Return the status of the jobid.
`List<JobItemBean>`	`showJobList(String fields, boolean showall, String jobid, String numrecords)` Return all the known job ids for this user based on the optional filter conditions.
`EnqueueBean`	`sqoop(String command, String optionsFile, String libdir, String otherFiles, String statusdir, String callback, boolean enablelog, Boolean enablejobreconnect)` Run a Sqoop job.
`javax.ws.rs.core.Response`	`sqoopVersion()` Get version of sqoop software being run by this WebHCat server
`Map<String,String>`	`status()` Check the status of this server.
`void`	`verifyDdlParam(String param, String name)` Verify that the parameter exists and is a simple DDL identifier name.
`void`	`verifyParam(List<String> param, String name)` Verify that the parameter exists.
`void`	`verifyParam(String param, String name)` Verify that the parameter exists.
`void`	`verifyUser()` Verify that we have a valid user.
`Map<String,Object>`	`version()` Check the version(s) supported by this server.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

VERSION
```
public static final String VERSION
```
See Also:
Constant Field Values

DO_AS_PARAM
```
public static final String DO_AS_PARAM
```
See Also:
Constant Field Values

STATUS_OK

public static final Map<String,String> STATUS_OK

The status message. Always "ok"

SUPPORTED_VERSIONS

public static final Map<String,Object> SUPPORTED_VERSIONS

The list of supported api versions.

SUPPORTED_FORMATS
```
public static final Map<String,Object> SUPPORTED_FORMATS
```
The list of supported return formats. Always json.

execService

protected static ExecService execService

DDL_ID
```
public static final Pattern DDL_ID
```

Constructor Detail
- Server
```
public Server()
```

Method Detail

status
```
public Map<String,String> status()
```
Check the status of this server. Always OK.

requestFormats
```
public Map<String,Object> requestFormats()
```
Check the supported request formats of this server.

version
```
public Map<String,Object> version()
```
Check the version(s) supported by this server.

hadoopVersion

public javax.ws.rs.core.Response hadoopVersion()
                                        throws IOException

Get version of hadoop software being run by this WebHCat server

Throws:: IOException

hiveVersion

public javax.ws.rs.core.Response hiveVersion()
                                      throws IOException

Get version of hive software being run by this WebHCat server

Throws:: IOException

sqoopVersion

public javax.ws.rs.core.Response sqoopVersion()
                                       throws IOException

Get version of sqoop software being run by this WebHCat server

Throws:: IOException

pigVersion

public javax.ws.rs.core.Response pigVersion()
                                     throws IOException

Get version of pig software being run by this WebHCat server

Throws:: IOException

ddl

public ExecBean ddl(String exec,
           String group,
           String permissions)
             throws NotAuthorizedException,
                    BusyException,
                    BadParam,
                    org.apache.commons.exec.ExecuteException,
                    IOException

Execute an hcat ddl expression on the local box. It is run as the authenticated user and rate limited.

Throws:: NotAuthorizedException; BusyException; BadParam; org.apache.commons.exec.ExecuteException; IOException

listTables

public javax.ws.rs.core.Response listTables(String db,
                                   String tablePattern)
                                     throws HcatException,
                                            NotAuthorizedException,
                                            BusyException,
                                            BadParam,
                                            org.apache.commons.exec.ExecuteException,
                                            IOException

List all the tables in an hcat database.

Throws:: HcatException; NotAuthorizedException; BusyException; BadParam; org.apache.commons.exec.ExecuteException; IOException

createTable

public javax.ws.rs.core.Response createTable(String db,
                                    String table,
                                    TableDesc desc)
                                      throws SimpleWebException,
                                             NotAuthorizedException,
                                             BusyException,
                                             BadParam,
                                             org.apache.commons.exec.ExecuteException,
                                             IOException

Create a new table.

Throws:: SimpleWebException; NotAuthorizedException; BusyException; BadParam; org.apache.commons.exec.ExecuteException; IOException

createTableLike

public javax.ws.rs.core.Response createTableLike(String db,
                                        String existingTable,
                                        String newTable,
                                        TableLikeDesc desc)
                                          throws SimpleWebException,
                                                 NotAuthorizedException,
                                                 BusyException,
                                                 BadParam,
                                                 org.apache.commons.exec.ExecuteException,
                                                 IOException

Create a new table like another table.

Throws:: SimpleWebException; NotAuthorizedException; BusyException; BadParam; org.apache.commons.exec.ExecuteException; IOException

descTable

public javax.ws.rs.core.Response descTable(String db,
                                  String table,
                                  String format)
                                    throws HcatException,
                                           NotAuthorizedException,
                                           BusyException,
                                           BadParam,
                                           org.apache.commons.exec.ExecuteException,
                                           IOException

Describe an hcat table. This is normally a simple list of columns (using "desc table"), but the extended format will show more information (using "show table extended like").

Throws:: HcatException; NotAuthorizedException; BusyException; BadParam; org.apache.commons.exec.ExecuteException; IOException

dropTable

public javax.ws.rs.core.Response dropTable(String db,
                                  String table,
                                  boolean ifExists,
                                  String group,
                                  String permissions)
                                    throws HcatException,
                                           NotAuthorizedException,
                                           BusyException,
                                           BadParam,
                                           org.apache.commons.exec.ExecuteException,
                                           IOException

Drop an hcat table.

Throws:: HcatException; NotAuthorizedException; BusyException; BadParam; org.apache.commons.exec.ExecuteException; IOException

renameTable

public javax.ws.rs.core.Response renameTable(String db,
                                    String oldTable,
                                    String newTable,
                                    String group,
                                    String permissions)
                                      throws HcatException,
                                             NotAuthorizedException,
                                             BusyException,
                                             BadParam,
                                             org.apache.commons.exec.ExecuteException,
                                             IOException

Rename an hcat table.

Throws:: HcatException; NotAuthorizedException; BusyException; BadParam; org.apache.commons.exec.ExecuteException; IOException

descOneTableProperty

public javax.ws.rs.core.Response descOneTableProperty(String db,
                                             String table,
                                             String property)
                                               throws HcatException,
                                                      NotAuthorizedException,
                                                      BusyException,
                                                      BadParam,
                                                      org.apache.commons.exec.ExecuteException,
                                                      IOException

Describe a single property on an hcat table.

Throws:: HcatException; NotAuthorizedException; BusyException; BadParam; org.apache.commons.exec.ExecuteException; IOException

listTableProperties

public javax.ws.rs.core.Response listTableProperties(String db,
                                            String table)
                                              throws HcatException,
                                                     NotAuthorizedException,
                                                     BusyException,
                                                     BadParam,
                                                     org.apache.commons.exec.ExecuteException,
                                                     IOException

List all the properties on an hcat table.

Throws:: HcatException; NotAuthorizedException; BusyException; BadParam; org.apache.commons.exec.ExecuteException; IOException

addOneTableProperty

public javax.ws.rs.core.Response addOneTableProperty(String db,
                                            String table,
                                            String property,
                                            TablePropertyDesc desc)
                                              throws HcatException,
                                                     NotAuthorizedException,
                                                     BusyException,
                                                     BadParam,
                                                     org.apache.commons.exec.ExecuteException,
                                                     IOException

Add a single property on an hcat table.

Throws:: HcatException; NotAuthorizedException; BusyException; BadParam; org.apache.commons.exec.ExecuteException; IOException

listPartitions

public javax.ws.rs.core.Response listPartitions(String db,
                                       String table)
                                         throws HcatException,
                                                NotAuthorizedException,
                                                BusyException,
                                                BadParam,
                                                org.apache.commons.exec.ExecuteException,
                                                IOException

List all the partitions in an hcat table.

Throws:: HcatException; NotAuthorizedException; BusyException; BadParam; org.apache.commons.exec.ExecuteException; IOException

descPartition

public javax.ws.rs.core.Response descPartition(String db,
                                      String table,
                                      String partition)
                                        throws HcatException,
                                               NotAuthorizedException,
                                               BusyException,
                                               BadParam,
                                               org.apache.commons.exec.ExecuteException,
                                               IOException

Describe a single partition in an hcat table.

Throws:: HcatException; NotAuthorizedException; BusyException; BadParam; org.apache.commons.exec.ExecuteException; IOException

addOnePartition

public javax.ws.rs.core.Response addOnePartition(String db,
                                        String table,
                                        String partition,
                                        PartitionDesc desc)
                                          throws HcatException,
                                                 NotAuthorizedException,
                                                 BusyException,
                                                 BadParam,
                                                 org.apache.commons.exec.ExecuteException,
                                                 IOException

Create a partition in an hcat table.

Throws:: HcatException; NotAuthorizedException; BusyException; BadParam; org.apache.commons.exec.ExecuteException; IOException

dropPartition

public javax.ws.rs.core.Response dropPartition(String db,
                                      String table,
                                      String partition,
                                      boolean ifExists,
                                      String group,
                                      String permissions)
                                        throws HcatException,
                                               NotAuthorizedException,
                                               BusyException,
                                               BadParam,
                                               org.apache.commons.exec.ExecuteException,
                                               IOException

Drop a partition in an hcat table.

Throws:: HcatException; NotAuthorizedException; BusyException; BadParam; org.apache.commons.exec.ExecuteException; IOException

listDatabases

public javax.ws.rs.core.Response listDatabases(String dbPattern)
                                        throws HcatException,
                                               NotAuthorizedException,
                                               BusyException,
                                               BadParam,
                                               org.apache.commons.exec.ExecuteException,
                                               IOException

List all databases, or those that match a pattern.

Throws:: HcatException; NotAuthorizedException; BusyException; BadParam; org.apache.commons.exec.ExecuteException; IOException

descDatabase

public javax.ws.rs.core.Response descDatabase(String db,
                                     String format)
                                       throws HcatException,
                                              NotAuthorizedException,
                                              BusyException,
                                              BadParam,
                                              org.apache.commons.exec.ExecuteException,
                                              IOException

Describe a database

Throws:: HcatException; NotAuthorizedException; BusyException; BadParam; org.apache.commons.exec.ExecuteException; IOException

createDatabase

public javax.ws.rs.core.Response createDatabase(String db,
                                       DatabaseDesc desc)
                                         throws HcatException,
                                                NotAuthorizedException,
                                                BusyException,
                                                BadParam,
                                                org.apache.commons.exec.ExecuteException,
                                                IOException

Create a database

Throws:: HcatException; NotAuthorizedException; BusyException; BadParam; org.apache.commons.exec.ExecuteException; IOException

dropDatabase

public javax.ws.rs.core.Response dropDatabase(String db,
                                     boolean ifExists,
                                     String option,
                                     String group,
                                     String permissions)
                                       throws HcatException,
                                              NotAuthorizedException,
                                              BusyException,
                                              BadParam,
                                              org.apache.commons.exec.ExecuteException,
                                              IOException

Drop a database

Throws:: HcatException; NotAuthorizedException; BusyException; BadParam; org.apache.commons.exec.ExecuteException; IOException

listColumns

public javax.ws.rs.core.Response listColumns(String db,
                                    String table)
                                      throws HcatException,
                                             NotAuthorizedException,
                                             BusyException,
                                             BadParam,
                                             org.apache.commons.exec.ExecuteException,
                                             IOException

List the columns in an hcat table. Currently the same as describe table.

Throws:: HcatException; NotAuthorizedException; BusyException; BadParam; org.apache.commons.exec.ExecuteException; IOException

descColumn

public javax.ws.rs.core.Response descColumn(String db,
                                   String table,
                                   String column)
                                     throws SimpleWebException,
                                            NotAuthorizedException,
                                            BusyException,
                                            BadParam,
                                            org.apache.commons.exec.ExecuteException,
                                            IOException

Describe a single column in an hcat table.

Throws:: SimpleWebException; NotAuthorizedException; BusyException; BadParam; org.apache.commons.exec.ExecuteException; IOException

addOneColumn

public javax.ws.rs.core.Response addOneColumn(String db,
                                     String table,
                                     String column,
                                     ColumnDesc desc)
                                       throws HcatException,
                                              NotAuthorizedException,
                                              BusyException,
                                              BadParam,
                                              org.apache.commons.exec.ExecuteException,
                                              IOException

Create a column in an hcat table.

Throws:: HcatException; NotAuthorizedException; BusyException; BadParam; org.apache.commons.exec.ExecuteException; IOException

mapReduceStreaming

public EnqueueBean mapReduceStreaming(List<String> inputs,
                             String inputreader,
                             String output,
                             String mapper,
                             String reducer,
                             String combiner,
                             List<String> fileList,
                             String files,
                             List<String> defines,
                             List<String> cmdenvs,
                             List<String> args,
                             String statusdir,
                             String callback,
                             boolean enablelog,
                             Boolean enablejobreconnect)
                               throws NotAuthorizedException,
                                      BusyException,
                                      BadParam,
                                      QueueException,
                                      org.apache.commons.exec.ExecuteException,
                                      IOException,
                                      InterruptedException

Run a MapReduce Streaming job.

Parameters:: callback - URL which WebHCat will call when the hive job finishes
Throws:: NotAuthorizedException; BusyException; BadParam; QueueException; org.apache.commons.exec.ExecuteException; IOException; InterruptedException

mapReduceJar

public EnqueueBean mapReduceJar(String jar,
                       String mainClass,
                       String libjars,
                       String files,
                       List<String> args,
                       List<String> defines,
                       String statusdir,
                       String callback,
                       boolean usesHcatalog,
                       boolean enablelog,
                       Boolean enablejobreconnect)
                         throws NotAuthorizedException,
                                BusyException,
                                BadParam,
                                QueueException,
                                org.apache.commons.exec.ExecuteException,
                                IOException,
                                InterruptedException

Run a MapReduce Jar job. Params correspond to the REST api params

Parameters:: usesHcatalog - if true, means the Jar uses HCat and thus needs to access metastore, which requires additional steps for WebHCat to perform in a secure cluster.; callback - URL which WebHCat will call when the hive job finishes
Throws:: NotAuthorizedException; BusyException; BadParam; QueueException; org.apache.commons.exec.ExecuteException; IOException; InterruptedException
See Also:: TempletonControllerJob

pig

public EnqueueBean pig(String execute,
              String srcFile,
              List<String> pigArgs,
              String otherFiles,
              String statusdir,
              String callback,
              boolean usesHcatalog,
              boolean enablelog,
              Boolean enablejobreconnect)
                throws NotAuthorizedException,
                       BusyException,
                       BadParam,
                       QueueException,
                       org.apache.commons.exec.ExecuteException,
                       IOException,
                       InterruptedException

Run a Pig job. Params correspond to the REST api params. If '-useHCatalog' is in the pigArgs, usesHcatalog, is interpreted as true.

Parameters:: usesHcatalog - if true, means the Pig script uses HCat and thus needs to access metastore, which requires additional steps for WebHCat to perform in a secure cluster. This does nothing to ensure that Pig is installed on target node in the cluster.; callback - URL which WebHCat will call when the hive job finishes
Throws:: NotAuthorizedException; BusyException; BadParam; QueueException; org.apache.commons.exec.ExecuteException; IOException; InterruptedException
See Also:: TempletonControllerJob

sqoop

public EnqueueBean sqoop(String command,
                String optionsFile,
                String libdir,
                String otherFiles,
                String statusdir,
                String callback,
                boolean enablelog,
                Boolean enablejobreconnect)
                  throws NotAuthorizedException,
                         BusyException,
                         BadParam,
                         QueueException,
                         IOException,
                         InterruptedException

Run a Sqoop job.

Parameters:: optionsFile - name of option file which contains Sqoop command to run; otherFiles - additional files to be shipped to the launcher, such as option files which contain part of the Sqoop command; libdir - dir containing JDBC jars that Sqoop will need to interact with the database; statusdir - where the stderr/stdout of templeton controller job goes; callback - URL which WebHCat will call when the sqoop job finishes; enablelog - whether to collect mapreduce log into statusdir/logs; enablejobreconnect - whether to reconnect to a running child job on templeton controller job retry
Throws:: NotAuthorizedException; BusyException; BadParam; QueueException; IOException; InterruptedException

hive
```
public EnqueueBean hive(String execute,
               String srcFile,
               List<String> hiveArgs,
               String otherFiles,
               List<String> defines,
               String statusdir,
               String callback,
               boolean enablelog,
               Boolean enablejobreconnect)
                 throws NotAuthorizedException,
                        BusyException,
                        BadParam,
                        QueueException,
                        org.apache.commons.exec.ExecuteException,
                        IOException,
                        InterruptedException
```
Run a Hive job.

Parameters:
execute - SQL statement to run, equivalent to "-e" from hive command line
srcFile - name of hive script file to run, equivalent to "-f" from hive command line
hiveArgs - additional command line argument passed to the hive command line. Please check https://cwiki.apache.org/Hive/languagemanual-cli.html for detailed explanation of command line arguments
otherFiles - additional files to be shipped to the launcher, such as the jars used in "add jar" statement in hive script
defines - shortcut for command line arguments "--define"
statusdir - where the stderr/stdout of templeton controller job goes
callback - URL which WebHCat will call when the hive job finishes
enablelog - whether to collect mapreduce log into statusdir/logs
enablejobreconnect - whether to reconnect to a running child job on templeton controller job retry

Throws:

NotAuthorizedException

BusyException

BadParam

QueueException

org.apache.commons.exec.ExecuteException

IOException

InterruptedException

showJobId

public QueueStatusBean showJobId(String jobid)
                          throws NotAuthorizedException,
                                 BadParam,
                                 IOException,
                                 InterruptedException

Return the status of the jobid.

Throws:: NotAuthorizedException; BadParam; IOException; InterruptedException

deleteJobId

public QueueStatusBean deleteJobId(String jobid)
                            throws NotAuthorizedException,
                                   BadParam,
                                   IOException,
                                   InterruptedException

Kill a job in the queue.

Throws:: NotAuthorizedException; BadParam; IOException; InterruptedException

showJobList
```
public List<JobItemBean> showJobList(String fields,
                            boolean showall,
                            String jobid,
                            String numrecords)
                              throws NotAuthorizedException,
                                     BadParam,
                                     IOException,
                                     InterruptedException
```
Return all the known job ids for this user based on the optional filter conditions.
Example usages: 1. curl -s 'http://localhost:50111/templeton/v1/jobs?user.name=hsubramaniyan' Return all the Job IDs submitted by hsubramaniyan 2. curl -s 'http://localhost:50111/templeton/v1/jobs?user.name=hsubramaniyan&showall=true' Return all the Job IDs that are visible to hsubramaniyan 3. curl -s 'http://localhost:50111/templeton/v1/jobs?user.name=hsubramaniyan&jobid=job_201312091733_0003' Return all the Job IDs for hsubramaniyan after job_201312091733_0003. 4. curl -s 'http://localhost:50111/templeton/v1/jobs? user.name=hsubramaniyan&jobid=job_201312091733_0003&numrecords=5' Return the first 5(atmost) Job IDs submitted by hsubramaniyan after job_201312091733_0003. 5. curl -s 'http://localhost:50111/templeton/v1/jobs?user.name=hsubramaniyan&numrecords=5' Return the first 5(atmost) Job IDs submitted by hsubramaniyan after sorting the Job ID list lexicographically.

Supporting pagination using "jobid" and "numrecords" parameters: Step 1: Get the start "jobid" = job_xxx_000, "numrecords" = n Step 2: Issue a curl command by specifying the user-defined "numrecords" and "jobid" Step 3: If list obtained from Step 2 has size equal to "numrecords", retrieve the list's last record and get the Job Id of the last record as job_yyy_k, else quit. Step 4: set "jobid"=job_yyy_k and go to step 2.

Parameters:
fields - If "fields" set to "*", the request will return full details of the job. If "fields" is missing, will only return the job ID. Currently the value can only be "*", other values are not allowed and will throw exception.
showall - If "showall" is set to "true", the request will return all jobs the user has permission to view, not only the jobs belonging to the user.
jobid - If "jobid" is present, the records whose Job Id is lexicographically greater than "jobid" are only returned. For example, if "jobid" = "job_201312091733_0001", the jobs whose Job ID is greater than "job_201312091733_0001" are returned. The number of records returned depends on the value of "numrecords".
numrecords - If the "jobid" and "numrecords" parameters are present, the top #numrecords records appearing after "jobid" will be returned after sorting the Job Id list lexicographically. If "jobid" parameter is missing and "numrecords" is present, the top #numrecords will be returned after lexicographically sorting the Job Id list. If "jobid" parameter is present and "numrecords" is missing, all the records whose Job Id is greater than "jobid" are returned.

Returns:
list of job items based on the filter conditions specified by the user.

Throws:

NotAuthorizedException

BadParam

IOException

InterruptedException

completeJob

public CompleteBean completeJob(String jobid,
                       String jobStatus)
                         throws CallbackFailedException,
                                IOException

Notify on a completed job. Called by JobTracker.

Throws:: CallbackFailedException; IOException

verifyUser
```
public void verifyUser()
                throws NotAuthorizedException
```
Verify that we have a valid user. Throw an exception if invalid.

Throws:

NotAuthorizedException

verifyParam

public void verifyParam(String param,
               String name)
                 throws BadParam

Verify that the parameter exists. Throw an exception if invalid.

Throws:: BadParam

verifyParam

public void verifyParam(List<String> param,
               String name)
                 throws BadParam

Verify that the parameter exists. Throw an exception if invalid.

Throws:: BadParam

verifyDdlParam
```
public void verifyDdlParam(String param,
                  String name)
                    throws BadParam
```
Verify that the parameter exists and is a simple DDL identifier name. Throw an exception if invalid. Bug: This needs to allow for quoted ddl identifiers.

Throws:

BadParam

getCompletedUrl
```
public String getCompletedUrl()
```
The callback url on this server when a task is completed.

Class Server

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

VERSION

DO_AS_PARAM

STATUS_OK

SUPPORTED_VERSIONS

SUPPORTED_FORMATS

execService

DDL_ID

Constructor Detail

Server

Method Detail

status

requestFormats

version

hadoopVersion

hiveVersion

sqoopVersion

pigVersion

ddl

listTables

createTable

createTableLike

descTable

dropTable

renameTable

descOneTableProperty

listTableProperties

addOneTableProperty

listPartitions

descPartition

addOnePartition

dropPartition

listDatabases

descDatabase

createDatabase

dropDatabase

listColumns

descColumn

addOneColumn

mapReduceStreaming

mapReduceJar

pig

sqoop

hive

showJobId

deleteJobId

showJobList

completeJob

verifyUser

verifyParam

verifyParam

verifyDdlParam

getCompletedUrl