cdac.medinfo.sdk.dcm30_04.services.scp.commons

Class ClientSession

java.lang.Object

java.lang.Thread

cdac.medinfo.sdk.dcm30_04.services.scp.commons.ClientSession

All Implemented Interfaces:

IConnectionListener, IDataNotificationReceiver, java.lang.Runnable

public class ClientSession
extends java.lang.Thread
implements IDataNotificationReceiver, IConnectionListener

Client Session implements as an interface between service class provider and user. When a new client request arrives new session wil be created.

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Thread

java.lang.Thread.State, java.lang.Thread.UncaughtExceptionHandler

Field Summary

Fields inherited from class java.lang.Thread

MAX_PRIORITY, MIN_PRIORITY, NORM_PRIORITY

Constructor Summary

Constructors

Constructor and Description
ClientSession(DicomMessage objDicomMessage) Initiates new Client Session.
ClientSession(IProcessHandler objProcessHandler, java.net.Socket socket) Instantiates a new client session.

Method Summary

Methods

Modifier and Type	Method and Description
void	acceptConnection(boolean acceptConnection) Accept connection.
void	addClientStatusListener(IClientStatusListener objIClientStatusListener) Adds the client status listener.
boolean	close() This method close the Client Session.
void	closeConnection() This function is automatically invoked when connection is closed by remote end.
AgreedAssociation	getAgreedAssociation() Gets the agreed association.
ServerSideAssociationAgent	getAssociationAgent() Gets the server side association agent.
boolean	getAssociationStatus() Retrieves Association status.
ISingleCollection<java.lang.Short>	getCancelledMsgIDCollection() Returns the collection of DICOM message IDs for which C-CANCEL RQ is received from service class user.
java.net.InetSocketAddress	getClientAddress() Gets the client address.
DefaultAssociation	getDefaultAssociation() Gets the default association.
DicomMessage	getDicomMessage() Gets the dicom message.
boolean	getDICOMMsgValidationStatus() Retrieves Status for Dicom Message Validation.
IDIMSEAssociation	getDIMSEAssociation() Gets the DIMSE association.
EnumEarlyFailedStatus	getEarlyFailedStatus() This method gets the Early Failed Status.
PDUReader	getPduReader() Retrieves the PDUReader
PDUWriter	getPduWriter() Retrieves the PDUWriter
IProcessHandler	getProcessHandler() Retrieves the Process Handler
ServerSideAssociationAgent	getServerSideAssociationAgent() Gets the server side association agent.
ServiceAgent	getServiceAgent() Gets the server side service agent.
void	initComm() Initializes the communication and registers with all Agents and Listeners.
boolean	isConnectionAccepted() Checks if connection is accepted.
boolean	isSecured() Returns socket communication status.
void	notifyData(DataNotificationEvent objDataNotificationEvent) Notify data.
void	onException(DicomException ex, EnumErrorCode ErrorCode) Gets automatically invoked when exception occur while processing data received
void	run()
boolean	sendAssociationMessage(IDIMSEAssociation objDIMSEAssociation) Send association message.
boolean	sendServiceMessage(DicomMessage objDicomMessage) Send service message.
void	setAgreedAssociation(AgreedAssociation objAgreedAssociation) Sets the agreed association.
void	setAssociationAgent(ServerSideAssociationAgent objServerSideAssociationAgent) Sets the server side association agent.
void	setAssociationStatus(boolean associationStatus) Sets the Association Staus.
void	setClientAddress(java.net.InetSocketAddress objClientAddress) Sets the client address.
void	setDefaultAssociation(DefaultAssociation objDefaultAssociation) Sets the default association.
void	setDRequest(DIMSERequest objDicomMessage) Sets the Dicom Message
void	setPduReader(PDUReader pduReader) Sets the PDUReader
void	setPduWriter(PDUWriter pduWriter) Sets the PDU Writer.
void	setProcessHandler(IProcessHandler objProcessHandler) Sets the Process Handler.
void	setSecured(boolean isSecured) sets socket communication status.
void	setServerSideAssociationAgent(ServerSideAssociationAgent objServerSideAssociationAgent) Sets the server side association agent.
void	setServiceAgent(ServiceAgent objServiceAgent) Sets the server side service agent.

Methods inherited from class java.lang.Thread

activeCount, checkAccess, countStackFrames, currentThread, destroy, dumpStack, enumerate, getAllStackTraces, getContextClassLoader, getDefaultUncaughtExceptionHandler, getId, getName, getPriority, getStackTrace, getState, getThreadGroup, getUncaughtExceptionHandler, holdsLock, interrupt, interrupted, isAlive, isDaemon, isInterrupted, join, join, join, resume, setContextClassLoader, setDaemon, setDefaultUncaughtExceptionHandler, setName, setPriority, setUncaughtExceptionHandler, sleep, sleep, start, stop, stop, suspend, toString, yield

Methods inherited from class java.lang.Object

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

Constructor Detail

ClientSession

public ClientSession(DicomMessage objDicomMessage)

Initiates new Client Session.

ClientSession

public ClientSession(IProcessHandler objProcessHandler,
             java.net.Socket socket)

Instantiates a new client session.

Parameters:

objProcessHandler - instance of process Handler.

socket - instance of Socket.

Method Detail

initComm

public void initComm()

Initializes the communication and registers with all Agents and Listeners.

closeConnection

public void closeConnection()

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

Specified by:

closeConnection in interface IConnectionListener

notifyData

public void notifyData(DataNotificationEvent objDataNotificationEvent)

Notify data.

Specified by:

notifyData in interface IDataNotificationReceiver

Parameters:

objDataNotificationEvent - instance of Data Notification Event.

Throws:

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

sendServiceMessage

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

Send service message.

Parameters:

objDicomMessage - instance of Dicom Message

Returns:

boolean - variable indicating success or failure of sending of serivce message.

Throws:

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

sendAssociationMessage

public boolean sendAssociationMessage(IDIMSEAssociation objDIMSEAssociation)

Send association message.

Parameters:

objDIMSEAssociation - instance of DIMSE Association.

Returns:

boolean - variable indicating status of Association.

Throws:

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

run

public void run()

Specified by:

run in interface java.lang.Runnable

Overrides:

run in class java.lang.Thread

addClientStatusListener

public void addClientStatusListener(IClientStatusListener objIClientStatusListener)

Adds the client status listener.

Parameters:

objIClientStatusListener - instance of Client Status Listener.

getDefaultAssociation

public DefaultAssociation getDefaultAssociation()

Gets the default association.

Returns:

DefaultAssociation - object of default association

getEarlyFailedStatus

public EnumEarlyFailedStatus getEarlyFailedStatus()

This method gets the Early Failed Status.

Returns:

EnumEarlyFailedStatus - value of early failed status.

setDefaultAssociation

public void setDefaultAssociation(DefaultAssociation objDefaultAssociation)

Sets the default association.

Parameters:

objDefaultAssociation - instance of Default Association.

getClientAddress

public java.net.InetSocketAddress getClientAddress()

Gets the client address.

Returns:

InetSocketAddress - Instance of INet Socket address

setClientAddress

public void setClientAddress(java.net.InetSocketAddress objClientAddress)

Sets the client address.

Parameters:

objClientAddress - instance of INet Socket Address.

getDicomMessage

public DicomMessage getDicomMessage()

Gets the dicom message.

Returns:

DicomMessage - instance of dicom message

setDRequest

public void setDRequest(DIMSERequest objDicomMessage)

Sets the Dicom Message

Parameters:

objDicomMessage - instance of dicom message.

getAssociationAgent

public ServerSideAssociationAgent getAssociationAgent()

Gets the server side association agent.

Returns:

ServerSideAssociationAgent - instance of server side association agent

setAssociationAgent

public void setAssociationAgent(ServerSideAssociationAgent objServerSideAssociationAgent)

Sets the server side association agent.

Parameters:

objServerSideAssociationAgent - object of server side association agent

getServiceAgent

public ServiceAgent getServiceAgent()

Gets the server side service agent.

Returns:

ServiceAgent - instance of server side service agent

setServiceAgent

public void setServiceAgent(ServiceAgent objServiceAgent)

Sets the server side service agent.

Parameters:

objServiceAgent - instance of Server Side Association Agent.

getDIMSEAssociation

public IDIMSEAssociation getDIMSEAssociation()

Gets the DIMSE association.

Returns:

IDIMSEAssociation - instance of Dimse Association.

setAgreedAssociation

public void setAgreedAssociation(AgreedAssociation objAgreedAssociation)

Sets the agreed association.

Parameters:

objAgreedAssociation - instance of agreed association.

getAgreedAssociation

public AgreedAssociation getAgreedAssociation()

Gets the agreed association.

Returns:

AgreedAssociation - object of agreed association.

isConnectionAccepted

public boolean isConnectionAccepted()

Checks if connection is accepted.

Returns:

boolean - true if is connection accepted.

acceptConnection

public void acceptConnection(boolean acceptConnection)

Accept connection.

Parameters:

acceptConnection - boolean variable accepting connection. true - if connection is accepted. false - if connection is not accepted.

close

public boolean close()

This method close the Client Session.

Returns:

boolean - true if successful.

getProcessHandler

public IProcessHandler getProcessHandler()

Retrieves the Process Handler

Returns:

ProcessHandler instance of ProcessHandler

setProcessHandler

public void setProcessHandler(IProcessHandler objProcessHandler)

Sets the Process Handler.

Parameters:

objProcessHandler - instance of Process Handler.

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 PDU Writer.

Parameters:

pduWriter - instance of PDUWriter

setServerSideAssociationAgent

public void setServerSideAssociationAgent(ServerSideAssociationAgent objServerSideAssociationAgent)

Sets the server side association agent.

Parameters:

objServerSideAssociationAgent - object of server side association agent

getServerSideAssociationAgent

public ServerSideAssociationAgent getServerSideAssociationAgent()

Gets the server side association agent.

Returns:

ServerSideAssociationAgent - instance of server side association agent

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.

isSecured

public boolean isSecured()

Returns socket communication status.

Returns:

true if the secure otherwise false

getCancelledMsgIDCollection

public ISingleCollection<java.lang.Short> getCancelledMsgIDCollection()

Returns the collection of DICOM message IDs for which C-CANCEL RQ is received from service class user.

Returns:

ISingleCollection Collection of DICOM message IDs.

setSecured

public void setSecured(boolean isSecured)

sets socket communication status.

Parameters:

isSecured - the isSecured to set

getDICOMMsgValidationStatus

public boolean getDICOMMsgValidationStatus()

Retrieves Status for Dicom Message Validation.

Returns:

boolean - indicating message status. true - if Dicom Message is Valid. false - if Dicom Message is Invalid.

onException

public void onException(DicomException ex,
               EnumErrorCode ErrorCode)

Description copied from interface: IDataNotificationReceiver

Gets automatically invoked when exception occur while processing data received

Specified by:

onException in interface IConnectionListener

Specified by:

onException in interface IDataNotificationReceiver

Parameters:

ex - - the exception object

ErrorCode - - the reason of the DicomException