Subversion Repositories XServices

Rev

Rev 87 | Only display areas with differences | Ignore whitespace | Details | Blame | Last modification | View Log | RSS feed

Rev 87 Rev 111
1
/*
1
/*
2
 *   Copyright 2010 Brian Rosenberger (Brutex Network)
2
 *   Copyright 2013 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.RuntimeInfoType;
25
import net.brutex.xservices.types.RuntimeInfoType;
26
import net.brutex.xservices.types.ant.FileSetResource;
26
import net.brutex.xservices.types.ant.FileSetResource;
27
import net.brutex.xservices.util.BrutexNamespaces;
-
 
28
 
27
 
29
import org.apache.cxf.aegis.type.java5.XmlElement;
28
import org.apache.cxf.aegis.type.java5.XmlElement;
30
import org.apache.cxf.aegis.type.java5.XmlReturnType;
29
import org.apache.cxf.aegis.type.java5.XmlReturnType;
31
import org.apache.cxf.annotations.WSDLDocumentation;
30
import org.apache.cxf.annotations.WSDLDocumentation;
32
 
31
 
33
/**
32
/**
34
 * Bundles various methods
33
 * Bundles various methods
35
 *
34
 *
36
 * @author Brian Rosenberger, bru@brutex.de
35
 * @author Brian Rosenberger, bru@brutex.de
37
 * @since 0.4.0
36
 * @since 0.4.0
38
 */
37
 */
39
@WebService(targetNamespace = BrutexNamespaces.WS_XSERVICES)
38
@WebService(targetNamespace = net.brutex.xservices.util.BrutexNamespaces.WS_XSERVICES)
40
@WSDLDocumentation("Various service operations.")
39
@WSDLDocumentation("Various service operations.")
41
public interface MiscService {
40
public interface MiscService {
42
	
-
 
43
	public static final String OPERATION_GETMEMORY = "getMemory";
-
 
44
 
-
 
45
	/**
41
 
46
	 * Get IP address from host name.
42
	 public static final String OPERATION_GETMEMORY = "getMemory";
47
	 * 
-
 
48
     * @param hostname
-
 
49
     * @return ReturnCode
-
 
50
     */
43
 
51
    @WebMethod(operationName = "getHostinfo")
44
	  @WebMethod(operationName="getHostinfo")
52
    @WSDLDocumentation(value = "Get information about a host.")
-
 
53
    public HostinfoType getHostinfo(
45
	  @WSDLDocumentation("Get information about a host.")
54
    		@WebParam(name = "hostname") @XmlElement(minOccurs="1", nillable=false ) String hostname);
-
 
55
 
46
	  public abstract HostinfoType getHostinfo(@WebParam(name="hostname") @XmlElement(minOccurs="1", nillable=false) String paramString);
56
    
-
 
57
    /**
-
 
58
     * Delay execution for a given time.
-
 
59
     * 
-
 
60
     * @param minutes
-
 
61
     * @param seconds
-
 
62
     * @return ReturnCode
-
 
63
     */
47
 
64
    @WebMethod(operationName = "sleep")
48
	  @WebMethod(operationName="sleep")
65
    @WSDLDocumentation(value = "Delay request response a specified duration.")
-
 
66
    public ReturnCode sleep(
-
 
67
    		@WebParam(name = "minutes") int minutes,
49
	  @WSDLDocumentation("Delay request response a specified duration.")
68
            @WebParam(name = "seconds") int seconds);
-
 
69
    
50
	  public abstract ReturnCode sleep(@WebParam(name="minutes") int paramInt1, @WebParam(name="seconds") int paramInt2);
70
    
-
 
71
    /**
-
 
72
     * @return ReturnCode
-
 
73
     */
51
 
74
    @WebMethod(operationName = "getInfo")
52
	  @WebMethod(operationName="getInfo")
75
    @WSDLDocumentation(value = "Get XService information.")
53
	  @WSDLDocumentation("Get XService information.")
76
    public ReturnCode getInfo();
54
	  public abstract ReturnCode getInfo();
77
    
-
 
78
    /**
-
 
79
     * Generate a UUID
-
 
80
     * @return new UUID
-
 
81
     */
55
 
82
    @WebMethod(operationName = "generateUUID")
56
	  @WebMethod(operationName="generateUUID")
83
    @WSDLDocumentation(value = "Generate a UUID.")
57
	  @WSDLDocumentation("Generate a UUID.")
84
    public String generateUUID();
58
	  public abstract String generateUUID();
85
    
-
 
86
    /**
-
 
87
     * Get Memory information
-
 
88
     */
59
 
89
    @WebMethod(operationName = MiscService.OPERATION_GETMEMORY)
60
	  @WebMethod(operationName="getMemory")
90
    @WSDLDocumentation(value = "Get memory and processor information")
61
	  @WSDLDocumentation("Get memory and processor information")
91
    public RuntimeInfoType getMemory();
-
 
92
     
62
	  public abstract RuntimeInfoType getMemory();
93
}
63
}