WebSVN – XServices – Diff – /xservices/trunk/src/java/net/brutex/xservices/ws/JobService.java


/*
 *   Copyright 2011 Brian Rosenberger (Brutex Network)
 *
 *   Licensed under the Apache License, Version 2.0 (the "License");
 *   you may not use this file except in compliance with the License.
 *   You may obtain a copy of the License at
 *
 *       http://www.apache.org/licenses/LICENSE-2.0
 *
 *   Unless required by applicable law or agreed to in writing, software
 *   distributed under the License is distributed on an "AS IS" BASIS,
 *   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 *   See the License for the specific language governing permissions and
 *   limitations under the License.
 */
 
package net.brutex.xservices.ws;
 
import java.util.List;
 
import javax.jws.WebMethod;
import javax.jws.WebParam;
import javax.jws.WebService;
import javax.xml.bind.annotation.XmlElement;
 
import net.brutex.xservices.types.ScheduledJob;
import net.brutex.xservices.types.SchedulerStatisticsType;
import net.brutex.xservices.util.BrutexNamespaces;
 
import org.apache.cxf.annotations.WSDLDocumentation;
 
/**
 * Job management services.
 * @author Brian Rosenberger
 * @since 0.5.0
 *
 */
@WebService(targetNamespace = BrutexNamespaces.WS_XSERVICES)
public interface JobService {
	
	public static final String SERVICE_NAME = "JobService";
	final String OPERATION_GETJOBLIST = "getJobs";
	final String OPERATION_SCHEDULEJOB = "scheduleJob";
	final String OPERATION_GETJOB = "getJob";
	final String OPERATION_DELETEJOB = "deleteJob";
 
	final String OPERATION_GETSTATISTICS = "getStatistics";
	final String PARAM_JOB = "job";
	
	
	/**
	 * Get a full list of all scheduled jobs.
	 * 
	 * @return List of scheduled jobs
	 * @throws XServicesFault
	 */
	@WebMethod(operationName=OPERATION_GETJOBLIST)
	@WSDLDocumentation(value="Get list of scheduled jobs")
	public abstract List<ScheduledJob> getJobList() throws XServicesFault;
	
	/**
	 * Add a job to the scheduler.
	 * 
	 * @param job
	 * @return The unique identifier of the job.
	 * @throws XServicesFault
	 */
	@WebMethod(operationName=OPERATION_SCHEDULEJOB)
	@WSDLDocumentation(value="Schedule a job")
	public abstract String scheduleJob(
			@WebParam(name=PARAM_JOB) @XmlElement(required=true) ScheduledJob job)
			throws XServicesFault;
	
	/**
	 * Get a job by id.
	 * 
	 * @param uuid
	 * @return Job details
	 * @throws XServicesFault
	 */
	@WebMethod(operationName=OPERATION_GETJOB)
	@WSDLDocumentation(value="Get a job by id")
	public abstract ScheduledJob getJob(
			@WebParam(name="id") @XmlElement(required=true) String uuid) throws XServicesFault;
	
	/**
	 * Delete a job from scheduler.
	 * 
	 * @param uuid Id of the job that should be deleted
	 * @throws XServicesFault
	 */
	@WebMethod(operationName=OPERATION_DELETEJOB)
	@WSDLDocumentation(value="Delete a scheduled job.")
	public abstract void deleteJob(
			@WebParam(name="id") @XmlElement(required=true) String uuid) throws XServicesFault;
	
	/**
	 * Get statisctis about the scheduler
	 * @throws XServicesFault 
	 */
	@WebMethod(operationName=OPERATION_GETSTATISTICS)
	@WSDLDocumentation(value="Get scheduler statistics")
	public abstract SchedulerStatisticsType getStatistics() throws XServicesFault;
	
}

Subversion Repositories XServices

(root)/xservices/trunk/src/java/net/brutex/xservices/ws/JobService.java @ 112 – Rev 72 → 87

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