Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Use XSL generation for the service documentation.

Description

AE 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 of the Administration Web Application. This is used/required 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 for a given AE Title matches. 

Collaborators

Attributes

No Format

<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

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

AuditLoggerName

Used internally. Do not modify.

EchoServiceName

Used internally. Do not modify.

PortNumbers

Port numbers for AE auto configuration. The method getAE(title, hostname) use this list to find a DICOM service hosted by hostname. 'NONE' will disable auto AE configuration!

DontSaveIP

This flag is used by auto AE configuration, if no hostname is available. Set this flag to false if you explicitly allow the saving of ip address. This should be only necessary if your network has static ip addresses and no name service active!

Warning

Avoid this option if you use DHCP!

Name

The class name of the MBean

State

The status of the MBean

StateString

The status of the MBean in text form

Operations

listAEs

Get list of AE Configurations

getAE

Get AE Configuration

getAE

Get AE Configuration

getAE

Get AE Configuration

updateAE

Update AE configuration

addAE

Add AE configuration

removeAE

Remove AE Configuration

create

Standard MBean lifecycle method

start

The start lifecycle operation

stop

The stop lifecycle operation

destroy

The destroy lifecycle operation

jbossInternalLifecycle

The detyped lifecycle operation (for internal use only)

Notifications