Subversion Repositories XServices

Rev

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

Rev 70 Rev 83
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
 
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 org.apache.cxf.annotations.WSDLDocumentation;
26
import org.apache.cxf.annotations.WSDLDocumentation;
27
import org.apache.cxf.annotations.WSDLDocumentationCollection;
27
import org.apache.cxf.annotations.WSDLDocumentationCollection;
28
 
-
 
29
import net.brutex.xservices.types.ArchiveResource;
-
 
30
import net.brutex.xservices.types.AttachmentType;
-
 
31
import net.brutex.xservices.types.FileResource;
-
 
32
import net.brutex.xservices.types.FileSetResource;
28
 
33
import net.brutex.xservices.types.ReplacePattern;
29
import net.brutex.xservices.types.ReplacePattern;
-
 
30
import net.brutex.xservices.types.ReturnCode;
-
 
31
import net.brutex.xservices.types.ant.ArchiveResource;
-
 
32
import net.brutex.xservices.types.ant.AttachmentType;
-
 
33
import net.brutex.xservices.types.ant.FileResource;
34
import net.brutex.xservices.types.ReturnCode;
34
import net.brutex.xservices.types.ant.FileSetResource;
35
import net.brutex.xservices.util.BrutexNamespaces;
35
import net.brutex.xservices.util.BrutexNamespaces;
36
import net.brutex.xservices.util.XServicesDocumentation;
36
import net.brutex.xservices.util.XServicesDocumentation;
37
/**
37
/**
38
 * File related web service operations.
38
 * File related web service operations.
39
 * 
39
 * 
40
 * @author Brian Rosenberger
40
 * @author Brian Rosenberger
41
 * @since 0.3.0
41
 * @since 0.3.0
42
 *
42
 *
43
 */
43
 */
44
@WebService(targetNamespace = BrutexNamespaces.WS_XSERVICES)
44
@WebService(targetNamespace = BrutexNamespaces.WS_XSERVICES)
45
@WSDLDocumentationCollection(
45
@WSDLDocumentationCollection(
46
    {
46
    {
47
    	@WSDLDocumentation(value = BrutexNamespaces.BRUTEX_COPYRIGHT, placement = WSDLDocumentation.Placement.TOP)
47
    	@WSDLDocumentation(value = BrutexNamespaces.BRUTEX_COPYRIGHT, placement = WSDLDocumentation.Placement.TOP)
48
    }
48
    }
49
)
49
)
50
public interface FileService {
50
public interface FileService {
51
 
51
 
52
	final String OPERATION_BASENAME ="basename";
52
	final String OPERATION_BASENAME ="basename";
53
	final String OPERATION_DOWNLOADFILE ="downloadFile";
53
	final String OPERATION_DOWNLOADFILE ="downloadFile";
54
	final String OPERATION_UPLOADFILE ="uploadFile";
54
	final String OPERATION_UPLOADFILE ="uploadFile";
55
	final String OPERATION_COPY ="copy";
55
	final String OPERATION_COPY ="copy";
56
	final String OPERATION_COPYFILE ="copyFile";
56
	final String OPERATION_COPYFILE ="copyFile";
57
	final String OPERATION_LOADRESOURCE = "loadResource";
57
	final String OPERATION_LOADRESOURCE = "loadResource";
58
	final String OPERATION_LOADRESOURCEFROMARCHIVE = "loadResourceFromArchive";
58
	final String OPERATION_LOADRESOURCEFROMARCHIVE = "loadResourceFromArchive";
59
	final String OPERATION_ECHOTOFILE = "echoToFile";
59
	final String OPERATION_ECHOTOFILE = "echoToFile";
60
	final String OPERATION_CHANGEOWNER = "changeOwner";
60
	final String OPERATION_CHANGEOWNER = "changeOwner";
61
	final String OPERATION_CHANGEMODE = "changeMode";
61
	final String OPERATION_CHANGEMODE = "changeMode";
62
	final String OPERATION_CHANGEGROUP = "changeGroup";
62
	final String OPERATION_CHANGEGROUP = "changeGroup";
63
	final String OPERATION_REPLACEINFILE = "replaceInFile";
63
	final String OPERATION_REPLACEINFILE = "replaceInFile";
64
	final String OPERATION_REPLACEINFILE2 = "replaceInFile2";
64
	final String OPERATION_REPLACEINFILE2 = "replaceInFile2";
65
	final String OPERATION_REPLACEINFILEREGEX = "replaceInFileRegEx";
65
	final String OPERATION_REPLACEINFILEREGEX = "replaceInFileRegEx";
66
	
66
	
67
	final String PARAM_FILE = "file";
67
	final String PARAM_FILE = "file";
68
	final String PARAM_ENCODING = "encoding";
68
	final String PARAM_ENCODING = "encoding";
69
	final String PARAM_OVERRIDE = "override";
69
	final String PARAM_OVERRIDE = "override";
70
	
70
	
71
	/**
71
	/**
72
	 * @param filename
72
	 * @param filename
73
	 * @param suffix
73
	 * @param suffix
74
	 * @return The base name of the given file excluding the suffix. 
74
	 * @return The base name of the given file excluding the suffix. 
75
	 */
75
	 */
76
	@WSDLDocumentation(value = "The base name of the given file excluding the suffix.")
76
	@WSDLDocumentation(value = "The base name of the given file excluding the suffix.")
77
	@WebMethod(operationName = OPERATION_BASENAME)
77
	@WebMethod(operationName = OPERATION_BASENAME)
78
	public abstract String basename(
78
	public abstract String basename(
79
			@WebParam(name = PARAM_FILE) @XmlElement(required=true) String filename,
79
			@WebParam(name = PARAM_FILE) @XmlElement(required=true) String filename,
80
			@WebParam(name = "suffix") String suffix);
80
			@WebParam(name = "suffix") String suffix);
81
 
81
 
82
	/**
82
	/**
83
	 * @param res
83
	 * @param res
84
	 * @return The file itself (MTOM attachment or inline base64) including some file metadata.
84
	 * @return The file itself (MTOM attachment or inline base64) including some file metadata.
85
	 * @throws XServicesFault 
85
	 * @throws XServicesFault 
86
	 */
86
	 */
87
	@WSDLDocumentation(XServicesDocumentation.SERVICE_OPERATION_DOWNLOADFILE)
87
	@WSDLDocumentation(XServicesDocumentation.SERVICE_OPERATION_DOWNLOADFILE)
88
	@WebMethod(operationName = OPERATION_DOWNLOADFILE)
88
	@WebMethod(operationName = OPERATION_DOWNLOADFILE)
89
	public abstract AttachmentType downloadFile(
89
	public abstract AttachmentType downloadFile(
90
			@WebParam(name = FileResource.XML_NAME) FileResource res) throws XServicesFault;
90
			@WebParam(name = FileResource.XML_NAME) FileResource res) throws XServicesFault;
91
	
91
	
92
	/**
92
	/**
93
	 * @param file
93
	 * @param file
94
	 * @return The file name of the file that has been uploaded.
94
	 * @return The file name of the file that has been uploaded.
95
	 * @throws XServicesFault 
95
	 * @throws XServicesFault 
96
	 */
96
	 */
97
	@WSDLDocumentation(XServicesDocumentation.SERVICE_OPERATION_UPLOADFILE)
97
	@WSDLDocumentation(XServicesDocumentation.SERVICE_OPERATION_UPLOADFILE)
98
	@WebMethod(operationName = OPERATION_UPLOADFILE)
98
	@WebMethod(operationName = OPERATION_UPLOADFILE)
99
	public abstract String uploadFile(
99
	public abstract String uploadFile(
100
			@WebParam(name = PARAM_FILE) AttachmentType file) throws XServicesFault;
100
			@WebParam(name = PARAM_FILE) AttachmentType file) throws XServicesFault;
101
			
101
			
102
	/**
102
	/**
103
	 * @param src
103
	 * @param src
104
	 * @param todir
104
	 * @param todir
105
	 * @param plm
105
	 * @param plm
106
	 * @param overwrite
106
	 * @param overwrite
107
	 * @param encoding
107
	 * @param encoding
108
	 * @return 
108
	 * @return 
109
	 * @throws XServicesFault
109
	 * @throws XServicesFault
110
	 */
110
	 */
111
	@WSDLDocumentation(value = XServicesDocumentation.SERVICE_OPERATION_COPY)
111
	@WSDLDocumentation(value = XServicesDocumentation.SERVICE_OPERATION_COPY)
112
	@WebMethod(operationName = OPERATION_COPY)
112
	@WebMethod(operationName = OPERATION_COPY)
113
	public abstract ReturnCode copy(
113
	public abstract ReturnCode copy(
114
			@WebParam(name =  FileSetResource.XML_NAME) @XmlElement(required=true) FileSetResource src,
114
			@WebParam(name =  FileSetResource.XML_NAME) @XmlElement(required=true) FileSetResource src,
115
			@WebParam(name = "todir") @XmlElement(required=true) String todir,
115
			@WebParam(name = "todir") @XmlElement(required=true) String todir,
116
			@WebParam(name = "preservelastmodified") boolean plm,
116
			@WebParam(name = "preservelastmodified") boolean plm,
117
			@WebParam(name = PARAM_OVERRIDE) boolean overwrite,
117
			@WebParam(name = PARAM_OVERRIDE) boolean overwrite,
118
			@WebParam(name = PARAM_ENCODING) String encoding) throws XServicesFault;
118
			@WebParam(name = PARAM_ENCODING) String encoding) throws XServicesFault;
119
	
119
	
120
	/**
120
	/**
121
	 * @param fromFile
121
	 * @param fromFile
122
	 * @param tofile
122
	 * @param tofile
123
	 * @param overwrite
123
	 * @param overwrite
124
	 * @return
124
	 * @return
125
	 * @throws XServicesFault
125
	 * @throws XServicesFault
126
	 */
126
	 */
127
	@WSDLDocumentation(value = XServicesDocumentation.SERVICE_OPERATION_COPYFILE)
127
	@WSDLDocumentation(value = XServicesDocumentation.SERVICE_OPERATION_COPYFILE)
128
	@WebMethod(operationName = OPERATION_COPYFILE)
128
	@WebMethod(operationName = OPERATION_COPYFILE)
129
	public abstract ReturnCode copyFile(
129
	public abstract ReturnCode copyFile(
130
			@WebParam(name = "fromFile") @XmlElement(required=true) String fromFile,
130
			@WebParam(name = "fromFile") @XmlElement(required=true) String fromFile,
131
			@WebParam(name = "toFile") @XmlElement(required=true) String tofile,
131
			@WebParam(name = "toFile") @XmlElement(required=true) String tofile,
132
			@WebParam(name = PARAM_OVERRIDE) boolean overwrite) throws XServicesFault;
132
			@WebParam(name = PARAM_OVERRIDE) boolean overwrite) throws XServicesFault;
133
 
133
 
134
	/**
134
	/**
135
	 * @param res
135
	 * @param res
136
	 * @param encoding
136
	 * @param encoding
137
	 * @return content of the resource
137
	 * @return content of the resource
138
	 * @throws XServicesFault 
138
	 * @throws XServicesFault 
139
	 */
139
	 */
140
	@WSDLDocumentation(value = XServicesDocumentation.SERVICE_OPERATION_LOADRESOURCE)
140
	@WSDLDocumentation(value = XServicesDocumentation.SERVICE_OPERATION_LOADRESOURCE)
141
	@WebMethod(operationName = OPERATION_LOADRESOURCE)
141
	@WebMethod(operationName = OPERATION_LOADRESOURCE)
142
	public abstract String loadRes(
142
	public abstract String loadRes(
143
			@WebParam(name = FileResource.XML_NAME) FileResource res,
143
			@WebParam(name = FileResource.XML_NAME) FileResource res,
144
			@WebParam(name = PARAM_ENCODING) String encoding) throws XServicesFault;
144
			@WebParam(name = PARAM_ENCODING) String encoding) throws XServicesFault;
145
 
145
 
146
	/**
146
	/**
147
	 * @param res
147
	 * @param res
148
	 * @param encoding
148
	 * @param encoding
149
	 * @return content of the resource
149
	 * @return content of the resource
150
	 * @throws XServicesFault 
150
	 * @throws XServicesFault 
151
	 */
151
	 */
152
	@WSDLDocumentation(value = XServicesDocumentation.SERVICE_OPERATION_LOADRESOURCEFROMARCHIVE)
152
	@WSDLDocumentation(value = XServicesDocumentation.SERVICE_OPERATION_LOADRESOURCEFROMARCHIVE)
153
	@WebMethod(operationName = OPERATION_LOADRESOURCEFROMARCHIVE)
153
	@WebMethod(operationName = OPERATION_LOADRESOURCEFROMARCHIVE)
154
	public abstract String loadResFromArchive(
154
	public abstract String loadResFromArchive(
155
			@WebParam(name = "archiveresource") ArchiveResource res,
155
			@WebParam(name = "archiveresource") ArchiveResource res,
156
			@WebParam(name = PARAM_ENCODING) String encoding) throws XServicesFault;
156
			@WebParam(name = PARAM_ENCODING) String encoding) throws XServicesFault;
157
 
157
 
158
	/**
158
	/**
159
	 * @param message
159
	 * @param message
160
	 * @param file
160
	 * @param file
161
	 * @param encoding
161
	 * @param encoding
162
	 * @param append
162
	 * @param append
163
	 * @return
163
	 * @return
164
	 * @throws XServicesFault 
164
	 * @throws XServicesFault 
165
	 */
165
	 */
166
	@WSDLDocumentation(value = XServicesDocumentation.SERVICE_OPERATION_ECHOTOFILE)
166
	@WSDLDocumentation(value = XServicesDocumentation.SERVICE_OPERATION_ECHOTOFILE)
167
	@WebMethod(operationName = OPERATION_ECHOTOFILE)
167
	@WebMethod(operationName = OPERATION_ECHOTOFILE)
168
	public abstract ReturnCode echo2file(
168
	public abstract ReturnCode echo2file(
169
			@WebParam(name = "message") @XmlElement(required=true) String message,
169
			@WebParam(name = "message") @XmlElement(required=true) String message,
170
			@WebParam(name = PARAM_FILE) @XmlElement(required=true) String file,
170
			@WebParam(name = PARAM_FILE) @XmlElement(required=true) String file,
171
			@WebParam(name = PARAM_ENCODING) String encoding,
171
			@WebParam(name = PARAM_ENCODING) String encoding,
172
			@WebParam(name = "append") boolean append) throws XServicesFault;
172
			@WebParam(name = "append") boolean append) throws XServicesFault;
173
 
173
 
174
	/**
174
	/**
175
	 * Changes the owner of a file or all files inside specified directories. 
175
	 * Changes the owner of a file or all files inside specified directories. 
176
	 * Right now it has effect only under Unix/ Linux as it is implemented through
176
	 * Right now it has effect only under Unix/ Linux as it is implemented through
177
	 * the 'chown' command.
177
	 * the 'chown' command.
178
	 * 
178
	 * 
179
	 * @param res Collection of files/ directories
179
	 * @param res Collection of files/ directories
180
	 * @param owner Identifier of the new owner
180
	 * @param owner Identifier of the new owner
181
	 * @return 
181
	 * @return 
182
	 */
182
	 */
183
	@WebMethod(operationName = OPERATION_CHANGEOWNER)
183
	@WebMethod(operationName = OPERATION_CHANGEOWNER)
184
	public abstract ReturnCode changeOwner(
184
	public abstract ReturnCode changeOwner(
185
			@WebParam(name =  FileSetResource.XML_NAME) FileSetResource res,
185
			@WebParam(name =  FileSetResource.XML_NAME) FileSetResource res,
186
			@WebParam(name = "owner") @XmlElement(required=true) String owner);
186
			@WebParam(name = "owner") @XmlElement(required=true) String owner);
187
 
187
 
188
	/**
188
	/**
189
	 * Changes the group owner of a file or all files inside specified directories. 
189
	 * Changes the group owner of a file or all files inside specified directories. 
190
	 * Right now it has effect only under Unix/ Linux as it is implemented through
190
	 * Right now it has effect only under Unix/ Linux as it is implemented through
191
	 * the 'chgrp' command.
191
	 * the 'chgrp' command.
192
	 * 
192
	 * 
193
	 * @param res Collection of files/ directories
193
	 * @param res Collection of files/ directories
194
	 * @param group Identifier of the new group owner
194
	 * @param group Identifier of the new group owner
195
	 * @return
195
	 * @return
196
	 */
196
	 */
197
	@WebMethod(operationName = OPERATION_CHANGEGROUP)
197
	@WebMethod(operationName = OPERATION_CHANGEGROUP)
198
	public abstract ReturnCode changeGroup(
198
	public abstract ReturnCode changeGroup(
199
			@WebParam(name =  FileSetResource.XML_NAME) FileSetResource res,
199
			@WebParam(name =  FileSetResource.XML_NAME) FileSetResource res,
200
			@WebParam(name = "group") @XmlElement(required=true) String group);
200
			@WebParam(name = "group") @XmlElement(required=true) String group);
201
 
201
 
202
	/**
202
	/**
203
	 * @param res
203
	 * @param res
204
	 * @param perm
204
	 * @param perm
205
	 * @return
205
	 * @return
206
	 */
206
	 */
207
	@WebMethod(operationName = OPERATION_CHANGEMODE)
207
	@WebMethod(operationName = OPERATION_CHANGEMODE)
208
	public abstract ReturnCode changeMode(
208
	public abstract ReturnCode changeMode(
209
			@WebParam(name = FileSetResource.XML_NAME) FileSetResource res,
209
			@WebParam(name = FileSetResource.XML_NAME) FileSetResource res,
210
			@WebParam(name = "permissions") @XmlElement(required=true) String perm);
210
			@WebParam(name = "permissions") @XmlElement(required=true) String perm);
211
	
211
	
212
	/**
212
	/**
213
	 * @param res
213
	 * @param res
214
	 * @param search
214
	 * @param search
215
	 * @param replace
215
	 * @param replace
216
	 * @return
216
	 * @return
217
	 * @throws XServicesFault
217
	 * @throws XServicesFault
218
	 */
218
	 */
219
	@WSDLDocumentation(value = XServicesDocumentation.SERVICE_OPERATION_REPLACEINFILE)
219
	@WSDLDocumentation(value = XServicesDocumentation.SERVICE_OPERATION_REPLACEINFILE)
220
	@WebMethod(operationName = OPERATION_REPLACEINFILE)
220
	@WebMethod(operationName = OPERATION_REPLACEINFILE)
221
	public abstract ReturnCode replaceInFile(
221
	public abstract ReturnCode replaceInFile(
222
			@WebParam(name = FileResource.XML_NAME) @XmlElement(required=true) FileResource res,
222
			@WebParam(name = FileResource.XML_NAME) @XmlElement(required=true) FileResource res,
223
			@WebParam(name = "search") @XmlElement(required=true) String search,
223
			@WebParam(name = "search") @XmlElement(required=true) String search,
224
			@WebParam(name = "replace") @XmlElement(required=true) String replace) throws XServicesFault;
224
			@WebParam(name = "replace") @XmlElement(required=true) String replace) throws XServicesFault;
225
	
225
	
226
	/**
226
	/**
227
	 * @param res
227
	 * @param res
228
	 * @param patternList
228
	 * @param patternList
229
	 * @return
229
	 * @return
230
	 * @throws XServicesFault
230
	 * @throws XServicesFault
231
	 */
231
	 */
232
	@WSDLDocumentation(value = XServicesDocumentation.SERVICE_OPERATION_REPLACEINFILE2)
232
	@WSDLDocumentation(value = XServicesDocumentation.SERVICE_OPERATION_REPLACEINFILE2)
233
	@WebMethod(operationName = OPERATION_REPLACEINFILE2)
233
	@WebMethod(operationName = OPERATION_REPLACEINFILE2)
234
	public abstract ReturnCode replaceInFile2(
234
	public abstract ReturnCode replaceInFile2(
235
			@WebParam(name = FileResource.XML_NAME) FileResource res,
235
			@WebParam(name = FileResource.XML_NAME) FileResource res,
236
			@WebParam(name = "patternList") List<ReplacePattern> patternList) throws XServicesFault;
236
			@WebParam(name = "patternList") List<ReplacePattern> patternList) throws XServicesFault;
237
	
237
	
238
	/**
238
	/**
239
	 * @param res
239
	 * @param res
240
	 * @param search
240
	 * @param search
241
	 * @param replace
241
	 * @param replace
242
	 * @param flags
242
	 * @param flags
243
	 * @return
243
	 * @return
244
	 * @throws XServicesFault
244
	 * @throws XServicesFault
245
	 */
245
	 */
246
	@WSDLDocumentation(value = XServicesDocumentation.SERVICE_OPERATION_REPLACEINFILEREGEX)
246
	@WSDLDocumentation(value = XServicesDocumentation.SERVICE_OPERATION_REPLACEINFILEREGEX)
247
	@WebMethod(operationName = OPERATION_REPLACEINFILEREGEX)
247
	@WebMethod(operationName = OPERATION_REPLACEINFILEREGEX)
248
	public abstract ReturnCode replaceInFileRegEx(
248
	public abstract ReturnCode replaceInFileRegEx(
249
			@WebParam(name = FileResource.XML_NAME) FileResource res,
249
			@WebParam(name = FileResource.XML_NAME) FileResource res,
250
			@WebParam(name = "search") String search,
250
			@WebParam(name = "search") String search,
251
			@WebParam(name = "replace") String replace,
251
			@WebParam(name = "replace") String replace,
252
			@WebParam(name = "flags") String flags) throws XServicesFault;
252
			@WebParam(name = "flags") String flags) throws XServicesFault;
253
}
253
}
254
 
254
 
255
Generated by GNU Enscript 1.6.5.90.
255
Generated by GNU Enscript 1.6.5.90.
256
 
256
 
257
 
257