org.dicom4j.network.association
Interface Association

All Known Implementing Classes:

AssociationImpl

public interface Association

Dicom Assocation (see DICOM PS 3.8)

Since:

0.0.0

Author:

Laurent Lecomte

Method Summary

void	closeTransportConnection(boolean aWaitARTIM)
boolean	containsAttribute(String key) Returns true if this Association contains the attribute with the specified key.
AssociateResponseHandler	getAssociateResponseListener() Deprecated. get the AssociateResponseHandler
AssociateSession	getAssociateSession() Return the AssociateSession of this association.
AssociationListener	getAssociationListener() Deprecated. get the AssociationListener
AsynOperationsWindow	getAsynOperationsWindow() the AsynOperationsWindow
Object	getAttachment() Returns an attachment of this Association.
Object	getAttribute(String key) Returns the value of user-defined attribute of this Association.
Set<String>	getAttributeKeys() Returns the set of keys of all user-defined attributes.
AssociationConfiguration	getConfiguration() get the AssociationConfiguration
AssociationMonitor	getMonitor() Deprecated. Get the AssociationMonitor
String	getTransferSyntaxFromPresentationID(byte aPresentationID) Deprecated.
boolean	isEstablished() Indicates if an association is established
boolean	isReleased() Indicates that the association is in release State and can be disposed
Object	removeAttribute(String key) Removes a user-defined attribute with the specified key.
void	sendAbort(AssociateAbort aAbort) Send an AssociateAbort request to a remote peer
void	sendAssociate(AssociateRequest aRequest) Send an A-ASSOCIATE request to a remote peer
void	sendMessage(byte aPresentationContextID, AbstractDimseMessage aMessage) Send a DimseMessage to a remote peer
void	sendReject(AssociateReject aAssociateReject) send a A-ASSOCIATE REJECT
void	sendReject(byte aResult, byte aSource, byte aReason) send a A-ASSOCIATE REJECT
void	sendReleaseRequest() Send an A-RELEASE request to a remote peer
void	sendReleaseResponse() Send an A-RELEASE response to a remote peer
void	setAssociateRequestListener(AssociateRequestHandler aAssociateRequestHandler) Deprecated. set the AssociateRequestHandler
void	setAssociateResponseListener(AssociateResponseHandler aAssociateResponseHandler) Deprecated. set the AssociateResponseHandler
void	setAssociationListener(AssociationListener aListener) Deprecated. Set the AssociationListener to by notify of Associations events
Object	setAttachment(Object attachment) Sets an attachment of this session.
Object	setAttribute(String key) Sets a user defined attribute without a value.
Object	setAttribute(String key, Object value) Sets a user-defined attribute.
void	setConfiguration(AssociationConfiguration aConfiguration) set the AssociationConfiguration
void	setMonitor(AssociationMonitor aAssociationMonitor) Deprecated. Set the AssociationMonitor for this Association
void	waitAssociate() Wait an AssociateRequest from a remote peer

Method Detail

closeTransportConnection

void closeTransportConnection(boolean aWaitARTIM)
                              throws AssociationException

Throws:

AssociationException

containsAttribute

boolean containsAttribute(String key)

Returns true if this Association contains the attribute with the specified key.

getAssociateResponseListener

@Deprecated
AssociateResponseHandler getAssociateResponseListener()

Deprecated. get the AssociateResponseHandler

getAssociateSession

AssociateSession getAssociateSession()

Return the AssociateSession of this association.

If isEstablished return false, getAssociateSession will return a null session

Returns:

the AssociateSession

getAssociationListener

@Deprecated
AssociationListener getAssociationListener()

Deprecated. get the AssociationListener

getAsynOperationsWindow

AsynOperationsWindow getAsynOperationsWindow()

the AsynOperationsWindow

Returns:

the AsynOperationsWindow

getAttachment

Object getAttachment()

Returns an attachment of this Association. This method is identical with getAttribute( "" ).

getAttribute

Object getAttribute(String key)

Returns the value of user-defined attribute of this Association.

Parameters:

key - the key of the attribute

Returns:

null if there is no attribute with the specified key

getAttributeKeys

Set<String> getAttributeKeys()

Returns the set of keys of all user-defined attributes.

getConfiguration

AssociationConfiguration getConfiguration()

get the AssociationConfiguration

Returns:

the configuration

Since:

Alpha 0.0.3

getMonitor

@Deprecated
AssociationMonitor getMonitor()

Deprecated. Get the AssociationMonitor

Returns:

the AssociationMonitor

getTransferSyntaxFromPresentationID

@Deprecated
String getTransferSyntaxFromPresentationID(byte aPresentationID)

Deprecated.

isEstablished

boolean isEstablished()

Indicates if an association is established

Returns:

true if established

isReleased

boolean isReleased()

Indicates that the association is in release State and can be disposed

Returns:

thue is released

removeAttribute

Object removeAttribute(String key)

Removes a user-defined attribute with the specified key.

Returns:

The old value of the attribute. null if not found.

sendAbort

void sendAbort(AssociateAbort aAbort)
               throws Exception

Send an AssociateAbort request to a remote peer

Parameters:

aAbort - the Abort request

Throws:

Exception - if error occurs

sendAssociate

void sendAssociate(AssociateRequest aRequest)
                   throws Exception

Send an A-ASSOCIATE request to a remote peer

Parameters:

aRequest - the AssociateRequest

Throws:

Exception - if error occurs

sendMessage

void sendMessage(byte aPresentationContextID,
                 AbstractDimseMessage aMessage)
                 throws Exception

Send a DimseMessage to a remote peer

Parameters:

aPresentationContextID - the Presentation Context ID to use

aMessage - the DimseMessage to send

Throws:

Exception - if error occurs

sendReject

void sendReject(AssociateReject aAssociateReject)
                throws Exception

send a A-ASSOCIATE REJECT

Parameters:

AssociateReject - the A-ASSOCIATE REJECT

Throws:

Exception - if error occurs

sendReject

void sendReject(byte aResult,
                byte aSource,
                byte aReason)
                throws Exception

send a A-ASSOCIATE REJECT

Parameters:

aResult -

aSource -

aReason -

Throws:

Exception - if error occurs

sendReleaseRequest

void sendReleaseRequest()
                        throws Exception

Send an A-RELEASE request to a remote peer

Throws:

Exception - if error occurs

sendReleaseResponse

void sendReleaseResponse()
                         throws Exception

Send an A-RELEASE response to a remote peer

Throws:

Exception

setAssociateRequestListener

@Deprecated
void setAssociateRequestListener(AssociateRequestHandler aAssociateRequestHandler)

Deprecated. set the AssociateRequestHandler

Parameters:

aAssociateRequestHandler -

setAssociateResponseListener

@Deprecated
void setAssociateResponseListener(AssociateResponseHandler aAssociateResponseHandler)

Deprecated. set the AssociateResponseHandler

Parameters:

aAssociateResponseHandler - the listener

setAssociationListener

@Deprecated
void setAssociationListener(AssociationListener aListener)

Deprecated. Set the AssociationListener to by notify of Associations events

Parameters:

aListener - the listener

setAttachment

Object setAttachment(Object attachment)

Sets an attachment of this session. This method is identical with setAttribute( "", attachment ).

Returns:

Old attachment. null if it is new.

setAttribute

Object setAttribute(String key)

Sets a user defined attribute without a value. This is useful when you just want to put a 'mark' attribute. Its value is set to Boolean.TRUE.

Parameters:

key - the key of the attribute

Returns:

The old value of the attribute. null if it is new.

setAttribute

Object setAttribute(String key,
                    Object value)

Sets a user-defined attribute.

Parameters:

key - the key of the attribute

value - the value of the attribute

Returns:

The old value of the attribute. null if it is new.

setConfiguration

void setConfiguration(AssociationConfiguration aConfiguration)

set the AssociationConfiguration

Parameters:

aConfiguration - the configuration

Since:

0.0.3

setMonitor

@Deprecated
void setMonitor(AssociationMonitor aAssociationMonitor)

Deprecated. Set the AssociationMonitor for this Association

Parameters:

aAssociationMonitor - the monitor

waitAssociate

void waitAssociate()
                   throws Exception

Wait an AssociateRequest from a remote peer

Throws:

Exception - if error occurs