cdac.medinfo.sdk.dcm30_04.services.scu.commons

Class SCUSession

java.lang.Object

cdac.medinfo.sdk.dcm30_04.services.scu.commons.SCUSession

All Implemented Interfaces:

IConnectionListener, IDataNotificationReceiver

Direct Known Subclasses:

TLSSCUSession

public class SCUSession
extends java.lang.Object
implements IDataNotificationReceiver, IConnectionListener

This class establishes SCU Session with the remote entity. This class act as a data notification receiver. When ever data arrives from the remote application entity is is notified to SCU Session. It also listen for the connection status. If the connection does not exits then SCU session is stopped.

Constructor Summary

Constructors

Constructor and Description
SCUSession() Instantiates a new SCU session.

Method Summary

Methods

Modifier and Type	Method and Description
void	addAsyncReceiver(IAsyncReceiver objIAsyncReceiver) Adds the async receiver.
boolean	associate(IDIMSEAssociation objDIMSEAssociation) This method establishes association.
boolean	close() Closes the session and set all resources free.
void	closeConnection() This function is automatically invoked when connection is closed by remote end.
boolean	connectionState()
void	endSession(boolean b) Sets the end session variable true.
AgreedAssociation	getAgreedAssociation() Gets Agreed Association.
boolean	getAssociationStatus() Retrieves Association status.
ClientSideAssociationAgent	getClientSideAssociationAgent() Retrieves the ClientSideAssociationAgent.
IDIMSEAssociation	getDIMSEAssociation() Gets the DIMSE association.
EnumEarlyFailedStatus	getEarlyFailedStatus() This method gets the Early Failed Status.
int	getNumberOfRequestSend() This function indicates the No of requests send by the user.
PDUReader	getPduReader() Retrieves the PDUReader.
PDUWriter	getPduWriter() Retrieves the PDUWriter.
ServiceAgent	getServiceAgent() Retrieves the ServiceAgent.
int	getTimeOut() Returns setting for Socket read timeout of this session, 0 returns implies that the option is disabled (i.e., timeout of infinity).
boolean	isSecured() Returns socket communication status.
void	notifyData(DataNotificationEvent objDataNotificationEvent) Notify ProcessHandler according to the response received and initializes association parameters.
void	onException(DicomException ex, EnumErrorCode ErrorCode) Gets automatically invoked when exception occur while processing data received
boolean	releaseAssociation() This method releases the current association.
boolean	sendAssociationMessage(IDIMSEAssociation objDIMSEAssociation) Sends the association Message to client side Association agent.
boolean	sendServiceMessage(DicomMessage objDicomMessge) Sends the Service Message to service agent.
void	setAssociationStatus(boolean associationStatus) Sets the Association Staus.
void	setClientSideAssociationAgent(ClientSideAssociationAgent objClientSideAssociationAgent) Sets the ClientSideAssociationAgent.
void	setConnectionState(boolean isConnected) Sets the connection state
void	setExceptionListener(IExceptionListener objExceptionListener) Sets the ExceptionListener on SCU session to notify user about the exceptions occurred
void	setMessageListener(SCU objSCU) Sets the message listener.
void	setPduReader(PDUReader pduReader) Sets the PDUReader.
void	setPduWriter(PDUWriter pduWriter) Sets the PDUWriter.
void	setSecured(boolean isSecured) sets socket communication status.
void	setServiceAgent(ServiceAgent objServiceAgent) Sets the ServiceAgent.
void	setTimeOut(int itimeout) sets Socket read timeout of this session, in milliseconds.
void	start(java.net.InetSocketAddress addr) Start the SCU session with the INet socket address given.
void	start(java.lang.String strIP, int iPort) Start the SCU session with the IP and port given.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SCUSession

public SCUSession()
           throws java.io.IOException

Instantiates a new SCU session.

Throws:

java.io.IOException - Signals if an IO Exception occurs.

Method Detail

start

public void start(java.lang.String strIP,
         int iPort)
           throws java.io.IOException

Start the SCU session with the IP and port given.

Parameters:

strIP - String value of IP.

iPort - int value of port.

Throws:

java.io.IOException - Signals that an I/O exception has occurred.

start

public void start(java.net.InetSocketAddress addr)
           throws java.io.IOException

Start the SCU session with the INet socket address given.

Parameters:

addr - instance of InetSocketAddress.

Throws:

java.io.IOException - Signals that an I/O exception has occurred.

setExceptionListener

public void setExceptionListener(IExceptionListener objExceptionListener)

Sets the ExceptionListener on SCU session to notify user about the exceptions occurred

Parameters:

objExceptionListener -

closeConnection

public void closeConnection()

This function is automatically invoked when connection is closed by remote end.

Specified by:

closeConnection in interface IConnectionListener

setConnectionState

public void setConnectionState(boolean isConnected)

Sets the connection state

Parameters:

isConnected -

getEarlyFailedStatus

public EnumEarlyFailedStatus getEarlyFailedStatus()

This method gets the Early Failed Status.

Returns:

EnumEarlyFailedStatus enum value of early failed status.

setAssociationStatus

public void setAssociationStatus(boolean associationStatus)

Sets the Association Staus.

Parameters:

associationStatus - boolean variable indicating Association Status. true - if association is Alive. false - if association does not exits.

getAssociationStatus

public boolean getAssociationStatus()

Retrieves Association status.

Returns:

boolean - indicating Association Status. true - if association is Alive. false - if association does not exits.

connectionState

public boolean connectionState()

Returns:

boolean

notifyData

public void notifyData(DataNotificationEvent objDataNotificationEvent)
                throws java.io.IOException

Notify ProcessHandler according to the response received and initializes association parameters.

Specified by:

notifyData in interface IDataNotificationReceiver

Parameters:

objDataNotificationEvent - the obj data notification event

Throws:

java.io.IOException - Signals that an I/O exception has occurred.

getAgreedAssociation

public AgreedAssociation getAgreedAssociation()

Gets Agreed Association.

Returns:

AgreedAssociation - instance of Agreed Association.

associate

public boolean associate(IDIMSEAssociation objDIMSEAssociation)

This method establishes association.

Parameters:

objDIMSEAssociation - - instance of IDIMSEAssociation

Returns:

boolean - boolean variable indicating whether association is established or not. true - if association is established. false - if association is not established.

releaseAssociation

public boolean releaseAssociation()

This method releases the current association.

Returns:

boolean - variable indication whether association is released or not.

sendAssociationMessage

public boolean sendAssociationMessage(IDIMSEAssociation objDIMSEAssociation)

Sends the association Message to client side Association agent. It checks for the validity of association message.

Parameters:

objDIMSEAssociation - the object of DIMSE association

Returns:

boolean true if successful else false

sendServiceMessage

public boolean sendServiceMessage(DicomMessage objDicomMessge)
                           throws java.io.IOException

Sends the Service Message to service agent.

Parameters:

objDicomMessge - instance of Dicom Message

Returns:

boolean true if successful else false

Throws:

java.io.IOException - Signals that an I/O exception has occurred.

getNumberOfRequestSend

public int getNumberOfRequestSend()

This function indicates the No of requests send by the user.

Returns:

int - No of reuest send .

getDIMSEAssociation

public IDIMSEAssociation getDIMSEAssociation()

Gets the DIMSE association.

Returns:

IDIMSEAssociation - instance of DIMSE association

endSession

public void endSession(boolean b)

Sets the end session variable true.

Parameters:

b - true to end the session.

close

public boolean close()

Closes the session and set all resources free.

Returns:

boolean true if successfully closes the session

getClientSideAssociationAgent

public ClientSideAssociationAgent getClientSideAssociationAgent()

Retrieves the ClientSideAssociationAgent.

Returns:

ClientSideAssociationAgent instance of ClientSideAssociationAgent

setClientSideAssociationAgent

public void setClientSideAssociationAgent(ClientSideAssociationAgent objClientSideAssociationAgent)

Sets the ClientSideAssociationAgent.

Parameters:

objClientSideAssociationAgent - instance of ClientSideAssociationAgent.

getServiceAgent

public ServiceAgent getServiceAgent()

Retrieves the ServiceAgent.

Returns:

ServiceAgent instance of ServiceAgent

setServiceAgent

public void setServiceAgent(ServiceAgent objServiceAgent)

Sets the ServiceAgent.

Parameters:

objServiceAgent - instance of ServiceAgent.

getPduReader

public PDUReader getPduReader()

Retrieves the PDUReader.

Returns:

PDUReader - instance of PDUReader

setPduReader

public void setPduReader(PDUReader pduReader)

Sets the PDUReader.

Parameters:

pduReader - instance of PDUReader

getPduWriter

public PDUWriter getPduWriter()

Retrieves the PDUWriter.

Returns:

PDUWriter instance of PDUWriter

setPduWriter

public void setPduWriter(PDUWriter pduWriter)

Sets the PDUWriter.

Parameters:

pduWriter - instance of PDUWriter

setMessageListener

public void setMessageListener(SCU objSCU)

Sets the message listener.

Parameters:

objSCU - object of SCU which is to be set as Message Listener.

addAsyncReceiver

public void addAsyncReceiver(IAsyncReceiver objIAsyncReceiver)

Adds the async receiver.

Parameters:

objIAsyncReceiver - the obj i async receiver

isSecured

public boolean isSecured()

Returns socket communication status.

Returns:

true if the secure otherwise false

setSecured

public void setSecured(boolean isSecured)

sets socket communication status.

Parameters:

isSecured - the isSecured to set

getTimeOut

public int getTimeOut()

Returns setting for Socket read timeout of this session, 0 returns implies that the option is disabled (i.e., timeout of infinity).

Returns:

the setting for socket read timeout.

setTimeOut

public void setTimeOut(int itimeout)

sets Socket read timeout of this session, in milliseconds. With this option set to a non-zero timeout, a read() call on the InputStream associated with this Socket will block for only this amount of time.If the timeout expires, a session is closed,The timeout must be > 0. A timeout of zero is interpreted as an infinite timeout.

Parameters:

timeout - the specified timeout, in milliseconds.

onException

public void onException(DicomException ex,
               EnumErrorCode ErrorCode)

Gets automatically invoked when exception occur while processing data received

Specified by:

onException in interface IConnectionListener

Specified by:

onException in interface IDataNotificationReceiver

Parameters:

objClientSession - - object of Client Session.

ex - - the exception object

ErrorCode - - the reason of the DicomException