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


/*
 *   Copyright 2010 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 javax.jws.WebMethod;
import javax.jws.WebParam;
import javax.jws.WebService;
import net.brutex.xservices.types.FileSetResource;
import net.brutex.xservices.types.HostConnection;
import net.brutex.xservices.types.HostinfoType;
import net.brutex.xservices.types.MailMimeType;
import net.brutex.xservices.types.ReturnCode;
import net.brutex.xservices.util.BrutexNamespaces;
 
import org.apache.cxf.aegis.type.java5.XmlElement;
import org.apache.cxf.annotations.WSDLDocumentation;
import org.apache.cxf.annotations.WSDLDocumentationCollection;
 
/**
 *
 * @author Brian Rosenberger, bru@brutex.de
 * @since 0.4.0
 */
@WebService(targetNamespace = BrutexNamespaces.WS_XSERVICES)
@WSDLDocumentation("Various service operations.")
public interface MiscService {
 
    
    
    /**
     * @param hostname
     * @return ReturnCode
     */
    @WebMethod(operationName = "getHostinfo")
    @WSDLDocumentation(value = "Get information about a host.")
    public HostinfoType getHostinfo(
    		@WebParam(name = "hostname") @XmlElement(minOccurs="1", nillable=false ) String hostname);
 
    /**
     *
     * @param mailhost
     * @param from
     * @param tolist
     * @param subject
     * @param message
     * @return ReturnCode
     */
    @WebMethod(operationName = "sendMailSimple")
    @WSDLDocumentation(value = "Send an email (simple).")
    public ReturnCode sendMailSimple(
    		@WebParam(name = "mailhost") @XmlElement(minOccurs="1", nillable=false) HostConnection mailhost,
            @WebParam(name = "from") @XmlElement(minOccurs="1", nillable=false) String from,
            @WebParam(name = "to") @XmlElement(minOccurs="1", nillable=false) String tolist,
            @WebParam(name = "subject") String subject,
            @WebParam(name = "message") String message);
 
    /**
     *
     * @param mailhost
     * @param from
     * @param tolist
     * @param subject
     * @param message
     * @param res
     * @return ReturnCode
     */
    @WebMethod(operationName = "sendMailSimpleWithAttachment")
    @WSDLDocumentation(value = "Send an email with attachment (simple).")
    public ReturnCode sendMailSimpleWithAttachment(
    		@WebParam(name = "mailhost") @XmlElement(minOccurs="1", nillable=false) HostConnection mailhost,
            @WebParam(name = "from") @XmlElement(minOccurs="1", nillable=false) String from,
            @WebParam(name = "to") @XmlElement(minOccurs="1", nillable=false) String tolist,
            @WebParam(name = "subject") String subject,
            @WebParam(name = "message") String message,
            @WebParam(name = "attachments") FileSetResource res);
 
    /**
     *
     * @param mailhost
     * @param from
     * @param tolist
     * @param cclist
     * @param bcclist
     * @param subject
     * @param mimetype
     * @param charset
     * @param message
     * @param res
     * @param ssl
     * @param tls
     * @return ReturnCode
     */
    @WebMethod(operationName = "sendMail")
    @WSDLDocumentation(value = "Send an email (advanced).")
    public ReturnCode sendMail(
    		@WebParam(name = "mailhost") @XmlElement(minOccurs="1", nillable=false) HostConnection mailhost,
            @WebParam(name = "from") @XmlElement(minOccurs="1", nillable=false) String from,
            @WebParam(name = "to") @XmlElement(minOccurs="1", nillable=false) String tolist,
            @WebParam(name = "cc") String cclist,
            @WebParam(name = "bcc") String bcclist,
            @WebParam(name = "subject") String subject,
            @WebParam(name = "mimetype") MailMimeType mimetype,
            @WebParam(name = "charset") String charset,
            @WebParam(name = "message") String message,
            @WebParam(name = "attachments") FileSetResource res,
            @WebParam(name = "useSSL") boolean ssl,
            @WebParam(name = "useStartTLS") boolean tls);
 
    /**
     *
     * @param minutes
     * @param seconds
     * @return ReturnCode
     */
    @WebMethod(operationName = "sleep")
    @WSDLDocumentation(value = "Delay request response a specified duration.")
    public ReturnCode sleep(
    		@WebParam(name = "minutes") int minutes,
            @WebParam(name = "seconds") int seconds);
    
    
    /**
     * @return ReturnCode
     */
    @WebMethod(operationName = "getInfo")
    @WSDLDocumentation(value = "Get XService information.")
    public ReturnCode getInfo();
    
    /**
     * Generate a UUID
     * @return new UUID
     */
    @WebMethod(operationName = "generateUUID")
    @WSDLDocumentation(value = "Generate a UUID.")
    public String generateUUID();
    
}

Rev 78	Rev 79
1	`/*`	1	`/*`
2	`* Copyright 2010 Brian Rosenberger (Brutex Network)`	2	`* Copyright 2010 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	`package net.brutex.xservices.ws;`	16	`package net.brutex.xservices.ws;`
17		17
18	`import javax.jws.WebMethod;`	18	`import javax.jws.WebMethod;`
19	`import javax.jws.WebParam;`	19	`import javax.jws.WebParam;`
20	`import javax.jws.WebService;`	20	`import javax.jws.WebService;`
21	`import net.brutex.xservices.types.FileSetResource;`	21	`import net.brutex.xservices.types.FileSetResource;`
22	`import net.brutex.xservices.types.HostConnection;`	22	`import net.brutex.xservices.types.HostConnection;`
23	`import net.brutex.xservices.types.HostinfoType;`	23	`import net.brutex.xservices.types.HostinfoType;`
24	`import net.brutex.xservices.types.MailMimeType;`	24	`import net.brutex.xservices.types.MailMimeType;`
25	`import net.brutex.xservices.types.ReturnCode;`	25	`import net.brutex.xservices.types.ReturnCode;`
26	`import net.brutex.xservices.util.BrutexNamespaces;`	26	`import net.brutex.xservices.util.BrutexNamespaces;`
27		27
28	`import org.apache.cxf.aegis.type.java5.XmlElement;`	28	`import org.apache.cxf.aegis.type.java5.XmlElement;`
29	`import org.apache.cxf.annotations.WSDLDocumentation;`	29	`import org.apache.cxf.annotations.WSDLDocumentation;`
30	`import org.apache.cxf.annotations.WSDLDocumentationCollection;`	30	`import org.apache.cxf.annotations.WSDLDocumentationCollection;`
31		31
32	`/**`	32	`/**`
33	`*`	33	`*`
34	`* @author Brian Rosenberger, bru@brutex.de`	34	`* @author Brian Rosenberger, bru@brutex.de`
35	`* @since 0.4.0`	35	`* @since 0.4.0`
36	`*/`	36	`*/`
37	`@WebService(targetNamespace = BrutexNamespaces.WS_XSERVICES)`	37	`@WebService(targetNamespace = BrutexNamespaces.WS_XSERVICES)`
38	`@WSDLDocumentation("Various service operations.")`	38	`@WSDLDocumentation("Various service operations.")`
39	`public interface MiscService {`	39	`public interface MiscService {`
40		40
41		41
42		42
43	`/**`	43	`/**`
44	`* @param hostname`	44	`* @param hostname`
45	`* @return ReturnCode`	45	`* @return ReturnCode`
46	`*/`	46	`*/`
47	`@WebMethod(operationName = "getHostinfo")`	47	`@WebMethod(operationName = "getHostinfo")`
48	`@WSDLDocumentation(value = "Get information about a host.")`	48	`@WSDLDocumentation(value = "Get information about a host.")`
49	`public HostinfoType getHostinfo(`	49	`public HostinfoType getHostinfo(`
50	`@WebParam(name = "hostname") @XmlElement(minOccurs="1", nillable=false ) String hostname);`	50	`@WebParam(name = "hostname") @XmlElement(minOccurs="1", nillable=false ) String hostname);`
51		51
52	`/**`	52	`/**`
53	`*`	53	`*`
54	`* @param mailhost`	54	`* @param mailhost`
55	`* @param from`	55	`* @param from`
56	`* @param tolist`	56	`* @param tolist`
57	`* @param subject`	57	`* @param subject`
58	`* @param message`	58	`* @param message`
59	`* @return ReturnCode`	59	`* @return ReturnCode`
60	`*/`	60	`*/`
61	`@WebMethod(operationName = "sendMailSimple")`	61	`@WebMethod(operationName = "sendMailSimple")`
62	`@WSDLDocumentation(value = "Send an email (simple).")`	62	`@WSDLDocumentation(value = "Send an email (simple).")`
-		63	`public ReturnCode sendMailSimple(`
63	`public ReturnCode sendMailSimple(@WebParam(name = "mailhost") HostConnection mailhost,`	64	`@WebParam(name = "mailhost") @XmlElement(minOccurs="1", nillable=false) HostConnection mailhost,`
64	`@WebParam(name = "from") String from,`	65	`@WebParam(name = "from") @XmlElement(minOccurs="1", nillable=false) String from,`
65	`@WebParam(name = "to") String tolist,`	66	`@WebParam(name = "to") @XmlElement(minOccurs="1", nillable=false) String tolist,`
66	`@WebParam(name = "subject") String subject,`	67	`@WebParam(name = "subject") String subject,`
67	`@WebParam(name = "message") String message);`	68	`@WebParam(name = "message") String message);`
68		69
69	`/**`	70	`/**`
70	`*`	71	`*`
71	`* @param mailhost`	72	`* @param mailhost`
72	`* @param from`	73	`* @param from`
73	`* @param tolist`	74	`* @param tolist`
74	`* @param subject`	75	`* @param subject`
75	`* @param message`	76	`* @param message`
76	`* @param res`	77	`* @param res`
77	`* @return ReturnCode`	78	`* @return ReturnCode`
78	`*/`	79	`*/`
79	`@WebMethod(operationName = "sendMailSimpleWithAttachment")`	80	`@WebMethod(operationName = "sendMailSimpleWithAttachment")`
80	`@WSDLDocumentation(value = "Send an email with attachment (simple).")`	81	`@WSDLDocumentation(value = "Send an email with attachment (simple).")`
-		82	`public ReturnCode sendMailSimpleWithAttachment(`
81	`public ReturnCode sendMailSimpleWithAttachment(@WebParam(name = "mailhost") HostConnection mailhost,`	83	`@WebParam(name = "mailhost") @XmlElement(minOccurs="1", nillable=false) HostConnection mailhost,`
82	`@WebParam(name = "from") String from,`	84	`@WebParam(name = "from") @XmlElement(minOccurs="1", nillable=false) String from,`
83	`@WebParam(name = "to") String tolist,`	85	`@WebParam(name = "to") @XmlElement(minOccurs="1", nillable=false) String tolist,`
84	`@WebParam(name = "subject") String subject,`	86	`@WebParam(name = "subject") String subject,`
85	`@WebParam(name = "message") String message,`	87	`@WebParam(name = "message") String message,`
86	`@WebParam(name = "attachments") FileSetResource res);`	88	`@WebParam(name = "attachments") FileSetResource res);`
87		89
88	`/**`	90	`/**`
89	`*`	91	`*`
90	`* @param mailhost`	92	`* @param mailhost`
91	`* @param from`	93	`* @param from`
92	`* @param tolist`	94	`* @param tolist`
93	`* @param cclist`	95	`* @param cclist`
94	`* @param bcclist`	96	`* @param bcclist`
95	`* @param subject`	97	`* @param subject`
96	`* @param mimetype`	98	`* @param mimetype`
97	`* @param charset`	99	`* @param charset`
98	`* @param message`	100	`* @param message`
99	`* @param res`	101	`* @param res`
100	`* @param ssl`	102	`* @param ssl`
101	`* @param tls`	103	`* @param tls`
102	`* @return ReturnCode`	104	`* @return ReturnCode`
103	`*/`	105	`*/`
104	`@WebMethod(operationName = "sendMail")`	106	`@WebMethod(operationName = "sendMail")`
105	`@WSDLDocumentation(value = "Send an email (advanced).")`	107	`@WSDLDocumentation(value = "Send an email (advanced).")`
-		108	`public ReturnCode sendMail(`
106	`public ReturnCode sendMail(@WebParam(name = "mailhost") HostConnection mailhost,`	109	`@WebParam(name = "mailhost") @XmlElement(minOccurs="1", nillable=false) HostConnection mailhost,`
107	`@WebParam(name = "from") String from,`	110	`@WebParam(name = "from") @XmlElement(minOccurs="1", nillable=false) String from,`
108	`@WebParam(name = "to") String tolist,`	111	`@WebParam(name = "to") @XmlElement(minOccurs="1", nillable=false) String tolist,`
109	`@WebParam(name = "cc") String cclist,`	112	`@WebParam(name = "cc") String cclist,`
110	`@WebParam(name = "bcc") String bcclist,`	113	`@WebParam(name = "bcc") String bcclist,`
111	`@WebParam(name = "subject") String subject,`	114	`@WebParam(name = "subject") String subject,`
112	`@WebParam(name = "mimetype") MailMimeType mimetype,`	115	`@WebParam(name = "mimetype") MailMimeType mimetype,`
113	`@WebParam(name = "charset") String charset,`	116	`@WebParam(name = "charset") String charset,`
114	`@WebParam(name = "message") String message,`	117	`@WebParam(name = "message") String message,`
115	`@WebParam(name = "attachments") FileSetResource res,`	118	`@WebParam(name = "attachments") FileSetResource res,`
116	`@WebParam(name = "useSSL") boolean ssl,`	119	`@WebParam(name = "useSSL") boolean ssl,`
117	`@WebParam(name = "useStartTLS") boolean tls);`	120	`@WebParam(name = "useStartTLS") boolean tls);`
118		121
119	`/**`	122	`/**`
120	`*`	123	`*`
121	`* @param minutes`	124	`* @param minutes`
122	`* @param seconds`	125	`* @param seconds`
123	`* @return ReturnCode`	126	`* @return ReturnCode`
124	`*/`	127	`*/`
125	`@WebMethod(operationName = "sleep")`	128	`@WebMethod(operationName = "sleep")`
126	`@WSDLDocumentation(value = "Delay request response a specified duration.")`	129	`@WSDLDocumentation(value = "Delay request response a specified duration.")`
-		130	`public ReturnCode sleep(`
127	`public ReturnCode sleep(@WebParam(name = "minutes") int minutes,`	131	`@WebParam(name = "minutes") int minutes,`
128	`@WebParam(name = "seconds") int seconds);`	132	`@WebParam(name = "seconds") int seconds);`
129		133
130		134
131	`/**`	135	`/**`
132	`* @return ReturnCode`	136	`* @return ReturnCode`
133	`*/`	137	`*/`
134	`@WebMethod(operationName = "getInfo")`	138	`@WebMethod(operationName = "getInfo")`
135	`@WSDLDocumentation(value = "Get XService information.")`	139	`@WSDLDocumentation(value = "Get XService information.")`
136	`public ReturnCode getInfo();`	140	`public ReturnCode getInfo();`
137		141
138	`/**`	142	`/**`
139	`* Generate a UUID`	143	`* Generate a UUID`
140	`* @return new UUID`	144	`* @return new UUID`
141	`*/`	145	`*/`
142	`@WebMethod(operationName = "generateUUID")`	146	`@WebMethod(operationName = "generateUUID")`
143	`@WSDLDocumentation(value = "Generate a UUID.")`	147	`@WSDLDocumentation(value = "Generate a UUID.")`
144	`public String generateUUID();`	148	`public String generateUUID();`
145		149
146	`}`	150	`}`

Subversion Repositories XServices

(root)/xservices/trunk/src/java/net/brutex/xservices/ws/MiscService.java – Rev 78 → 79