The following properties are required for the plugin to work:
catdv.rest_api.host = <CatDV server hostname>
catdv.rest_api.port = <CatDV API port>
catdv.rest_api.user = <CatDV API user>
catdv.rest_api.password = <CatDV API user password>
catdv.rest_api.client_key = <generated licence key for plugin API usage>
Typical values for a development machine would be:
localhost, 8080, Administrator,
** If the password is blank, do not include the password property.
In addition, the following optional properties can also be set:
catdv.service.api_timeout = <time_period_in_milliseconds>
Determines the timeout period after which the current connection to the
CatDV API will be assumed to have timed out and therefore be replaced
with a new connection (this is to pre-empt exceptions due to timeouts).
catdv.s3archive_service.restrict_command_access = NOT SET / config / all
If set, restricts the specified plugin commands to sys admin users. Can be
used to hide ‘config’ commands only (i.e. Manage Service), or ‘all’ commands.
NB – this only works with CatDV client versions from 12 onwards.
catdv.s3archive_service.days_to_display = <number_of_days>
The number of days into the past for which jobs are listed in the job queue.
Any job updated in this time period is listed. The default value is 7.
catdv.s3archive_service.loop_delay = <time_period_in_milliseconds>
Determines the frequency with which the archive service checks the Job
queue and attempts to run outstanding Jobs. The default value is 10000,
equivalent to 10 seconds.
catdv.s3archive_service.retry_interrupted_job_delay = <time_period_in_milliseconds>
Determines the time period after which to re-try an interrupted job. Note
that interrupted jobs are retried immediately <num_immediate_job_retries> times,
after which the delay applies until another <num_delayed_retries> attempts have
been made, at which point the Job will be abandoned. The default value is
equivalent to 1 hour.
Determines the time period after which a Job which is in progress will be
restarted if it has not been updated during that period. Defaults to a
value equivalent to 1 hour.
The number of times an interrupted job is retried in immediate succession before
the time delay kicks in for subsequent retries. The default value is 5.
The number of times an interrupted job is retried at an interval determined by
the retry_interrupted_job_delay. The default value is 24.
Determines the number of transfers that the Amazon S3 transfer manager
will attempt to run concurrently. Note that when the limit is reached
the last transfer blocks the addition of any new transfers until it is
complete, regardless of whether or not any of the preceding transfers
have completed. The default value is 1.
Determines whether the plugin uses virtual host addressing or resource
path addressing to connect with the S3 service. Valid values are ‘virtual’
or ‘pathStyle’. The default value is ‘virtual’.
Sets the name of the signature algorithm to use for signing requests. If not
set or explicitly set to null, the Amazon S3 SDK will choose a signature algorithm
to use based on a configuration file of supported signature algorithms for the
service and region. The default is not set, which should ideally not be overridden
for the Amazon S3 service. However, other archive services which provide an S3
interface may need to set this property, e.g “S3SignerType”.
catdv.s3archive_service.initial_name = The name used to initially create
the ‘in_server’ service. The default value is “Amazon S3”. This property
may be used to customise the name for an S3 compatible service such as
Google Cloud Storage.
catdv.s3archive_service.initial_description = The description use to initially
create the ‘in server’ service. The default value is “Archive to and restore
from Amazon S3 cloud storage”. This property may be used to customise
the description for an S3 compatible service such as Google Cloud Storage.