Class InstanceReceiver
- Direct Known Subclasses:
ProcessReceivedWholeSlideImagesMakeTiledPyramidAndSend
A class to wait for incoming composite instance storage operations and process each instance as it is received.
The doSomethingWithReceivedDicomFile()
method may be implemented in a sub-class to actually do something more useful than just storing the files.
It is configured by use of a properties file that resides in the user's
home directory in .com.pixelmed.apps.ProcessReceivedWholeSlideImagesMakeTiledPyramidAndSend.properties
.
The properties allow control over the user interface elements that are displayed
and record the settings changed by the user when the application closes.
For a description of the network configuration properties, see NetworkApplicationProperties
.
The properties that are specific to the application, and their default values, are as follows
Application.SavedImagesFolderName=.com.pixelmed.apps.InstanceReceiver.receivedinstances
- where to store DICOM instances received
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionprotected static class
protected class
protected class
-
Field Summary
FieldsModifier and TypeFieldDescriptionprotected static String
protected String
protected NetworkApplicationInformationFederated
protected NetworkApplicationProperties
protected String
protected Properties
protected static String
protected File
protected StoredFilePathStrategy
protected static final AttributeList.ReadTerminationStrategy
-
Constructor Summary
ConstructorsConstructorDescriptionInstanceReceiver
(String propertiesFileName) Wait for incoming composite instance storage operations and process each instance as it is received. -
Method Summary
Modifier and TypeMethodDescriptionvoid
Start or restart DICOM storage listener.protected void
doSomethingWithReceivedDicomFile
(String receivedFileName, String sourceApplicationEntityTitle, String transferSyntaxUID, String sopClassUID) Do something with the received DICOM file.protected static File
getFolderNameCreatingItIfNecessary
(String folderName) Return the folder, creating it if necessary.protected void
loadProperties
(String propertiesFileName) Load properties.static void
Wait for incoming composite instance storage operations and process each instance as it is received.void
Shutdown DICOM storage listener.
-
Field Details
-
defaultPropertiesFileName
-
propertyName_SavedImagesFolderName
-
defaultSavedImagesFolderName
-
properties
-
networkApplicationProperties
-
networkApplicationInformation
-
ourCalledAETitle
-
savedImagesFolder
-
storedFilePathStrategy
-
terminateAfterRelationshipGroup
-
-
Constructor Details
-
InstanceReceiver
public InstanceReceiver(String propertiesFileName) throws DicomException, DicomNetworkException, IOException, InterruptedException Wait for incoming composite instance storage operations and process each instance as it is received.
- Parameters:
propertiesFileName
-- Throws:
DicomException
DicomNetworkException
IOException
InterruptedException
-
-
Method Details
-
loadProperties
Load properties.
- Throws:
IOException
- thrown if properties file is missing
-
doSomethingWithReceivedDicomFile
protected void doSomethingWithReceivedDicomFile(String receivedFileName, String sourceApplicationEntityTitle, String transferSyntaxUID, String sopClassUID) Do something with the received DICOM file.
This method may be implemented in a sub-class to do something useful even if it is only logging to the user interface.
The default method does nothing.
This method is called on the ReceivedFileProcessor thread.
This method does not define any exceptions and hence must handle any errors locally.
- Parameters:
receivedFileName
- the path name to a DICOM filesourceApplicationEntityTitle
- the Application Entity from which the file was receivedtransferSyntaxUID
- the Transfer Syntax of the Data Set in the DICOM filesopClassUID
- the SOP Class of the Data Set in the DICOM file
-
getFolderNameCreatingItIfNecessary
Return the folder, creating it if necessary.
If not an absolute path, will be sought or created relative to the current user's home directory.
- Returns:
- the folder
- Throws:
IOException
-
activateStorageSCP
Start or restart DICOM storage listener.
Shuts down existing listener, if any, so may be used to restart after configuration change.
- Throws:
DicomException
IOException
-
shutdownStorageSCP
public void shutdownStorageSCP()Shutdown DICOM storage listener.
-
main
Wait for incoming composite instance storage operations and process each instance as it is received.
- Parameters:
arg
- none
-