Package com.logicaldoc.enterprise.webservice.soap.client

Class SoapTaskClient

java.lang.Object

com.logicaldoc.webservice.soap.client.SoapClient<TaskService>

com.logicaldoc.enterprise.webservice.soap.client.SoapTaskClient

All Implemented Interfaces:

TaskService

public class SoapTaskClient
extends com.logicaldoc.webservice.soap.client.SoapClient<TaskService>
implements TaskService

Task Web Service client.

Since:

7.1.1

Author:

Marco Meschieri - LogicalDOC

Constructor Summary

Constructors

Constructor	Description
SoapTaskClient(String endpoint)

Method Summary

Modifier and Type	Method	Description
void	disable(String sid, String name)	Disables a task
void	enable(String sid, String name)	Enables a task
javax.activation.DataHandler	getLog(String sid, String name)	Gets the log file of a given task
WSTask	getTask(String sid, String name)	Gets a specific task
List<WSTask>	listTasks(String sid)	Gets the list of available tasks
void	saveLog(String sid, String name, File target)
void	start(String sid, String name)	Starts the execution of a task
void	stop(String sid, String name)	Stops the execution of a task

Methods inherited from class java.lang.Object

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

Constructor Details

SoapTaskClient

public SoapTaskClient(String endpoint)

Method Details

listTasks

public List<WSTask> listTasks(String sid)
                       throws AuthenticationException,
com.logicaldoc.webservice.WebserviceException,
com.logicaldoc.core.PersistenceException

Description copied from interface: TaskService

Gets the list of available tasks

Specified by:

listTasks in interface TaskService

Parameters:

sid - Session identifier

Returns:

The list of tasks

Throws:

AuthenticationException - the user has not been authenticated

com.logicaldoc.webservice.WebserviceException - Error in the webservice

com.logicaldoc.core.PersistenceException - error in the data layer

enable

public void enable(String sid,
 String name)
            throws AuthenticationException,
com.logicaldoc.webservice.WebserviceException,
com.logicaldoc.core.PersistenceException

Description copied from interface: TaskService

Enables a task

Specified by:

enable in interface TaskService

Parameters:

sid - Session identifier

name - The name of the task

Throws:

AuthenticationException - The user has not been authenticated

com.logicaldoc.webservice.WebserviceException - Error in the webservice

com.logicaldoc.core.PersistenceException - Error in the data layer

disable

public void disable(String sid,
 String name)
             throws AuthenticationException,
com.logicaldoc.webservice.WebserviceException,
com.logicaldoc.core.PersistenceException

Description copied from interface: TaskService

Disables a task

Specified by:

disable in interface TaskService

Parameters:

sid - Session identifier

name - The name of the task

Throws:

AuthenticationException - the user has not been authenticated

com.logicaldoc.webservice.WebserviceException - error in the scheduling system

com.logicaldoc.core.PersistenceException - error in the data layer

getTask

public WSTask getTask(String sid,
 String name)
               throws AuthenticationException,
com.logicaldoc.webservice.WebserviceException,
com.logicaldoc.core.PersistenceException

Description copied from interface: TaskService

Gets a specific task

Specified by:

getTask in interface TaskService

Parameters:

sid - identifier of the session

name - unique name of the task

Returns:

All task's metadata

Throws:

AuthenticationException - the user has not been authenticated

com.logicaldoc.webservice.WebserviceException - error in the server

com.logicaldoc.core.PersistenceException - error in the data layer

start

public void start(String sid,
 String name)
           throws AuthenticationException,
com.logicaldoc.webservice.WebserviceException,
com.logicaldoc.core.PersistenceException

Description copied from interface: TaskService

Starts the execution of a task

Specified by:

start in interface TaskService

Parameters:

sid - Session identifier

name - The name of the task

Throws:

AuthenticationException - the user has not been authenticated

com.logicaldoc.webservice.WebserviceException - error in the scheduling system

com.logicaldoc.core.PersistenceException - error in the data layer

stop

public void stop(String sid,
 String name)
          throws AuthenticationException,
com.logicaldoc.webservice.WebserviceException,
com.logicaldoc.core.PersistenceException

Description copied from interface: TaskService

Stops the execution of a task

Specified by:

stop in interface TaskService

Parameters:

sid - Session identifier

name - The name of the task

Throws:

AuthenticationException - the user has not been authenticated

com.logicaldoc.webservice.WebserviceException - error in the scheduling system

com.logicaldoc.core.PersistenceException - error in the data layer

getLog

public javax.activation.DataHandler getLog(String sid,
 String name)
                                    throws AuthenticationException,
com.logicaldoc.webservice.WebserviceException,
com.logicaldoc.core.PersistenceException

Description copied from interface: TaskService

Gets the log file of a given task

Specified by:

getLog in interface TaskService

Parameters:

sid - Session identifier

name - The name of the task

Returns:

The requested logger file

Throws:

AuthenticationException - the user has not been authenticated

com.logicaldoc.webservice.WebserviceException - error trying to access the log file

com.logicaldoc.core.PersistenceException - error in the data layer

saveLog

public void saveLog(String sid,
 String name,
 File target)
             throws IOException,
com.logicaldoc.webservice.WebserviceException,
com.logicaldoc.core.PersistenceException

Throws:

IOException

com.logicaldoc.webservice.WebserviceException

com.logicaldoc.core.PersistenceException