|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object org.dcm4che2.net.NetworkApplicationEntity
public class NetworkApplicationEntity
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.
Constructor Summary | |
---|---|
NetworkApplicationEntity()
|
Method Summary | |
---|---|
void |
addAssociationListener(AssociationListener l)
|
Association |
connect(NetworkApplicationEntity remoteAE,
java.util.concurrent.Executor executor)
Open a connection to the remote AE, using the passed in threading model. |
Association |
connect(NetworkApplicationEntity remoteAE,
java.util.concurrent.Executor executor,
boolean forceNew)
Open a connection to the remote AE, using the passed in threading model. |
Association |
connect(UserIdentity userIdentity,
NetworkApplicationEntity remoteAE,
java.util.concurrent.Executor executor)
Open a connection to the remote AE, using the passed in user identity Negotiation will be performed. |
Association |
connect(UserIdentity userIdentity,
NetworkApplicationEntity remoteAE,
java.util.concurrent.Executor executor,
boolean forceNew)
Open a connection to the remote AE, using the passed in user identity and threading model. |
java.lang.String |
getAETitle()
Get the AE title for this Network AE. |
java.lang.String[] |
getApplicationCluster()
Get the locally defined names for a subset of related applications. |
java.lang.String |
getDescription()
Get the description of this network AE |
Device |
getDevice()
Get the device that is identified by this application entity. |
int |
getDimseRspTimeout()
Get the timeout in milliseconds for receiving DIMSE-RSP on an open association. |
int |
getIdleTimeout()
Get the maximum time in milliseconds that an association may remain idle. |
int |
getMaxOpsInvoked()
Get maximum number of outstanding operations this network AE may invoke asynchronously as an SCU. |
int |
getMaxOpsPerformed()
Get the maximum number of operation this network AE may perform asynchronously as an SCP. |
int |
getMaxPDULengthReceive()
Get the maximum length (in bytes) of P-DATA-TF PDUs that can be received. |
int |
getMaxPDULengthSend()
Set the maximum length (in bytes) of P-DATA-TF PDUs that will be sent. |
int |
getMoveRspTimeout()
Deprecated. use getRetrieveRspTimeout() |
NetworkConnection[] |
getNetworkConnection()
Get the NetworkConnection objects associated with this
network AE. |
java.lang.String[] |
getPreferredCalledAETitle()
Get the AE Title(s) (SCPs) that are preferred for initiating associations from this network AE (SCU). |
java.lang.String[] |
getPreferredCallingAETitle()
Get the AE title(s) that are preferred for accepting associations from. |
int |
getRetrieveRspTimeout()
Get the timeout in milliseconds for receiving DIMSE-RSP for an open C-GET or C-MOVE request. |
java.lang.String[] |
getReuseAssocationFromAETitle()
Get an array of AE titles. |
java.lang.String[] |
getReuseAssocationToAETitle()
Get an array of AE titles. |
java.lang.String[] |
getSupportedCharacterSet()
Get the Character Set(s) supported by the Network AE for data sets it receives. |
TransferCapability[] |
getTransferCapability()
Get the transfer capabilities (presentation contexts, extended information, etc.) that this network AE may make use of. |
UserIdentity |
getUserIdentity()
Get User Identity used for initiating associations, if no User Identity is specified in the connect method. |
java.lang.Object[] |
getVendorData()
Get any vendor information or configuration specific to this network AE. |
boolean |
hasPreferredCalledAETitle()
Determine whether or not this network AE (SCU) has an AE Title (SCP) that is preferred for initiating associations to. |
boolean |
hasPreferredCallingAETitle()
Determine whether or not this network AE has a preferred calling AE title. |
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 |
isAsyncOps()
Determine whether or not this network AE is capable of asynchronous operations. |
boolean |
isInstalled()
Determine whether or not this network AE is installed on a network. |
boolean |
isOfferDefaultTransferSyntaxInSeparatePresentationContext()
|
boolean |
isPackPDV()
Get whether or not this network AE will send only one PDV in one P-Data-TF PDU. |
boolean |
isPreferredCalledAETitle(java.lang.String aet)
Determine whether or not the parameter is a preferred called AE title (SCP) for this network AE (SCU). |
boolean |
isPreferredCallingAETitle(java.lang.String aet)
Determine whether or not the parameter is a preferred calling AE title for accepting associations from. |
protected AAssociateRQ |
makeAAssociateRQ(UserIdentity userIdentity,
NetworkApplicationEntity remoteAE)
|
void |
register(DicomService service)
Register a DicomService with this network AE. |
void |
removeAssociationListener(AssociationListener l)
|
void |
setAETitle(java.lang.String aetitle)
Set the AE title for this Network AE. |
void |
setApplicationCluster(java.lang.String[] cluster)
Set the locally defined names for a subset of related applications. |
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 |
setDescription(java.lang.String description)
Set a description of this network AE. |
void |
setDimseRspTimeout(int dimseRspTimeout)
Set the timeout in milliseconds for receiving DIMSE-RSP on an open association. |
void |
setIdleTimeout(int idleTimeout)
Set the maximum time in milliseconds that an association may remain idle. |
void |
setInstalled(boolean installed)
Set whether or not this network AE is installed on a network. |
void |
setMaxOpsInvoked(int maxOpsInvoked)
Set maximum number of outstanding operations this network AE may invoke asynchronously as an SCU. |
void |
setMaxOpsPerformed(int maxOpsPerformed)
Set the maximum number of operation this network AE may perform asynchronously as an SCP. |
void |
setMaxPDULengthReceive(int maxPDULengthReceive)
Get the maximum length (in bytes) of P-DATA-TF PDUs that can be received. |
void |
setMaxPDULengthSend(int maxPDULengthSend)
Get the maximum length (in bytes) of P-DATA-TF PDUs that will be sent. |
void |
setMoveRspTimeout(int moveRspTimeout)
Deprecated. use setRetrieveRspTimeout(int) |
void |
setNetworkConnection(NetworkConnection nc)
Set the NetworkConnection object associated with this
network AE. |
void |
setNetworkConnection(NetworkConnection[] nc)
Set the NetworkConnection objects associated with this
network AE. |
void |
setOfferDefaultTransferSyntaxInSeparatePresentationContext(boolean offerDefaultTSInSeparatePC)
|
void |
setPackPDV(boolean packPDV)
Set whether or not to send only one PDV in one P-Data-TF PDU. |
void |
setPreferredCalledAETitle(java.lang.String[] aets)
Set the AE title(s) (SCPs) that are preferred for initiating associations from this network AE (SCU). |
void |
setPreferredCallingAETitle(java.lang.String[] aets)
Set the AE title(s) that are preferred for accepting associations from. |
void |
setRetrieveRspTimeout(int retrieveRspTimeout)
Set the timeout in milliseconds for receiving DIMSE-RSP on for open C-GET or C-MOVE request. |
void |
setReuseAssocationFromAETitle(java.lang.String[] reuseAssocationFromAETitle)
Set an array of AE titles. |
void |
setReuseAssocationToAETitle(java.lang.String[] reuseAssocationToAETitle)
Get an array of AE titles. |
void |
setSupportedCharacterSet(java.lang.String[] characterSets)
Set the Character Set(s) supported by the Network AE for data sets it receives. |
void |
setTransferCapability(TransferCapability[] transferCapability)
Set the transfer capabilities (presentation contexts, extended information, etc.) that this network AE may make use of. |
void |
setUserIdentity(UserIdentity userIdentity)
Set User Identity used for initiating associations, if no User Identity is specified in the connect method. |
void |
setVendorData(java.lang.Object[] vendorData)
Set any vendor information or configuration specific to this network AE |
void |
unregister(DicomService service)
Unregister (remove) a DicomService from this network AE. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public NetworkApplicationEntity()
Method Detail |
---|
public Device getDevice()
Device
.public java.lang.String getAETitle()
public void setAETitle(java.lang.String aetitle)
aetitle
- A String containing the AE title.public java.lang.String[] getApplicationCluster()
public void setApplicationCluster(java.lang.String[] cluster)
cluster
- A String array containing the names.public boolean isAssociationAcceptor()
public void setAssociationAcceptor(boolean acceptor)
acceptor
- A boolean value. True if the Network AE can accept
associations, false otherwise.public boolean isAssociationInitiator()
public void setAssociationInitiator(boolean initiator)
initiator
- A boolean value. True if the Network AE can accept
associations, false otherwise.public java.lang.String getDescription()
public void setDescription(java.lang.String description)
description
- A String containing the description.public boolean isInstalled()
public void setInstalled(boolean installed)
installed
- 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 devicepublic NetworkConnection[] getNetworkConnection()
NetworkConnection
objects associated with this
network AE.
NetworkConnection
objects.public void setNetworkConnection(NetworkConnection nc)
NetworkConnection
object associated with this
network AE.
nc
- A NetworkConnection
object.public void setNetworkConnection(NetworkConnection[] nc)
NetworkConnection
objects associated with this
network AE.
nc
- An array of NetworkConnection
objects.public java.lang.String[] getPreferredCalledAETitle()
public boolean hasPreferredCalledAETitle()
public boolean isPreferredCalledAETitle(java.lang.String aet)
aet
- A String containing the AE title to test.
public void setPreferredCalledAETitle(java.lang.String[] aets)
aets
- A String array containing the preferred called AE titles.public java.lang.String[] getPreferredCallingAETitle()
public boolean hasPreferredCallingAETitle()
public boolean isPreferredCallingAETitle(java.lang.String aet)
aet
- A String containing the AE title to test.
public void setPreferredCallingAETitle(java.lang.String[] aets)
aets
- A String array containing the preferred calling AE titles.public java.lang.String[] getSupportedCharacterSet()
public void setSupportedCharacterSet(java.lang.String[] characterSets)
characterSets
- A String array of the supported character sets.public TransferCapability[] getTransferCapability()
TransferCapability
objects.public void setTransferCapability(TransferCapability[] transferCapability)
transferCapability
- An array of TransferCapability
objects.public boolean isOfferDefaultTransferSyntaxInSeparatePresentationContext()
public void setOfferDefaultTransferSyntaxInSeparatePresentationContext(boolean offerDefaultTSInSeparatePC)
public java.lang.Object[] getVendorData()
public void setVendorData(java.lang.Object[] vendorData)
vendorData
- An Object array of the vendor data.public int getMaxOpsInvoked()
public void setMaxOpsInvoked(int maxOpsInvoked)
maxOpsInvoked
- An int value containing the max ops.public int getMaxOpsPerformed()
public void setMaxOpsPerformed(int maxOpsPerformed)
maxOpsPerformed
- An int value containing the max ops.public boolean isAsyncOps()
public int getMaxPDULengthReceive()
public void setMaxPDULengthReceive(int maxPDULengthReceive)
maxPDULengthReceive
- An int signifying the max PDU length.public int getMaxPDULengthSend()
public void setMaxPDULengthSend(int maxPDULengthSend)
maxPDULengthSend
- An int signifying the max PDU length.public boolean isPackPDV()
public void setPackPDV(boolean packPDV)
packPDV
- A boolean value. If true, this network AE will pack
command and data PDV in one P-DATA-TF PDU when sending.public int getDimseRspTimeout()
public void setDimseRspTimeout(int dimseRspTimeout)
dimseRspTimeout
- An int value signifying the timeout in milliseconds.public int getIdleTimeout()
public void setIdleTimeout(int idleTimeout)
idleTimeout
- An int value signifying the max idle period in
milliseconds.@Deprecated public int getMoveRspTimeout()
getRetrieveRspTimeout()
@Deprecated public void setMoveRspTimeout(int moveRspTimeout)
setRetrieveRspTimeout(int)
moveRspTimeout
- An int value signifying the timeout in milliseconds.public int getRetrieveRspTimeout()
public void setRetrieveRspTimeout(int retrieveRspTimeout)
retrieveRspTimeout
- An int value signifying the timeout in milliseconds.public java.lang.String[] getReuseAssocationFromAETitle()
public void setReuseAssocationFromAETitle(java.lang.String[] reuseAssocationFromAETitle)
reuseAssocationFromAETitle
- String array containing the AE titles that association
reuse will be enabled for.public java.lang.String[] getReuseAssocationToAETitle()
public void setReuseAssocationToAETitle(java.lang.String[] reuseAssocationToAETitle)
reuseAssocationToAETitle
- String array containing the AE titles that association
reuse will be enabled for.public UserIdentity getUserIdentity()
null
, if no
User Identity is associated with this NetworkApplicationEntity.
setUserIdentity(org.dcm4che2.net.UserIdentity)
,
connect(NetworkApplicationEntity, Executor)
,
connect(NetworkApplicationEntity, Executor, boolean)
public void setUserIdentity(UserIdentity userIdentity)
User
- Identity associated with this NetworkApplicationEntity.getUserIdentity()
,
connect(NetworkApplicationEntity, Executor)
,
connect(NetworkApplicationEntity, Executor, boolean)
public Association connect(NetworkApplicationEntity remoteAE, java.util.concurrent.Executor executor) throws ConfigurationException, java.io.IOException, java.lang.InterruptedException
setUserIdentity(UserIdentity)
, corresponding User Identity
Negotiation will be performed. This method will result in an association
being opened (or re-used if so configured). This association is then
returned for use.
remoteAE
- A NetworkApplicationEntity
to connect to.executor
- An Executor
implementation containing the
threading model to use for this connection/association.
Association
object.
ConfigurationException
- If there is no compatible network connection between this
AE title and the one that it is connecting to.
java.io.IOException
java.lang.InterruptedException
public Association connect(UserIdentity userIdentity, NetworkApplicationEntity remoteAE, java.util.concurrent.Executor executor) throws ConfigurationException, java.io.IOException, java.lang.InterruptedException
userIdentity
- The UserIdentity
notified to the
Association Acceptor by User Identity Negotiation.remoteAE
- A NetworkApplicationEntity
to connect to.executor
- An Executor
implementation containing the
threading model to use for this connection/association.
Association
object.
ConfigurationException
- If there is no compatible network connection between this
AE title and the one that it is connecting to.
java.io.IOException
java.lang.InterruptedException
public Association connect(NetworkApplicationEntity remoteAE, java.util.concurrent.Executor executor, boolean forceNew) throws ConfigurationException, java.io.IOException, java.lang.InterruptedException
setUserIdentity(UserIdentity)
, corresponding User Identity
Negotiation will be performed. This method will result in an association
being opened (or reused if so configured, and the "forceNew" parameter is
false). This association is then returned for use.
remoteAE
- A NetworkApplicationEntity
to connect to.executor
- An Executor
implementation containing the
threading model to use for this connection/association.forceNew
- A boolean value. If true, always create a new association,
ignoring any existing association re-use configuration
that has been set.
Association
object.
ConfigurationException
- If there is no compatible network connection between this
AE title and the one that it is connecting to.
java.io.IOException
java.lang.InterruptedException
public Association connect(UserIdentity userIdentity, NetworkApplicationEntity remoteAE, java.util.concurrent.Executor executor, boolean forceNew) throws ConfigurationException, java.io.IOException, java.lang.InterruptedException
userIdentity
- The UserIdentity
notified to the
Association Acceptor by User Identity Negotiation.remoteAE
- A NetworkApplicationEntity
to connect to.executor
- An Executor
implementation containing the
threading model to use for this connection/association.forceNew
- A boolean value. If true, always create a new association,
ignoring any existing association re-use configuration
that has been set.
Association
object.
ConfigurationException
- If there is no compatible network connection between this
AE title and the one that it is connecting to.
java.io.IOException
java.lang.InterruptedException
protected AAssociateRQ makeAAssociateRQ(UserIdentity userIdentity, NetworkApplicationEntity remoteAE)
public void register(DicomService service)
DicomService
with this network AE.
service
- The DicomService
that will respond to DICOM
requests.public void unregister(DicomService service)
DicomService
from this network AE.
service
- The DicomService
to unregister.public void addAssociationListener(AssociationListener l)
public void removeAssociationListener(AssociationListener l)
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |