Subversion Repositories XServices

Rev

Rev 83 | Go to most recent revision | Details | Compare with Previous | Last modification | View Log | RSS feed

Rev Author Line No. Line
16 brianR 1
/*
2
 *   Copyright 2010 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
package net.brutex.xservices.ws;
17
 
18
import javax.jws.WebMethod;
19
import javax.jws.WebParam;
20
import javax.jws.WebService;
18 brianR 21
import net.brutex.xservices.types.HostConnection;
78 brianR 22
import net.brutex.xservices.types.HostinfoType;
22 brianR 23
import net.brutex.xservices.types.MailMimeType;
16 brianR 24
import net.brutex.xservices.types.ReturnCode;
83 brianR 25
import net.brutex.xservices.types.ant.FileSetResource;
16 brianR 26
import net.brutex.xservices.util.BrutexNamespaces;
78 brianR 27
 
28
import org.apache.cxf.aegis.type.java5.XmlElement;
83 brianR 29
import org.apache.cxf.aegis.type.java5.XmlReturnType;
23 brianR 30
import org.apache.cxf.annotations.WSDLDocumentation;
16 brianR 31
 
32
/**
85 brianR 33
 * Bundles various methods
16 brianR 34
 *
35
 * @author Brian Rosenberger, bru@brutex.de
70 brianR 36
 * @since 0.4.0
16 brianR 37
 */
21 brianR 38
@WebService(targetNamespace = BrutexNamespaces.WS_XSERVICES)
72 brianR 39
@WSDLDocumentation("Various service operations.")
16 brianR 40
public interface MiscService {
41
 
85 brianR 42
	/**
43
	 * Get IP address from host name.
44
	 *
23 brianR 45
     * @param hostname
72 brianR 46
     * @return ReturnCode
23 brianR 47
     */
21 brianR 48
    @WebMethod(operationName = "getHostinfo")
72 brianR 49
    @WSDLDocumentation(value = "Get information about a host.")
78 brianR 50
    public HostinfoType getHostinfo(
51
    		@WebParam(name = "hostname") @XmlElement(minOccurs="1", nillable=false ) String hostname);
18 brianR 52
 
85 brianR 53
 
23 brianR 54
    /**
85 brianR 55
     * Delay execution for a given time.
56
     *
23 brianR 57
     * @param minutes
58
     * @param seconds
72 brianR 59
     * @return ReturnCode
23 brianR 60
     */
21 brianR 61
    @WebMethod(operationName = "sleep")
72 brianR 62
    @WSDLDocumentation(value = "Delay request response a specified duration.")
79 brianR 63
    public ReturnCode sleep(
64
    		@WebParam(name = "minutes") int minutes,
21 brianR 65
            @WebParam(name = "seconds") int seconds);
54 brianR 66
 
67
 
72 brianR 68
    /**
69
     * @return ReturnCode
70
     */
54 brianR 71
    @WebMethod(operationName = "getInfo")
72 brianR 72
    @WSDLDocumentation(value = "Get XService information.")
54 brianR 73
    public ReturnCode getInfo();
74
 
78 brianR 75
    /**
76
     * Generate a UUID
77
     * @return new UUID
78
     */
79
    @WebMethod(operationName = "generateUUID")
80
    @WSDLDocumentation(value = "Generate a UUID.")
81
    public String generateUUID();
82
 
16 brianR 83
}