Class Purging

java.lang.Object
com.elpical.jclaro.admin.ws.server.Purging

public class Purging extends Object
Holds settings about purging actions of a Purging Channel
  • Constructor Details

    • Purging

      public Purging()
      Empty constructor
    • Purging

      public Purging(HashMap<String,​String> theClaroChannelPreferences)
  • Method Details

    • getWhenNrOfFilesExceedsValue

      public int getWhenNrOfFilesExceedsValue()
      Returns the file amount which triggers the purge action
      Returns:
      The file amount which triggers the purge action
    • setWhenNrOfFilesExceedsValue

      public void setWhenNrOfFilesExceedsValue(int whenNrOfFilesExceedsValue)
      Sets the file amount which triggers the purge action
      Parameters:
      whenNrOfFilesExceedsValue - The file amount which triggers the purge action
    • getWhenNrOfFilesExceedsKind

      public int getWhenNrOfFilesExceedsKind()
      Returns which files to remove first if the amount of files exceed the amount set 0=purge oldest files on modified date 1=purge newest files on modified date
      Returns:
      Which files to remove first
    • setWhenNrOfFilesExceedsKind

      public void setWhenNrOfFilesExceedsKind(int whenNrOfFilesExceedsKind)
      Sets which files to remove first if the amount of files exceed the amount set 0=purge oldest files on modified date 1=purge newest files on modified date
      Parameters:
      whenNrOfFilesExceedsKind - Which files to remove first
    • getWhenFileOlderThanKind

      public int getWhenFileOlderThanKind()
      Returns the older than value interpretation 0=days 1=minutes
      Returns:
      The older than value interpretation
    • setWhenFileOlderThanKind

      public void setWhenFileOlderThanKind(int whenFileOlderThanKind)
      Sets the older than value interpretation 0=days 1=minutes
      Parameters:
      whenFileOlderThanKind - The older than value interpretation
    • getWhenFileOlderThanValue

      public int getWhenFileOlderThanValue()
      The value to use in the older than criteria
      Returns:
      The value to use in the older than criteria
    • setWhenFileOlderThanValue

      public void setWhenFileOlderThanValue(int whenFileOlderThanValue)
      Sets the value to use in the older than criteria
      Parameters:
      whenFileOlderThanValue - The value to use in the older than criteria
    • getWhenNrOfFilesExceeds

      public boolean getWhenNrOfFilesExceeds()
      Return whether to use the amount of files criteria
      Returns:
      Whether to use the amount of files criteria
    • setWhenNrOfFilesExceeds

      public void setWhenNrOfFilesExceeds(boolean whenNrOfFilesExceeds)
      Sets whether to use the amount of files criteria
      Parameters:
      whenNrOfFilesExceeds - Whether to use the amount of files criteria
    • isWhenFileOlderThan

      public boolean isWhenFileOlderThan()
      Returns whether to use the older than criteria
      Returns:
      Whether to use the older than criteria
    • setWhenFileOlderThan

      public void setWhenFileOlderThan(boolean whenFileOlderThan)
      Sets whether to use the older than criteria
      Parameters:
      whenFileOlderThan - Whether to use the older than criteria
    • isIgnoreReadOnly

      public boolean isIgnoreReadOnly()
      Returns whether to ignore read-only files
      Returns:
      Whether to ignore read-only files
    • setIgnoreReadOnly

      public void setIgnoreReadOnly(boolean ignoreReadOnly)
      Sets whether to ignore read-only files
      Parameters:
      ignoreReadOnly - Whether to ignore read-only files
    • isIgnoreHidden

      public boolean isIgnoreHidden()
      Returns whether to ignore hidden files
      Returns:
      Whether to ignore hidden files
    • setIgnoreHidden

      public void setIgnoreHidden(boolean ignoreHidden)
      Sets whether to ignore hidden files
      Parameters:
      ignoreHidden - Whether to ignore hidden files
    • getFileNameFilter

      public String getFileNameFilter()
      Returns the file name filter to use
      Returns:
      The file name filter to use
    • setFileNameFilter

      public void setFileNameFilter(String fileNameFilter)
      Sets the file name filter to use
      Parameters:
      fileNameFilter - The file name filter to use
    • getActionKind

      public int getActionKind()
      Returns the kind of action 0=Delete Purge Files 1=Move Purge Files
      Returns:
      The kind of action
    • setActionKind

      public void setActionKind(int actionKind)
      Sets the kind of action 0=Delete Purge Files 1=Move Purge Files
      Parameters:
      actionKind - The kind of action
    • save

      public void save(com.elpical.jclaro.database.entities.ClaroChannel aClaroChannel)