com.asakusafw.yaess.jobqueue.client

Class HttpJobClient

java.lang.Object

com.asakusafw.yaess.jobqueue.client.HttpJobClient

All Implemented Interfaces:

JobClient

public class HttpJobClient
extends Object
implements JobClient

An implementation of JobClient via HTTP(S) connections.

Since:

0.2.6

Constructor Summary

Constructors

Constructor and Description
HttpJobClient(String baseUri) Creates a new instance.
HttpJobClient(String baseUri, String user, String password) Creates a new instance.

Method Summary

Modifier and Type	Method and Description
String	getBaseUri() Returns the base URI.
JobStatus	getStatus(JobId id) Obtains and returns the job information.
String	getUser() Returns the target user name for auth.
JobId	register(JobScript script) Creates a new job.
void	submit(JobId id) Request to execute the registered job.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

HttpJobClient

public HttpJobClient(String baseUri)

Creates a new instance.

Parameters:

baseUri - the target base URL

Throws:

IllegalArgumentException - if some parameters were null

HttpJobClient

public HttpJobClient(String baseUri,
                     String user,
                     String password)

Creates a new instance.

Parameters:

baseUri - the target base URL

user - user name

password - password

Throws:

IllegalArgumentException - if some parameters were null

Method Detail

getBaseUri

public String getBaseUri()

Returns the base URI. This URI must end with a slash.

Returns:

the base URI

getUser

public String getUser()

Returns the target user name for auth.

Returns:

the user name for auth, or null if there are no credentials

register

public JobId register(JobScript script)
               throws IOException,
                      InterruptedException

Description copied from interface: JobClient

Creates a new job.

Specified by:

register in interface JobClient

Parameters:

script - the job script

Returns:

the corresponded job ID

Throws:

IOException - if failed to create a new job

InterruptedException - if interrupted

getStatus

public JobStatus getStatus(JobId id)
                    throws IOException,
                           InterruptedException

Description copied from interface: JobClient

Obtains and returns the job information.

Specified by:

getStatus in interface JobClient

Parameters:

id - the target job ID

Returns:

the corresponded information

Throws:

IOException - if failed to obtain the information

InterruptedException - if interrupted

submit

public void submit(JobId id)
            throws IOException,
                   InterruptedException

Description copied from interface: JobClient

Request to execute the registered job.

Specified by:

submit in interface JobClient

Parameters:

id - the target job ID

Throws:

IOException - if failed to request the job

InterruptedException - if interrupted

toString

public String toString()

Overrides:

toString in class Object