Class Files

java.lang.Object
org.bgerp.app.servlet.file.Files
public class Files extends Object
Files accessor, allowing to see and remove directory files

  • Constructor Details

    • Files

      public Files(Class<? extends BaseAction> actionClass, String id, String basedir, Options options, String... wildcards)
      Constructor
      Parameters:
      actionClass - the linked action class
      id - unique ID of the files
      basedir - base dir, only the files there are shown
      options - extended possibilities
      wildcards - wildcards for filtering files, '*' is supported

  • Method Details

    • getId

      public String getId()
      Returns:
      unique string ID of the files set, used for generation action names

    • getOptions

      public Options getOptions()
      Returns:
      the options

    • getDownloadPermissionAction

      public String getDownloadPermissionAction()
      Returns:
      file download permission action for checking it using ctxUser.checkPerm()

    • getDownloadURL

      public String getDownloadURL()
      Returns:
      file download URL, e.g.: '/admin/app.do?method=downloadLogUpdate'. A name param has to be added at the end.

    • getHighlightPermissionAction

      public String getHighlightPermissionAction()

    • getHighlightURL

      public String getHighlightURL()

    • getDeletePermissionAction

      public String getDeletePermissionAction()
      Returns:
      file deletion permission action for checking it using ctxUser.checkPerm()

    • getDeleteURL

      public String getDeleteURL()
      Returns:
      file deletion URL, e.g.: '/admin/app.do?method=deleteLogUpdate'. A name param has to be added at the end.

    • list

      public List<File> list()
      Returns:
      list of files matching fileFilter sorted accordingly Options.getOrder()

    • size

      public long size(List<File> files)
      Calculates total size of provided files.
      Parameters:
      files - list of files to sum
      Returns:
      total size in bytes

    • download

      public org.apache.struts.action.ActionForward download(DynActionForm form) throws BGIllegalArgumentException, IOException, FileNotFoundException
      Sends a file content to response output stream
      Parameters:
      form - request form with file name in param name
      Returns:
      always null
      Throws:
      BGIllegalArgumentException
      IOException
      FileNotFoundException

    • highlight

      public DynActionForm highlight(DynActionForm form) throws BGIllegalArgumentException, FileNotFoundException
      Set a file highlight classes to a response
      Parameters:
      form - the request form with the file name in param name
      Returns:
      the form
      Throws:
      BGIllegalArgumentException
      FileNotFoundException

    • delete

      public DynActionForm delete(DynActionForm form) throws FileNotFoundException
      Delete file(s)
      Parameters:
      form - form with name parameter values, containing the file name(s)
      Returns:
      the form
      Throws:
      FileNotFoundException