com.ontimize.gui

Interface RemotelyManageable

All Superinterfaces:

Remote

All Known Implementing Classes:

DelegationPermissionReferenceLocator, DelegationSecurePermissionSecureReferenceLocator, PermissionReferenceLocator, PermissionSecureReferenceLocator, ReferenceLocator, SecureReferenceLocator

public interface RemotelyManageable
extends Remote

Field Summary

Fields

Modifier and Type	Field and Description
static String	ADMINISTRATION_PERMISSION
static String	CONNECTION_INFO
static String	IS_MULTICONNECTION
static String	LOADED_ENTITIES
static String	MULTICONNECTION_IDLIST
static String	MULTICONNECTION_INFO

Method Summary

Methods

Modifier and Type	Method and Description
void	closeLockedConnections(String id, String databaseId)
boolean	closeSession(String id, int sessionId) This method close the user's session with the given sessionID.
void	finishAdministrationRemoteSession(String id) Method that finishes the remote session.
boolean	getDEBUGValueRemote(String id, String v) Method to obtain the current value of the DEBUG Server variables.
String	getLastNCharactersFromLogFile(int nCharacters) Method that recovers the n characters indicated from the log file.
IRemoteLogManager	getRemoteLogManager(String id)
Properties	getRemotePreferencesFile(String id) Method to get remotely the Server Preferences file.
SessionInfo[]	getSessionInfo(String id) This method returns the main information of all available user's sessions.
Hashtable	getStartSessionTime(String id) This method obtains a list with all the start times of all connections.
Hashtable	getSystemInfo(String id, String key) Method that returns system information about the connection with the database.
Hashtable	getUserIds(String id) This method returns a Hashtable with the current list of users's IDs.
boolean	ping() unimplemented.
void	removeEntity(String id, String entityName)
void	restartServer(String id)
void	setDEBUGValueRemote(String id, String v, boolean b) Method to set the DEBUG Server variables.
void	setRemotePreferencesFile(String id, Properties prop) Method to set remotely the Server Preferences file.
String	startAdministrationRemoteSession(String user, String password) This method starts a new remote session.
void	stopServer(String id)

Field Detail

CONNECTION_INFO

static final String CONNECTION_INFO

See Also:

Constant Field Values

IS_MULTICONNECTION

static final String IS_MULTICONNECTION

See Also:

Constant Field Values

MULTICONNECTION_IDLIST

static final String MULTICONNECTION_IDLIST

See Also:

Constant Field Values

MULTICONNECTION_INFO

static final String MULTICONNECTION_INFO

See Also:

Constant Field Values

LOADED_ENTITIES

static final String LOADED_ENTITIES

See Also:

Constant Field Values

ADMINISTRATION_PERMISSION

static final String ADMINISTRATION_PERMISSION

See Also:

Constant Field Values

Method Detail

startAdministrationRemoteSession

String startAdministrationRemoteSession(String user,
                                      String password)
                                        throws Exception

This method starts a new remote session. It returns a String that are going to be the ID that allows to perform any remote action in the server.

Parameters:

user - String with the user.

password - String with the password.

Returns:

a String with the administrator id of the remote session.

Throws:

Exception

closeSession

boolean closeSession(String id,
                   int sessionId)
                     throws Exception

This method close the user's session with the given sessionID.

Parameters:

id - String with the administrator id of the remote session.

sessionId - int with the session id of the user's session.

Returns:

a boolean with the result of the operation.

Throws:

Exception

getStartSessionTime

Hashtable getStartSessionTime(String id)
                              throws Exception

This method obtains a list with all the start times of all connections.

Parameters:

id - String with the administrator id of the remote session.

Returns:

a Hashtable with the values.

Throws:

Exception

getSessionInfo

SessionInfo[] getSessionInfo(String id)
                             throws Exception

This method returns the main information of all available user's sessions. The information available of each session is:

• SessionID. The sessionID
• User. The user of the session.
• InitSessionDate. The time of the beginning of the session.
• From. The host where the session has been started.
• LastAccess. The time of the last access.

Parameters:

id - String with the administrator id of the remote session.

Returns:

a SessionInfo[] with the information of the sessions.

Throws:

Exception

getSystemInfo

Hashtable getSystemInfo(String id,
                      String key)
                        throws Exception

Method that returns system information about the connection with the database. The keys to request information are stored into static variables in the class RemoteUtilities. The available keys are:

key	meaning
CONNECTION_INFO	To get the connection information when exist only one connection.
IS_MULTICONNECTION	To know if multiconnection is available. Returns a String "true" or "false".
MULTICONNECTION_IDLIST	To get the list of Strings with the identification of the connections.
MULTICONNECTION_INFO	To get the connection information of all connections available.

NOTE: the connection information contains into the Hashtable returned is:

• the number of connections with the database.
• the number of locked connections.
• the amount of locked time.
• the maximum locked time.

Parameters:

id - String with the administrator id of the remote session.

key - String indicating what information you wish to request.

Returns:

a Hashtable with the values.

Throws:

Exception

getUserIds

Hashtable getUserIds(String id)
                     throws Exception

This method returns a Hashtable with the current list of users's IDs.

Parameters:

id - String with the administrator id of the remote session.

Returns:

a Hashtable with the user's IDs.

Throws:

Exception

stopServer

void stopServer(String id)
                throws Exception

Throws:

Exception

restartServer

void restartServer(String id)
                   throws Exception

Throws:

Exception

finishAdministrationRemoteSession

void finishAdministrationRemoteSession(String id)
                                       throws Exception

Method that finishes the remote session.

Parameters:

id - String with the administrator id of the remote session.

Throws:

Exception

getLastNCharactersFromLogFile

String getLastNCharactersFromLogFile(int nCharacters)
                                     throws Exception

Method that recovers the n characters indicated from the log file. If a -1 is passed as parameter the method returns the entire log file.

Parameters:

nCharacters - int with the number of characters that will be recovered.

Returns:

a String with the characters of the log file.

Throws:

Exception

ping

boolean ping()
             throws Exception

unimplemented.

Returns:

Throws:

Exception

setDEBUGValueRemote

void setDEBUGValueRemote(String id,
                       String v,
                       boolean b)
                         throws Exception

Method to set the DEBUG Server variables.

Parameters:

id - String with the administrator id of the remote session.

v - String with the name of the variable.

b - Boolean with the value.

Throws:

Exception

getDEBUGValueRemote

boolean getDEBUGValueRemote(String id,
                          String v)
                            throws Exception

Method to obtain the current value of the DEBUG Server variables.

Parameters:

id - String with the administrator id of the remote session.

v - String with the name of the variable.

Returns:

a boolean with the value of the indicated variable.

Throws:

Exception

getRemotePreferencesFile

Properties getRemotePreferencesFile(String id)
                                    throws Exception

Method to get remotely the Server Preferences file.

Parameters:

id - String with the administrator id of the remote session.

Returns:

a Properties with the preferences.

Throws:

Exception

setRemotePreferencesFile

void setRemotePreferencesFile(String id,
                            Properties prop)
                              throws Exception

Method to set remotely the Server Preferences file.

Parameters:

id - String with the administrator id of the remote session.

prop - The properties file to be established. This file will contain the structure of pair values: key-value.

Throws:

Exception

removeEntity

void removeEntity(String id,
                String entityName)
                  throws Exception

Throws:

Exception

closeLockedConnections

void closeLockedConnections(String id,
                          String databaseId)
                            throws Exception

Throws:

Exception

getRemoteLogManager

IRemoteLogManager getRemoteLogManager(String id)
                                      throws Exception

Throws:

Exception