Subversion Repositories XServices

Rev

Rev 83 | Rev 87 | Go to most recent revision | Only display areas with differences | Ignore whitespace | Details | Blame | Last modification | View Log | RSS feed

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