JBoss

JMX MBean View
Back to Agent View Refresh MBean View

MBean description:

Compression Service. The Compression Service supports delayed, lossless compression of received images. This is an alternative to immediately compressing images when received. (The lossless compression rules are configured by the CompressionRules attribute in the StorageSCP service.) The value of the attributes MaxConcurrentCodec, MaxBufferedImagePoolSize and MaxBufferedImagePoolMemoryattribute of the Compression Service also effects the on-the-fly compression and decompression during the receive and retrieve of images by the StorageSCP and QueryRetrieveSCP services. (For details, see the these attributes below.)

List of MBean attributes:

Name Type Access Value Description
MaxConcurrentCodec int RW Maximum number of concurrent tasks for compressing and decompressing images. With the default value of MaxConcurrentCodec = 1, all compression and decompression operations are serialized. For example, if on-the-fly compression during an image receive is activated, and three modalities concurrently send uncompressed images to the archive, only one image received from one modality is compressed at the same time. This significantly reduces the receiving performance. The used codec allocates memory for uncompressed pixel data of at least one frame, so without limiting the maximum number of concurrent compression tasks, memory consumption could become unacceptable. You will receive an out of memory error if the memory consumption exceeds the configured -Xmx value in the $DCM4CHEE_HOME/bin/run.conf file).
MaxConcurrentCompression int RW Maximum number of concurrent tasks for compressing images. With the default value of MaxConcurrentCompression = 1, all compression operations are serialized.
MaxConcurrentDecompression int RW Maximum number of concurrent tasks for decompressing images. With the default value of MaxConcurrentDecompression = 1, all decompression operations are serialized.
FileSystemGroupIDs java.lang.String RW Group IDs of writable file systems which are scanned for image files to compress in configured TaskInterval. Separate multiple values by comma (',').
MaxBufferedImagePoolSize int RW Maximum number of pooled BufferedImage objects. If MaxBufferedImagePoolSize > 0, BufferedImage objects allocated for compression and decompression operations are pooled so they can be reused by subsequent compression and decompression operations with matching pixel matrix dimensions. The pool size is additional limited by MaxBufferedImagePoolMemory, the maximum amount of memory allocated by pooled BufferedImage objects.
CurrentBufferedImagePoolSize int R 0 Current number of pooled BufferedImage objects.
MaxBufferedImagePoolMemory java.lang.String RW Maximum amount of memory allocated by pooled BufferedImage objects. 1MB = 1000000 bytes. If MaxBufferedImagePoolSize > 0, BufferedImage objects allocated for compression and decompression operations are pooled so they can be reused by subsequent compression and decompression operations with matching pixel matrix dimensions. The pool size is additional limited by MaxBufferedImagePoolSize, the maximum number of pooled BufferedImage objects.
CurrentBufferedImagePoolMemory java.lang.String R 0.0MB Current amount of memory allocated by pooled BufferedImage objects. 1MB = 1000000 bytes.
BufferedImagePoolHitRate float R 0.0 Ratio of the number of BufferedImage objects reused from the pool to the total number of used (= reused or new allocated) BufferedImage objects.
TaskInterval java.lang.String RW Interval in which the database is checked for image files located on writeable file systems with one of the configured FileSystemGroupIDs to compress.
Format:
interval!from-to or NEVER
interval = ##s (in seconds), ##m (in minutes), ##h (in hours).
from = start hour (0-23) when no compression should be performed
to = end hour (0-23) when no compression should be performed
NEVER = disable automatic compression
Example:10s!9-17 means every 10 seconds, poll the database and check for images to compress, except between the hours of 9:00am and 5:00pm. By setting this type of TaskInterval, you can ensure compression of images happens outside of peak imaging hours.
isRunning boolean R False Current state if compression task is running. Used to avoid concurrency!
LimitNumberOfFilesPerTask int RW Maximum number of files that are compressed in one task.
CompressionRules java.lang.String RW Specifies compression rules and delay for individual SOP Classes.
Format:
sop-class-name-or-uid:compression:delay
sop-class-name-or-uid = the UID of the SOP class, or a string name defined in the dictionary.xml file under uids type="SOPClass"
compression = JPLL|JLSL|J2KR
JPLL -JPEG lossless
JLSL - JPEG-LS lossless
J2KR - JPEG 2000 lossless
delay = ##d (in days)
Example:
ComputedRadiographyImageStorage:JLSL:5d means compress Computed Radiography Images with JPEG-LS lossless compression after 5 days.
VerifyCompression boolean RW True False Enables the verification of the compressed file.
TempDirectory java.lang.String RW Directory used to spool decompressed files for compression verification. Relative path names are resolved relative to $DCM4CHEE_HOME/server/default/.
KeepTempFileIfVerificationFails java.lang.String RW Defines how long files that were decompressed for verification remain for further analysis before being deleted, if the decompressed pixel data differs from the pixel data in the original file.
Format:
##m (in minutes), ##h (in hours), ##d (in days)
BufferSize int RW Size of write byte buffer.
SchedulerServiceName javax.management.ObjectName RW View MBean Used internally. Do NOT modify.
TimerIDCheckFilesToCompress java.lang.String RW Used internally. Do NOT modify.
Name java.lang.String R CompressionService 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

void resetBufferedImagePoolHitRate()

Reset BufferedImagePoolHitRate.

void checkForTempFilesToDelete()

Check for temporary image files to delete.

void checkForFilesToCompress()

Check for files to compress.

boolean compress()

Compress specified object if it is uncompressed and if there is a Compression Rule for its SOP Class UID configured

Param ParamType ParamValue ParamDescription
fileDTO org.dcm4chex.archive.ejb.interfaces.FileDTO (no description)