Files
config-pacs-docker/dcm4chee/default/conf/xmdesc/dcm4chee-stgcmt-xmbean.xml
2025-02-26 14:49:25 +07:00

450 lines
17 KiB
XML

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE mbean PUBLIC "-//JBoss//DTD JBOSS XMBEAN 1.1//EN" "http://www.jboss.org/j2ee/dtd/jboss_xmbean_1_1.dtd">
<mbean>
<description>DICOM Storage Commitment SCU/SCP. Provides a DICOM Storage
Commitment Service in the Service Class Provider
(SCP) and the Service Class User (SCU) Role. When acting as the SCP,
the service handles storage commitment requests that it receives
from modalities or evidence creators (workstations).
When acting as the SCU, it may request storage
commitment for objects for itself that were retrieved from the archive to a remote
application. Typically this application is a further archive
instance acting as a long-term or central archive.</description>
<descriptors>
<persistence persistPolicy="OnUpdate"/>
<persistence-manager value="org.jboss.mx.persistence.DelegatingPersistenceManager"/>
</descriptors>
<class>org.dcm4chex.archive.dcm.stgcmt.StgCmtScuScpService</class>
<constructor>
<description>The default constructor</description>
<name>StgCmtScuScpService</name>
</constructor>
<!-- Attributes -->
<attribute access="read-write"
getMethod="getCalledAETs"
setMethod="setCalledAETs">
<description>Accepted called AE titles, separated by \ (backslash).
</description>
<name>CalledAETitles</name>
<type>java.lang.String</type>
<descriptors>
<value value="ABPACS"/>
</descriptors>
</attribute>
<attribute access="read-write"
getMethod="getCallingAETs"
setMethod="setCallingAETs">
<description><![CDATA[
List of accepted calling AE titles, separated by \(backslash).<br/>
ANY = accept any. <br/>
CONFIGURED_AETS = accept any configured AE Title.
]]>
</description>
<name>CallingAETitles</name>
<type>java.lang.String</type>
<descriptors>
<value value="ANY"/>
</descriptors>
</attribute>
<attribute access="read-write"
getMethod="getRequestStgCmtFromAETs"
setMethod="setRequestStgCmtFromAETs">
<description><![CDATA[Move Destination AE titles, from which Storage
Commitment for transmitted objects shall be requested.
<br>Format:
<br><i>STORAGE_AET</i>:<i>STGCMT_AET</i>.
<br>The AE title of the Storage Commitment Service (<i>STGCMT_AET</i>)
can be omitted, if identical to the AE title of the
Move Destination (<i>STORAGE_AET</i>).
Separate multiple values with a \(backslash).
NONE = No Move Destination from which Storage Commitment
will be requested.]]>
</description>
<name>RequestStorageCommitFromAETitles</name>
<type>java.lang.String</type>
<descriptors>
<value value="NONE"/>
</descriptors>
</attribute>
<attribute access="read-write"
getMethod="getTrustStgCmtFromAETs"
setMethod="setTrustStgCmtFromAETs">
<description><![CDATA[AE titles of trusted Storage Commitment SCPs.
Only Storage Commitment results received from these sources will cause
to mark referenced instances as external retrievable.
Separate multiple values with a \(backslash).
<br>NONE = Do not mark instances as external retrievable.
<br>ANY = Trust Storage Commitment results from any Storage
Commitment SCP.]]>
</description>
<name>TrustStorageCommitFromAETitles</name>
<type>java.lang.String</type>
<descriptors>
<value value="NONE"/>
</descriptors>
</attribute>
<attribute access="read-write"
getMethod="getReceiveResultInSameAssocTimeout"
setMethod="setReceiveResultInSameAssocTimeout">
<description>Time in milliseconds that the Storage Commit SCU waits to
receive the Storage Commit Result in the same association
as the storage commit was requested, before releasing the association.
</description>
<name>ReceiveResultInSameAssociationTimeout</name>
<type>long</type>
<descriptors>
<value value="0"/>
</descriptors>
</attribute>
<attribute access="read-write"
getMethod="getScuRetryIntervalls"
setMethod="setScuRetryIntervalls">
<description><![CDATA[Number and interval of retries by the SCU to invoke
Storage Commitment Requests.
<br>Format:
<br>Comma separated list of <i>number</i> x <i>interval</i> pairs.
<br>The interval can be specified in seconds (##s),
minutes (##m), hours (##h) or days (##d).
<br>Example:
<br>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.]]>
</description>
<name>SCURetryIntervals</name>
<type>java.lang.String</type>
<descriptors>
<value value="5x1m,12x5m"/>
</descriptors>
</attribute>
<attribute access="read-write"
getMethod="getScpRetryIntervalls"
setMethod="setScpRetryIntervalls">
<description><![CDATA[Number and interval of retries by the SCP to send
Storage Commitment Results to the SCU.
<br>Format:
<br>Comma separated list of <i>number</i>x<i>interval</i> pairs.
<br>The interval can be specified in seconds (##s),
minutes (##m), hours (##h) or days (##d).
<br>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.]]>
</description>
<name>SCPRetryIntervals</name>
<type>java.lang.String</type>
<descriptors>
<value value="5x1m,12x5m"/>
</descriptors>
</attribute>
<attribute access="read-write"
getMethod="getAcceptedTransferSyntax"
setMethod="setAcceptedTransferSyntax">
<description><![CDATA[
List of accepted Transfer Syntaxes. Order defines selection preference.
Use either the Transfer Syntaxes UID value or following defined
symbolic names:
ImplicitVRLittleEndian,
ExplicitVRLittleEndian,
DeflatedExplicitVRLittleEndian,
ExplicitVRBigEndian
]]>
</description>
<name>AcceptedTransferSyntax</name>
<type>java.lang.String</type>
<descriptors>
<value value="
ExplicitVRLittleEndian
ImplicitVRLittleEndian
"/>
</descriptors>
</attribute>
<attribute access="read-write"
getMethod="getCoerceConfigDir"
setMethod="setCoerceConfigDir">
<description><![CDATA[Directory where configuration files for Storage
Commitment Result attribute coercion are located: if XSL stylesheet
"stgcmt-neventreportrq.xsl" exists in this directory or a sub-directory
equal to the AE Title of a Storage Commitment SCP, Storage Commitment
Result attributes from this SCP will be coerced according this stylesheet.
A relative path name is resolved relative to
<i>archive-install-directory</i>/server/default/.]]>
</description>
<name>CoerceConfigDirectory</name>
<type>java.lang.String</type>
<descriptors>
<value value="conf/dcm4chee-ae"/>
</descriptors>
</attribute>
<attribute access="read-write"
getMethod="getConcurrency"
setMethod="setConcurrency">
<description>Maximum number of concurrent invoked or processed
Storage Commit Requests.
</description>
<name>Concurrency</name>
<type>int</type>
<descriptors>
<value value="1"/>
</descriptors>
</attribute>
<attribute access="read-write"
getMethod="getMaxPDULength"
setMethod="setMaxPDULength">
<description>Maximum protocol data unit (PDU) package length for receiving PDUs.
Attention: This property should be set to equal values for all DICOM SCP
services with same called AE Title(s)! Otherwise it is non-deterministic,
which configured value is effective!
</description>
<name>MaximumPDULength</name>
<type>int</type>
<descriptors>
<value value="16352"/>
</descriptors>
</attribute>
<attribute access="read-write"
getMethod="getMaxOpsInvoked"
setMethod="setMaxOpsInvoked">
<description>The maximum number of outstanding operations and/or
sub-operations it allows the Association-requester to invoke asynchronously.
A value of zero indicates an unlimited number of outstanding operations.
Attention: This property should be set to equal values for all DICOM SCP
services with same called AE Title(s)! Otherwise it is non-deterministic,
which configured value is effective!
</description>
<name>MaximumOperationsInvoked</name>
<type>int</type>
<descriptors>
<value value="1"/>
</descriptors>
</attribute>
<attribute access="read-write"
getMethod="getMaxOpsPerformed"
setMethod="setMaxOpsPerformed">
<description>The maximum number of outstanding operations and/or
sub-operations it allows the Association-requester to perform asynchronously.
A value of zero indicates an unlimited number of outstanding operations.
Attention: This property should be set to equal values for all DICOM SCP
services with same called AE Title(s)! Otherwise it is non-deterministic,
which configured value is effective!
</description>
<name>MaximumOperationsPerformed</name>
<type>int</type>
<descriptors>
<value value="1"/>
</descriptors>
</attribute>
<attribute access="read-write"
getMethod="getAcTimeout"
setMethod="setAcTimeout">
<description>A-Associate accept timeout in milliseconds. 0 = no timeout.
</description>
<name>AcceptTimeout</name>
<type>int</type>
<descriptors>
<value value="10000"/>
</descriptors>
</attribute>
<attribute access="read-write"
getMethod="getDimseTimeout"
setMethod="setDimseTimeout">
<description>DIMSE message timeout in milliseconds. 0 = no timeout.
</description>
<name>DIMSETimeout</name>
<type>int</type>
<descriptors>
<value value="60000"/>
</descriptors>
</attribute>
<attribute access="read-write"
getMethod="getSoCloseDelay"
setMethod="setSoCloseDelay">
<description>Socket close delay in milliseconds after an A-Release response.
</description>
<name>SocketCloseDelay</name>
<type>int</type>
<descriptors>
<value value="50"/>
</descriptors>
</attribute>
<attribute access="read-write"
getMethod="isTcpNoDelay"
setMethod="setTcpNoDelay">
<description>Send packets as quickly as possible (Disable Nagle's algorithmn).
</description>
<name>TcpNoDelay</name>
<type>boolean</type>
<descriptors>
<value value="true" />
</descriptors>
</attribute>
<attribute access="read-write"
getMethod="getSendBufferSize"
setMethod="setSendBufferSize">
<description>Buffer size used for socket output. 0 = use platform default.
</description>
<name>SendBufferSize</name>
<type>int</type>
<descriptors>
<value value="0" />
</descriptors>
</attribute>
<attribute access="read-write"
getMethod="getReceiveBufferSize"
setMethod="setReceiveBufferSize">
<description>Buffer size used for socket input. 0 = use platform default.
</description>
<name>ReceiveBufferSize</name>
<type>int</type>
<descriptors>
<value value="0" />
</descriptors>
</attribute>
<attribute access="read-write"
getMethod="getFetchSize"
setMethod="setFetchSize">
<description>JDBC Fetch size.
</description>
<name>FetchSize</name>
<type>int</type>
<descriptors>
<value value="50"/>
</descriptors>
</attribute>
<attribute access="read-write"
getMethod="getQueueName"
setMethod="setQueueName">
<description>Used internally. Do NOT modify.
</description>
<name>QueueName</name>
<type>java.lang.String</type>
</attribute>
<attribute access="read-write"
getMethod="getJmsServiceName"
setMethod="setJmsServiceName">
<description>Used internally. Do NOT modify.
</description>
<name>JMSServiceName</name>
<type>javax.management.ObjectName</type>
</attribute>
<attribute access="read-write"
getMethod="getQueryRetrieveScpServiceName"
setMethod="setQueryRetrieveScpServiceName">
<description>Used internally. Do NOT modify.
</description>
<name>QueryRetrieveScpServiceName</name>
<type>javax.management.ObjectName</type>
</attribute>
<attribute access="read-write"
getMethod="getDcmServerName"
setMethod="setDcmServerName">
<description>Used internally. Do NOT modify.
</description>
<name>DcmServerName</name>
<type>javax.management.ObjectName</type>
</attribute>
<attribute access="read-write"
getMethod="getTLSConfigName"
setMethod="setTLSConfigName">
<description>Used internally. Do NOT modify.
</description>
<name>TLSConfigName</name>
<type>javax.management.ObjectName</type>
</attribute>
<attribute access="read-write"
getMethod="getAEServiceName"
setMethod="setAEServiceName">
<description>Used internally. Do NOT modify.
</description>
<name>AEServiceName</name>
<type>javax.management.ObjectName</type>
</attribute>
<attribute access="read-write"
getMethod="getTemplatesServiceName"
setMethod="setTemplatesServiceName">
<description>Used internally. Do NOT modify.
</description>
<name>TemplatesServiceName</name>
<type>javax.management.ObjectName</type>
</attribute>
&defaultAttributes;
<!-- Operations -->
&defaultOperations;
<operation impact="ACTION">
<description>Used internally.</description>
<name>onInstancesRetrieved</name>
<parameter>
<description>Called AE Title of Move SCP</description>
<name>moveScp</name>
<type>java.lang.String</type>
</parameter>
<parameter>
<description>AE Title of Move Destination.</description>
<name>moveDest</name>
<type>java.lang.String</type>
</parameter>
<parameter>
<description>Dataset for StgCmt N-ACTION request.</description>
<name>actionInfo</name>
<type>org.dcm4che.data.Dataset</type>
</parameter>
<parameter>
<description>Delay of sending StgCmt in ms.</description>
<name>Delay</name>
<type>int</type>
</parameter>
<return-type>void</return-type>
</operation>
<operation impact="ACTION">
<description>Schedule Storage Commitment Request for Study.
Return number of instances of scheduled StgCmt request.</description>
<name>scheduleStgCmtForStudy</name>
<parameter>
<description>Study Instance UID</description>
<name>suid</name>
<type>java.lang.String</type>
</parameter>
<parameter>
<description>Called AET of StgCmt SCP to send request.</description>
<name>called</name>
<type>java.lang.String</type>
</parameter>
<parameter>
<description>Calling AET in StgCmt request. (Use first AET of CalledAETs attribute as default)</description>
<name>calling</name>
<type>java.lang.String</type>
</parameter>
<return-type>int</return-type>
</operation>
<operation impact="ACTION">
<description>Schedule Storage Commitment Request for Series.
Return number of instances of scheduled StgCmt request.</description>
<name>scheduleStgCmtForSeries</name>
<parameter>
<description>Series Instance UID</description>
<name>suid</name>
<type>java.lang.String</type>
</parameter>
<parameter>
<description>Called AET of StgCmt SCP to send request.</description>
<name>called</name>
<type>java.lang.String</type>
</parameter>
<parameter>
<description>Calling AET in StgCmt request. (Use first AET of CalledAETs attribute as default)</description>
<name>calling</name>
<type>java.lang.String</type>
</parameter>
<return-type>int</return-type>
</operation>
<!-- Notifications -->
</mbean>