com.ibm.mm.sdk.rm

Class DKRMConfigDefSMS

  • All Implemented Interfaces:
    com.ibm.mm.sdk.rm.dkRMEntityDef

    public class DKRMConfigDefSMS
extends com.ibm.mm.sdk.rm.DKRMEntityDefSMS
    This class provides methods to access the information of a System Managed Storage (SMS) configuration object, and to create, retrieve, update, and delete this object on a resource manager datastore.

    • Field Summary

      • Fields inherited from class com.ibm.mm.sdk.rm.DKRMEntityDefSMS

        SMS_COLLECTION, SMS_CONFIG, SMS_DEVMGR, SMS_MGTCLASS, SMS_SERVER, SMS_STAGINGAREA, SMS_STGCLASS, SMS_STGGROUP, SMS_VOLUME, SMS_VOLUME_AIX, SMS_VOLUME_CLOUD_OBJECT_STORAGE, SMS_VOLUME_LINUX, SMS_VOLUME_LOCAL, SMS_VOLUME_MA, SMS_VOLUME_NT, SMS_VOLUME_SUN, SMS_VOLUME_TSM, SMS_VOLUME_VC

    • Constructor Summary

      Constructors 
      Constructor and Description
      DKRMConfigDefSMS()
      Default constructor
      DKRMConfigDefSMS(com.ibm.mm.sdk.rm.dkRMStore rmStore)
      Constructs a new DKRMConfigDefSMS object with a given reference to a resource manager datastore.
      DKRMConfigDefSMS(java.lang.String name)
      Constructs a new DKRMConfigDefSMS object with a given name for this object.

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method and Description
      void add()
      Adds this configuration object to a resource manager datastore that is currently connected.
      void del()
      Deletes this configuration object from a resource manager datastore that is currently connected.
      void enableActivation()
      Makes this configuration object as an activated configuration on a resource manager that is currently connected by this client.
      int getClientTimeout()
      Gets the required maximum amount of time in seconds that a resource manager currently connected by this client should wait for a response from a client application.
      java.lang.String getDescription()
      Gets the description of this configuration object.
      int getLibTimeout()
      Gets the required maximum amount of time in seconds that a resource manager currently connected by this client should wait for a response from a library server.
      int getMigratorBatchSize()
      Gets the number of files in the batch when a group of files is moved from one storage class to another.
      DKRMScheduleSMS getMigratorEverydaySchedule()
      Gets the schedule for the migrator process to run daily on a resource manager that is currently connected by this client.
      com.ibm.mm.sdk.rm.DKRMTimeSMS getMigratorFrequency()
      Gets the amount of time in hours and minutes that must elapse before the system checks whether to migrate objects from one storage class to another on a resource manager that is currently connected by this client.
      int getMigratorFrequencyHours()
      Gets the amount of time in hours and minutes that must elapse before the system checks whether to migrate objects from one storage class to another on a resource manager that is currently connected by this client.
      int getMigratorFrequencyMinutes()
      Gets the amount of time in hours and minutes that must elapse before the system checks whether to migrate objects from one storage class to another on a resource manager that is currently connected by this client.
      int getPurgerBatchSize()
      Gets the number of files in the batch during the purger process.
      com.ibm.mm.sdk.rm.DKRMTimeSMS getPurgerFrequency()
      Gets the amount of time in hours and minutes that must elapse before the system checks whether to delete objects from the staging area of a resource manager that is currently connected by this client.
      int getPurgerFrequencyHours()
      Gets the amount of time in hours and minutes that must elapse before the system checks whether to delete objects from the staging area of a resource manager that is currently connected by this client.
      int getPurgerFrequencyMinutes()
      Gets the amount of time in hours and minutes that must elapse before the system checks whether to delete objects from the staging area of a resource manager that is currently connected by this client.
      int getPurgerTimeout()
      Gets the required maximum amount of time in seconds that a resource manager currently connected by this client should wait when there is not enough available space in the staging area.
      DKRMScheduleSMS getReplicatorEverydaySchedule()
      Gets the schedule for the replicator process to run daily on a resource manager that is currently connected by this client.
      com.ibm.mm.sdk.rm.DKRMTimeSMS getReplicatorFrequency()
      Gets the amount of time in hours and minutes that must elapse before the system checks whether to start the replication process on a resource manager that is currently connected by this client.
      int getReplicatorFrequencyHours()
      Gets the amount of time in hours and minutes that must elapse before the system checks whether to start the replication process on a resource manager that is currently connected by this client.
      int getReplicatorFrequencyMinutes()
      Gets the amount of time in hours and minutes that must elapse before the system checks whether to start the replication process on a resource manager that is currently connected by this client.
      com.ibm.mm.sdk.rm.DKRMTimeSMS getThresholdFrequency()
      Gets the amount of time in hours and minutes that must elapse before the system checks the capacity of the volumes on a resource manager that is currently connected by this client.
      int getThresholdFrequencyHours()
      Gets the amount of time in hours and minutes that must elapse before the system checks the capacity of the volumes on a resource manager that is currently connected by this client.
      int getThresholdFrequencyMinutes()
      Gets the amount of time in hours and minutes that must elapse before the system checks the capacity of the volumes on a resource manager that is currently connected by this client.
      boolean getValidatorCleanHistory()
      Gets the RMVALREPORT history control.
      java.util.Date getValidatorDateRangeEndDate()
      Gets the validation end date parameter.
      java.util.Date getValidatorDateRangeStartDate()
      Gets the validation start date parameter.
      DKRMConstantSMS.DATE_RANGE_TYPE getValidatorDateRangeType()
      Gets the validation date range type parameter.
      int getValidatorDateRangeWindow()
      Gets the validation date range window parameter.
      DKRMScheduleSMS getValidatorEverydaySchedule()
      Gets the schedule for the validator process to run daily on a resource manager that is currently connected by this client.
      DKRMConstantSMS.VALIDATION_METADATA getValidatorMetadata()
      Obtain current validation Metadata value.
      boolean getValidatorRunImmediate()
      Retrieves the state of �run immediate� setting.
      boolean getValidatorScheduleOneTimeOnly()
      Retrieves one time validation flag.
      java.lang.String getValidatorVolume()
      Gets the volume setting for validation utility.
      boolean isActivationEnabled()
      Checks whether this configuration object currently as an activated configuration on a resource manager that is currently connected by this client.
      boolean isMigratorInEverydaySchedule()
      Checks if the migrator process runs on the daily schedule on a resource manager that is currently connected by this client.
      boolean isReplicatorInEverydaySchedule()
      Checks if the replicator process runs on the daily schedule on a resource manager that is currently connected by this client.
      boolean isValidatorInEverydaySchedule()
      Checks if the validator process runs on the daily schedule on a resource manager that is currently connected by this client.
      dkCollection listMigratorWeeklySchedule()
      Gets a weekly schedule for the migrator process to run in different time on each specific day of a week on a resource manager that is currently connected by this client.
      dkCollection listReplicatorWeeklySchedule()
      Gets a weekly schedule for the replicator process to run in different time on each specific day of a week on a resource manager that is currently connected by this client.
      dkCollection listValidatorWeeklySchedule()
      Gets a weekly schedule for the validator process to run in different time on each specific day of a week on a resource manager that is currently connected by this client.
      void setClientTimeout(int seconds)
      Sets the required maximum amount of time in seconds that a resource manager currently connected by this client should wait for a response from a client application.
      void setDescription(java.lang.String description)
      Sets the description of this configuration object.
      void setLibTimeout(int seconds)
      Sets the required maximum amount of time in seconds that a resource manager currently connected by this client should wait for a response from a library server.
      void setMigratorBatchSize(int size)
      Sets the number of files in the batch when a group of files is moved from one storage class to another.
      void setMigratorEverydaySchedule(DKRMScheduleSMS migratorEverydaySchedule)
      Sets a given schedule for the migrator process to run daily on a resource manager that is currently connected by this client.
      void setMigratorFrequency(com.ibm.mm.sdk.rm.DKRMTimeSMS frequency)
      Sets the amount of time in hours and minutes that must elapse before the system checks whether to migrate objects from one storage class to another on a resource manager that is currently connected by this client.
      void setMigratorFrequency(int hours, int minutes)
      Sets the amount of time in hours and minutes that must elapse before the system checks whether to migrate objects from one storage class to another on a resource manager that is currently connected by this client.
      void setMigratorWeeklySchedule(dkCollection migratorWeeklySchedule)
      Sets a weekly schedule for the migrator process to run in different time on each specific day of a week on a resource manager that is currently connected by this client.
      void setPurgerBatchSize(int size)
      Sets the number of files in the batch during the purger process.
      void setPurgerFrequency(com.ibm.mm.sdk.rm.DKRMTimeSMS frequency)
      Sets the amount of time in hours and minutes that must elapse before the system checks whether to delete objects from the staging area of a resource manager that is currently connected by this client.
      void setPurgerFrequency(int hours, int minutes)
      Sets the amount of time in hours and minutes that must elapse before the system checks whether to delete objects from the staging area of a resource manager that is currently connected by this client.
      void setPurgerTimeout(int seconds)
      Sets the required maximum amount of time in seconds that a resource manager currently connected by this client should wait when there is not enough available space in the staging area.
      void setReplicatorEverydaySchedule(DKRMScheduleSMS replicatorEverydaySchedule)
      Sets a given schedule for the replicator process to run daily on a resource manager that is currently connected by this client.
      void setReplicatorFrequency(com.ibm.mm.sdk.rm.DKRMTimeSMS frequency)
      Sets the amount of time in hours and minutes that must elapse before the system checks whether to start the replication process on a resource manager that is currently connected by this client.
      void setReplicatorFrequency(int hours, int minutes)
      Sets the amount of time in hours and minutes that must elapse before the system checks whether to start the replication process on a resource manager that is currently connected by this client.
      void setReplicatorWeeklySchedule(dkCollection replicatorWeeklySchedule)
      Sets a weekly schedule for the replicator process to run in different time on each specific day of a week on a resource manager that is currently connected by this client.
      void setThresholdFrequency(com.ibm.mm.sdk.rm.DKRMTimeSMS frequency)
      Sets the amount of time in hours and minutes that must elapse before the system checks the capacity of the volumes on a resource manager that is currently connected by this client.
      void setThresholdFrequency(int hours, int minutes)
      Sets the amount of time in hours and minutes that must elapse before the system checks the capacity of the volumes on a resource manager that is currently connected by this client.
      void setValidatorCleanHistory(boolean valCleanHistory)
      Sets the RMVALREPORT history control.
      void setValidatorDateRangeEndDate(java.util.Date valEndDate)
      Sets the end date or validation date range.
      void setValidatorDateRangeStartDate(java.util.Date valStartDate)
      Sets the start date or validation date range.
      void setValidatorDateRangeType(DKRMConstantSMS.DATE_RANGE_TYPE valDateRangeType)
      Sets the Date range type value.
      void setValidatorDateRangeWindow(int valPastDays)
      Sets the number of day of data for validation utility.
      void setValidatorEverydaySchedule(DKRMScheduleSMS validatorEverydaySchedule)
      Sets a given schedule for the validator process to run daily on a resource manager that is currently connected by this client.
      void setValidatorMetadata(DKRMConstantSMS.VALIDATION_METADATA valMetadata)
      Sets the Metadata value for validation utility.
      void setValidatorRunImmediate(boolean valImmediate)
      Informs Reasource Manager to run validation as soon as service is started.
      void setValidatorScheduleOneTimeOnly(boolean valScheduleOnce)
      Informs Reasource Manager to run Validation schedule for only one time, using first available scheduled time.
      void setValidatorVolumeID(java.lang.String valVolume)
      Sets the Volume for validation utility.
      void setValidatorWeeklySchedule(dkCollection validatorWeeklySchedule)
      Sets a weekly schedule for the validator utility to run in different time on each specific day of a week on a resource manager that is currently connected by this client.
      void update()
      Updates this configuration object to a resource manager datastore that is currently connected.

      • Methods inherited from class com.ibm.mm.sdk.rm.DKRMEntityDefSMS

        retrieve

      • Methods inherited from class com.ibm.mm.sdk.rm.dkAbstractRMEntityDef

        getName, getRMStore, setName, setRMStore

      • Methods inherited from class java.lang.Object

        equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Constructor Detail

      • DKRMConfigDefSMS

        public DKRMConfigDefSMS()
                 throws DKException,
                        java.lang.Exception
        Default constructor
        Throws:
        DKException - if an error occurs
        java.lang.Exception

      • DKRMConfigDefSMS

        public DKRMConfigDefSMS(com.ibm.mm.sdk.rm.dkRMStore rmStore)
                 throws DKException,
                        java.lang.Exception
        Constructs a new DKRMConfigDefSMS object with a given reference to a resource manager datastore.
        Parameters:
        rmStore - a dkRMStore object referred to a resource manager datastore
        Throws:
        DKException - if an error occurs
        java.lang.Exception
        See Also:
        dkRMStore

      • DKRMConfigDefSMS

        public DKRMConfigDefSMS(java.lang.String name)
                 throws DKException,
                        java.lang.Exception
        Constructs a new DKRMConfigDefSMS object with a given name for this object.
        Parameters:
        name - a given name for this new object
        Throws:
        DKException - if an error occurs
        java.lang.Exception

    • Method Detail

      • setValidatorMetadata

        public void setValidatorMetadata(DKRMConstantSMS.VALIDATION_METADATA valMetadata)
        Sets the Metadata value for validation utility.
        Parameters:
        valMetadata - Valid metadata value:
        • VALIDATION_METADATA.VAL_METADATA_ID_RMOBJECTS - validate object metadata
        • VALIDATION_METADATA.VAL_METADATA_ID_RMMIGRATIONTASKS - validate migration tasks
        • VALIDATION_METADATA.VAL_METADATA_ID_ALL - validate all metadata (RMOBJECTS and RMMIGRATIONTASK)
        • VALIDATION_METADATA.VAL_METADATA_ID_NONE - perform No metadata validation

      • getValidatorMetadata

        public DKRMConstantSMS.VALIDATION_METADATA getValidatorMetadata()
        Obtain current validation Metadata value.
        Returns:
        valMetadata Valid metadata value:
        • VALIDATION_METADATA.VAL_METADATA_ID_RMOBJECTS - validate object metadata
        • VALIDATION_METADATA.VAL_METADATA_ID_RMMIGRATIONTASKS - validate migration tasks
        • VALIDATION_METADATA.VAL_METADATA_ID_ALL - validate all metadata (RMOBJECTS and RMMIGRATIONTASK)
        • VALIDATION_METADATA.VAL_METADATA_ID_NONE - perform No metadata validation

      • setValidatorVolumeID

        public void setValidatorVolumeID(java.lang.String valVolume)
        Sets the Volume for validation utility.
        Parameters:
        volume - Valid volume name or one of the following options:
        • DKRMConstantSMS.VAL_VOLUMEID_ALL - validate all storage volumes
        • DKRMConstantSMS.VAL_VOLUMEID_NONE - perform No storage validation

      • getValidatorVolume

        public java.lang.String getValidatorVolume()
        Gets the volume setting for validation utility.
        Returns:
        A String value, which is volume name or one of the following values:
        • DKRMConstantSMS.VAL_VOLUMEID_ALL - validate all storage volumes
        • DKRMConstantSMS.VAL_VOLUMEID_NONE - perform No storage validation

      • setValidatorCleanHistory

        public void setValidatorCleanHistory(boolean valCleanHistory)
        Sets the RMVALREPORT history control. This option can control is RMVALREPORT table is cleaned at start of validation utility.
        Parameters:
        bCleanHistory - true indicates RMVALREPORT table is cleared at start of validation. false indicates that validation report records will be added to RMVALREPORT table.

      • getValidatorCleanHistory

        public boolean getValidatorCleanHistory()
        Gets the RMVALREPORT history control.
        Returns:
        A boolean indicating if history is clear or kept intact.

      • setValidatorDateRangeType

        public void setValidatorDateRangeType(DKRMConstantSMS.DATE_RANGE_TYPE valDateRangeType)
        Sets the Date range type value. This option can controls which additional data range parameters are used, and how they are applied to validation operation.
        Parameters:
        dateRangeType - parameter values are:
        • DATE_RANGE_TYPE.VAL_DATE_RANGE_TYPE_WINDOWED_RANGE - use moving sized windows for validation date limits.
        • DATE_RANGE_TYPE.VAL_DATE_RANGE_TYPE_CUSTOM_RANGE - use specified data range for validation date limits

      • getValidatorDateRangeType

        public DKRMConstantSMS.DATE_RANGE_TYPE getValidatorDateRangeType()
        Gets the validation date range type parameter.
        Returns:
        dateRangeType values are:
        • DATE_RANGE_TYPE.VAL_DATE_RANGE_TYPE_WINDOWED_RANGE - use moving sized windows for validation date limits.
        • DATE_RANGE_TYPE.VAL_DATE_RANGE_TYPE_CUSTOM_RANGE - use specified data range for validation date limits

      • setValidatorDateRangeWindow

        public void setValidatorDateRangeWindow(int valPastDays)
        Sets the number of day of data for validation utility. This parameter is ignored unless date range type of DKRMConstantSMS.VAL_DATE_RANGE_TYPE_WINDOWED_RANGE is specified.
        Parameters:
        valpastDays - The number of previous days to validate.

      • getValidatorDateRangeWindow

        public int getValidatorDateRangeWindow()
        Gets the validation date range window parameter.
        Returns:
        A int value, which is the number of previous days on which validation is run. This value is only meaningful if Validator Date Range Type is set to DKRMConstantSMS.VAL_DATE_RANGE_TYPE_WINDOWED_RANGE.

      • setValidatorDateRangeStartDate

        public void setValidatorDateRangeStartDate(java.util.Date valStartDate)
        Sets the start date or validation date range. This parameter is ignored unless date range type of DKRMConstantSMS.VAL_DATE_RANGE_TYPE_CUSTOM_RANGE is specified. The date will not be validated for accuracy or correctness.
        Parameters:
        valStartDate - - starting date for validation

      • getValidatorDateRangeStartDate

        public java.util.Date getValidatorDateRangeStartDate()
        Gets the validation start date parameter.
        Returns:
        Date, the starting date for validation limits

      • setValidatorDateRangeEndDate

        public void setValidatorDateRangeEndDate(java.util.Date valEndDate)
        Sets the end date or validation date range. This parameter is ignored unless date range type of DKRMConstantSMS.VAL_DATE_RANGE_TYPE_CUSTOM_RANGE is specified. The date will not be validated for accuracy or correctness.
        Parameters:
        valEndDate - Ending date for validation range

      • getValidatorDateRangeEndDate

        public java.util.Date getValidatorDateRangeEndDate()
        Gets the validation end date parameter.
        Returns:
        Date, The ending date for validation limits

      • setValidatorRunImmediate

        public void setValidatorRunImmediate(boolean valImmediate)
        Informs Reasource Manager to run validation as soon as service is started. Resource Manager server will interpret this value to run without changing persisted schedules. Using this value implies �RUN ONE TIME ONLY (even if setValidatorScheduleOneTimeOnly sets false). See setValidatorScheduleOneTimeOnly method for additional details. When this option is enabled, any prior schedule will be canceled upon completion of immediate operation and must be restarted to resume prior schedule.
        Parameters:
        valImmediate - true indicates to run validation immediate on starting service.

      • getValidatorRunImmediate

        public boolean getValidatorRunImmediate()
        Retrieves the state of �run immediate� setting.
        Returns:
        boolean, true indicates that validation is run whenever validation service is started.

      • setValidatorWeeklySchedule

        public void setValidatorWeeklySchedule(dkCollection validatorWeeklySchedule)
                                throws DKException,
                                       java.lang.Exception
        Sets a weekly schedule for the validator utility to run in different time on each specific day of a week on a resource manager that is currently connected by this client.
        Parameters:
        validatorWeeklySchedule - a dkCollection object containing the DKRMScheduleSMS objects that have different time on each specific day of a week for the validator utility to run
        Throws:
        DKException
        java.lang.Exception
        See Also:
        DKRMScheduleSMS, dkCollection

      • listValidatorWeeklySchedule

        public dkCollection listValidatorWeeklySchedule()
                                         throws DKException,
                                                java.lang.Exception
        Gets a weekly schedule for the validator process to run in different time on each specific day of a week on a resource manager that is currently connected by this client.
        Returns:
        a dkCollection object containing the DKRMScheduleSMS objects that have different time on each specific day of a week for the validation utility to run. If the daily schedule is active, then this collection will contain only default values, as the values are not used when a daily schedule is active.
        Throws:
        DKException
        java.lang.Exception
        See Also:
        DKRMScheduleSMS, dkCollection

      • setValidatorEverydaySchedule

        public void setValidatorEverydaySchedule(DKRMScheduleSMS validatorEverydaySchedule)
                                  throws DKException,
                                         java.lang.Exception
        Sets a given schedule for the validator process to run daily on a resource manager that is currently connected by this client.
        Parameters:
        validatorEverydaySchedule - a DKRMScheduleSMS object contains a schedule that the validator process runs daily
        Throws:
        DKException
        java.lang.Exception
        See Also:
        DKRMScheduleSMS

      • getValidatorEverydaySchedule

        public DKRMScheduleSMS getValidatorEverydaySchedule()
        Gets the schedule for the validator process to run daily on a resource manager that is currently connected by this client.
        Returns:
        a DKRMScheduleSMS object contains a schedule that the validation utility runs daily This schedule is only valid if the daily schedule is active, if a weekly schedule is active, then this method will return a schedule with only default values.
        See Also:
        DKRMScheduleSMS

      • setValidatorScheduleOneTimeOnly

        public void setValidatorScheduleOneTimeOnly(boolean valScheduleOnce)
        Informs Reasource Manager to run Validation schedule for only one time, using first available scheduled time.
        Parameters:
        valScheduleOnce - A flag to indicate if validation is run repetitively or one time only.

      • getValidatorScheduleOneTimeOnly

        public boolean getValidatorScheduleOneTimeOnly()
        Retrieves one time validation flag. When true (run one time only), Validation is run once each time Validation schedule is started.
        Returns:
        boolean, a flag to indicate if validation is run repetitively or one time only. True indicates validation is to run one time only.

      • enableActivation

        public void enableActivation()
        Makes this configuration object as an activated configuration on a resource manager that is currently connected by this client.

        No action taken if this object is currently activated on the resource manager.

      • isActivationEnabled

        public boolean isActivationEnabled()
        Checks whether this configuration object currently as an activated configuration on a resource manager that is currently connected by this client.
        Returns:
        true if the configuration represented by this object currently activated on the resource manager; false otherwise.

      • setDescription

        public void setDescription(java.lang.String description)
        Sets the description of this configuration object.
        Parameters:
        description - the description of this configuration object

      • getDescription

        public java.lang.String getDescription()
        Gets the description of this configuration object.
        Returns:
        the description of this configuration object

      • setLibTimeout

        public void setLibTimeout(int seconds)
        Sets the required maximum amount of time in seconds that a resource manager currently connected by this client should wait for a response from a library server.
        Parameters:
        seconds - the maximum amount of time in seconds for the resource manager to wait for a response from a library server

      • getLibTimeout

        public int getLibTimeout()
        Gets the required maximum amount of time in seconds that a resource manager currently connected by this client should wait for a response from a library server.
        Returns:
        the maximum amount of time in seconds for the resource manager to wait for a response from a library server

      • setClientTimeout

        public void setClientTimeout(int seconds)
        Sets the required maximum amount of time in seconds that a resource manager currently connected by this client should wait for a response from a client application.
        Parameters:
        seconds - the maximum amount of time in seconds for the resource manager to wait for a response from a client application

      • getClientTimeout

        public int getClientTimeout()
        Gets the required maximum amount of time in seconds that a resource manager currently connected by this client should wait for a response from a client application.
        Returns:
        the maximum amount of time in seconds for the resource manager to wait for a response from a client application

      • setPurgerTimeout

        public void setPurgerTimeout(int seconds)
        Sets the required maximum amount of time in seconds that a resource manager currently connected by this client should wait when there is not enough available space in the staging area.
        Parameters:
        seconds - the maximum amount of time in seconds for the resource manager to wait when there is not enough available space in the staging area.

      • getPurgerTimeout

        public int getPurgerTimeout()
        Gets the required maximum amount of time in seconds that a resource manager currently connected by this client should wait when there is not enough available space in the staging area.
        Returns:
        the maximum amount of time in seconds for the resource manager to wait when there is not enough available space in the staging area.

      • setPurgerFrequency

        public void setPurgerFrequency(com.ibm.mm.sdk.rm.DKRMTimeSMS frequency)
        Sets the amount of time in hours and minutes that must elapse before the system checks whether to delete objects from the staging area of a resource manager that is currently connected by this client.
        Parameters:
        frequency - a DKRMTimeSMS object containing the amount of time as a frequency to check whether to delete objects from the staging area of the resource manager
        See Also:
        DKRMTimeSMS

      • setPurgerFrequency

        public void setPurgerFrequency(int hours,
                               int minutes)
                        throws DKException,
                               java.lang.Exception
        Sets the amount of time in hours and minutes that must elapse before the system checks whether to delete objects from the staging area of a resource manager that is currently connected by this client.
        Parameters:
        hours - the amount of time in hours for the hour part of the frequency
        minutes - the amount of time in minutes for the minute part of the frequency
        Throws:
        DKException
        java.lang.Exception

      • getPurgerFrequency

        public com.ibm.mm.sdk.rm.DKRMTimeSMS getPurgerFrequency()
        Gets the amount of time in hours and minutes that must elapse before the system checks whether to delete objects from the staging area of a resource manager that is currently connected by this client.
        Returns:
        a DKRMTimeSMS object containing the amount of time as a frequency to check whether to delete objects from the staging area of the resource manager
        See Also:
        DKRMTimeSMS

      • getPurgerFrequencyHours

        public int getPurgerFrequencyHours()
        Gets the amount of time in hours and minutes that must elapse before the system checks whether to delete objects from the staging area of a resource manager that is currently connected by this client.
        Returns:
        the amount of time in hours from the hour part of the frequency

      • getPurgerFrequencyMinutes

        public int getPurgerFrequencyMinutes()
        Gets the amount of time in hours and minutes that must elapse before the system checks whether to delete objects from the staging area of a resource manager that is currently connected by this client.
        Returns:
        the amount of time in minutes from the minute part of the frequency

      • setMigratorFrequency

        public void setMigratorFrequency(com.ibm.mm.sdk.rm.DKRMTimeSMS frequency)
        Sets the amount of time in hours and minutes that must elapse before the system checks whether to migrate objects from one storage class to another on a resource manager that is currently connected by this client.
        Parameters:
        frequency - a DKRMTimeSMS object containing the amount of time as a frequency to check whether to migrate objects from one storage class to another on the resource manager
        See Also:
        DKRMTimeSMS

      • setMigratorFrequency

        public void setMigratorFrequency(int hours,
                                 int minutes)
                          throws DKException,
                                 java.lang.Exception
        Sets the amount of time in hours and minutes that must elapse before the system checks whether to migrate objects from one storage class to another on a resource manager that is currently connected by this client.
        Parameters:
        hours - the amount of time in hours for the hour part of the frequency
        minutes - the amount of time in minutes for the minute part of the frequency
        Throws:
        DKException
        java.lang.Exception

      • getMigratorFrequency

        public com.ibm.mm.sdk.rm.DKRMTimeSMS getMigratorFrequency()
        Gets the amount of time in hours and minutes that must elapse before the system checks whether to migrate objects from one storage class to another on a resource manager that is currently connected by this client.
        Returns:
        a DKRMTimeSMS object containing the amount of time as a frequency to check whether to migrate objects from one storage class to another on the resource manager
        See Also:
        DKRMTimeSMS

      • getMigratorFrequencyHours

        public int getMigratorFrequencyHours()
        Gets the amount of time in hours and minutes that must elapse before the system checks whether to migrate objects from one storage class to another on a resource manager that is currently connected by this client.
        Returns:
        the amount of time in hours from the hour part of the frequency

      • getMigratorFrequencyMinutes

        public int getMigratorFrequencyMinutes()
        Gets the amount of time in hours and minutes that must elapse before the system checks whether to migrate objects from one storage class to another on a resource manager that is currently connected by this client.
        Returns:
        the amount of time in minutes from the minute part of the frequency

      • setThresholdFrequency

        public void setThresholdFrequency(com.ibm.mm.sdk.rm.DKRMTimeSMS frequency)
        Sets the amount of time in hours and minutes that must elapse before the system checks the capacity of the volumes on a resource manager that is currently connected by this client.
        Parameters:
        frequency - a DKRMTimeSMS object containing the amount of time as a frequency to check the capacity of the volumes on the resource manager
        See Also:
        DKRMTimeSMS

      • setThresholdFrequency

        public void setThresholdFrequency(int hours,
                                  int minutes)
                           throws DKException,
                                  java.lang.Exception
        Sets the amount of time in hours and minutes that must elapse before the system checks the capacity of the volumes on a resource manager that is currently connected by this client.
        Parameters:
        hours - the amount of time in hours for the hour part of the frequency
        minutes - the amount of time in minutes for the minute part of the frequency
        Throws:
        DKException
        java.lang.Exception

      • getThresholdFrequency

        public com.ibm.mm.sdk.rm.DKRMTimeSMS getThresholdFrequency()
        Gets the amount of time in hours and minutes that must elapse before the system checks the capacity of the volumes on a resource manager that is currently connected by this client.
        Returns:
        a DKRMTimeSMS object containing the amount of time as a frequency to check the capacity of the volumes on the resource manager
        See Also:
        DKRMTimeSMS

      • getThresholdFrequencyHours

        public int getThresholdFrequencyHours()
        Gets the amount of time in hours and minutes that must elapse before the system checks the capacity of the volumes on a resource manager that is currently connected by this client.
        Returns:
        the amount of time in hours from the hour part of the frequency

      • getThresholdFrequencyMinutes

        public int getThresholdFrequencyMinutes()
        Gets the amount of time in hours and minutes that must elapse before the system checks the capacity of the volumes on a resource manager that is currently connected by this client.
        Returns:
        the amount of time in minutes from the minute part of the frequency

      • setReplicatorFrequency

        public void setReplicatorFrequency(com.ibm.mm.sdk.rm.DKRMTimeSMS frequency)
        Sets the amount of time in hours and minutes that must elapse before the system checks whether to start the replication process on a resource manager that is currently connected by this client.
        Parameters:
        frequency - a DKRMTimeSMS object containing the amount of time as a frequency to check whether to start the replication process on the resource manager
        See Also:
        DKRMTimeSMS

      • setReplicatorFrequency

        public void setReplicatorFrequency(int hours,
                                   int minutes)
                            throws DKException,
                                   java.lang.Exception
        Sets the amount of time in hours and minutes that must elapse before the system checks whether to start the replication process on a resource manager that is currently connected by this client.
        Parameters:
        hours - the amount of time in hours for the hour part of the frequency
        minutes - the amount of time in minutes for the minute part of the frequency
        Throws:
        DKException
        java.lang.Exception

      • getReplicatorFrequency

        public com.ibm.mm.sdk.rm.DKRMTimeSMS getReplicatorFrequency()
        Gets the amount of time in hours and minutes that must elapse before the system checks whether to start the replication process on a resource manager that is currently connected by this client.
        Returns:
        a DKRMTimeSMS object containing the amount of time as a frequency to check whether to start the replication process on the resource manager
        See Also:
        DKRMTimeSMS

      • getReplicatorFrequencyHours

        public int getReplicatorFrequencyHours()
        Gets the amount of time in hours and minutes that must elapse before the system checks whether to start the replication process on a resource manager that is currently connected by this client.
        Returns:
        the amount of time in hours from the hour part of the frequency

      • getReplicatorFrequencyMinutes

        public int getReplicatorFrequencyMinutes()
        Gets the amount of time in hours and minutes that must elapse before the system checks whether to start the replication process on a resource manager that is currently connected by this client.
        Returns:
        the amount of time in minutes from the minute part of the frequency

      • setPurgerBatchSize

        public void setPurgerBatchSize(int size)
        Sets the number of files in the batch during the purger process.
        Parameters:
        size - the number of files in the batch for the purger process

      • getPurgerBatchSize

        public int getPurgerBatchSize()
        Gets the number of files in the batch during the purger process.
        Returns:
        the number of files in the batch for the purger process

      • setMigratorBatchSize

        public void setMigratorBatchSize(int size)
        Sets the number of files in the batch when a group of files is moved from one storage class to another.
        Parameters:
        size - the number of files in the batch for the migrator process

      • getMigratorBatchSize

        public int getMigratorBatchSize()
        Gets the number of files in the batch when a group of files is moved from one storage class to another.
        Returns:
        the number of files in the batch for the migrator process

      • isMigratorInEverydaySchedule

        public boolean isMigratorInEverydaySchedule()
        Checks if the migrator process runs on the daily schedule on a resource manager that is currently connected by this client.
        Returns:
        true if the migrator process runs daily; false otherwise.

      • isReplicatorInEverydaySchedule

        public boolean isReplicatorInEverydaySchedule()
        Checks if the replicator process runs on the daily schedule on a resource manager that is currently connected by this client.
        Returns:
        true if the replicator process runs daily; false otherwise.

      • isValidatorInEverydaySchedule

        public boolean isValidatorInEverydaySchedule()
        Checks if the validator process runs on the daily schedule on a resource manager that is currently connected by this client.
        Returns:
        true if the migrator process runs daily; false otherwise.

      • setMigratorEverydaySchedule

        public void setMigratorEverydaySchedule(DKRMScheduleSMS migratorEverydaySchedule)
                                 throws DKException,
                                        java.lang.Exception
        Sets a given schedule for the migrator process to run daily on a resource manager that is currently connected by this client.
        Parameters:
        migratorEverydaySchedule - a DKRMScheduleSMS object contains a schedule that the migrator process runs daily
        Throws:
        DKException
        java.lang.Exception
        See Also:
        DKRMScheduleSMS

      • getMigratorEverydaySchedule

        public DKRMScheduleSMS getMigratorEverydaySchedule()
        Gets the schedule for the migrator process to run daily on a resource manager that is currently connected by this client.
        Returns:
        a DKRMScheduleSMS object contains a schedule that the migrator process runs daily This schedule is only valid if the daily schedule is active, if a weekly schedule is active, then this method will return a schedule with only default values.
        See Also:
        DKRMScheduleSMS

      • setMigratorWeeklySchedule

        public void setMigratorWeeklySchedule(dkCollection migratorWeeklySchedule)
                               throws DKException,
                                      java.lang.Exception
        Sets a weekly schedule for the migrator process to run in different time on each specific day of a week on a resource manager that is currently connected by this client.
        Parameters:
        migratorWeeklySchedule - a dkCollection object containing the DKRMScheduleSMS objects that have different time on each specific day of a week for the migrator process to run
        Throws:
        DKException
        java.lang.Exception
        See Also:
        DKRMScheduleSMS, dkCollection

      • listMigratorWeeklySchedule

        public dkCollection listMigratorWeeklySchedule()
                                        throws DKException,
                                               java.lang.Exception
        Gets a weekly schedule for the migrator process to run in different time on each specific day of a week on a resource manager that is currently connected by this client.
        Returns:
        a dkCollection object containing the DKRMScheduleSMS objects that have different time on each specific day of a week for the migrator process to run If the daily schedule is active, then this collection will contain only default values, as the values are not used when a daily schedule is active.
        Throws:
        DKException
        java.lang.Exception
        See Also:
        DKRMScheduleSMS, dkCollection

      • setReplicatorEverydaySchedule

        public void setReplicatorEverydaySchedule(DKRMScheduleSMS replicatorEverydaySchedule)
                                   throws DKException,
                                          java.lang.Exception
        Sets a given schedule for the replicator process to run daily on a resource manager that is currently connected by this client.
        Parameters:
        replicatorEverydaySchedule - a DKRMScheduleSMS object contains a schedule that the replicator process runs daily
        Throws:
        DKException
        java.lang.Exception
        See Also:
        DKRMScheduleSMS

      • getReplicatorEverydaySchedule

        public DKRMScheduleSMS getReplicatorEverydaySchedule()
        Gets the schedule for the replicator process to run daily on a resource manager that is currently connected by this client.
        Returns:
        a DKRMScheduleSMS object contains a schedule that the replicator process runs daily This schedule is only valid if the daily schedule is active, if a weekly schedule is active, then this method will return a schedule with only default values.
        See Also:
        DKRMScheduleSMS

      • setReplicatorWeeklySchedule

        public void setReplicatorWeeklySchedule(dkCollection replicatorWeeklySchedule)
                                 throws DKException,
                                        java.lang.Exception
        Sets a weekly schedule for the replicator process to run in different time on each specific day of a week on a resource manager that is currently connected by this client.
        Parameters:
        replicatorWeeklySchedule - a dkCollection object containing the DKRMScheduleSMS objects that have different time on each specific day of a week for the replicator process to run
        Throws:
        DKException
        java.lang.Exception
        See Also:
        DKRMScheduleSMS, dkCollection

      • listReplicatorWeeklySchedule

        public dkCollection listReplicatorWeeklySchedule()
                                          throws DKException,
                                                 java.lang.Exception
        Gets a weekly schedule for the replicator process to run in different time on each specific day of a week on a resource manager that is currently connected by this client.
        Returns:
        a dkCollection object containing the DKRMScheduleSMS objects that have different time on each specific day of a week for the replicator process to run If the daily schedule is active, then this collection will contain only default values, as the values are not used when a daily schedule is active.
        Throws:
        DKException
        java.lang.Exception
        See Also:
        DKRMScheduleSMS, dkCollection

      • add

        public void add()
         throws DKException,
                java.lang.Exception
        Adds this configuration object to a resource manager datastore that is currently connected.
        Specified by:
        add in interface com.ibm.mm.sdk.rm.dkRMEntityDef
        Overrides:
        add in class com.ibm.mm.sdk.rm.DKRMEntityDefSMS
        Throws:
        DKException - if an error occurs
        java.lang.Exception

      • update

        public void update()
            throws DKException,
                   java.lang.Exception
        Updates this configuration object to a resource manager datastore that is currently connected.
        Specified by:
        update in interface com.ibm.mm.sdk.rm.dkRMEntityDef
        Overrides:
        update in class com.ibm.mm.sdk.rm.DKRMEntityDefSMS
        Throws:
        DKException - if an error occurs
        java.lang.Exception

      • del

        public void del()
         throws DKException,
                java.lang.Exception
        Deletes this configuration object from a resource manager datastore that is currently connected.
        Specified by:
        del in interface com.ibm.mm.sdk.rm.dkRMEntityDef
        Overrides:
        del in class com.ibm.mm.sdk.rm.DKRMEntityDefSMS
        Throws:
        DKException - if an error occurs
        java.lang.Exception