public class NetworkApplicationProperties
extends java.lang.Object
This class provides common support to applications requiring properties related to DICOM network services.
Also contains a main method that can be used, for example, to convert information previously statically configured by properties on each device, to assemble LDIF files to be loaded into an LDAP server for use via the DICOM Network Configuration Management service.
The following properties are supported:
Network.DynamicConfigurationDebugLevel
- for no debugging (silent), > 0 for more verbose levels of debugging
Dicom.ListeningPort
- the port that an association acceptor will listen on for incoming connections
Dicom.CalledAETitle
- what the AE expects to be called when accepting an association
Dicom.CallingAETitle
- what the AE will call itself when initiating an association
Dicom.PrimaryDeviceType
- what our own primary device type is
Dicom.QueryDebugLevel
- for no debugging (silent), > 0 for more verbose levels of debugging
Dicom.StorageSCUDebugLevel
- for no debugging (silent), > 0 for more verbose levels of debugging
Dicom.StorageSCPDebugLevel
- for no debugging (silent), > 0 for more verbose levels of debugging
Dicom.StorageSCUCompressionLevel
- determines what types of compressed Transfer Syntaxes are proposed by a Storage SCU; 0 = uncompressed transfer syntaxes only; 1 = propose deflate as well; 2 = propose deflate and bzip2 (if bzip2 codec is available)
Dicom.RemoteAEs
- a space or comma separated list of the local names all the available remote AEs; each local name may be anything unique (in this file) without a space or comma; the local name does not need to be the same as the remote AE's called AE title
Dicom.XXXX.CalledAETitle
- for the remote AE with local name XXXX, what that AE expects to be called when accepting an association
Dicom.XXXX.HostNameOrIPAddress
- for the remote AE with local name XXXX, what hostname or IP addess that AE will listen on for incoming connections
Dicom.XXXX.Port
- for the remote AE with local name XXXX, what port that AE will listen on for incoming connections
Dicom.XXXX.QueryModel
- for the remote AE with local name XXXX, what query model is supported; values are STUDYROOT or PATIENTROOT; leave absent if query/retrieve not supported by the remote AE
Dicom.XXXX.PrimaryDeviceType
- for the remote AE with local name XXXX, what the primary device type is (see DICOM PS 3.15 and PS 3.16)
Modifier and Type | Class and Description |
---|---|
protected class |
NetworkApplicationProperties.OurNetworkConfigurationSource |
Modifier and Type | Field and Description |
---|---|
protected NetworkConfigurationSource |
networkConfigurationSource |
static java.lang.String |
PatientRootQueryModel |
static java.lang.String |
PatientStudyOnlyQueryModel |
static java.lang.String |
propertyName_DicomCalledAETitle |
static java.lang.String |
propertyName_DicomCallingAETitle |
static java.lang.String |
propertyName_DicomListeningPort |
static java.lang.String |
propertyName_NetworkDynamicConfigurationDebugLevel |
static java.lang.String |
propertyName_PrimaryDeviceType |
static java.lang.String |
propertyName_QueryDebugLevel |
static java.lang.String |
propertyName_StorageSCPDebugLevel |
static java.lang.String |
propertyName_StorageSCUCompressionLevel |
static java.lang.String |
propertyName_StorageSCUDebugLevel |
static java.lang.String |
StudyRootQueryModel |
Constructor and Description |
---|
NetworkApplicationProperties()
Create default properties.
|
NetworkApplicationProperties(java.util.Properties properties)
Extract the DICOM network properties from the supplied properties.
|
NetworkApplicationProperties(java.util.Properties properties,
boolean addPublicStorageSCPsIfNoRemoteAEsConfigured)
Extract the DICOM network properties from the supplied properties.
|
Modifier and Type | Method and Description |
---|---|
java.lang.String |
getCalledAETitle()
Return the called AET.
|
java.lang.String |
getCallingAETitle()
Return the calling AET.
|
int |
getListeningPort()
Return the listening port.
|
NetworkApplicationInformation |
getNetworkApplicationInformation()
Return the network application information.
|
NetworkConfigurationSource |
getNetworkConfigurationSource()
Return a network configuration source that will supply the network application information.
|
int |
getNetworkDynamicConfigurationDebugLevel()
Return the network dynamic configuration debug level.
|
java.lang.String |
getPrimaryDeviceType()
Return the primary device type.
|
java.util.Properties |
getProperties(java.util.Properties properties)
Retrieve the DICOM network properties.
|
int |
getQueryDebugLevel()
Return the query debug level.
|
int |
getStorageSCPDebugLevel()
Return the storage SCP debug level.
|
int |
getStorageSCUCompressionLevel()
Return the storage SCU compression level.
|
int |
getStorageSCUDebugLevel()
Return the storage SCU debug level.
|
static boolean |
isPatientRootQueryModel(java.lang.String model)
Is the model Patient Root ?
|
static boolean |
isPatientStudyOnlyQueryModel(java.lang.String model)
Is the model Patient/Study Only ?
|
static boolean |
isStudyRootQueryModel(java.lang.String model)
Is the model Study Root ?
|
static void |
main(java.lang.String[] arg)
Test the parsing of network properties from the specified file, by reading them and converting into LDIF format.
|
void |
setCalledAETitle(java.lang.String calledAETitle)
Set the called AET.
|
void |
setCallingAETitle(java.lang.String callingAETitle)
Set the calling AET.
|
void |
setListeningPort(int port)
Set the listening port.
|
void |
setPrimaryDeviceType(java.lang.String primaryDeviceType)
Set the primary device type.
|
java.lang.String |
toString() |
public static final java.lang.String propertyName_DicomListeningPort
public static final java.lang.String propertyName_DicomCalledAETitle
public static final java.lang.String propertyName_DicomCallingAETitle
public static final java.lang.String propertyName_PrimaryDeviceType
public static final java.lang.String StudyRootQueryModel
public static final java.lang.String PatientRootQueryModel
public static final java.lang.String PatientStudyOnlyQueryModel
public static final java.lang.String propertyName_QueryDebugLevel
public static final java.lang.String propertyName_StorageSCUDebugLevel
public static final java.lang.String propertyName_StorageSCUCompressionLevel
public static final java.lang.String propertyName_StorageSCPDebugLevel
public static final java.lang.String propertyName_NetworkDynamicConfigurationDebugLevel
protected NetworkConfigurationSource networkConfigurationSource
public NetworkApplicationProperties() throws DicomNetworkException
Create default properties.
DicomNetworkException
public NetworkApplicationProperties(java.util.Properties properties) throws DicomNetworkException, java.io.IOException
Extract the DICOM network properties from the supplied properties.
properties
- DicomNetworkException
java.io.IOException
public NetworkApplicationProperties(java.util.Properties properties, boolean addPublicStorageSCPsIfNoRemoteAEsConfigured) throws DicomNetworkException, java.io.IOException
Extract the DICOM network properties from the supplied properties.
properties
- addPublicStorageSCPsIfNoRemoteAEsConfigured
- DicomNetworkException
java.io.IOException
public static final boolean isStudyRootQueryModel(java.lang.String model)
Is the model Study Root ?
model
- the string value describing the model, as used in the query model remote AE propertypublic static final boolean isPatientRootQueryModel(java.lang.String model)
Is the model Patient Root ?
model
- the string value describing the model, as used in the query model remote AE propertypublic static final boolean isPatientStudyOnlyQueryModel(java.lang.String model)
Is the model Patient/Study Only ?
model
- the string value describing the model, as used in the query model remote AE propertypublic java.util.Properties getProperties(java.util.Properties properties)
Retrieve the DICOM network properties.
param properties the existing properties to add to (replacing corresponding properties already there), or null if nonepublic int getListeningPort()
Return the listening port.
public void setListeningPort(int port)
Set the listening port.
param port the listening portpublic java.lang.String getCalledAETitle()
Return the called AET.
public void setCalledAETitle(java.lang.String calledAETitle)
Set the called AET.
param calledAETitle the called AETpublic java.lang.String getCallingAETitle()
Return the calling AET.
public void setCallingAETitle(java.lang.String callingAETitle)
Set the calling AET.
param callingAETitle the calling AETpublic java.lang.String getPrimaryDeviceType()
Return the primary device type.
public void setPrimaryDeviceType(java.lang.String primaryDeviceType)
Set the primary device type.
param primaryDeviceType the primary device typepublic int getStorageSCUCompressionLevel()
Return the storage SCU compression level.
public int getStorageSCUDebugLevel()
Return the storage SCU debug level.
public int getStorageSCPDebugLevel()
Return the storage SCP debug level.
public int getQueryDebugLevel()
Return the query debug level.
public int getNetworkDynamicConfigurationDebugLevel()
Return the network dynamic configuration debug level.
public NetworkApplicationInformation getNetworkApplicationInformation()
Return the network application information.
public NetworkConfigurationSource getNetworkConfigurationSource()
Return a network configuration source that will supply the network application information.
public java.lang.String toString()
toString
in class java.lang.Object
public static void main(java.lang.String[] arg)
Test the parsing of network properties from the specified file, by reading them and converting into LDIF format.
Can be used, for example, to convert information previously statically configured by properties on each device, to assemble LDIF files to be loaded into an LDAP server for use via the DICOM Network Configuration Management service.
arg
- two arguments, a single file name that is the properties file, then the root distinguished name for LDAP