com.archimed.dicom.scu

Interface SCU

All Known Subinterfaces:

CEchoSCU, MultiCFindSCU, MultiCGetSCU, MultiCMoveSCU, MultiCStoreSCU

public interface SCU

Base SCU interface with methods available to any implementation.

The general call sequence of an SCU implementation is like:

• createAssociationRequest()
• associate()
• Execute implementation specific methods that perform the actual DIMSE message exchange (C-STORE,C-GET,C-ECHO,...)
• release()

Method Summary

Methods

Modifier and Type	Method and Description
void	abort(int source, int reason)
void	addSCUProgressListener(SCUProgressListener scuProgressListener) adds a listener that can be informed of SCU message exchanges
AssociationResult	associate() executes an A-ASSOCIATE message exchange.
AssociationResult	associate(AssociationRequest associationRequest) executes an A-ASSOCIATE message exchange.
void	cancel(boolean graceful) Cancels the current and future SCU message exchanges.
AssociationRequest	createAssociationRequest() scans the input (if appropriate) and prepares a request that can be sent during association setup
int	getConnectTimeout() The connect timeout in milliseconds
int	getMaxReceivePduSize() the maximum pdu length that we are willing to receive.
int	getMaxSendPduSize() The maximum pdu length with which Dimse messages will be sent.
int	getReadTimeout() The read timeout in milliseconds
javax.net.SocketFactory	getSocketFactory() returns the currently configured socket factory
UserIdentityNegotiationRequest	getUserIdentityNegotationRequest()
boolean	isCancelled() has this SCU been cancelled ?
void	release() executes an A-RELEASE message exchange
void	removeSCUProgressListener(SCUProgressListener scuProgressListener) removes a registered progress listener
void	setConnectTimeout(int connectTimeout)
void	setMaxReceivePduSize(int maxReceivePduSize)
void	setMaxSendPduSize(int maxSendPduSize)
void	setReadTimeout(int readTimeout)
void	setSocketFactory(javax.net.SocketFactory socketFactory) set the socket factory and replaces the default socket factory.
void	setUserIdentityNegotationRequest(UserIdentityNegotiationRequest userIdentityNegotationRequest)

Method Detail

createAssociationRequest

AssociationRequest createAssociationRequest()
                                            throws SCUException

scans the input (if appropriate) and prepares a request that can be sent during association setup

Returns:

the request that will be used for association setup

Throws:

SCUException

associate

AssociationResult associate()
                            throws SCUException,
                                   java.io.IOException

executes an A-ASSOCIATE message exchange. Make sure that createAssociationRequest() has been executed first.

Returns:

the result of the association setup

Throws:

SCUException

java.io.IOException

associate

AssociationResult associate(AssociationRequest associationRequest)
                            throws SCUException,
                                   java.io.IOException

executes an A-ASSOCIATE message exchange. Make sure that createAssociationRequest() has been executed first.

Returns:

the result of the association setup

Throws:

SCUException

java.io.IOException

release

void release()
             throws SCUException,
                    java.io.IOException

executes an A-RELEASE message exchange

Throws:

SCUException

java.io.IOException

cancel

void cancel(boolean graceful)

Cancels the current and future SCU message exchanges. After this method has been called, this SCU cannot be used anymore for any message exchange

Parameters:

graceful - if true, the SCU will be cancelled after the current operation and will release the association properly; if false, the current operation will be interrupted and the association will be aborted without a proper message exchange

isCancelled

boolean isCancelled()

has this SCU been cancelled ?

See Also:

cancel(boolean)

addSCUProgressListener

void addSCUProgressListener(SCUProgressListener scuProgressListener)

adds a listener that can be informed of SCU message exchanges

Parameters:

scuProgressListener - the listener

removeSCUProgressListener

void removeSCUProgressListener(SCUProgressListener scuProgressListener)

removes a registered progress listener

Parameters:

scuProgressListener - the listener

abort

void abort(int source,
         int reason)
           throws java.io.IOException,
                  SCUException

Throws:

java.io.IOException

SCUException

getSocketFactory

javax.net.SocketFactory getSocketFactory()

returns the currently configured socket factory

Returns:

socketFactory

setSocketFactory

void setSocketFactory(javax.net.SocketFactory socketFactory)

set the socket factory and replaces the default socket factory. Use this to replace the default non-TLS socket factory with another SSLSocketFactory like one created with ConfigurableTLSSocketFactory

Parameters:

socketFactory - socketFactory

getUserIdentityNegotationRequest

UserIdentityNegotiationRequest getUserIdentityNegotationRequest()

setUserIdentityNegotationRequest

void setUserIdentityNegotationRequest(UserIdentityNegotiationRequest userIdentityNegotationRequest)

getMaxSendPduSize

int getMaxSendPduSize()

The maximum pdu length with which Dimse messages will be sent. If the specified maximum is higher than the maximum specified by the scp, this value is ignored. If this value is set to zero, the maximum specified by the scp will be used always.

Returns:

length in bytes

setMaxSendPduSize

void setMaxSendPduSize(int maxSendPduSize)

getMaxReceivePduSize

int getMaxReceivePduSize()

the maximum pdu length that we are willing to receive. This value is sent in the a-associate request

Returns:

length in bytes

setMaxReceivePduSize

void setMaxReceivePduSize(int maxReceivePduSize)

getConnectTimeout

int getConnectTimeout()

The connect timeout in milliseconds

Returns:

timeout in ms

setConnectTimeout

void setConnectTimeout(int connectTimeout)

getReadTimeout

int getReadTimeout()

The read timeout in milliseconds

Returns:

timeout in ms

setReadTimeout

void setReadTimeout(int readTimeout)