|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.opends.server.tools.tasks.TaskClient
public class TaskClient
Helper class for interacting with the task backend on behalf of utilities that are capable of being scheduled.
Field Summary | |
---|---|
protected LDAPConnection |
connection
Connection through which task scheduling will take place. |
Constructor Summary | |
---|---|
TaskClient(LDAPConnection conn)
Creates a new TaskClient for interacting with the task backend remotely. |
Method Summary | |
---|---|
TaskEntry |
cancelTask(java.lang.String id)
Changes that the state of the task in the backend to a canceled state. |
java.util.List<TaskEntry> |
getTaskEntries()
Gets all the ds-task entries from the task root. |
TaskEntry |
getTaskEntry(java.lang.String id)
Gets the entry of the task whose ID is id from the directory. |
TaskEntry |
schedule(TaskScheduleInformation information)
Schedule a task for execution by writing an entry to the task backend. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
protected LDAPConnection connection
Constructor Detail |
---|
public TaskClient(LDAPConnection conn)
conn
- for accessing the task backendMethod Detail |
---|
public TaskEntry schedule(TaskScheduleInformation information) throws LDAPException, java.io.IOException, ASN1Exception, TaskClientException
information
- to be scheduled
java.io.IOException
- if there is a stream communication problem
LDAPException
- if there is a problem getting information
out to the directory
ASN1Exception
- if there is a problem with the encoding
TaskClientException
- if there is a problem with the task entrypublic java.util.List<TaskEntry> getTaskEntries() throws LDAPException, java.io.IOException, ASN1Exception
java.io.IOException
- if there is a stream communication problem
LDAPException
- if there is a problem getting information
out to the directory
ASN1Exception
- if there is a problem with the encodingpublic TaskEntry getTaskEntry(java.lang.String id) throws LDAPException, java.io.IOException, ASN1Exception, TaskClientException
id
from the directory.
id
- of the entry to retrieve
java.io.IOException
- if there is a stream communication problem
LDAPException
- if there is a problem getting information
out to the directory
ASN1Exception
- if there is a problem with the encoding
TaskClientException
- if there is no task with the requested idpublic TaskEntry cancelTask(java.lang.String id) throws TaskClientException, java.io.IOException, ASN1Exception, LDAPException
id
- if the task to cancel
java.io.IOException
- if there is a stream communication problem
LDAPException
- if there is a problem getting information
out to the directory
ASN1Exception
- if there is a problem with the encoding
TaskClientException
- if there is no task with the requested id
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |