Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

Version 1 Next »

Description

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

Collaborators

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

<operation impact="INFO">
 <description>Get list of AE Configurations</description>
 <name>listAEs</name>
 <return-type>java.util.List</return-type>
</operation>

<operation impact="ACTION">
 <description>Get AE Configuration</description>
 <name>getAE</name>
 <parameter>
   <description>AE Title</description>
   <name>title</name>
   <type>java.lang.String</type>
 </parameter>
 <return-type>org.dcm4chex.archive.ejb.jdbc.AEData</return-type>
</operation>

<operation impact="ACTION">
 <description>Get AE Configuration</description>
 <name>getAE</name>
 <parameter>
   <description>AE Title</description>
   <name>title</name>
   <type>java.lang.String</type>
 </parameter>
 <parameter>
   <description>Hostname or ip</description>
   <name>host</name>
   <type>java.lang.String</type>
 </parameter>
 <return-type>org.dcm4chex.archive.ejb.jdbc.AEData</return-type>
</operation>

<operation impact="ACTION">
 <description>Get AE Configuration</description>
 <name>getAE</name>
 <parameter>
   <description>AE Title</description>
   <name>title</name>
   <type>java.lang.String</type>
 </parameter>
 <parameter>
   <description>InetAddress</description>
   <name>addr</name>
   <type>java.net.InetAddress</type>
 </parameter>
 <return-type>org.dcm4chex.archive.ejb.jdbc.AEData</return-type>
</operation>

<operation impact="ACTION">
 <description>Update AE configuration</description>
 <name>updateAE</name>
 <parameter>
   <description>Primary key of AE (use -1 for new AE)</description>
   <name>pk</name>
   <type>long</type>
 </parameter>
 <parameter>
   <description>AE Title</description>
   <name>aet</name>
   <type>java.lang.String</type>
 </parameter>
 <parameter>
   <description>Hostname or ip</description>
   <name>host</name>
   <type>java.lang.String</type>
 </parameter>
 <parameter>
   <description>Port number</description>
   <name>port</name>
   <type>int</type>
 </parameter>
 <parameter>
   <description>Cipher (seperated with ',')</description>
   <name>cipher</name>
   <type>java.lang.String</type>
 </parameter>
 <parameter>
   <description>Enable/disable check if host can be resolved to an IP address</description>
   <name>checkHost</name>
   <type>boolean</type>
 </parameter>
 <return-type>void</return-type>
</operation>

<operation impact="ACTION">
 <description>Add AE configuration</description>
 <name>addAE</name>
 <parameter>
   <description>AE Title</description>
   <name>aet</name>
   <type>java.lang.String</type>
 </parameter>
 <parameter>
   <description>Hostname or ip</description>
   <name>host</name>
   <type>java.lang.String</type>
 </parameter>
 <parameter>
   <description>Port number</description>
   <name>port</name>
   <type>int</type>
 </parameter>
 <parameter>
   <description>Cipher (seperated with ',')</description>
   <name>cipher</name>
   <type>java.lang.String</type>
 </parameter>
 <parameter>
   <description>Enable/disable check if host can be resolved to an IP address</description>
   <name>checkHost</name>
   <type>boolean</type>
 </parameter>
 <return-type>void</return-type>
</operation>

<operation impact="ACTION">
 <description>Remove AE Configuration</description>
 <name>removeAE</name>
 <parameter>
   <description>AET</description>
   <name>aet</name>
   <type>java.lang.String</type>
 </parameter>
 <return-type>void</return-type>
</operation>
  • No labels