JBoss

JMX MBean View

Back to Agent View Refresh MBean View

MBean description:

File Copy Service.

List of MBean attributes:

Name Type Access Value Description
DestinationFileSystem java.lang.String RW Destination file system or NONE to disable the service. The file system name can be suffixed by '!'from'-'to to defer copying outside a particular time interval, and/or prefixed by a condition '[calling'['!']'='aeTitle['|'..]']' to limit/exclude copying to/of series received from modalities with specified AE title(s). If the file system name is a tar URI (tar:), instances of one series are packed into one tarball. Otherwise instance files are copied individually to the destination file system. If an external command is used for the copy of tarballs to the destination, the destination name (after the "tar:" prefix) need not follow the syntax of a directory path (e.g.: tar:ftp://user@pass/service).

Attention: The file system must have already been configured by invoking operation File System Management Service#addRWFileSystem(). Otherwise the copy task will fail! If you configured a tar URI as destination file system, the name of the configured file system has to match that URI, and not only the part!

The filesystem status and/or availability may be also changed to fulfil configured deleter criteria.
(see also updateFileSystemStatus and updateFileSystemAvailability in File System Managment Service)

HSMModulServicename java.lang.String RW HSM Module to store tarballs to HSM systems.
Use NONE to store files on local filesystem without additional HSM support.
Only effective if destination is a tar filesystem!
RegisteredHSMModules java.lang.String R dcm4chee.archive:service=FileCopyHSMModule,type=Command dcm4chee.archive:service=FileCopyHSMModule,type=DiceyFileBased dcm4chee.archive:service=FileCopyHSMModule,type=FileBased Registered HSM modules.
isReady boolean R True Status if FileCopy Service is ready to process FileCopy orders.
If the destination is a tar filesystem and a HSMModule is configured, this module must be also registered!
If this status is false the processing of Filecopy orders will be delayed according NotReadyDelay to wait for deployment/registration of the configured HSMModule.
FileStatus java.lang.String RW Status of copied file. Enumerated values: DEFAULT, TO_ARCHIVE, ARCHIVED
VerifyCopy boolean RW True False Verify MD5 sum of copied file.
RetryIntervals java.lang.String RW Number and interval of retries made for failed Copy Requests.
Format:
Comma separated list of numberxinterval pairs.
The interval can be specified in seconds (##s), minutes (##m), hours (##h) or days (##d).
Example:
5x1m,10x10m means retry a total of 5 times, one minute apart for each retry; then retry a total of 10 times, 10 minutes apart for each retry.
NotReadyDelay java.lang.String RW Delay to reschedule FileCopy orders when the FileCopy Service is not ready.
The delay can be specified in seconds (##s), minutes (##m), hours (##h) or days (##d).
Concurrency int RW Maximum number of concurrent invoked Copy Requests.
BufferSize int RW Size of write byte buffer.
FetchSize int RW JDBC Fetch size.
QueueName java.lang.String RW Used internally. Do NOT modify.
StoreScpServiceName javax.management.ObjectName RW View MBean Used internally. Do NOT modify.
JMSServiceName javax.management.ObjectName RW View MBean Used internally. Do NOT modify.
QueryRetrieveScpServiceName javax.management.ObjectName RW View MBean Used internally. Do NOT modify.
Name java.lang.String R FileCopyService The class name of the MBean
State int R 3 The status of the MBean
StateString java.lang.String R Started The status of the MBean in text form

List of MBean operations:


void create()

Standard MBean lifecycle method


void start()

The start lifecycle operation


void stop()

The stop lifecycle operation


void destroy()

The destroy lifecycle operation


void jbossInternalLifecycle()

The detyped lifecycle operation (for internal use only)

Param ParamType ParamValue ParamDescription
method java.lang.String The lifecycle operation

boolean copyFilesOfStudy()

Copy files of given study

Param ParamType ParamValue ParamDescription
studyIUID java.lang.String Study Instance UID

boolean copyFilesOfSeries()

Copy files of given series

Param ParamType ParamValue ParamDescription
seriesIUID java.lang.String Series Instance UID

boolean scheduleByIAN()

Schedule Filecopy Order for given IAN Dataset

Param ParamType ParamValue ParamDescription
ianDataset org.dcm4che.data.Dataset IAN Dataset
scheduleTime long Schedule delivery time as long.
Note: -1 means default behaviour (after business hours configured in destination: <destination>!<from>-<to>).

void registerHSMModule()

Register a HSM Module (start queue if the module is set in HSMModulServicename)

Param ParamType ParamValue ParamDescription
moduleName javax.management.ObjectName MBean Name of HSM module

void unregisterHSMModule()

Unregister a HSM Module (stop queue if the module is set in HSMModulServicename)

Param ParamType ParamValue ParamDescription
moduleName javax.management.ObjectName MBean Name of HSM module