|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface CentralDispatcher
CentralDispatcher interface provides methods for accessing central dispatcher of the app server.
Implementations must have a constructor with a single Framework
argument.
Field Summary | |
---|---|
static java.lang.String |
FORMAT_XML
|
static java.lang.String |
FORMAT_YAML
|
Method Summary | |
---|---|
java.util.Collection<DeleteJobResult> |
deleteStoredJobs(java.util.Collection<java.lang.String> jobIds)
Delete the jobs specified by the IDs, and return a list of results |
ExecutionFollowResult |
followDispatcherExecution(java.lang.String id,
ExecutionFollowRequest request,
ExecutionFollowReceiver receiver)
Attempt to kill the execution of an item currently on the dispatcher queue |
ExecutionDetail |
getExecution(java.lang.String execId)
Return execution detail for a particular execution. |
DispatcherResult |
killDispatcherExecution(java.lang.String id)
Attempt to kill the execution of an item currently on the dispatcher queue |
java.util.Collection<QueuedItem> |
listDispatcherQueue()
Deprecated. The rundeck API requires a project parameter, use listDispatcherQueue(String) |
java.util.Collection<QueuedItem> |
listDispatcherQueue(java.lang.String project)
List the items on the dispatcher queue |
java.util.Collection<IStoredJob> |
listStoredJobs(IStoredJobsQuery query,
java.io.OutputStream output,
JobDefinitionFileFormat format)
Return a list of stored jobs matching the query criteria |
java.util.Collection<IStoredJobLoadResult> |
loadJobs(ILoadJobsRequest request,
java.io.File input,
JobDefinitionFileFormat format)
Upload Jobs.xml content to the server |
QueuedItemResult |
queueDispatcherJob(IDispatchedJob job)
Add a script dispatch to the dispatcher queue |
QueuedItemResult |
queueDispatcherScript(IDispatchedScript dispatch)
Add a script dispatch to the dispatcher queue |
void |
reportExecutionStatus(java.lang.String project,
java.lang.String title,
java.lang.String status,
int failedNodeCount,
int successNodeCount,
java.lang.String tags,
java.lang.String script,
java.lang.String summary,
java.util.Date start,
java.util.Date end)
Report execution status |
Field Detail |
---|
static final java.lang.String FORMAT_XML
static final java.lang.String FORMAT_YAML
Method Detail |
---|
QueuedItemResult queueDispatcherScript(IDispatchedScript dispatch) throws CentralDispatcherException
dispatch
- script dispatch descriptor
CentralDispatcherException
- if an error occursQueuedItemResult queueDispatcherJob(IDispatchedJob job) throws CentralDispatcherException
job
- job execution reference definition
CentralDispatcherException
- if an error occursjava.util.Collection<QueuedItem> listDispatcherQueue() throws CentralDispatcherException
listDispatcherQueue(String)
CentralDispatcherException
- if an error occursjava.util.Collection<QueuedItem> listDispatcherQueue(java.lang.String project) throws CentralDispatcherException
CentralDispatcherException
- if an error occursDispatcherResult killDispatcherExecution(java.lang.String id) throws CentralDispatcherException
id
- the ID string of the item
CentralDispatcherException
- if an error occursExecutionFollowResult followDispatcherExecution(java.lang.String id, ExecutionFollowRequest request, ExecutionFollowReceiver receiver) throws CentralDispatcherException
id
- the ID string of the item
CentralDispatcherException
- if an error occursjava.util.Collection<IStoredJob> listStoredJobs(IStoredJobsQuery query, java.io.OutputStream output, JobDefinitionFileFormat format) throws CentralDispatcherException
query
- jobs queryoutput
- optional outputstream to store the XML content
CentralDispatcherException
- if an error occursjava.util.Collection<DeleteJobResult> deleteStoredJobs(java.util.Collection<java.lang.String> jobIds) throws CentralDispatcherException
jobIds
- the job IDs
CentralDispatcherException
- if an error occursjava.util.Collection<IStoredJobLoadResult> loadJobs(ILoadJobsRequest request, java.io.File input, JobDefinitionFileFormat format) throws CentralDispatcherException
request
- load request parametersinput
- XML file
CentralDispatcherException
- if an error occursvoid reportExecutionStatus(java.lang.String project, java.lang.String title, java.lang.String status, int failedNodeCount, int successNodeCount, java.lang.String tags, java.lang.String script, java.lang.String summary, java.util.Date start, java.util.Date end) throws CentralDispatcherException
project
- projecttitle
- execution titlestatus
- result status, either 'succeed','cancel','fail'failedNodeCount
- count of failed nodessuccessNodeCount
- count of successful nodestags
- script
- script content (can be null if summary specified)summary
- summary of execution (can be null if script specified)start
- start date (can be null)end
- end date (can be null)
CentralDispatcherException
ExecutionDetail getExecution(java.lang.String execId) throws CentralDispatcherException
execId
- ID of the execution
CentralDispatcherException
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |