org.dcm4che3.net

Class Device

java.lang.Object

org.dcm4che3.net.Device

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

HL7Pix, HL7Snd, IanSCP, MoveSCU

public class Device
extends Object
implements Serializable

DICOM Part 15, Annex H compliant description of a DICOM enabled system or device. This is used to describe a DICOM-enabled network endpoint in terms of its physical attributes (serial number, manufacturer, etc.), its context (issuer of patient ids used by the device, etc.), as well as its capabilities (TLS-enabled, AE titles used, etc.).

Author:

Gunter Zeilinger

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
Device(String name)

Method Summary

Methods

Modifier and Type	Method and Description
void	addApplicationEntity(ApplicationEntity ae)
void	addConnection(Connection conn)
void	addDeviceExtension(DeviceExtension ext)
void	bindConnections()
Connection	connectionWithEqualsRDN(Connection other)
void	execute(Runnable command)
X509Certificate[]	getAllAuthorizedNodeCertificates()
X509Certificate[]	getAllThisNodeCertificates()
Collection<String>	getApplicationAETitles()
Collection<ApplicationEntity>	getApplicationEntities()
ApplicationEntity	getApplicationEntity(String aet)
AssociationHandler	getAssociationHandler()
String[]	getAuthorizedNodeCertificateRefs()
X509Certificate[]	getAuthorizedNodeCertificates(String ref)
ConnectionMonitor	getConnectionMonitor()
String	getDescription() Get the description of this device.
<T extends DeviceExtension> T	getDeviceExtension(Class<T> clazz)
<T extends DeviceExtension> T	getDeviceExtensionNotNull(Class<T> clazz)
String	getDeviceName() Get the name of this device.
String	getDeviceSerialNumber() Get the serial number belonging to this device.
DimseRQHandler	getDimseRQHandler()
Executor	getExecutor()
String[]	getInstitutionAddresses() Set the address of the institution which operates this device.
String[]	getInstitutionalDepartmentNames() Get the department name associated with this device.
Code[]	getInstitutionCodes()
String[]	getInstitutionNames() Get the institution name associated with this device; may be the site where it resides or is operating on behalf of.
Issuer	getIssuerOfAccessionNumber()
Issuer	getIssuerOfAdmissionID()
Issuer	getIssuerOfContainerIdentifier()
Issuer	getIssuerOfPatientID()
Issuer	getIssuerOfServiceEpisodeID()
Issuer	getIssuerOfSpecimenIdentifier()
KeyManager	getKeyManager()
String	getKeyStoreKeyPin()
String	getKeyStoreKeyPinProperty()
String	getKeyStorePin()
String	getKeyStorePinProperty()
String	getKeyStoreType()
String	getKeyStoreURL()
int	getLimitOpenAssociations()
String	getManufacturer() Get the manufacturer of this device.
String	getManufacturerModelName() Get the manufacturer model name of this device.
int	getNumberOfOpenAssociations()
Issuer	getOrderFillerIdentifier()
Issuer	getOrderPlacerIdentifier()
String[]	getPrimaryDeviceTypes() Get the type codes associated with this device.
String[]	getRelatedDeviceRefs()
ScheduledExecutorService	getScheduledExecutor()
String[]	getSoftwareVersions() Get the software versions running on (or implemented by) this device.
String	getStationName() Get the station name belonging to this device.
String[]	getThisNodeCertificateRefs()
X509Certificate[]	getThisNodeCertificates(String ref)
TimeZone	getTimeZoneOfDevice()
TrustManager	getTrustManager()
String	getTrustStorePin()
String	getTrustStorePinProperty()
String	getTrustStoreType()
String	getTrustStoreURL()
byte[][]	getVendorData() Get device specific vendor configuration information
boolean	isInstalled() Get a boolean to indicate whether this device is presently installed on the network.
boolean	isLimitOfOpenAssociationsExceeded()
List<Connection>	listConnections()
Collection<DeviceExtension>	listDeviceExtensions()
StringBuilder	promptTo(StringBuilder sb, String indent)
void	rebindConnections()
void	reconfigure(Device from)
void	reconfigureConnections(List<Connection> conns, List<Connection> src)
void	removeAllAuthorizedNodeCertificates()
void	removeAllThisNodeCertificates()
ApplicationEntity	removeApplicationEntity(ApplicationEntity ae)
ApplicationEntity	removeApplicationEntity(String aet)
X509Certificate[]	removeAuthorizedNodeCertificates(String ref)
boolean	removeConnection(Connection conn)
boolean	removeDeviceExtension(DeviceExtension ext)
X509Certificate[]	removeThisNodeCertificates(String ref)
ScheduledFuture<?>	schedule(Runnable command, long delay, TimeUnit unit)
ScheduledFuture<?>	scheduleAtFixedRate(Runnable command, long initialDelay, long period, TimeUnit unit)
ScheduledFuture<?>	scheduleWithFixedDelay(Runnable command, long initialDelay, long delay, TimeUnit unit)
void	setAssociationHandler(AssociationHandler associationHandler)
void	setAuthorizedNodeCertificates(String ref, X509Certificate... certs)
void	setConnectionMonitor(ConnectionMonitor connectionMonitor)
void	setDescription(String description) Set the description of this device.
protected void	setDeviceAttributes(Device from)
void	setDeviceName(String name) Set the name of this device.
void	setDeviceSerialNumber(String deviceSerialNumber) Set the serial number of this device.
void	setDimseRQHandler(DimseRQHandler dimseRQHandler)
void	setExecutor(Executor executor)
void	setInstalled(boolean installed) Get a boolean to indicate whether this device is presently installed on the network.
void	setInstitutionAddresses(String... addresses) Get the address of the institution which operates this device.
void	setInstitutionalDepartmentNames(String... names) Set the department name associated with this device.
void	setInstitutionCodes(Code... codes)
void	setInstitutionNames(String... names) Set the institution name associated with this device; may be the site where it resides or is operating on behalf of.
void	setIssuerOfAccessionNumber(Issuer issuerOfAccessionNumber)
void	setIssuerOfAdmissionID(Issuer issuerOfAdmissionID)
void	setIssuerOfContainerIdentifier(Issuer issuerOfContainerIdentifier)
void	setIssuerOfPatientID(Issuer issuerOfPatientID)
void	setIssuerOfServiceEpisodeID(Issuer issuerOfServiceEpisodeID)
void	setIssuerOfSpecimenIdentifier(Issuer issuerOfSpecimenIdentifier)
void	setKeyManager(KeyManager km)
void	setKeyStoreKeyPin(String keyStorePin)
void	setKeyStoreKeyPinProperty(String keyStoreKeyPinProperty)
void	setKeyStorePin(String keyStorePin)
void	setKeyStorePinProperty(String keyStorePinProperty)
void	setKeyStoreType(String keyStoreType)
void	setKeyStoreURL(String keyStoreURL)
void	setLimitOpenAssociations(int limit)
void	setManufacturer(String manufacturer) Set the manufacturer of this device.
void	setManufacturerModelName(String manufacturerModelName) Set the manufacturer model name of this device.
void	setOrderFillerIdentifier(Issuer orderFillerIdentifier)
void	setOrderPlacerIdentifier(Issuer orderPlacerIdentifier)
void	setPrimaryDeviceTypes(String... primaryDeviceTypes) Set the type codes associated with this device.
void	setRelatedDeviceRefs(String... refs)
void	setScheduledExecutor(ScheduledExecutorService executor)
void	setSoftwareVersions(String... softwareVersions) Set the software versions running on (or implemented by) this device.
void	setStationName(String stationName) Set the station name belonging to this device.
void	setThisNodeCertificates(String ref, X509Certificate... certs)
void	setTimeZoneOfDevice(TimeZone timeZoneOfDevice)
void	setTrustManager(TrustManager tm)
void	setTrustStorePin(String trustStorePin)
void	setTrustStorePinProperty(String trustStorePinProperty)
void	setTrustStoreType(String trustStoreType)
void	setTrustStoreURL(String trustStoreURL)
void	setVendorData(byte[]... vendorData) Set device specific vendor configuration information
String	toString()
void	unbindConnections()
void	waitForNoOpenConnections()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

Device

public Device(String name)

Method Detail

getDeviceName

public final String getDeviceName()

Get the name of this device.

Returns:

A String containing the device name.

setDeviceName

public final void setDeviceName(String name)

Set the name of this device.

Parameters:

name - A String containing the device name.

getDescription

public final String getDescription()

Get the description of this device.

Returns:

A String containing the device description.

setDescription

public final void setDescription(String description)

Set the description of this device.

Parameters:

description - A String containing the device description.

getManufacturer

public final String getManufacturer()

Get the manufacturer of this device.

Returns:

A String containing the device manufacturer.

setManufacturer

public final void setManufacturer(String manufacturer)

Set the manufacturer of this device.

This should be the same as the value of Manufacturer (0008,0070) in SOP instances created by this device.

Parameters:

manufacturer - A String containing the device manufacturer.

getManufacturerModelName

public final String getManufacturerModelName()

Get the manufacturer model name of this device.

Returns:

A String containing the device manufacturer model name.

setManufacturerModelName

public final void setManufacturerModelName(String manufacturerModelName)

Set the manufacturer model name of this device.

This should be the same as the value of Manufacturer Model Name (0008,1090) in SOP instances created by this device.

Parameters:

manufacturerModelName - A String containing the device manufacturer model name.

getSoftwareVersions

public final String[] getSoftwareVersions()

Get the software versions running on (or implemented by) this device.

Returns:

A String array containing the software versions.

setSoftwareVersions

public final void setSoftwareVersions(String... softwareVersions)

Set the software versions running on (or implemented by) this device.

This should be the same as the values of Software Versions (0018,1020) in SOP instances created by this device.

Parameters:

softwareVersion - A String array containing the software versions.

getStationName

public final String getStationName()

Get the station name belonging to this device.

Returns:

A String containing the station name.

setStationName

public final void setStationName(String stationName)

Set the station name belonging to this device.

This should be the same as the value of Station Name (0008,1010) in SOP instances created by this device.

Parameters:

stationName - A String containing the station name.

getDeviceSerialNumber

public final String getDeviceSerialNumber()

Get the serial number belonging to this device.

Returns:

A String containing the serial number.

setDeviceSerialNumber

public final void setDeviceSerialNumber(String deviceSerialNumber)

Set the serial number of this device.

This should be the same as the value of Device Serial Number (0018,1000) in SOP instances created by this device.

Parameters:

deviceSerialNumber - A String containing the serial number.

getPrimaryDeviceTypes

public final String[] getPrimaryDeviceTypes()

Get the type codes associated with this device.

Returns:

A String array containing the type codes of this device.

setPrimaryDeviceTypes

public void setPrimaryDeviceTypes(String... primaryDeviceTypes)

Set the type codes associated with this device.

Represents the kind of device and is most applicable for acquisition modalities. Types should be selected from the list of code values (0008,0100) for Context ID 30 in PS3.16 when applicable.

Parameters:

primaryDeviceTypes -

getInstitutionNames

public final String[] getInstitutionNames()

Get the institution name associated with this device; may be the site where it resides or is operating on behalf of.

Returns:

A String array containing the institution name values.

setInstitutionNames

public void setInstitutionNames(String... names)

Set the institution name associated with this device; may be the site where it resides or is operating on behalf of.

Should be the same as the value of Institution Name (0008,0080) in SOP Instances created by this device.

Parameters:

names - A String array containing the institution name values.

getInstitutionCodes

public final Code[] getInstitutionCodes()

setInstitutionCodes

public void setInstitutionCodes(Code... codes)

getInstitutionAddresses

public final String[] getInstitutionAddresses()

Set the address of the institution which operates this device.

Returns:

A String array containing the institution address values.

setInstitutionAddresses

public void setInstitutionAddresses(String... addresses)

Get the address of the institution which operates this device.

Should be the same as the value of Institution Address (0008,0081) attribute in SOP Instances created by this device.

Parameters:

addr - A String array containing the institution address values.

getInstitutionalDepartmentNames

public final String[] getInstitutionalDepartmentNames()

Get the department name associated with this device.

Returns:

A String array containing the dept. name values.

setInstitutionalDepartmentNames

public void setInstitutionalDepartmentNames(String... names)

Set the department name associated with this device.

Should be the same as the value of Institutional Department Name (0008,1040) in SOP Instances created by this device.

Parameters:

name - A String array containing the dept. name values.

getIssuerOfPatientID

public final Issuer getIssuerOfPatientID()

setIssuerOfPatientID

public final void setIssuerOfPatientID(Issuer issuerOfPatientID)

getIssuerOfAccessionNumber

public final Issuer getIssuerOfAccessionNumber()

setIssuerOfAccessionNumber

public final void setIssuerOfAccessionNumber(Issuer issuerOfAccessionNumber)

getOrderPlacerIdentifier

public final Issuer getOrderPlacerIdentifier()

setOrderPlacerIdentifier

public final void setOrderPlacerIdentifier(Issuer orderPlacerIdentifier)

getOrderFillerIdentifier

public final Issuer getOrderFillerIdentifier()

setOrderFillerIdentifier

public final void setOrderFillerIdentifier(Issuer orderFillerIdentifier)

getIssuerOfAdmissionID

public final Issuer getIssuerOfAdmissionID()

setIssuerOfAdmissionID

public final void setIssuerOfAdmissionID(Issuer issuerOfAdmissionID)

getIssuerOfServiceEpisodeID

public final Issuer getIssuerOfServiceEpisodeID()

setIssuerOfServiceEpisodeID

public final void setIssuerOfServiceEpisodeID(Issuer issuerOfServiceEpisodeID)

getIssuerOfContainerIdentifier

public final Issuer getIssuerOfContainerIdentifier()

setIssuerOfContainerIdentifier

public final void setIssuerOfContainerIdentifier(Issuer issuerOfContainerIdentifier)

getIssuerOfSpecimenIdentifier

public final Issuer getIssuerOfSpecimenIdentifier()

setIssuerOfSpecimenIdentifier

public final void setIssuerOfSpecimenIdentifier(Issuer issuerOfSpecimenIdentifier)

getAuthorizedNodeCertificates

public X509Certificate[] getAuthorizedNodeCertificates(String ref)

setAuthorizedNodeCertificates

public void setAuthorizedNodeCertificates(String ref,
                                 X509Certificate... certs)

removeAuthorizedNodeCertificates

public X509Certificate[] removeAuthorizedNodeCertificates(String ref)

removeAllAuthorizedNodeCertificates

public void removeAllAuthorizedNodeCertificates()

getAllAuthorizedNodeCertificates

public X509Certificate[] getAllAuthorizedNodeCertificates()

getAuthorizedNodeCertificateRefs

public String[] getAuthorizedNodeCertificateRefs()

getTrustStoreURL

public final String getTrustStoreURL()

setTrustStoreURL

public final void setTrustStoreURL(String trustStoreURL)

getTrustStoreType

public final String getTrustStoreType()

setTrustStoreType

public final void setTrustStoreType(String trustStoreType)

getTrustStorePin

public final String getTrustStorePin()

setTrustStorePin

public final void setTrustStorePin(String trustStorePin)

getTrustStorePinProperty

public final String getTrustStorePinProperty()

setTrustStorePinProperty

public final void setTrustStorePinProperty(String trustStorePinProperty)

getThisNodeCertificates

public X509Certificate[] getThisNodeCertificates(String ref)

setThisNodeCertificates

public void setThisNodeCertificates(String ref,
                           X509Certificate... certs)

removeThisNodeCertificates

public X509Certificate[] removeThisNodeCertificates(String ref)

getKeyStoreURL

public final String getKeyStoreURL()

setKeyStoreURL

public final void setKeyStoreURL(String keyStoreURL)

getKeyStoreType

public final String getKeyStoreType()

setKeyStoreType

public final void setKeyStoreType(String keyStoreType)

getKeyStorePin

public final String getKeyStorePin()

setKeyStorePin

public final void setKeyStorePin(String keyStorePin)

getKeyStorePinProperty

public final String getKeyStorePinProperty()

setKeyStorePinProperty

public final void setKeyStorePinProperty(String keyStorePinProperty)

getKeyStoreKeyPin

public final String getKeyStoreKeyPin()

setKeyStoreKeyPin

public final void setKeyStoreKeyPin(String keyStorePin)

getKeyStoreKeyPinProperty

public final String getKeyStoreKeyPinProperty()

setKeyStoreKeyPinProperty

public final void setKeyStoreKeyPinProperty(String keyStoreKeyPinProperty)

removeAllThisNodeCertificates

public void removeAllThisNodeCertificates()

getAllThisNodeCertificates

public X509Certificate[] getAllThisNodeCertificates()

getThisNodeCertificateRefs

public String[] getThisNodeCertificateRefs()

getRelatedDeviceRefs

public final String[] getRelatedDeviceRefs()

setRelatedDeviceRefs

public void setRelatedDeviceRefs(String... refs)

getVendorData

public final byte[][] getVendorData()

Get device specific vendor configuration information

Returns:

An Object of the device data.

setVendorData

public void setVendorData(byte[]... vendorData)

Set device specific vendor configuration information

Parameters:

vendorData - An Object of the device data.

isInstalled

public final boolean isInstalled()

Get a boolean to indicate whether this device is presently installed on the network. (This is useful for pre-configuration, mobile vans, and similar situations.)

Returns:

A boolean which will be true if this device is installed.

setInstalled

public final void setInstalled(boolean installed)

Get a boolean to indicate whether this device is presently installed on the network. (This is useful for pre-configuration, mobile vans, and similar situations.)

Parameters:

installed - A boolean which will be true if this device is installed.

Throws:

IOException

GeneralSecurityException

KeyManagementException

setTimeZoneOfDevice

public void setTimeZoneOfDevice(TimeZone timeZoneOfDevice)

getTimeZoneOfDevice

public TimeZone getTimeZoneOfDevice()

setDimseRQHandler

public final void setDimseRQHandler(DimseRQHandler dimseRQHandler)

getDimseRQHandler

public final DimseRQHandler getDimseRQHandler()

getAssociationHandler

public final AssociationHandler getAssociationHandler()

setAssociationHandler

public void setAssociationHandler(AssociationHandler associationHandler)

getConnectionMonitor

public ConnectionMonitor getConnectionMonitor()

setConnectionMonitor

public void setConnectionMonitor(ConnectionMonitor connectionMonitor)

bindConnections

public void bindConnections()
                     throws IOException,
                            GeneralSecurityException

Throws:

IOException

GeneralSecurityException

rebindConnections

public void rebindConnections()
                       throws IOException,
                              GeneralSecurityException

Throws:

IOException

GeneralSecurityException

unbindConnections

public void unbindConnections()

getExecutor

public final Executor getExecutor()

setExecutor

public final void setExecutor(Executor executor)

getScheduledExecutor

public final ScheduledExecutorService getScheduledExecutor()

setScheduledExecutor

public final void setScheduledExecutor(ScheduledExecutorService executor)

addConnection

public void addConnection(Connection conn)

removeConnection

public boolean removeConnection(Connection conn)

listConnections

public List<Connection> listConnections()

connectionWithEqualsRDN

public Connection connectionWithEqualsRDN(Connection other)

addApplicationEntity

public void addApplicationEntity(ApplicationEntity ae)

removeApplicationEntity

public ApplicationEntity removeApplicationEntity(ApplicationEntity ae)

removeApplicationEntity

public ApplicationEntity removeApplicationEntity(String aet)

addDeviceExtension

public void addDeviceExtension(DeviceExtension ext)

removeDeviceExtension

public boolean removeDeviceExtension(DeviceExtension ext)

getLimitOpenAssociations

public final int getLimitOpenAssociations()

setLimitOpenAssociations

public final void setLimitOpenAssociations(int limit)

getNumberOfOpenAssociations

public int getNumberOfOpenAssociations()

waitForNoOpenConnections

public void waitForNoOpenConnections()
                              throws InterruptedException

Throws:

InterruptedException

isLimitOfOpenAssociationsExceeded

public boolean isLimitOfOpenAssociationsExceeded()

getApplicationEntity

public ApplicationEntity getApplicationEntity(String aet)

getApplicationAETitles

public Collection<String> getApplicationAETitles()

getApplicationEntities

public Collection<ApplicationEntity> getApplicationEntities()

setKeyManager

public final void setKeyManager(KeyManager km)

getKeyManager

public final KeyManager getKeyManager()

setTrustManager

public final void setTrustManager(TrustManager tm)

getTrustManager

public final TrustManager getTrustManager()

execute

public void execute(Runnable command)

schedule

public ScheduledFuture<?> schedule(Runnable command,
                          long delay,
                          TimeUnit unit)

scheduleAtFixedRate

public ScheduledFuture<?> scheduleAtFixedRate(Runnable command,
                                     long initialDelay,
                                     long period,
                                     TimeUnit unit)

scheduleWithFixedDelay

public ScheduledFuture<?> scheduleWithFixedDelay(Runnable command,
                                        long initialDelay,
                                        long delay,
                                        TimeUnit unit)

toString

public String toString()

Overrides:

toString in class Object

promptTo

public StringBuilder promptTo(StringBuilder sb,
                     String indent)

reconfigure

public void reconfigure(Device from)
                 throws IOException,
                        GeneralSecurityException

Throws:

IOException

GeneralSecurityException

setDeviceAttributes

protected void setDeviceAttributes(Device from)

reconfigureConnections

public void reconfigureConnections(List<Connection> conns,
                          List<Connection> src)

listDeviceExtensions

public Collection<DeviceExtension> listDeviceExtensions()

getDeviceExtension

public <T extends DeviceExtension> T getDeviceExtension(Class<T> clazz)

getDeviceExtensionNotNull

public <T extends DeviceExtension> T getDeviceExtensionNotNull(Class<T> clazz)