WebSVN – XServices – Diff – /xservices/trunk/src/java/net/brutex/xservices/ws/FileService.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 java.util.List;
 import javax.jws.WebMethod;
 import javax.jws.WebParam;
 import javax.jws.WebService;
 import javax.xml.bind.annotation.XmlElement;
 import org.apache.cxf.annotations.WSDLDocumentation;
 import org.apache.cxf.annotations.WSDLDocumentationCollection;
 import com.sun.xml.internal.ws.api.model.wsdl.WSDLDescriptorKind;
 import net.brutex.xservices.types.ArchiveResource;
 import net.brutex.xservices.types.AttachmentType;
 import net.brutex.xservices.types.FileResource;
 import net.brutex.xservices.types.FileSetResource;
 import net.brutex.xservices.types.ReplacePattern;
 import net.brutex.xservices.types.ReturnCode;
 import net.brutex.xservices.util.BrutexNamespaces;
 import net.brutex.xservices.util.XServicesDocumentation;
 /**
  * @author Brian Rosenberger
+ *
  */
 @WebService(targetNamespace = BrutexNamespaces.WS_XSERVICES)
 @WSDLDocumentationCollection(
+    {
     	@WSDLDocumentation(value = BrutexNamespaces.BRUTEX_COPYRIGHT, placement = WSDLDocumentation.Placement.TOP)
+    }
+)
 public interface FileService {
+	public static final String OPERATION_BASENAME ="basename";
+	public static final String OPERATION_DOWNLOADFILE ="downloadFile";
+	public static final String OPERATION_UPLOADFILE ="uploadFile";
+	public static final String OPERATION_COPY ="copy";
+	public static final String OPERATION_COPYFILE ="copyFile";
+	public static final String OPERATION_LOADRESOURCE = "loadResource";
+	public static final String OPERATION_LOADRESOURCEFROMARCHIVE = "loadResourceFromArchive";
+	public static final String OPERATION_ECHOTOFILE = "echoToFile";
+	public static final String OPERATION_CHANGEOWNER = "changeOwner";
+	public static final String OPERATION_CHANGEMODE = "changeMode";
+	public static final String OPERATION_CHANGEGROUP = "changeGroup";
+	public static final String OPERATION_REPLACEINFILE = "replaceInFile";
+	public static final String OPERATION_REPLACEINFILE2 = "replaceInFile2";
+	public static final String OPERATION_REPLACEINFILEREGEX = "replaceInFileRegEx";
 	/**
 	 * @param filename
 	 * @param suffix
 	 * @return The base name of the given file excluding the suffix.
 	 */
 	@WSDLDocumentation(value = "The base name of the given file excluding the suffix.")
-	@WebMethod(operationName = "basename")
+	@WebMethod(operationName = OPERATION_BASENAME)
 	public abstract String basename(
 			@WebParam(name = "file") @XmlElement(required=true) String filename,
 			@WebParam(name = "suffix") String suffix);
 	/**
 	 * @param res
 	 * @return The file itself (MTOM attachment or inline base64) including some file metadata.
+	 * @throws XServicesFault
 	 */
 	@WSDLDocumentation(XServicesDocumentation.SERVICE_OPERATION_DOWNLOADFILE)
-	@WebMethod(operationName = "downloadFile")
+	@WebMethod(operationName = OPERATION_DOWNLOADFILE)
 	public abstract AttachmentType downloadFile(
-			@WebParam(name = "file") FileResource res);
+			@WebParam(name = FileResource.XML_NAME) FileResource res) throws XServicesFault;
 	/**
 	 * @param file
 	 * @return The file name of the file that has been uploaded.
+	 * @throws XServicesFault
 	 */
 	@WSDLDocumentation(XServicesDocumentation.SERVICE_OPERATION_UPLOADFILE)
-	@WebMethod(operationName = "uploadFile")
+	@WebMethod(operationName = OPERATION_UPLOADFILE)
 	public abstract String uploadFile(
-			@WebParam(name = "file") AttachmentType file);
+			@WebParam(name = "file") AttachmentType file) throws XServicesFault;
 	/**
 	 * @param src
 	 * @param todir
 	 * @param plm
 	 * @param overwrite
 	 * @param encoding
 	 * @return
 	 * @throws XServicesFault
 	 */
 	@WSDLDocumentation(value = XServicesDocumentation.SERVICE_OPERATION_COPY)
-	@WebMethod(operationName = "copy")
+	@WebMethod(operationName = OPERATION_COPY)
 	public abstract ReturnCode copy(
-			@WebParam(name = "fileset") @XmlElement(required=true) FileSetResource src,
+			@WebParam(name =  FileSetResource.XML_NAME) @XmlElement(required=true) FileSetResource src,
 			@WebParam(name = "todir") @XmlElement(required=true) String todir,
 			@WebParam(name = "preservelastmodified") boolean plm,
 			@WebParam(name = "overwrite") boolean overwrite,
 			@WebParam(name = "encoding") String encoding) throws XServicesFault;
 	/**
 	 * @param fromFile
 	 * @param tofile
 	 * @param overwrite
 	 * @return
 	 * @throws XServicesFault
 	 */
 	@WSDLDocumentation(value = XServicesDocumentation.SERVICE_OPERATION_COPYFILE)
-	@WebMethod(operationName = "copyFile")
+	@WebMethod(operationName = OPERATION_COPYFILE)
 	public abstract ReturnCode copyFile(
 			@WebParam(name = "fromFile") @XmlElement(required=true) String fromFile,
 			@WebParam(name = "toFile") @XmlElement(required=true) String tofile,
 			@WebParam(name = "overwrite") boolean overwrite) throws XServicesFault;
 	/**
 	 * @param res
 	 * @param encoding
 	 * @return content of the resource
+	 * @throws XServicesFault
 	 */
 	@WSDLDocumentation(value = XServicesDocumentation.SERVICE_OPERATION_LOADRESOURCE)
-	@WebMethod(operationName = "loadResource")
+	@WebMethod(operationName = OPERATION_LOADRESOURCE)
 	public abstract String loadRes(
-			@WebParam(name = "resource") FileResource res,
+			@WebParam(name = FileResource.XML_NAME) FileResource res,
-			@WebParam(name = "encoding") String encoding);
+			@WebParam(name = "encoding") String encoding) throws XServicesFault;
 	/**
 	 * @param res
 	 * @param encoding
 	 * @return content of the resource
+	 * @throws XServicesFault
 	 */
 	@WSDLDocumentation(value = XServicesDocumentation.SERVICE_OPERATION_LOADRESOURCEFROMARCHIVE)
-	@WebMethod(operationName = "loadResourceFromArchive")
+	@WebMethod(operationName = OPERATION_LOADRESOURCEFROMARCHIVE)
 	public abstract String loadResFromArchive(
 			@WebParam(name = "archiveresource") ArchiveResource res,
-			@WebParam(name = "encoding") String encoding);
+			@WebParam(name = "encoding") String encoding) throws XServicesFault;
 	/**
 	 * @param message
 	 * @param file
 	 * @param encoding
 	 * @param append
 	 * @return
+	 * @throws XServicesFault
 	 */
 	@WSDLDocumentation(value = XServicesDocumentation.SERVICE_OPERATION_ECHOTOFILE)
-	@WebMethod(operationName = "echoToFile")
+	@WebMethod(operationName = OPERATION_ECHOTOFILE)
 	public abstract ReturnCode echo2file(
 			@WebParam(name = "message") @XmlElement(required=true) String message,
 			@WebParam(name = "file") @XmlElement(required=true) String file,
 			@WebParam(name = "encoding") String encoding,
-			@WebParam(name = "append") boolean append);
+			@WebParam(name = "append") boolean append) throws XServicesFault;
+	/**
+	 * @param res
+	 * @param owner
+	 * @return
+	 */
-	@WebMethod(operationName = "changeOwner")
+	@WebMethod(operationName = OPERATION_CHANGEOWNER)
 	public abstract ReturnCode changeOwner(
-			@WebParam(name = "fileset") FileSetResource res,
+			@WebParam(name =  FileSetResource.XML_NAME) FileSetResource res,
+			@WebParam(name = "owner") @XmlElement(required=true) String owner);
+	/**
+	 * @param res
+	 * @param group
-			@WebParam(name = "owner") @XmlElement(required=true) String owner);
+	 * @return
 	 */
-	@WebMethod(operationName = "changeGroup")
+	@WebMethod(operationName = OPERATION_CHANGEGROUP)
 	public abstract ReturnCode changeGroup(
+			@WebParam(name =  FileSetResource.XML_NAME) FileSetResource res,
+			@WebParam(name = "group") @XmlElement(required=true) String group);
+	/**
+	 * @param res
-			@WebParam(name = "fileset") FileSetResource res,
+	 * @param perm
-			@WebParam(name = "group") @XmlElement(required=true) String group);
+	 * @return
+	 */
-	@WebMethod(operationName = "changeMode")
+	@WebMethod(operationName = OPERATION_CHANGEMODE)
+	public abstract ReturnCode changeMode(
+			@WebParam(name = FileSetResource.XML_NAME) FileSetResource res,
+			@WebParam(name = "permissions") @XmlElement(required=true) String perm);
+	/**
+	 * @param res
+	 * @param search
+	 * @param replace
-	public abstract ReturnCode changeMode(
+	 * @return
-			@WebParam(name = "fileset") FileSetResource res,
+	 * @throws XServicesFault
-			@WebParam(name = "permissions") @XmlElement(required=true) String perm);
+	 */
 	@WSDLDocumentation(value = XServicesDocumentation.SERVICE_OPERATION_REPLACEINFILE)
-	@WebMethod(operationName = "replaceInFile")
+	@WebMethod(operationName = OPERATION_REPLACEINFILE)
+	public abstract ReturnCode replaceInFile(
+			@WebParam(name = FileResource.XML_NAME) @XmlElement(required=true) FileResource res,
+			@WebParam(name = "search") @XmlElement(required=true) String search,
+			@WebParam(name = "replace") @XmlElement(required=true) String replace) throws XServicesFault;
+	/**
+	 * @param res
-	public abstract ReturnCode replaceInFile(
+	 * @param patternList
-			@WebParam(name = "file") @XmlElement(required=true) FileResource res,
+	 * @return
-			@WebParam(name = "search") @XmlElement(required=true) String search,
+	 * @throws XServicesFault
-			@WebParam(name = "replace") @XmlElement(required=true) String replace);
+	 */
+	@WSDLDocumentation(value = XServicesDocumentation.SERVICE_OPERATION_REPLACEINFILE2)
+	@WebMethod(operationName = OPERATION_REPLACEINFILE2)
+	public abstract ReturnCode replaceInFile2(
+			@WebParam(name = FileResource.XML_NAME) FileResource res,
+			@WebParam(name = "patternList") List<ReplacePattern> patternList) throws XServicesFault;
+	/**
+	 * @param res
+	 * @param search
+	 * @param replace
-	@WebMethod(operationName = "replaceInFile2")
+	 * @param flags
-	public abstract ReturnCode replaceInFile2(
+	 * @return
-			@WebParam(name = "file") FileResource res,
+	 * @throws XServicesFault
-			@WebParam(name = "patternList") List<ReplacePattern> patternList);
+	 */
+	@WSDLDocumentation(value = XServicesDocumentation.SERVICE_OPERATION_REPLACEINFILEREGEX)
-	@WebMethod(operationName = "replaceInFileRegEx")
+	@WebMethod(operationName = OPERATION_REPLACEINFILEREGEX)
 	public abstract ReturnCode replaceInFileRegEx(
-			@WebParam(name = "file") FileResource res,
+			@WebParam(name = FileResource.XML_NAME) FileResource res,
 			@WebParam(name = "search") String search,
 			@WebParam(name = "replace") String replace,
-			@WebParam(name = "flags") String flags);
+			@WebParam(name = "flags") String flags) throws XServicesFault;
+}
 Generated by GNU Enscript 1.6.5.90.

Subversion Repositories XServices

(root)/xservices/trunk/src/java/net/brutex/xservices/ws/FileService.java – Rev 64 → 65