Interface IMediaCacheStoreItemEvent


  • public interface IMediaCacheStoreItemEvent
    Interface for Store Item GC events
    
    When an item within a store is about to be processed for removal this provides the detailed information of the item.
    
    It gives the opportunity to alter the timing parameters of the item so to delay when it is next processed or allow it to be removed.
    
    The default is for the item to be removed unless this is changed with
    
    item.setItemRemove(false);
       
    • Method Detail

      • setItemName

        void setItemName​(String name)
        Set the item name
        Parameters:
        name -
      • getItemName

        String getItemName()
        Get the item name
        Returns:
        item name
      • setItemStorePath

        void setItemStorePath​(String path)
        Set the item store path
        Parameters:
        path -
      • getItemStorePath

        String getItemStorePath()
        Get the item store path
        Returns:
        storage path
      • setItemReleaseTime

        void setItemReleaseTime​(long releaseTime)
        Sets the item current release time
        Parameters:
        releaseTime - time in milliseconds
      • getReleaseItemTime

        long getReleaseItemTime()
        Gets release time in milliseconds
        Returns:
        time in milliseconds
      • setBadItemTime

        void setBadItemTime​(boolean state)
        Sets the state for bad item time
        Parameters:
        state -
      • getBadItemTime

        boolean getBadItemTime()
        Gets the current bad item state
        Returns:
        state
      • setMaxTTLReached

        void setMaxTTLReached​(boolean state)
        Sets the MaxTTL reached state
        Parameters:
        state -
      • getMaxTTLReached

        boolean getMaxTTLReached()
        Gets the MaxTTL reached state
        Returns:
        maxTTL reached state
      • setMinTTLReached

        void setMinTTLReached​(boolean state)
        Sets the MinTTL reached state
        Parameters:
        state -
      • getMinTTLReached

        boolean getMinTTLReached()
        Gets the MinTTL reached state
        Returns:
        MinTTL reached state
      • setItemSize

        void setItemSize​(long size)
        Sets the item size in bytes
        Parameters:
        size -
      • getItemSize

        long getItemSize()
        Gets the item size in bytes
        Returns:
        item size in bytes
      • setFreedSpaceTotal

        void setFreedSpaceTotal​(long size)
        Set the total space to be made available
        Parameters:
        size -
      • getFreedSpaceTotal

        long getFreedSpaceTotal()
        Get the total space to be made available
        Returns:
        total space to be made available
      • setItemTotalCount

        void setItemTotalCount​(int count)
        Set the total number of items to be processed
        Parameters:
        count -
      • getItemTotalCount

        int getItemTotalCount()
        Get the total number of items to be processed
        Returns:
        total number of items to be processed
      • setItemNumber

        void setItemNumber​(int number)
        Set this item number
        Parameters:
        number -
      • getItemNumber

        int getItemNumber()
        Get this item number
        Returns:
        item number
      • setItemRemove

        void setItemRemove​(boolean state)
        Set the item remove flag
        Parameters:
        state -
      • getItemRemove

        boolean getItemRemove()
        Get the item remove flag
        Returns:
        item remove flag