Package com.netlang.io

Class Files

java.lang.Object
com.netlang.io.Files
public class Files extends Object
This class implements the most common file system operations, e.g. copy, move, list etc.

Example - List all pdf-files in C:\temp

  		List<String> fileList = Files.list(new File("C:\\Temp"),"*.pdf",false,null);
  		for(String file : fileList) {
  			Log.info(file, null);
  		}

Example - Remove all tmp-files in a File Resource

  		Files.remove("resource id or name","/folder/", *.tmp, false,null);

Example - Copy txt-files from the local file system to a resource.

  		Files.copy(NetlangSessionSingleton.getSession(),new File("c:\\temp\\"),new NetlangFile("myesource","/somefolder/"),"*.txt",false,null);

  • Field Details

    • GENERIC_OPER

      public static int GENERIC_OPER

    • FILE_OPER

      public static int FILE_OPER

    • FOLDER_OPER

      public static int FOLDER_OPER

  • Constructor Details

    • Files

      public Files()
      Initializes a newly created Log

  • Method Details

    • getSystemTempFolder

      public static String getSystemTempFolder()

    • removeFolder

      public static void removeFolder(com.netlang.session.NetlangSession session, NetlangFile folder) throws com.net4z.APIException
      Remove folder
      Parameters:
      data -
      Throws:
      com.net4z.APIException

    • removeFolder

      public static void removeFolder(File folder) throws com.net4z.APIException
      Throws:
      com.net4z.APIException

    • removeFolder

      public static void removeFolder(String path) throws com.net4z.APIException
      Throws:
      com.net4z.APIException

    • removeFolder

      public static void removeFolder(com.netlang.session.NetlangSession session, String resourceId, String path) throws com.net4z.APIException
      Throws:
      com.net4z.APIException

    • removeFolderSilent

      public static void removeFolderSilent(com.netlang.session.NetlangSession session, NetlangFile folder)

    • removeFolderSilent

      public static void removeFolderSilent(File folder)

    • removeFolderSilent

      public static void removeFolderSilent(String path)

    • removeFolderSilent

      public static void removeFolderSilent(com.netlang.session.NetlangSession session, String resourceId, String path)

    • removeFolder

      public static void removeFolder(com.netlang.session.NetlangSession session, String resourceId, String path, com.net4z.CompletionHandler completion) throws com.net4z.APIException
      Throws:
      com.net4z.APIException

    • removeFile

      public static void removeFile(com.netlang.session.NetlangSession session, String resourceId, String path, com.net4z.CompletionHandler completion) throws com.net4z.APIException
      Remove file
      Parameters:
      data -
      Throws:
      com.net4z.APIException

    • removeFile

      public static void removeFile(com.netlang.session.NetlangSession session, NetlangFile file) throws com.net4z.APIException
      Throws:
      com.net4z.APIException

    • removeFile

      public static void removeFile(com.netlang.session.NetlangSession session, String resourceId, String path) throws com.net4z.APIException
      Throws:
      com.net4z.APIException

    • removeFile

      public static void removeFile(File file) throws com.net4z.APIException
      Throws:
      com.net4z.APIException

    • removeFile

      public static void removeFile(String path) throws com.net4z.APIException
      Throws:
      com.net4z.APIException

    • removeFileSilent

      public static void removeFileSilent(com.netlang.session.NetlangSession session, NetlangFile file)

    • removeFileSilent

      public static void removeFileSilent(com.netlang.session.NetlangSession session, String resourceId, String path)

    • removeFileSilent

      public static void removeFileSilent(File file)

    • removeFileSilent

      public static void removeFileSilent(String path)

    • remove

      public static void remove(String resourceId, String path, String pattern, boolean removeFromSubDir, FileOptions options) throws com.net4z.APIException
      Remove files
      Parameters:
      data -
      Throws:
      com.net4z.APIException

    • remove

      public static void remove(com.netlang.session.NetlangSession session, NetlangFile file, String pattern, boolean removeFromSubDir, FileOptions options) throws com.net4z.APIException
      Throws:
      com.net4z.APIException

    • remove

      public static void remove(File file, String pattern, boolean removeFromSubDir, FileOptions options) throws com.net4z.APIException
      Throws:
      com.net4z.APIException

    • remove

      public static void remove(com.netlang.session.NetlangSession session, String resourceId, String path, String pattern, boolean removeFromSubDir, FileOptions options) throws com.net4z.APIException
      Throws:
      com.net4z.APIException

    • removeSilent

      public static void removeSilent(com.netlang.session.NetlangSession session, NetlangFile file, String pattern, boolean removeFromSubDir, FileOptions options)

    • removeSilent

      public static void removeSilent(File file, String pattern, boolean removeFromSubDir, FileOptions options)

    • removeSilent

      public static void removeSilent(com.netlang.session.NetlangSession session, String resourceId, String path, String pattern, boolean removeFromSubDir, FileOptions options)

    • move

      public static void move(String fromResourceId, String frompath, String toResourceId, String topath, String pattern, boolean copySubDir, FileOptions options) throws com.net4z.APIException
      Move files
      Parameters:
      data -
      Throws:
      com.net4z.APIException

    • move

      public static void move(com.netlang.session.NetlangSession session, String fromResourceId, String frompath, String toResourceId, String topath, String pattern, boolean copySubDir, FileOptions options) throws com.net4z.APIException
      Throws:
      com.net4z.APIException

    • move

      public static void move(com.netlang.session.NetlangSession session, NetlangFile from, NetlangFile to, String pattern, boolean copySubDir, FileOptions options) throws com.net4z.APIException
      Throws:
      com.net4z.APIException

    • move

      public static void move(com.netlang.session.NetlangSession session, File from, NetlangFile to, String pattern, boolean copySubDir, FileOptions options) throws com.net4z.APIException
      Throws:
      com.net4z.APIException

    • move

      public static void move(com.netlang.session.NetlangSession session, NetlangFile from, File to, String pattern, boolean copySubDir, FileOptions options) throws com.net4z.APIException
      Throws:
      com.net4z.APIException

    • move

      public static void move(File from, File to, String pattern, boolean copySubDir, FileOptions options) throws com.net4z.APIException
      Throws:
      com.net4z.APIException

    • moveSilent

      public static void moveSilent(com.netlang.session.NetlangSession session, String fromResourceId, String frompath, String toResourceId, String topath, String pattern, boolean copySubDir, FileOptions options)

    • moveSilent

      public static void moveSilent(com.netlang.session.NetlangSession session, NetlangFile from, NetlangFile to, String pattern, boolean copySubDir, FileOptions options)

    • moveSilent

      public static void moveSilent(com.netlang.session.NetlangSession session, File from, NetlangFile to, String pattern, boolean copySubDir, FileOptions options)

    • moveSilent

      public static void moveSilent(com.netlang.session.NetlangSession session, NetlangFile from, File to, String pattern, boolean copySubDir, FileOptions options)

    • moveSilent

      public static void moveSilent(File from, File to, String pattern, boolean copySubDir, FileOptions options)

    • move

      public static void move(com.netlang.session.NetlangSession session, String fromResourceId, String frompath, String toResourceId, String topath, String pattern, boolean subdirs, com.net4z.CompletionHandler completion, FileOptions options) throws com.net4z.APIException
      Throws:
      com.net4z.APIException

    • moveFile

      public static void moveFile(String fromResourceId, String frompath, String toResourceId, String topath) throws com.net4z.APIException
      Move file
      Parameters:
      data -
      Throws:
      com.net4z.APIException

    • moveFile

      public static void moveFile(com.netlang.session.NetlangSession session, String fromResourceId, String frompath, String toResourceId, String topath) throws com.net4z.APIException
      Throws:
      com.net4z.APIException

    • moveFile

      public static void moveFile(com.netlang.session.NetlangSession session, NetlangFile from, NetlangFile to) throws com.net4z.APIException
      Throws:
      com.net4z.APIException

    • moveFile

      public static void moveFile(com.netlang.session.NetlangSession session, File from, NetlangFile to) throws com.net4z.APIException
      Throws:
      com.net4z.APIException

    • moveFile

      public static void moveFile(com.netlang.session.NetlangSession session, NetlangFile from, File to) throws com.net4z.APIException
      Throws:
      com.net4z.APIException

    • moveFile

      public static void moveFile(File from, File to) throws com.net4z.APIException
      Throws:
      com.net4z.APIException

    • moveFileSilent

      public static void moveFileSilent(com.netlang.session.NetlangSession session, String fromResourceId, String frompath, String toResourceId, String topath)

    • moveFileSilent

      public static void moveFileSilent(com.netlang.session.NetlangSession session, NetlangFile from, NetlangFile to)

    • moveFileSilent

      public static void moveFileSilent(com.netlang.session.NetlangSession session, File from, NetlangFile to)

    • moveFileSilent

      public static void moveFileSilent(com.netlang.session.NetlangSession session, NetlangFile from, File to)

    • moveFileSilent

      public static void moveFileSilent(File from, File to)

    • moveFile

      public static void moveFile(com.netlang.session.NetlangSession session, String fromResourceId, String frompath, String toResourceId, String topath, String tofilename, com.net4z.CompletionHandler completion) throws com.net4z.APIException
      Throws:
      com.net4z.APIException

    • copyFile

      public static void copyFile(com.netlang.session.NetlangSession session, String fromResourceId, String frompath, String toResourceId, String topath) throws com.net4z.APIException
      Copy file
      Parameters:
      data -
      Throws:
      com.net4z.APIException

    • copyFile

      public static void copyFile(com.netlang.session.NetlangSession session, NetlangFile from, NetlangFile to) throws com.net4z.APIException
      Throws:
      com.net4z.APIException

    • copyFile

      public static void copyFile(com.netlang.session.NetlangSession session, File from, NetlangFile to) throws com.net4z.APIException
      Throws:
      com.net4z.APIException

    • copyFile

      public static void copyFile(com.netlang.session.NetlangSession session, NetlangFile from, File to) throws com.net4z.APIException
      Throws:
      com.net4z.APIException

    • copyFile

      public static void copyFile(com.netlang.session.NetlangSession session, File from, File to) throws com.net4z.APIException
      Throws:
      com.net4z.APIException

    • copyFile

      public static void copyFile(File from, File to) throws com.net4z.APIException
      Throws:
      com.net4z.APIException

    • copyFileSilent

      public static void copyFileSilent(com.netlang.session.NetlangSession session, String fromResourceId, String frompath, String toResourceId, String topath)

    • copyFileSilent

      public static void copyFileSilent(com.netlang.session.NetlangSession session, NetlangFile from, NetlangFile to)

    • copyFileSilent

      public static void copyFileSilent(com.netlang.session.NetlangSession session, File from, NetlangFile to)

    • copyFileSilent

      public static void copyFileSilent(com.netlang.session.NetlangSession session, NetlangFile from, File to)

    • copyFileSilent

      public static void copyFileSilent(File from, File to)

    • copyFile

      public static void copyFile(com.netlang.session.NetlangSession session, String fromResourceId, String frompath, String toResourceId, String topath, String tofilename, com.net4z.CompletionHandler completion) throws com.net4z.APIException
      Throws:
      com.net4z.APIException

    • copyFolder

      public static void copyFolder(com.netlang.session.NetlangSession session, String fromResourceId, String frompath, String toResourceId, String topath) throws com.net4z.APIException
      Copy folder
      Parameters:
      data -
      Throws:
      com.net4z.APIException

    • copyFolder

      public static void copyFolder(com.netlang.session.NetlangSession session, NetlangFile from, NetlangFile to) throws com.net4z.APIException
      Throws:
      com.net4z.APIException

    • copyFolder

      public static void copyFolder(com.netlang.session.NetlangSession session, NetlangFile from, File to) throws com.net4z.APIException
      Throws:
      com.net4z.APIException

    • copyFolder

      public static void copyFolder(com.netlang.session.NetlangSession session, File from, NetlangFile to) throws com.net4z.APIException
      Throws:
      com.net4z.APIException

    • copyFolder

      public static void copyFolder(File from, File to) throws com.net4z.APIException
      Throws:
      com.net4z.APIException

    • copyFolderSilent

      public static void copyFolderSilent(com.netlang.session.NetlangSession session, String fromResourceId, String frompath, String toResourceId, String topath)

    • copyFolderSilent

      public static void copyFolderSilent(com.netlang.session.NetlangSession session, NetlangFile from, NetlangFile to)

    • copyFolderSilent

      public static void copyFolderSilent(com.netlang.session.NetlangSession session, NetlangFile from, File to)

    • copyFolderSilent

      public static void copyFolderSilent(com.netlang.session.NetlangSession session, File from, NetlangFile to)

    • copyFolderSilent

      public static void copyFolderSilent(File from, File to)

    • copyFolder

      public static void copyFolder(com.netlang.session.NetlangSession session, String fromResourceId, String frompath, String toResourceId, String topath, com.net4z.CompletionHandler completion) throws com.net4z.APIException
      Throws:
      com.net4z.APIException

    • moveFolder

      public static void moveFolder(com.netlang.session.NetlangSession session, String fromResourceId, String frompath, String toResourceId, String topath) throws com.net4z.APIException
      Move folder
      Parameters:
      data -
      Throws:
      com.net4z.APIException

    • moveFolder

      public static void moveFolder(com.netlang.session.NetlangSession session, NetlangFile from, NetlangFile to) throws com.net4z.APIException
      Throws:
      com.net4z.APIException

    • moveFolder

      public static void moveFolder(com.netlang.session.NetlangSession session, NetlangFile from, File to) throws com.net4z.APIException
      Throws:
      com.net4z.APIException

    • moveFolder

      public static void moveFolder(com.netlang.session.NetlangSession session, File from, NetlangFile to) throws com.net4z.APIException
      Throws:
      com.net4z.APIException

    • moveFolder

      public static void moveFolder(File from, File to) throws com.net4z.APIException
      Throws:
      com.net4z.APIException

    • moveFolderSilent

      public static void moveFolderSilent(com.netlang.session.NetlangSession session, String fromResourceId, String frompath, String toResourceId, String topath)

    • moveFolderSilent

      public static void moveFolderSilent(com.netlang.session.NetlangSession session, NetlangFile from, NetlangFile to)

    • moveFolderSilent

      public static void moveFolderSilent(com.netlang.session.NetlangSession session, NetlangFile from, File to)

    • moveFolderSilent

      public static void moveFolderSilent(com.netlang.session.NetlangSession session, File from, NetlangFile to)

    • moveFolderSilent

      public static void moveFolderSilent(File from, File to)

    • moveFolder

      public static void moveFolder(com.netlang.session.NetlangSession session, String fromResourceId, String frompath, String toResourceId, String topath, com.net4z.CompletionHandler completion) throws com.net4z.APIException
      Throws:
      com.net4z.APIException

    • copy

      public static void copy(String from, String frompath, String to, String topath, String pattern, boolean copySubDir, FileOptions options) throws com.net4z.APIException
      Copy files
      Parameters:
      data -
      Throws:
      com.net4z.APIException

    • copy

      public static void copy(com.netlang.session.NetlangSession session, String from, String frompath, String to, String topath, String pattern, boolean copySubDir, FileOptions options) throws com.net4z.APIException
      Throws:
      com.net4z.APIException

    • copy

      public static void copy(com.netlang.session.NetlangSession session, NetlangFile from, NetlangFile to, String pattern, boolean copySubDir, FileOptions options) throws com.net4z.APIException
      Throws:
      com.net4z.APIException

    • copy

      public static void copy(com.netlang.session.NetlangSession session, File from, NetlangFile to, String pattern, boolean copySubDir, FileOptions options) throws com.net4z.APIException
      Throws:
      com.net4z.APIException

    • copy

      public static void copy(com.netlang.session.NetlangSession session, NetlangFile from, File to, String pattern, boolean copySubDir, FileOptions options) throws com.net4z.APIException
      Throws:
      com.net4z.APIException

    • copy

      public static void copy(File from, File to, String pattern, boolean copySubDir, FileOptions options) throws com.net4z.APIException
      Throws:
      com.net4z.APIException

    • copySilent

      public static void copySilent(String from, String frompath, String to, String topath, String pattern, boolean copySubDir, FileOptions options)

    • copySilent

      public static void copySilent(com.netlang.session.NetlangSession session, String from, String frompath, String to, String topath, String pattern, boolean copySubDir, FileOptions options)

    • copySilent

      public static void copySilent(com.netlang.session.NetlangSession session, NetlangFile from, NetlangFile to, String pattern, boolean copySubDir, FileOptions options)

    • copySilent

      public static void copySilent(com.netlang.session.NetlangSession session, File from, NetlangFile to, String pattern, boolean copySubDir, FileOptions options)

    • copySilent

      public static void copySilent(com.netlang.session.NetlangSession session, NetlangFile from, File to, String pattern, boolean copySubDir, FileOptions options)

    • copySilent

      public static void copySilent(File from, File to, String pattern, boolean copySubDir, FileOptions options)

    • copy

      public static void copy(com.netlang.session.NetlangSession session, String fromResourceId, String frompath, String toResourceId, String topath, String pattern, boolean subdirs, com.net4z.CompletionHandler completion, FileOptions options, int operation) throws com.net4z.APIException
      Throws:
      com.net4z.APIException

    • list

      public static List<String> list(String resourceId, String path, String pattern, boolean subdirs, FileOptions options) throws com.net4z.APIException
      List files
      Parameters:
      resourceId -
      path -
      pattern -
      subdirs -
      options -
      Returns:
      Throws:
      com.net4z.APIException

    • list

      public static List<String> list(com.netlang.session.NetlangSession session, NetlangFile path, String pattern, boolean subdirs, FileOptions options) throws com.net4z.APIException
      Throws:
      com.net4z.APIException

    • list

      public static List<String> list(File path, String pattern, boolean subdirs, FileOptions options) throws com.net4z.APIException
      Throws:
      com.net4z.APIException

    • list

      public static List<String> list(com.netlang.session.NetlangSession session, String resourceId, String path, String pattern, boolean subdirs, FileOptions options) throws com.net4z.APIException
      Throws:
      com.net4z.APIException

    • listFiles

      public static List<NLFile> listFiles(String resourceId, String path, String pattern, boolean subdirs, FileOptions options) throws com.net4z.APIException
      List files
      Parameters:
      resourceId -
      path -
      pattern -
      subdirs -
      options -
      Returns:
      Throws:
      com.net4z.APIException

    • listFiles

      public static List<NLFile> listFiles(com.netlang.session.NetlangSession session, NetlangFile path, String pattern, boolean subdirs, FileOptions options) throws com.net4z.APIException
      Throws:
      com.net4z.APIException

    • listFiles

      public static List<NLFile> listFiles(File path, String pattern, boolean subdirs, FileOptions options) throws com.net4z.APIException
      Throws:
      com.net4z.APIException

    • listFiles

      public static List<NLFile> listFiles(com.netlang.session.NetlangSession session, String resourceId, String path, String pattern, boolean subdirs, FileOptions options) throws com.net4z.APIException
      Throws:
      com.net4z.APIException

    • listFolders

      public static List<String> listFolders(String resourceId, String path, String pattern, boolean subdirs) throws com.net4z.APIException
      List folders
      Parameters:
      session -
      resourceId -
      path -
      pattern -
      subdirs -
      Returns:
      Throws:
      com.net4z.APIException

    • listFolders

      public static List<String> listFolders(com.netlang.session.NetlangSession session, NetlangFile path, String pattern, boolean subdirs) throws com.net4z.APIException
      Throws:
      com.net4z.APIException

    • listFolders

      public static List<String> listFolders(File path, String pattern, boolean subdirs) throws com.net4z.APIException
      Throws:
      com.net4z.APIException

    • listFolders

      public static List<String> listFolders(com.netlang.session.NetlangSession session, String resourceId, String path, String pattern, boolean subdirs) throws com.net4z.APIException
      Throws:
      com.net4z.APIException

    • existFile

      public static boolean existFile(com.netlang.session.NetlangSession session, NetlangFile path) throws com.net4z.APIException
      Check if file exists
      Parameters:
      session -
      resourceId -
      path -
      Returns:
      Throws:
      com.net4z.APIException

    • existFile

      public static boolean existFile(File path) throws com.net4z.APIException
      Throws:
      com.net4z.APIException

    • existFile

      public static boolean existFile(com.netlang.session.NetlangSession session, String resourceId, String path) throws com.net4z.APIException
      Throws:
      com.net4z.APIException

    • lastModified

      public static long lastModified(com.netlang.session.NetlangSession session, NetlangFile path) throws com.net4z.APIException
      Get when file is last modified
      Parameters:
      session -
      resourceId -
      path -
      Returns:
      Throws:
      com.net4z.APIException

    • lastModified

      public static long lastModified(File path) throws com.net4z.APIException
      Throws:
      com.net4z.APIException

    • lastModified

      public static long lastModified(com.netlang.session.NetlangSession session, String resourceId, String path) throws com.net4z.APIException
      Throws:
      com.net4z.APIException

    • size

      public static long size(com.netlang.session.NetlangSession session, NetlangFile path) throws com.net4z.APIException
      Get file size
      Parameters:
      session -
      resourceId -
      path -
      Returns:
      Throws:
      com.net4z.APIException

    • size

      public static long size(File path) throws com.net4z.APIException
      Throws:
      com.net4z.APIException

    • size

      public static long size(com.netlang.session.NetlangSession session, String resourceId, String path) throws com.net4z.APIException
      Throws:
      com.net4z.APIException

    • mkdir

      public static void mkdir(com.netlang.session.NetlangSession session, NetlangFile folder) throws com.net4z.APIException
      Parameters:
      resourceId -
      path -
      localDestinationPath -
      completion -
      Throws:
      com.net4z.APIException

    • mkdir

      public static void mkdir(File folder) throws com.net4z.APIException
      Throws:
      com.net4z.APIException

    • mkdir

      public static void mkdir(String resourceId, String path) throws com.net4z.APIException
      Throws:
      com.net4z.APIException

    • mkdir

      public static void mkdir(com.netlang.session.NetlangSession session, String resourceId, String path) throws com.net4z.APIException
      Throws:
      com.net4z.APIException

    • mkdirSilent

      public static void mkdirSilent(com.netlang.session.NetlangSession session, NetlangFile folder)

    • mkdirSilent

      public static void mkdirSilent(File folder)

    • mkdirSilent

      public static void mkdirSilent(String resourceId, String path)

    • mkdirSilent

      public static void mkdirSilent(com.netlang.session.NetlangSession session, String resourceId, String path)

    • copy

      public static void copy(com.netlang.session.NetlangSession session, String fromResourceId, String toResourceId, FileOperation[] operations, com.net4z.CompletionHandler completion) throws com.net4z.APIException
      Copy data
      Parameters:
      data -
      Throws:
      com.net4z.APIException

    • listTree

      public static List<NLFile> listTree(com.netlang.session.NetlangSession session, String resourceId, String path, String pattern, boolean subdirs) throws com.net4z.APIException
      List file tree
      Parameters:
      session -
      resourceId -
      path -
      pattern -
      subdirs -
      Returns:
      Throws:
      com.net4z.APIException

    • listTreeByAgent

      public static List<NLFile> listTreeByAgent(com.netlang.session.NetlangSession session, String agentid, String path, String pattern, boolean subdirs) throws com.net4z.APIException
      List file tree
      Parameters:
      session -
      resourceId -
      path -
      pattern -
      subdirs -
      Returns:
      Throws:
      com.net4z.APIException

    • getFile

      public static FileReference getFile(com.netlang.session.NetlangSession session, NetlangFile path) throws com.net4z.APIException
      Get file
      Parameters:
      resourceId -
      path -
      localDestinationPath -
      completion -
      Throws:
      com.net4z.APIException

    • getFile

      public static FileReference getFile(File path) throws com.net4z.APIException
      Throws:
      com.net4z.APIException

    • getFile

      public static FileReference getFile(String path) throws com.net4z.APIException
      Throws:
      com.net4z.APIException

    • getFile

      public static FileReference getFile(com.netlang.session.NetlangSession session, String resourceId, String path) throws com.net4z.APIException
      Throws:
      com.net4z.APIException

    • getFile

      public static FileReference getFile(com.netlang.session.NetlangSession session, String resourceId, String path, boolean fetchRemoteContent) throws com.net4z.APIException
      Throws:
      com.net4z.APIException

    • rename

      public static void rename(com.netlang.session.NetlangSession session, String resourceId, String frompath, String topath) throws com.net4z.APIException
      Rename file
      Parameters:
      data -
      Throws:
      com.net4z.APIException

    • move

      public static void move(com.netlang.session.NetlangSession session, String fromResourceId, String toResourceId, FileOperation[] operations, com.net4z.CompletionHandler completion) throws com.net4z.APIException
      Copy data
      Parameters:
      data -
      Throws:
      com.net4z.APIException

    • uploadFile

      public static void uploadFile(com.netlang.session.NetlangSession session, String toResourceId, String topath, String toFilename, String localFile, boolean temporaryFile, com.net4z.CompletionHandler completion) throws com.net4z.APIException
      Throws:
      com.net4z.APIException