org.dcm4che3.net

Class ApplicationEntity

java.lang.Object

org.dcm4che3.net.ApplicationEntity

All Implemented Interfaces:

Serializable

public class ApplicationEntity
extends Object
implements Serializable

DICOM Part 15, Annex H compliant description of a DICOM network service.

A Network AE is an application entity that provides services on a network. A Network AE will have the 16 same functional capability regardless of the particular network connection used. If there are functional differences based on selected network connection, then these are separate Network AEs. If there are 18 functional differences based on other internal structures, then these are separate Network AEs.

Author:

Gunter Zeilinger

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
private Set<String>	acceptedCallingAETitlesSet
private Boolean	aeInstalled
private String	AETitle
private List<String>	AETitleAliases
private String[]	applicationClusters
private boolean	associationAcceptor
private boolean	associationInitiator
private List<Connection>	connections
private String	description
private Device	device
private DimseRQHandler	dimseRQHandler
private Map<Class<? extends AEExtension>,AEExtension>	extensions
protected static Logger	LOG
private String	olockHash
private String[]	preferredCalledAETitles
private String[]	preferredCallingAETitles
private Map<String,TransferCapability>	scpTCs
private Map<String,TransferCapability>	scuTCs
private static long	serialVersionUID
private String[]	supportedCharacterSets
private Collection<TransferCapability>	transferCapabilities "Proxy" property, actually forwards everything to scuTCs and scpTCs in its setter/getter
private String	uuid
private byte[][]	vendorData

Constructor Summary

Constructors

Constructor and Description
ApplicationEntity()
ApplicationEntity(String aeTitle)

Method Summary

Modifier and Type	Method and Description
void	addAEExtension(AEExtension ext)
void	addConnection(Connection conn)
TransferCapability	addTransferCapability(TransferCapability tc)
private void	checkDevice()
private void	checkInstalled()
Association	connect(ApplicationEntity remote, AAssociateRQ rq)
Association	connect(Connection remote, AAssociateRQ rq)
Association	connect(Connection local, Connection remote, AAssociateRQ rq)
CompatibleConnection	findCompatibelConnection(ApplicationEntity remote)
Connection	findCompatibelConnection(Connection remoteConn)
String[]	getAcceptedCallingAETitles()
Set<String>	getAcceptedCallingAETitlesSet()
<T extends AEExtension> T	getAEExtension(Class<T> clazz)
<T extends AEExtension> T	getAEExtensionNotNull(Class<T> clazz)
Boolean	getAeInstalled()
String	getAETitle() Get the AE title for this Network AE.
List<String>	getAETitleAliases()
String[]	getApplicationClusters() Get the locally defined names for a subset of related applications.
List<Connection>	getConnections()
String	getDescription() Get the description of this network AE
Device	getDevice() Get the device that is identified by this application entity.
DimseRQHandler	getDimseRQHandler()
Map<Class<? extends AEExtension>,AEExtension>	getExtensions()
String	getOlockHash()
String[]	getPreferredCalledAETitles() Get the AE Title(s) that are preferred for initiating associations from this network AE.
String[]	getPreferredCallingAETitles() Get the AE title(s) that are preferred for accepting associations by this network AE.
String[]	getSupportedCharacterSets() Get the Character Set(s) supported by the Network AE for data sets it receives.
private TransferCapability	getTC(Map<String,TransferCapability> tcs, String asuid, AAssociateRQ rq)
Collection<TransferCapability>	getTransferCapabilities()
Collection<TransferCapability>	getTransferCapabilitiesWithRole(TransferCapability.Role role)
TransferCapability	getTransferCapabilityFor(String sopClass, TransferCapability.Role role)
String	getUuid()
byte[][]	getVendorData() Get any vendor information or configuration specific to this network AE.
boolean	isAcceptedCallingAETitle(String aet)
boolean	isAssociationAcceptor() Determine whether or not this network AE can accept associations.
boolean	isAssociationInitiator() Determine whether or not this network AE can initiate associations.
boolean	isInstalled() Determine whether or not this network AE is installed on a network.
Collection<AEExtension>	listAEExtensions()
protected PresentationContext	negotiate(AAssociateRQ rq, AAssociateAC ac, PresentationContext rqpc)
private byte[]	negotiate(ExtendedNegotiation exneg, TransferCapability tc)
(package private) void	onDimseRQ(Association as, PresentationContext pc, Dimse cmd, Attributes cmdAttrs, PDVInputStream data)
StringBuilder	promptTo(StringBuilder sb, String indent)
(package private) void	reconfigure(ApplicationEntity src)
private void	reconfigureAEExtensions(ApplicationEntity from)
private void	reconfigureTransferCapabilities(ApplicationEntity src)
boolean	removeAEExtension(AEExtension ext)
boolean	removeConnection(Connection conn)
TransferCapability	removeTransferCapabilityFor(String sopClass, TransferCapability.Role role)
private TransferCapability	roleSelection(AAssociateRQ rq, AAssociateAC ac, String asuid)
void	setAcceptedCallingAETitles(String... aets)
void	setAcceptedCallingAETitlesSet(Set<String> acceptedCallingAETitlesSet)
void	setAeInstalled(Boolean aeInstalled) Set whether or not this network AE is installed on a network.
void	setAETitle(String aet) Set the AE title for this Network AE.
void	setAETitleAliases(List<String> AETitleAliases)
void	setApplicationClusters(String... clusters)
protected void	setApplicationEntityAttributes(ApplicationEntity from)
void	setAssociationAcceptor(boolean acceptor) Set whether or not this network AE can accept associations.
void	setAssociationInitiator(boolean initiator) Set whether or not this network AE can initiate associations.
void	setConnections(List<Connection> connections)
void	setDescription(String description) Set a description of this network AE.
void	setDevice(Device device) Set the device that is identified by this application entity.
void	setDimseRQHandler(DimseRQHandler dimseRQHandler)
void	setExtensions(Map<Class<? extends AEExtension>,AEExtension> extensions)
void	setOlockHash(String olockHash)
void	setPreferredCalledAETitles(String... aets)
void	setPreferredCallingAETitles(String... aets)
void	setSupportedCharacterSets(String... characterSets) Set the Character Set(s) supported by the Network AE for data sets it receives.
void	setTransferCapabilities(Collection<TransferCapability> transferCapabilities)
void	setUuid(String uuid)
void	setVendorData(byte[]... vendorData) Set any vendor information or configuration specific to this network AE
boolean	supportsTransferCapability(TransferCapability transferCapability, boolean onlyAbstractSyntax)
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

serialVersionUID

private static final long serialVersionUID

See Also:

Constant Field Values

LOG

protected static final Logger LOG

AETitle

private String AETitle

uuid

private String uuid

description

private String description

olockHash

private String olockHash

vendorData

private byte[][] vendorData

applicationClusters

private String[] applicationClusters

preferredCalledAETitles

private String[] preferredCalledAETitles

preferredCallingAETitles

private String[] preferredCallingAETitles

supportedCharacterSets

private String[] supportedCharacterSets

aeInstalled

private Boolean aeInstalled

acceptedCallingAETitlesSet

private final Set<String> acceptedCallingAETitlesSet

connections

private final List<Connection> connections

transferCapabilities

private Collection<TransferCapability> transferCapabilities

"Proxy" property, actually forwards everything to scuTCs and scpTCs in its setter/getter

scuTCs

private final Map<String,TransferCapability> scuTCs

scpTCs

private final Map<String,TransferCapability> scpTCs

extensions

private Map<Class<? extends AEExtension>,AEExtension> extensions

associationAcceptor

private boolean associationAcceptor

associationInitiator

private boolean associationInitiator

AETitleAliases

private List<String> AETitleAliases

device

private Device device

dimseRQHandler

private transient DimseRQHandler dimseRQHandler

Constructor Detail

ApplicationEntity

public ApplicationEntity()

ApplicationEntity

public ApplicationEntity(String aeTitle)

Method Detail

getAETitleAliases

public List<String> getAETitleAliases()

setAETitleAliases

public void setAETitleAliases(List<String> AETitleAliases)

getExtensions

public Map<Class<? extends AEExtension>,AEExtension> getExtensions()

setExtensions

public void setExtensions(Map<Class<? extends AEExtension>,AEExtension> extensions)

getUuid

public String getUuid()

setUuid

public void setUuid(String uuid)

setTransferCapabilities

public void setTransferCapabilities(Collection<TransferCapability> transferCapabilities)

getTransferCapabilities

public Collection<TransferCapability> getTransferCapabilities()

getDevice

public Device getDevice()

Get the device that is identified by this application entity.

Returns:

The owning Device.

setDevice

public void setDevice(Device device)

Set the device that is identified by this application entity.

Parameters:

device - The owning Device.

getAETitle

public final String getAETitle()

Get the AE title for this Network AE.

Please note that there could also be alias AE titles for the same AE. You can get them via getAETitleAliases().

Returns:

A String containing the AE title.

setAETitle

public void setAETitle(String aet)

Set the AE title for this Network AE.

Parameters:

aet - A String containing the AE title.

getDescription

public final String getDescription()

Get the description of this network AE

Returns:

A String containing the description.

setDescription

public final void setDescription(String description)

Set a description of this network AE.

Parameters:

description - A String containing the description.

getVendorData

public final byte[][] getVendorData()

Get any vendor information or configuration specific to this network AE.

Returns:

An Object of the vendor data.

setVendorData

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

Set any vendor information or configuration specific to this network AE

Parameters:

vendorData - An Object of the vendor data.

getApplicationClusters

public String[] getApplicationClusters()

Get the locally defined names for a subset of related applications. E.g. neuroradiology.

Returns:

A String[] containing the names.

setApplicationClusters

public void setApplicationClusters(String... clusters)

getPreferredCalledAETitles

public String[] getPreferredCalledAETitles()

Get the AE Title(s) that are preferred for initiating associations from this network AE.

Returns:

A String[] of the preferred called AE titles.

setPreferredCalledAETitles

public void setPreferredCalledAETitles(String... aets)

getPreferredCallingAETitles

public String[] getPreferredCallingAETitles()

Get the AE title(s) that are preferred for accepting associations by this network AE.

Returns:

A String[] containing the preferred calling AE titles.

setPreferredCallingAETitles

public void setPreferredCallingAETitles(String... aets)

getAcceptedCallingAETitles

public String[] getAcceptedCallingAETitles()

setAcceptedCallingAETitles

public void setAcceptedCallingAETitles(String... aets)

isAcceptedCallingAETitle

public boolean isAcceptedCallingAETitle(String aet)

getSupportedCharacterSets

public String[] getSupportedCharacterSets()

Get the Character Set(s) supported by the Network AE for data sets it receives. The value shall be selected from the Defined Terms for Specific Character Set (0008,0005) in PS3.3. If no values are present, this implies that the Network AE supports only the default character repertoire (ISO IR 6).

Returns:

A String array of the supported character sets.

setSupportedCharacterSets

public void setSupportedCharacterSets(String... characterSets)

Set the Character Set(s) supported by the Network AE for data sets it receives. The value shall be selected from the Defined Terms for Specific Character Set (0008,0005) in PS3.3. If no values are present, this implies that the Network AE supports only the default character repertoire (ISO IR 6).

Parameters:

characterSets - A String array of the supported character sets.

isAssociationAcceptor

public final boolean isAssociationAcceptor()

Determine whether or not this network AE can accept associations.

Returns:

A boolean value. True if the Network AE can accept associations, false otherwise.

setAssociationAcceptor

public final void setAssociationAcceptor(boolean acceptor)

Set whether or not this network AE can accept associations.

Parameters:

acceptor - A boolean value. True if the Network AE can accept associations, false otherwise.

isAssociationInitiator

public final boolean isAssociationInitiator()

Determine whether or not this network AE can initiate associations.

Returns:

A boolean value. True if the Network AE can accept associations, false otherwise.

setAssociationInitiator

public final void setAssociationInitiator(boolean initiator)

Set whether or not this network AE can initiate associations.

Parameters:

initiator - A boolean value. True if the Network AE can accept associations, false otherwise.

isInstalled

public boolean isInstalled()

Determine whether or not this network AE is installed on a network.

Returns:

A Boolean value. True if the AE is installed on a network. If not present, information about the installed status of the AE is inherited from the device

getAeInstalled

public Boolean getAeInstalled()

setAeInstalled

public void setAeInstalled(Boolean aeInstalled)

Set whether or not this network AE is installed on a network.

Parameters:

aeInstalled - A Boolean value. True if the AE is installed on a network. If not present, information about the installed status of the AE is inherited from the device

getDimseRQHandler

public DimseRQHandler getDimseRQHandler()

setDimseRQHandler

public final void setDimseRQHandler(DimseRQHandler dimseRQHandler)

checkInstalled

private void checkInstalled()

checkDevice

private void checkDevice()

onDimseRQ

void onDimseRQ(Association as,
               PresentationContext pc,
               Dimse cmd,
               Attributes cmdAttrs,
               PDVInputStream data)
        throws IOException

Throws:

IOException

addConnection

public void addConnection(Connection conn)

removeConnection

public boolean removeConnection(Connection conn)

setConnections

public void setConnections(List<Connection> connections)

getConnections

public List<Connection> getConnections()

addTransferCapability

public TransferCapability addTransferCapability(TransferCapability tc)

removeTransferCapabilityFor

public TransferCapability removeTransferCapabilityFor(String sopClass,
                                                      TransferCapability.Role role)

getTransferCapabilitiesWithRole

public Collection<TransferCapability> getTransferCapabilitiesWithRole(TransferCapability.Role role)

getTransferCapabilityFor

public TransferCapability getTransferCapabilityFor(String sopClass,
                                                   TransferCapability.Role role)

negotiate

protected PresentationContext negotiate(AAssociateRQ rq,
                                        AAssociateAC ac,
                                        PresentationContext rqpc)

roleSelection

private TransferCapability roleSelection(AAssociateRQ rq,
                                         AAssociateAC ac,
                                         String asuid)

getTC

private TransferCapability getTC(Map<String,TransferCapability> tcs,
                                 String asuid,
                                 AAssociateRQ rq)

negotiate

private byte[] negotiate(ExtendedNegotiation exneg,
                         TransferCapability tc)

connect

public Association connect(Connection local,
                           Connection remote,
                           AAssociateRQ rq)
                    throws IOException,
                           InterruptedException,
                           IncompatibleConnectionException,
                           GeneralSecurityException

Throws:

IOException

InterruptedException

IncompatibleConnectionException

GeneralSecurityException

connect

public Association connect(Connection remote,
                           AAssociateRQ rq)
                    throws IOException,
                           InterruptedException,
                           IncompatibleConnectionException,
                           GeneralSecurityException

Throws:

IOException

InterruptedException

IncompatibleConnectionException

GeneralSecurityException

findCompatibelConnection

public Connection findCompatibelConnection(Connection remoteConn)
                                    throws IncompatibleConnectionException

Throws:

IncompatibleConnectionException

findCompatibelConnection

public CompatibleConnection findCompatibelConnection(ApplicationEntity remote)
                                              throws IncompatibleConnectionException

Throws:

IncompatibleConnectionException

connect

public Association connect(ApplicationEntity remote,
                           AAssociateRQ rq)
                    throws IOException,
                           InterruptedException,
                           IncompatibleConnectionException,
                           GeneralSecurityException

Throws:

IOException

InterruptedException

IncompatibleConnectionException

GeneralSecurityException

toString

public String toString()

Overrides:

toString in class Object

promptTo

public StringBuilder promptTo(StringBuilder sb,
                              String indent)

reconfigure

void reconfigure(ApplicationEntity src)

reconfigureTransferCapabilities

private void reconfigureTransferCapabilities(ApplicationEntity src)

reconfigureAEExtensions

private void reconfigureAEExtensions(ApplicationEntity from)

setApplicationEntityAttributes

protected void setApplicationEntityAttributes(ApplicationEntity from)

getAcceptedCallingAETitlesSet

public Set<String> getAcceptedCallingAETitlesSet()

setAcceptedCallingAETitlesSet

public void setAcceptedCallingAETitlesSet(Set<String> acceptedCallingAETitlesSet)

addAEExtension

public void addAEExtension(AEExtension ext)

removeAEExtension

public boolean removeAEExtension(AEExtension ext)

getOlockHash

public String getOlockHash()

setOlockHash

public void setOlockHash(String olockHash)

listAEExtensions

public Collection<AEExtension> listAEExtensions()

getAEExtension

public <T extends AEExtension> T getAEExtension(Class<T> clazz)

getAEExtensionNotNull

public <T extends AEExtension> T getAEExtensionNotNull(Class<T> clazz)

supportsTransferCapability

public boolean supportsTransferCapability(TransferCapability transferCapability,
                                          boolean onlyAbstractSyntax)