pt.ua.dicoogle.server.web.management

Class Dicoogle

java.lang.Object

pt.ua.dicoogle.server.web.management.Dicoogle

public class Dicoogle
extends java.lang.Object

A wrapper used to manage the Dicoogle Settings remotely through the web environment/app.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Dicoogle.SOPClassSettings Holds and provides information about the accepted SOP Classes and Transfer Storages allowed within Dicoogle.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	SETTING_CLIENT_PERMIT_ACCESS_LIST_HELP The help for the setting that indicates the Client Permit Access List.
static java.lang.String	SETTING_CLIENT_PERMIT_ACCESS_LIST_NAME The name of the setting that indicates the Client Permit Access List.
static java.lang.String	SETTING_DIRECTORY_MONITORIZATION_NAME The name of the setting that indicates the Dicoogle Directory Monitorization.
static java.lang.String	SETTING_DIRECTORY_WATCHER_NAME The name of the setting that indicates the Dicoogle Enable Directory Watcher.
static java.lang.String	SETTING_INDEX_ZIP_FILES_NAME The name of the setting that indicates if ZIP files are to be Indexed.
static java.lang.String	SETTING_INDEXING_EFFORT_HELP The help of the Indexing Effort setting.
static java.lang.String	SETTING_INDEXING_EFFORT_NAME The name of the setting that indicates the Indexing Effort.
static java.lang.String	SETTING_PERMIT_ALL_AE_TITLES_HELP The help of the setting that indicates the Permit All AE Titles.
static java.lang.String	SETTING_PERMIT_ALL_AE_TITLES_NAME The name of the setting that indicates the Permit All AE Titles.
static java.lang.String	SETTING_SAVE_THUMBNAILS_NAME The name of the setting that indicates if Thumbnails are to be Saved.
static java.lang.String	SETTING_SERVER_AE_TITLE_HELP The help for the setting that indicates the Server AE Title.
static java.lang.String	SETTING_SERVER_AE_TITLE_NAME The name of the setting that indicates the Server AE Title.
static java.lang.String	SETTING_SOP_CLASS_ACCEPT_ALL_NAME The name of the setting that indicates if Accept All SOP Classes.
static java.lang.String	SETTING_SOP_CLASS_GLOBAL_TRANSFER_STORAGE_NAME The name of the setting that indicates the Global Transfer Storage settings.
static java.lang.String	SETTING_THUMBNAILS_SIZE_NAME The name of the setting that indicates the Thumbnails Size.

Method Summary

Modifier and Type	Method and Description
java.util.HashMap<java.lang.String,java.lang.Object>	getAccessListSettings() Returns a Map containing the current settings.
java.util.HashMap<java.lang.String,java.lang.String>	getAccessListSettingsHelp() Returns the settings help.
java.util.HashMap<java.lang.String,java.lang.Object>	getIndexingSettings() Returns a Map containing the current settings.
java.util.HashMap<java.lang.String,java.lang.String>	getIndexingSettingsHelp() Returns the settings help.
static Dicoogle	getInstance() Returns the current instance of this class.
java.util.HashMap<java.lang.String,java.lang.Object>	getSOPClassGlobalSettings() Returns a Map containing the current settings.
java.util.HashMap<java.lang.String,java.lang.String>	getSOPClassGlobalSettingsHelp() Returns the settings help.
java.lang.Object[]	getTransferSettingsForAllSOPClasses() Returns a StaticDataTable containing the TransferStorages settings for all SOP Classes UIDs.
java.lang.Object[]	getTransferSettingsForSOPClass(java.lang.String sopClassUID) Returns a StaticDataTable containing the TransferStorages for a specific SOP Class UID.
boolean	setAccessListSettings(java.util.HashMap<java.lang.String,java.lang.Object> settings) Tries to set the supplied settings as the new settings.
boolean	setIndexingSettings(java.util.HashMap<java.lang.String,java.lang.Object> settings) Tries to set the supplied settings as the new settings.
boolean	setSOPClassGlobalSettings(java.util.HashMap<java.lang.String,java.lang.Object> settings) Tries to set the supplied settings as the new settings.
void	setTransferSettingsForAllSOPClasses(java.lang.Boolean accepted, StaticDataTable table) Applies the Transfer Storage settings present on a StaticDataTable to all SOP Classes UIDs.
void	setTransferSettingsForSOPClass(java.lang.String sopClassUID, java.lang.Boolean accepted, StaticDataTable table) Applies the Transfer Storage settings present on a StaticDataTable to a specific SOP Class UID.
boolean	tryAccessListSettings(java.util.HashMap<java.lang.String,java.lang.Object> map) Validates the settings supplied and checks if they are valid ones.
boolean	tryIndexingSettings(java.util.HashMap<java.lang.String,java.lang.Object> map) Validates the settings supplied and checks if they are valid ones.
boolean	trySOPClassGlobalSettings(java.util.HashMap<java.lang.String,java.lang.Object> map) Validates the settings supplied and checks if they are valid ones.

Methods inherited from class java.lang.Object

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

Field Detail

SETTING_DIRECTORY_MONITORIZATION_NAME

public static final java.lang.String SETTING_DIRECTORY_MONITORIZATION_NAME

The name of the setting that indicates the Dicoogle Directory Monitorization.

See Also:

Constant Field Values

SETTING_DIRECTORY_WATCHER_NAME

public static final java.lang.String SETTING_DIRECTORY_WATCHER_NAME

The name of the setting that indicates the Dicoogle Enable Directory Watcher.

See Also:

Constant Field Values

SETTING_INDEXING_EFFORT_NAME

public static final java.lang.String SETTING_INDEXING_EFFORT_NAME

The name of the setting that indicates the Indexing Effort.

See Also:

Constant Field Values

SETTING_THUMBNAILS_SIZE_NAME

public static final java.lang.String SETTING_THUMBNAILS_SIZE_NAME

The name of the setting that indicates the Thumbnails Size.

See Also:

Constant Field Values

SETTING_SAVE_THUMBNAILS_NAME

public static final java.lang.String SETTING_SAVE_THUMBNAILS_NAME

The name of the setting that indicates if Thumbnails are to be Saved.

See Also:

Constant Field Values

SETTING_INDEX_ZIP_FILES_NAME

public static final java.lang.String SETTING_INDEX_ZIP_FILES_NAME

The name of the setting that indicates if ZIP files are to be Indexed.

See Also:

Constant Field Values

SETTING_SERVER_AE_TITLE_NAME

public static final java.lang.String SETTING_SERVER_AE_TITLE_NAME

The name of the setting that indicates the Server AE Title.

See Also:

Constant Field Values

SETTING_PERMIT_ALL_AE_TITLES_NAME

public static final java.lang.String SETTING_PERMIT_ALL_AE_TITLES_NAME

The name of the setting that indicates the Permit All AE Titles.

See Also:

Constant Field Values

SETTING_CLIENT_PERMIT_ACCESS_LIST_NAME

public static final java.lang.String SETTING_CLIENT_PERMIT_ACCESS_LIST_NAME

The name of the setting that indicates the Client Permit Access List.

See Also:

Constant Field Values

SETTING_SOP_CLASS_ACCEPT_ALL_NAME

public static final java.lang.String SETTING_SOP_CLASS_ACCEPT_ALL_NAME

The name of the setting that indicates if Accept All SOP Classes.

See Also:

Constant Field Values

SETTING_SOP_CLASS_GLOBAL_TRANSFER_STORAGE_NAME

public static final java.lang.String SETTING_SOP_CLASS_GLOBAL_TRANSFER_STORAGE_NAME

The name of the setting that indicates the Global Transfer Storage settings.

See Also:

Constant Field Values

SETTING_INDEXING_EFFORT_HELP

public static final java.lang.String SETTING_INDEXING_EFFORT_HELP

The help of the Indexing Effort setting.

See Also:

Constant Field Values

SETTING_SERVER_AE_TITLE_HELP

public static final java.lang.String SETTING_SERVER_AE_TITLE_HELP

The help for the setting that indicates the Server AE Title.

See Also:

Constant Field Values

SETTING_PERMIT_ALL_AE_TITLES_HELP

public static final java.lang.String SETTING_PERMIT_ALL_AE_TITLES_HELP

The help of the setting that indicates the Permit All AE Titles.

See Also:

Constant Field Values

SETTING_CLIENT_PERMIT_ACCESS_LIST_HELP

public static final java.lang.String SETTING_CLIENT_PERMIT_ACCESS_LIST_HELP

The help for the setting that indicates the Client Permit Access List.

See Also:

Constant Field Values

Method Detail

getInstance

public static Dicoogle getInstance()

Returns the current instance of this class.

Returns:

the current instance of this class.

getIndexingSettings

public java.util.HashMap<java.lang.String,java.lang.Object> getIndexingSettings()

Returns a Map containing the current settings.

Returns:

a Map containing the current settings.

getIndexingSettingsHelp

public java.util.HashMap<java.lang.String,java.lang.String> getIndexingSettingsHelp()

Returns the settings help.

Returns:

a HashMap containing the setting help.

tryIndexingSettings

public boolean tryIndexingSettings(java.util.HashMap<java.lang.String,java.lang.Object> map)
                            throws InvalidSettingValueException

Validates the settings supplied and checks if they are valid ones.

Parameters:

map - a Map containing the settings.

Returns:

true if all the settings are valid.

Throws:

InvalidSettingValueException - if at least one of the settings is invalid.

setIndexingSettings

public boolean setIndexingSettings(java.util.HashMap<java.lang.String,java.lang.Object> settings)

Tries to set the supplied settings as the new settings.

Parameters:

settings - a Map containing the new settings.

Returns:

true if all settings were successfully changed to the ones supplied, false otherwise (no settings changed).

getAccessListSettings

public java.util.HashMap<java.lang.String,java.lang.Object> getAccessListSettings()

Returns a Map containing the current settings.

Returns:

a Map containing the current settings.

getAccessListSettingsHelp

public java.util.HashMap<java.lang.String,java.lang.String> getAccessListSettingsHelp()

Returns the settings help.

Returns:

a HashMap containing the setting help.

tryAccessListSettings

public boolean tryAccessListSettings(java.util.HashMap<java.lang.String,java.lang.Object> map)
                              throws InvalidSettingValueException

Validates the settings supplied and checks if they are valid ones.

Parameters:

map - a Map containing the settings.

Returns:

true if all the settings are valid.

Throws:

InvalidSettingValueException - if at least one of the settings is invalid.

setAccessListSettings

public boolean setAccessListSettings(java.util.HashMap<java.lang.String,java.lang.Object> settings)

Tries to set the supplied settings as the new settings.

Parameters:

settings - a Map containing the new settings.

Returns:

true if all settings were successfully changed to the ones supplied, false otherwise (no settings changed).

getSOPClassGlobalSettings

public java.util.HashMap<java.lang.String,java.lang.Object> getSOPClassGlobalSettings()

Returns a Map containing the current settings.

Returns:

a Map containing the current settings.

getSOPClassGlobalSettingsHelp

public java.util.HashMap<java.lang.String,java.lang.String> getSOPClassGlobalSettingsHelp()

Returns the settings help.

Returns:

a HashMap containing the setting help.

trySOPClassGlobalSettings

public boolean trySOPClassGlobalSettings(java.util.HashMap<java.lang.String,java.lang.Object> map)
                                  throws InvalidSettingValueException

Validates the settings supplied and checks if they are valid ones.

Parameters:

map - a Map containing the settings.

Returns:

true if all the settings are valid.

Throws:

InvalidSettingValueException - if at least one of the settings is invalid.

setSOPClassGlobalSettings

public boolean setSOPClassGlobalSettings(java.util.HashMap<java.lang.String,java.lang.Object> settings)

Tries to set the supplied settings as the new settings.

Parameters:

settings - a Map containing the new settings.

Returns:

true if all settings were successfully changed to the ones supplied, false otherwise (no settings changed).

getTransferSettingsForSOPClass

public java.lang.Object[] getTransferSettingsForSOPClass(java.lang.String sopClassUID)

Returns a StaticDataTable containing the TransferStorages for a specific SOP Class UID.

Parameters:

sopClassUID - a SOP Class UID.

Returns:

an Object array containing as first elements a Boolean object indicating if this SOP Class is accepted and as second element a StaticDataTable that contains the TransferStorages for this specific SOP Class UID.

getTransferSettingsForAllSOPClasses

public java.lang.Object[] getTransferSettingsForAllSOPClasses()

Returns a StaticDataTable containing the TransferStorages settings for all SOP Classes UIDs.

Returns:

an Object array containing as first elements a Boolean object indicating if all SOP Classes are accepted and as second element a StaticDataTable that contains the TransferStorages for all SOP Classes UIDs.

setTransferSettingsForSOPClass

public void setTransferSettingsForSOPClass(java.lang.String sopClassUID,
                                           java.lang.Boolean accepted,
                                           StaticDataTable table)

Applies the Transfer Storage settings present on a StaticDataTable to a specific SOP Class UID.

Parameters:

sopClassUID - the target SOP Class UID.

accepted - if the SOP Class UID is accepted. Can be null and if so, the target accepted value will remain the same.

table - a StaticDataTable with the Transfer Storage settings.

setTransferSettingsForAllSOPClasses

public void setTransferSettingsForAllSOPClasses(java.lang.Boolean accepted,
                                                StaticDataTable table)

Applies the Transfer Storage settings present on a StaticDataTable to all SOP Classes UIDs.

Parameters:

accepted - if all SOP Classes UIDs are accepted. Can be null and if so, the target accepted value will remain the same.

table - a StaticDataTable with the Transfer Storage settings.