Page Comparison

Description

The AE (Application Entity) Configuration Service.  Used to list/add/remove AE configuration entities. This is a programmatic way of accessing the AE Title configuration, as an   A programmatic alternative to the more convenient AE Management Page console of the web Administration Web Application. This is used/required Tools user interface. Used/Required by various DICOM services (Query/Retrieve SCP, Storage Commitment SCU/SCP, DICOM Hanging Protocol SCP, etc.) to 'guess' the port number of DICOM peer DICOM Application Entities, if no AE configuration entry is defined for a given AE Title matches. 

Dependencies

...

Image Added

Attributes

...

<attribute access="read-only" getMethod="getAEs">
  <description>Configured application entities.&lt;br&gt;
  Use the addAE and removeAE commands  below to add and remove AE configurations.</description>
  <name>AEConfiguration</name>
  <type>java.lang.String</type>
</attribute>

<attribute access="read-write" getMethod="getAuditLoggerName" setMethod="setAuditLoggerName">
  <description>Used internally. Do not modify.
  </description>
  <name>AuditLoggerName</name>
  <type>javax.management.ObjectName</type>
  <descriptors>
     <value value="dcm4chee.archive:service=AuditLogger"/>
  </descriptors>
</attribute>

<attribute access="read-write" getMethod="getEchoServiceName" setMethod="setEchoServiceName">
  <description>Used internally. Do not modify.
  </description>
  <name>EchoServiceName</name>
  <type>javax.management.ObjectName</type>
  <descriptors>
     <value value="dcm4chee.archive:service=ECHOService"/>
  </descriptors>
</attribute>

<attribute access="read-write" getMethod="getPortNumbers" setMethod="setPortNumbers">
  <description>Port numbers for AE auto configuration.&lt;br&gt;
                 The method getAE(title, hostname) use this list to find a DICOM service hosted by hostname.&lt;br&gt;
                 'NONE' will disable auto AE configuration!
  </description>
  <name>PortNumbers</name>
  <type>java.lang.String</type>
  <descriptors>
     <value value="104,11112"/>
  </descriptors>
</attribute>

<attribute access="read-write" getMethod="isDontSaveIP" setMethod="setDontSaveIP">
  <description> This flag is used by auto AE configuration, if no hostname is available.&lt;br&gt;
                  Set this flag to false if you explicitly allow the saving of ip address.&lt;br&gt;
                  This should be only necessary if your network have static ip address and no name service active!&lt;br&gt;
                  Avoid this option if you use DHCP!
  </description>
  <name>DontSaveIP</name>
  <type>boolean</type>
  <descriptors>
     <value value="true"/>
  </descriptors>
</attribute>

Operations

...

#AEConfiguration

Anchor
AEConfiguration AEConfiguration

Configured application entities. Use the addAE and removeAE commands below to add and remove AE configurations.

#PortNumbers

Anchor
PortNumbers PortNumbers

Port numbers used for automatic configuration of AE titles. In C-Move and Storage commit messages, if the server does not know AE title of the move destination, the server automatically tries to connect to the unknown AE title on the ports defined in PortNumbers. The defaults are port 104 and port 11112.  The method getAE(title, hostname) uses this list to find a DICOM service hosted by hostname. If the AE title can be found, it is automatically added to the AE Management console in the web Administration Tools.

'NONE' disables automatic AE configuration.

Changes to this value are applied immediately. 

Default Value: 104,11112

#DontSaveIP

Anchor
DontSaveIP DontSaveIP

This flag is used by automatic AE configuration, if no hostname is available. Set this flag to false if you explicitly allow the saving of IP addresses. This should only be necessary if your network has static IP addresses and no domain name service (DNS) active. Otherwise, set the value to true if you are running a DNS.

Avoid this option if you use DHCP!

Default Value: true

#AutoUpdateIP

Anchor
AutoUpdateIP AutoUpdateIP

Controls if configured IP addresses of AE Titles shall be updated automatically on receive of C-MOVE requests with the requester's AE Title as Move Destination. Useful for retrieve to clients with dynamic IP.

Default Value: false

#MaxCacheSize

Anchor
MaxCacheSize MaxCacheSize

Maximal number of cached AE configurations.

Default Value: 20

#CacheSize

Anchor
CacheSize CacheSize

Current number of cached AE configurations.

#AuditLoggerName

Anchor
AuditLoggerName AuditLoggerName

Used internally. Do not modify.

Default Value: dcm4chee.archive:service=AuditLogger

#EchoServiceName

Anchor
EchoServiceName EchoServiceName

Used internally. Do not modify.

Default Value: dcm4chee.archive:service=ECHOService

#Name

Anchor
Name Name

The class name of the MBean

#State

Anchor
State State

The status of the MBean

#StateString

Anchor
StateString StateString

The status of the MBean in text form

Operations

#listAEs

Anchor
listAEs listAEs

Get list of AE Configurations

#getAE

Anchor
getAE getAE

Get AE Configuration

#getAE

Anchor
getAE getAE

Get AE Configuration

#getAE

Anchor
getAE getAE

Get AE Configuration

#updateAE

Anchor
updateAE updateAE

Update AE configuration

#addAE

Anchor
addAE addAE

Add AE configuration

#removeAE

Anchor
removeAE removeAE

Remove AE Configuration

#updateAETitle

Anchor
updateAETitle updateAETitle

Update AE Title of existing AE configuration

#clearCache

Anchor
clearCache clearCache

Clear AE Cache

#create

Anchor
create create

Standard MBean lifecycle method

#start

Anchor
start start

The start lifecycle operation

#stop

Anchor
stop stop

The stop lifecycle operation

#destroy

Anchor
destroy destroy

The destroy lifecycle operation

#jbossInternalLifecycle

Anchor
jbossInternalLifecycle jbossInternalLifecycle

The detyped lifecycle operation (for internal use only)

Notifications