Package edu.byu.hbll.box

Class SourceConfig

  • public class SourceConfig
extends Object
    The configuration of a source in Box.

    • Field Detail

      • PRINCIPAL_SOURCE_ALIAS

        public static final String PRINCIPAL_SOURCE_ALIAS
        Always points to the principal source.
        See Also:
        Constant Field Values

      • ALL_SOURCES_ALIAS

        public static final String ALL_SOURCES_ALIAS
        For participating operations, this refers to all sources.
        See Also:
        Constant Field Values

      • RESERVED_SOURCE_NAMES

        public static final Set<String> RESERVED_SOURCE_NAMES
        Reserved source names.

    • Method Detail

      • getName

        public String getName()
        Return the name of this source.
        Returns:
        the name

      • isEnabled

        public boolean isEnabled()
        Returns whether or not this source is enabled.
        Returns:
        the enabled

      • isPrincipal

        public boolean isPrincipal()
        Returns whether or not this source is the principal source.
        Returns:
        the principal

      • getProcessor

        public Processor getProcessor()
        Returns the processor.
        Returns:
        the processor

      • getBatchDelay

        public Duration getBatchDelay()
        Returns the batchDelay.
        Returns:
        the batchDelay

      • getBatchCapacity

        public int getBatchCapacity()
        Returns the batchCapacity.
        Returns:
        the batchCapacity

      • getThreadCount

        public int getThreadCount()
        Returns the threadCount.
        Returns:
        the threadCount

      • getSuspend

        public Duration getSuspend()
        Returns the suspend.
        Returns:
        the suspend

      • getQuota

        public int getQuota()
        Returns the quota.
        Returns:
        the quota

      • getQuotaReset

        public edu.byu.hbll.scheduler.Schedule getQuotaReset()
        Returns the quotaReset schedule.
        Returns:
        the quotaReset

      • getOn

        public edu.byu.hbll.scheduler.Schedule getOn()
        Returns when processing is turned on.
        Returns:
        the on

      • getOff

        public edu.byu.hbll.scheduler.Schedule getOff()
        Returns when processing is turned off.
        Returns:
        the off

      • isProcessEnabled

        public boolean isProcessEnabled()
        Returns whether or not the processor is enabled.
        Returns:
        the processEnabled

      • getHarvester

        public Harvester getHarvester()
        Returns the harvest processor.
        Returns:
        the harvestProcessor

      • isHarvestEnabled

        public boolean isHarvestEnabled()
        Returns whether or not harvester is enabled.
        Returns:
        the harvestEnabled

      • getHarvestSchedule

        public edu.byu.hbll.scheduler.Schedule getHarvestSchedule()
        Returns the harvestSchedule.
        Returns:
        the harvestSchedule

      • getHarvestResetSchedule

        public edu.byu.hbll.scheduler.Schedule getHarvestResetSchedule()
        Returns the harvestResetSchedule.
        Returns:
        the harvestResetSchedule

      • isSaveDeleted

        public boolean isSaveDeleted()
        Returns whether or not to save newly harvested deleted items.
        Returns:
        the saveDeleted

      • getReprocessAge

        public Duration getReprocessAge()
        Returns the reprocessAge.
        Returns:
        the reprocessAge

      • getReprocessSchedule

        public edu.byu.hbll.scheduler.Schedule getReprocessSchedule()
        Returns the reprocessSchedule.
        Returns:
        the reprocessSchedule

      • getRemoveAge

        public Duration getRemoveAge()
        Returns the removeAge.
        Returns:
        the removeAge

      • getRemoveSchedule

        public edu.byu.hbll.scheduler.Schedule getRemoveSchedule()
        Returns the removeSchedule.
        Returns:
        the removeSchedule

      • getFacetFields

        public Map<String,​Set<String>> getFacetFields()
        Returns the facetFields.
        Returns:
        the facetFields

      • isSave

        public boolean isSave()
        Returns whether or not to save the documents.
        Returns:
        the save

      • isProcess

        public boolean isProcess()
        Returns whether or not to always process.
        Returns:
        the process

      • isDependencyOnly

        public boolean isDependencyOnly()
        Returns whether or not this source is a dependency only.
        Returns:
        the dependencyOnly

      • getDefaultLimit

        public int getDefaultLimit()
        Returns the defaultLimit.
        Returns:
        the defaultLimit

      • toString

        public String toString()
        Returns the name of the source.
        Overrides:
        toString in class Object
        Returns:
        the name of the source

      • getDb

        public BoxDatabase getDb()
        Returns the db.
        Returns:
        the db

      • getCursorDb

        public BoxDatabase getCursorDb()
        Returns the cursorDb.
        Returns:
        the cursorDb

      • getOthers

        public List<BoxConfigurable> getOthers()
        Returns other managed objects.
        Returns:
        the others managed objects

      • getPreferredCursorDb

        public BoxDatabase getPreferredCursorDb()
        Returns cursorDb if not null, otherwise db.
        Returns:
        cursorDb if not null, otherwise db

      • isOverwrite

        public boolean isOverwrite()
        Returns whether or not to always overwrite.
        Returns:
        whether or not to always overwrite

      • isPostEnabled

        public boolean isPostEnabled()
        Returns whether or not post is enabled.
        Returns:
        whether or not post is enabled