Subversion Repositories XServices

Rev

Details | Last modification | View Log | RSS feed

Rev Author Line No. Line
70 brianR 1
/*
2
 *   Copyright 2011 Brian Rosenberger (Brutex Network)
3
 *
4
 *   Licensed under the Apache License, Version 2.0 (the "License");
5
 *   you may not use this file except in compliance with the License.
6
 *   You may obtain a copy of the License at
7
 *
8
 *       http://www.apache.org/licenses/LICENSE-2.0
9
 *
10
 *   Unless required by applicable law or agreed to in writing, software
11
 *   distributed under the License is distributed on an "AS IS" BASIS,
12
 *   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13
 *   See the License for the specific language governing permissions and
14
 *   limitations under the License.
15
 */
16
 
17
package net.brutex.xservices.ws;
18
 
19
import java.math.BigInteger;
20
import java.util.GregorianCalendar;
21
import java.util.List;
22
 
23
import javax.jws.WebMethod;
24
import javax.jws.WebParam;
25
import javax.jws.WebService;
26
import javax.xml.bind.annotation.XmlElement;
27
 
28
import net.brutex.xservices.types.DateFormatType;
29
import net.brutex.xservices.types.DateTimeUnits;
30
import net.brutex.xservices.types.ScheduledJob;
31
import net.brutex.xservices.util.BrutexNamespaces;
32
 
33
import org.apache.cxf.annotations.WSDLDocumentation;
34
import org.apache.cxf.annotations.WSDLDocumentationCollection;
35
 
36
/**
37
 * Job management services.
38
 * @author Brian Rosenberger
39
 * @since 0.5.0
40
 *
41
 */
42
@WebService(targetNamespace = BrutexNamespaces.WS_XSERVICES)
43
public interface JobService {
44
 
45
	public static final String SERVICE_NAME = "JobService";
46
	final String OPERATION_GETJOBLIST = "getJobs";
47
	final String OPERATION_SCHEDULEJOB = "scheduleJob";
48
	final String OPERATION_GETJOB = "getJob";
49
	final String OPERATION_DELETEJOB = "deleteJob";
50
 
51
	final String PARAM_JOB = "job";
52
 
53
 
54
	/**
55
	 * Get a full list of all scheduled jobs.
56
	 *
57
	 * @return List of scheduled jobs
58
	 * @throws XServicesFault
59
	 */
60
	@WebMethod(operationName=OPERATION_GETJOBLIST)
61
	@WSDLDocumentation(value="Get list of scheduled jobs")
62
	public abstract List<ScheduledJob> getJobList() throws XServicesFault;
63
 
64
	/**
65
	 * Add a job to the scheduler.
66
	 *
67
	 * @param job
68
	 * @return The unique identifier of the job.
69
	 * @throws XServicesFault
70
	 */
71
	@WebMethod(operationName=OPERATION_SCHEDULEJOB)
72
	@WSDLDocumentation(value="Schedule a job")
73
	public abstract String scheduleJob(
74
			@WebParam(name=PARAM_JOB) @XmlElement(required=true) ScheduledJob job)
75
			throws XServicesFault;
76
 
77
	/**
78
	 * Get a job by id.
79
	 *
80
	 * @param uuid
81
	 * @return Job details
82
	 * @throws XServicesFault
83
	 */
84
	@WebMethod(operationName=OPERATION_GETJOB)
85
	@WSDLDocumentation(value="Get a job by id")
86
	public abstract ScheduledJob getJob(
87
			@WebParam(name="id") @XmlElement(required=true) String uuid) throws XServicesFault;
88
 
89
	/**
90
	 * Delete a job from scheduler.
91
	 *
92
	 * @param uuid Id of the job that should be deleted
93
	 * @throws XServicesFault
94
	 */
95
	@WebMethod(operationName=OPERATION_DELETEJOB)
96
	@WSDLDocumentation(value="Delete a scheduled job.")
97
	public abstract void deleteJob(
98
			@WebParam(name="id") @XmlElement(required=true) String uuid) throws XServicesFault;
99
 
100
 
101
 
102
}