pt.ua.dicoogle.server.web.management

Class Services

java.lang.Object

pt.ua.dicoogle.server.web.management.Services

public class Services
extends java.lang.Object

A wrapper used to manage the services and plugins remotely through the web environment/app.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	ACTION_INIT_START
static java.lang.String	ACTION_SET_ADVANCED_SETTINGS
static java.lang.String	ACTION_SET_PORT
static java.lang.String	ACTION_START Textual representation of the actions available.
static java.lang.String	ACTION_STOP
static java.lang.String	PARAM_ACTION Textural representation of the params available.
static java.lang.String	PARAM_INIT_START
static java.lang.String	PARAM_PORT
static java.lang.String	PARAM_SERVICE
static java.lang.String	queryRetrieveName
static java.lang.String	remoteGUIName
static int	RES_INVALID_ACTION
static int	RES_INVALID_ACTION_PARAMETER
static int	RES_INVALID_SERVICE_NAME
static int	RES_NO_ACTION The results indicating what was wrong with a performAction call.
static int	RES_NO_SERVICE_NAME
static int	RES_OK
static int	RES_WARNING
static java.lang.String	storageName The embedded services name.
static int	SVC_INIT_START
static int	SVC_NO_ACTION Types of actions to perform.
static int	SVC_SET_PORT
static int	SVC_SET_SETTINGS
static int	SVC_START
static int	SVC_STOP
static java.lang.String	webServerName
static java.lang.String	webServicesName

Method Summary

Modifier and Type	Method and Description
java.lang.String	getHTMLAdvancedSettingsFormRow(java.lang.String name, java.lang.Object value, java.lang.String help) Returns a row for the advanced settings form.
java.lang.String	getHTMLServiceAdvancedSettingsForm(HttpServletRequest request, java.lang.String brokerURL, java.lang.String elementID) Based on the request, returns a String containing a form with all the settings inputs boxes.
java.lang.String	getHTMLServiceManagementTable(java.lang.String brokerURL, java.lang.String advancedOptionsManagerURL) Deprecated.
java.lang.String	getHTMLServiceManagementTable(java.lang.String brokerURL, java.lang.String advancedOptionsManagerURL, java.lang.String id) Deprecated.
java.lang.String	getHTMLSettingHelp(java.lang.String fieldTitle, java.lang.String help)
static Services	getInstance() Returns the current instance of this class.
java.lang.String	getRequestServiceName(HttpServletRequest request) For a request, returns the name of the service/plugin required.
int	performAction(HttpServletRequest request) Performs a certain action to a service or plugin, and save the settings if needed.
int	performAction(int action, java.lang.String svcName, boolean initStart, int port, java.util.HashMap<java.lang.String,java.lang.String[]> advSettings) Deprecated.
java.util.HashMap<java.lang.String,java.lang.Object>	processAdvancedSettings(java.util.HashMap<java.lang.String,java.lang.Object> originalSettings, java.util.HashMap<java.lang.String,java.lang.String[]> newSettings) This converts and applies the new textual values into the originalSettings HashMap, taking into account their original class/type.
void	processServletRequest(HttpServletRequest request, HttpServletResponse response) Processes a request from a servlet to perform an action on a service or plugin.
int	processWebappRequest(HttpServletRequest request, HttpServletResponse response) Processes a request from a webapp to perform an action on a service or plugin.
int	queryRetrievePort() Returns the QueryRetrieve service port.
boolean	queryRetrieveStart() Return if the QueryRetrieve service is started initially.
java.lang.String	remoteGUIExtIP() Returns the RemoteGUI service external IP.
int	remoteGUIPort() Returns the RemoteGUI service port.
void	saveSettings() Saves the settings for use between server inits.
void	setQueryRetrievePort(int port) Sets the QueryRetrieve service port.
void	setQueryRetrieveStart(boolean start) Sets if the QueryRetrieve service is started initially.
void	setRemoteGUIExtIP(java.lang.String extIP) Sets the RemoteGUI service external IP.
void	setRemoteGUIPort(int port) Sets the RemoteGUI service port.
void	setStoragePort(int port) Sets the Storage service port.
void	setStorageStart(boolean start) Sets if the Storage service is started initially.
void	setWebServerPort(int port) Sets the WebServer service port.
void	setWebServerStart(boolean start) Sets if the WebServer service is started initially.
void	setWebServicesPort(int port) Sets the WebServices service port.
void	setWebServicesStart(boolean start) Sets if the WebServices service is started initially.
int	storagePort() Returns the Storage service port.
boolean	storageStart() Return if the Storage service is started initially.
int	webServerPort() Returns the WebServer service port.
boolean	webServerStart() Return if the WebServer service is started initially.
int	webServicesPort() Returns the WebServices service port.
boolean	webServicesStart() Return if the WebServices service is started initially.

Methods inherited from class java.lang.Object

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

Field Detail

SVC_NO_ACTION

public static final int SVC_NO_ACTION

Types of actions to perform.

See Also:

Constant Field Values

SVC_START

public static final int SVC_START

See Also:

Constant Field Values

SVC_STOP

public static final int SVC_STOP

See Also:

Constant Field Values

SVC_INIT_START

public static final int SVC_INIT_START

See Also:

Constant Field Values

SVC_SET_PORT

public static final int SVC_SET_PORT

See Also:

Constant Field Values

SVC_SET_SETTINGS

public static final int SVC_SET_SETTINGS

See Also:

Constant Field Values

ACTION_START

public static final java.lang.String ACTION_START

Textual representation of the actions available.

See Also:

Constant Field Values

ACTION_STOP

public static final java.lang.String ACTION_STOP

See Also:

Constant Field Values

ACTION_INIT_START

public static final java.lang.String ACTION_INIT_START

See Also:

Constant Field Values

ACTION_SET_PORT

public static final java.lang.String ACTION_SET_PORT

See Also:

Constant Field Values

ACTION_SET_ADVANCED_SETTINGS

public static final java.lang.String ACTION_SET_ADVANCED_SETTINGS

See Also:

Constant Field Values

PARAM_ACTION

public static final java.lang.String PARAM_ACTION

Textural representation of the params available.

See Also:

Constant Field Values

PARAM_SERVICE

public static final java.lang.String PARAM_SERVICE

See Also:

Constant Field Values

PARAM_INIT_START

public static final java.lang.String PARAM_INIT_START

See Also:

Constant Field Values

PARAM_PORT

public static final java.lang.String PARAM_PORT

See Also:

Constant Field Values

storageName

public static final java.lang.String storageName

The embedded services name.

See Also:

Constant Field Values

queryRetrieveName

public static final java.lang.String queryRetrieveName

See Also:

Constant Field Values

webServicesName

public static final java.lang.String webServicesName

See Also:

Constant Field Values

webServerName

public static final java.lang.String webServerName

See Also:

Constant Field Values

remoteGUIName

public static final java.lang.String remoteGUIName

See Also:

Constant Field Values

RES_NO_ACTION

public static final int RES_NO_ACTION

The results indicating what was wrong with a performAction call.

See Also:

Constant Field Values

RES_INVALID_ACTION

public static final int RES_INVALID_ACTION

See Also:

Constant Field Values

RES_NO_SERVICE_NAME

public static final int RES_NO_SERVICE_NAME

See Also:

Constant Field Values

RES_INVALID_SERVICE_NAME

public static final int RES_INVALID_SERVICE_NAME

See Also:

Constant Field Values

RES_INVALID_ACTION_PARAMETER

public static final int RES_INVALID_ACTION_PARAMETER

See Also:

Constant Field Values

RES_WARNING

public static final int RES_WARNING

See Also:

Constant Field Values

RES_OK

public static final int RES_OK

See Also:

Constant Field Values

Method Detail

getInstance

public static Services getInstance()

Returns the current instance of this class.

Returns:

the current instance of this class.

processAdvancedSettings

public java.util.HashMap<java.lang.String,java.lang.Object> processAdvancedSettings(java.util.HashMap<java.lang.String,java.lang.Object> originalSettings,
                                                                                    java.util.HashMap<java.lang.String,java.lang.String[]> newSettings)

This converts and applies the new textual values into the originalSettings HashMap, taking into account their original class/type. Only the settings that exist on both Maps are updated, this avoid invalid settings and Class type injections from happening.

Parameters:

originalSettings - the original advanced/internal settings of a plugin or service.

newSettings - the new settings to apply.

Returns:

the originalSettings HashMap with the new values in place (you can use the reference passed as originalSettings instead if you want, they will allways be the same).

performAction

@Deprecated
public int performAction(int action,
                                     java.lang.String svcName,
                                     boolean initStart,
                                     int port,
                                     java.util.HashMap<java.lang.String,java.lang.String[]> advSettings)

Deprecated.

Performs a certain action to a service or plugin.

Parameters:

action - the action to perform.

svcName - the name of the service or plugin to perform the action at.

initStart - the init-start param value.

port - the set-port param value.

advSettings - a HashMap with all the advanced settings and their values.

Returns:

an int value indicating what was wrong with the call (see Services.RES_* for values/name pairs)

performAction

public int performAction(HttpServletRequest request)
                  throws java.io.UnsupportedEncodingException

Performs a certain action to a service or plugin, and save the settings if needed.

Parameters:

request - the request object.

Returns:

an int value indicating what was wrong with the call (see Services.RES_* for values/name pairs).

Throws:

java.io.UnsupportedEncodingException

processServletRequest

public void processServletRequest(HttpServletRequest request,
                                  HttpServletResponse response)
                           throws java.io.IOException

Processes a request from a servlet to perform an action on a service or plugin.

Parameters:

request - the servlet request object.

response - the servlet response object.

Throws:

java.io.IOException - if there was an error while attempting to perform the requested action.

processWebappRequest

public int processWebappRequest(HttpServletRequest request,
                                HttpServletResponse response)
                         throws java.io.IOException

Processes a request from a webapp to perform an action on a service or plugin.

Parameters:

request - the webapp request object.

response - the webapp response object.

Returns:

an int value that represents theresult of the operation performed (see Services.RES_* for values/name pairs).

Throws:

java.io.IOException - if there was an error while attempting to perform the requested action.

getHTMLServiceManagementTable

@Deprecated
public java.lang.String getHTMLServiceManagementTable(java.lang.String brokerURL,
                                                                  java.lang.String advancedOptionsManagerURL,
                                                                  java.lang.String id)

Deprecated.

Returns an HTML String containing the list of all plugins and services available, their status and action that can be taken.

Parameters:

brokerURL - the URL of the service manager page (where the form will post data to).

advancedOptionsManagerURL - the URL of the plugin/service advanced/internal options manager.

id - the ID of this HTML element, can be null if not needed.

Returns:

an HTML String containing the list of all plugins and services available, their status and action that can be taken.

getHTMLServiceManagementTable

@Deprecated
public java.lang.String getHTMLServiceManagementTable(java.lang.String brokerURL,
                                                                  java.lang.String advancedOptionsManagerURL)

Deprecated.

Returns an HTML String containing the list of all plugins and services available, their status and action that can be taken.

Parameters:

brokerURL - the URL of the service manager page (where the form will post data to).

advancedOptionsManagerURL - the URL of the plugin/service advanced/internal options manager.

Returns:

an HTML String containing the list of all plugins and services available, their status and action that can be taken.

storageStart

public boolean storageStart()

Return if the Storage service is started initially.

Returns:

if the Storage service is started initially.

queryRetrieveStart

public boolean queryRetrieveStart()

Return if the QueryRetrieve service is started initially.

Returns:

if the QueryRetrieve service is started initially.

webServicesStart

public boolean webServicesStart()

Return if the WebServices service is started initially.

Returns:

if the WebServices service is started initially.

webServerStart

public boolean webServerStart()

Return if the WebServer service is started initially.

Returns:

if the WebServer service is started initially.

setStorageStart

public void setStorageStart(boolean start)

Sets if the Storage service is started initially.

Parameters:

start - if the Storage service is started initially.

setQueryRetrieveStart

public void setQueryRetrieveStart(boolean start)

Sets if the QueryRetrieve service is started initially.

Parameters:

start - if the QueryRetrieve service is started initially.

setWebServicesStart

public void setWebServicesStart(boolean start)

Sets if the WebServices service is started initially.

Parameters:

start - if the WebServices service is started initially.

setWebServerStart

public void setWebServerStart(boolean start)

Sets if the WebServer service is started initially.

Parameters:

start - if the WebServer service is started initially.

storagePort

public int storagePort()

Returns the Storage service port.

Returns:

the Storage service port.

queryRetrievePort

public int queryRetrievePort()

Returns the QueryRetrieve service port.

Returns:

the QueryRetrieve service port.

webServicesPort

public int webServicesPort()

Returns the WebServices service port.

Returns:

the WebServices service port.

webServerPort

public int webServerPort()

Returns the WebServer service port.

Returns:

the WebServer service port.

remoteGUIPort

public int remoteGUIPort()

Returns the RemoteGUI service port.

Returns:

the RemoteGUI service port.

remoteGUIExtIP

public java.lang.String remoteGUIExtIP()

Returns the RemoteGUI service external IP.

Returns:

the RemoteGUI service external IP.

setStoragePort

public void setStoragePort(int port)

Sets the Storage service port.

Parameters:

port - the Storage service port.

setQueryRetrievePort

public void setQueryRetrievePort(int port)

Sets the QueryRetrieve service port.

Parameters:

port - the QueryRetrieve service port.

setWebServicesPort

public void setWebServicesPort(int port)

Sets the WebServices service port.

Parameters:

port - the WebServices service port.

setWebServerPort

public void setWebServerPort(int port)

Sets the WebServer service port.

Parameters:

port - the WebServer service port.

setRemoteGUIPort

public void setRemoteGUIPort(int port)

Sets the RemoteGUI service port.

Parameters:

port - the RemoteGUI service port.

setRemoteGUIExtIP

public void setRemoteGUIExtIP(java.lang.String extIP)

Sets the RemoteGUI service external IP.

Parameters:

extIP - the RemoteGUI service external IP.

saveSettings

public void saveSettings()

Saves the settings for use between server inits.

getRequestServiceName

public java.lang.String getRequestServiceName(HttpServletRequest request)
                                       throws java.io.IOException

For a request, returns the name of the service/plugin required.

Parameters:

request - the servlet request object.

Returns:

the name of the service/plugin required.

Throws:

java.io.IOException

getHTMLSettingHelp

public java.lang.String getHTMLSettingHelp(java.lang.String fieldTitle,
                                           java.lang.String help)

getHTMLAdvancedSettingsFormRow

public java.lang.String getHTMLAdvancedSettingsFormRow(java.lang.String name,
                                                       java.lang.Object value,
                                                       java.lang.String help)

Returns a row for the advanced settings form.

Parameters:

name - the name of the setting.

value - the type/value of the setting.

help - s String containing a help notice for this setting, can be null if not needed.

Returns:

a String containing a HTML code to a row for the advanced settings form.

getHTMLServiceAdvancedSettingsForm

public java.lang.String getHTMLServiceAdvancedSettingsForm(HttpServletRequest request,
                                                           java.lang.String brokerURL,
                                                           java.lang.String elementID)
                                                    throws java.io.IOException

Based on the request, returns a String containing a form with all the settings inputs boxes. These boxes are rendered/specified in accordance with the each setting value type reported by the plugin/service.

Parameters:

request - the servlet request object.

brokerURL - the URL of the broker that will apply the settings after receiving this forms post.

elementID - the ID of this HTML form, can be null.

Returns:

a String containing the HTML structure for the form with all the plugin advanced setting.

Throws:

java.io.IOException