48,6 → 48,21 |
) |
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 |
54,7 → 69,7 |
* @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); |
62,20 → 77,22 |
/** |
* @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 |
87,9 → 104,9 |
* @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, |
103,7 → 120,7 |
* @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, |
113,23 → 130,25 |
* @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 = "encoding") String encoding); |
@WebParam(name = FileResource.XML_NAME) FileResource res, |
@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 |
137,45 → 156,85 |
* @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; |
|
@WebMethod(operationName = "changeOwner") |
/** |
* @param res |
* @param owner |
* @return |
*/ |
@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); |
|
@WebMethod(operationName = "changeGroup") |
/** |
* @param res |
* @param group |
* @return |
*/ |
@WebMethod(operationName = OPERATION_CHANGEGROUP) |
public abstract ReturnCode changeGroup( |
@WebParam(name = "fileset") FileSetResource res, |
@WebParam(name = FileSetResource.XML_NAME) FileSetResource res, |
@WebParam(name = "group") @XmlElement(required=true) String group); |
|
@WebMethod(operationName = "changeMode") |
/** |
* @param res |
* @param perm |
* @return |
*/ |
@WebMethod(operationName = OPERATION_CHANGEMODE) |
public abstract ReturnCode changeMode( |
@WebParam(name = "fileset") FileSetResource res, |
@WebParam(name = FileSetResource.XML_NAME) FileSetResource res, |
@WebParam(name = "permissions") @XmlElement(required=true) String perm); |
|
@WebMethod(operationName = "replaceInFile") |
/** |
* @param res |
* @param search |
* @param replace |
* @return |
* @throws XServicesFault |
*/ |
@WSDLDocumentation(value = XServicesDocumentation.SERVICE_OPERATION_REPLACEINFILE) |
@WebMethod(operationName = OPERATION_REPLACEINFILE) |
public abstract ReturnCode replaceInFile( |
@WebParam(name = "file") @XmlElement(required=true) FileResource res, |
@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); |
@WebParam(name = "replace") @XmlElement(required=true) String replace) throws XServicesFault; |
|
@WebMethod(operationName = "replaceInFile2") |
/** |
* @param res |
* @param patternList |
* @return |
* @throws XServicesFault |
*/ |
@WSDLDocumentation(value = XServicesDocumentation.SERVICE_OPERATION_REPLACEINFILE2) |
@WebMethod(operationName = OPERATION_REPLACEINFILE2) |
public abstract ReturnCode replaceInFile2( |
@WebParam(name = "file") FileResource res, |
@WebParam(name = "patternList") List<ReplacePattern> patternList); |
@WebParam(name = FileResource.XML_NAME) FileResource res, |
@WebParam(name = "patternList") List<ReplacePattern> patternList) throws XServicesFault; |
|
@WebMethod(operationName = "replaceInFileRegEx") |
/** |
* @param res |
* @param search |
* @param replace |
* @param flags |
* @return |
* @throws XServicesFault |
*/ |
@WSDLDocumentation(value = XServicesDocumentation.SERVICE_OPERATION_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; |
} |