Package org.oa4mp.delegation.server.storage.uuc

Class UUCConfiguration

  • public class UUCConfiguration
extends Object
    Typical configuration example: 
      <unusedClientCleanup gracePeriod="6 hr"
                                 alarms="6:00"
                                 deleteVersions="false"
                                 enabled="true"
                                 createdNotBefore=ISO 8601 time
                                 interval="1 hr">
      <whitelist>
         <clientID>id...</clientID>
         <clientID>id...</clientID>
         <clientID>id...</clientID>
         <regex>^localhost.*</regex>
         <regex>^urn.*</regex>
      </whitelist>
      <blacklist>
         <clientID>id...</clientID>
         <regex>^template.*</regex>
      </blacklist>
  </unusedClientCleanup>

    Created by Jeff Gaynor
    on 5/11/23 at 6:43 AM

    • Field Detail

      • UUC_LAST_ACCESSED_NEVER_VALUE

        public static final long UUC_LAST_ACCESSED_NEVER_VALUE
        See Also:
        Constant Field Values

      • enabled

        public boolean enabled

      • gracePeriod

        public long gracePeriod

      • interval

        public long interval

      • testMode

        public boolean testMode

      • allRules

        public static final int[] allRules

      • deleteVersions

        public boolean deleteVersions

      • lastAccessedBefore

        public Long lastAccessedBefore
        If set, this will be the upper bound on the last access date. Therefore, for a client whose last accesed timestamp is L 
        L ∈ [lastAccessedAfter, lastAccessedBefore]

      • lastAccessedAfter

        public Long lastAccessedAfter
        If this is set, it is a lower bound for last accessed, so the utility will look for unused clients last accessed after this date.

    • Constructor Detail

      • UUCConfiguration

        public UUCConfiguration()

    • Method Detail

      • getFilter

        public RuleFilter getFilter​(int rule)

      • hasFilter

        public boolean hasFilter​(int rule)

      • hasSubFilter

        public boolean hasSubFilter()

      • getRule

        public MetaRule getRule​(int rule)

      • hasRule

        public boolean hasRule​(int rule)

      • setFilter

        public void setFilter​(RuleFilter filter)

      • hasFilter

        public boolean hasFilter()

      • getBlackList

        public ListRule getBlackList()

      • setBlackList

        public void setBlackList​(ListRule blackList)

      • setWhiteList

        public void setWhiteList​(ListRule whiteList)

      • getWhiteList

        public ListRule getWhiteList()

      • hasWhitelist

        public boolean hasWhitelist()

      • hasBlacklist

        public boolean hasBlacklist()

      • isLastAccessedNever

        public boolean isLastAccessedNever()

      • setLastAccessedNever

        public void setLastAccessedNever​(Boolean lastAccessedNever)

      • getDebugOn

        public boolean getDebugOn()

      • setDebugOn

        public void setDebugOn​(boolean debugOn)

      • getCreatedAfter

        public Date getCreatedAfter()
        Do not process clients whose creation date is before this. The intent is that systems that are introducing UUC may have several older clients that may be used infrequently or in the case of upgrading the system from a much older version of OA4MP, the information simply has not had time to accrue.
        Returns:

      • setCreatedAfter

        public void setCreatedAfter​(Date createdAfter)

      • hasCreatedAfter

        public boolean hasCreatedAfter()

      • getCreatedBefore

        public Date getCreatedBefore()

      • setCreatedBefore

        public void setCreatedBefore​(Date createdBefore)

      • hasCreatedBefore

        public boolean hasCreatedBefore()

      • hasAlarms

        public boolean hasAlarms()

      • hasUnusedRule

        public boolean hasUnusedRule()

      • hasAbandonedRule

        public boolean hasAbandonedRule()

      • unusedClientsOnly

        public boolean unusedClientsOnly()

      • hasLastAccessedAfter

        public boolean hasLastAccessedAfter()

      • hasLastAccessedBefore

        public boolean hasLastAccessedBefore()

      • toString

        public String toString​(boolean prettyPrint)

      • getUnusedRule

        public UnusedRule getUnusedRule()

      • setUnusedRule

        public void setUnusedRule​(UnusedRule unusedRule)

      • setAbandonedRule

        public void setAbandonedRule​(AbandonedRule abandonedRule)