ReferenceLocator (ontimize-core 5.6.0 API)

java.lang.Object
- com.ontimize.locator.ReferenceLocator

All Implemented Interfaces:

RemoteApplicationPreferenceReferencer, RemotelyManageable, ClientReferenceLocator, EntityReferenceLocator, UtilReferenceLocator, LOk, RemoteReportReferencer, TokenLogin, INoticeSendMails, INoticeSystem, XMLClientProvider, XMLFormProvider, Remote, RMIFailureHandler

Direct Known Subclasses:

PermissionReferenceLocator
```
public class ReferenceLocator
extends Object
implements EntityReferenceLocator, RMIFailureHandler, RemotelyManageable, UtilReferenceLocator, RemoteReportReferencer, RemoteApplicationPreferenceReferencer, LOk, INoticeSystem, INoticeSendMails, XMLClientProvider, ClientReferenceLocator, TokenLogin
```
Standard implementation of EntityReferenceLocator.
This class implements a 'local' EntityReferenceLocator, where 'local' means that the object is instantiated and used in the client side. In this mode, the entity requests (and other requests) that this object receives are forwarded to a remote ReferenceLocator.
Also, the ReferenceLocator can be instantiated in nonlocal mode. In this way, the object will not forward requests but will process these requests itself.
This class implements the RMIFailureHandler interface for managing RMI failures. These failures are handled only if the value of the parameter 'CustomSocket' is yes.
*

Author:

Imatia Innovation

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`protected class`	`ReferenceLocator.DefaultClientSocketFactory` Inner class that implements a RMISocketFactory and manages reconnection in case of RMI failures.
`protected class`	`ReferenceLocator.DefaultSSLClientSocketFactory` Inner class that implements a RMISocketFactory with SSL communications and manages reconnection in case of RMI failures.

Nested classes/interfaces inherited from interface com.ontimize.locator.UtilReferenceLocator
UtilReferenceLocator.Message

Field Summary

Fields
Modifier and Type	Field and Description
`static boolean`	`askUserChangeTimezone` Configuration variable used when client and server have different time zones.
`static String`	`ATTACHMENT_ENTITY` AttachmentEntity property
`static String`	`ATTACHMENT_ENTITY_PATH` AttachmentEntityPath property
`protected String`	`attachmentEntity` The name of the entity for managing attachments
`protected Entity`	`attachmentEntityInstance`
`protected String`	`attachmentPath`
`static String`	`AUTONUMERICAL_PROPERTIES` AutonumericalProperties property
`protected JButton`	`b`
`protected int`	`chatCheckTime`
`protected JDialog`	`chatWindow`
`static String`	`CHECK_SERVER_MESSAGES_PERIOD` CheckServerMessagePeriod property
`protected Thread`	`checkMessagesThread`
`protected Thread`	`checkRemoteAdministrationMessagesThread`
`protected static String`	`CONTROL_ACCESS_ATTEMPTS`
`protected boolean`	`controlAccessAttempt`
`static String`	`CUSTOM_SOCKET` CustomSocket property
`protected ClientWatch`	`cw`
`protected DatabaseEntityManager`	`databaseEntityManager`
`static String`	`DB_PROPERTIES` DatabaseProperties property
`static boolean`	`DEBUG` For debugging purposes
`protected static String`	`defaultNoticeDestinyEntityClass`
`protected static String`	`defaultNoticeEntityClass`
`static boolean`	`defaultValueUseServerTimezone` Configuration variable used when client and server have different time zones.
`protected static String`	`DYNAMIC_LOCAL_ENTITY_PREFIX`
`protected static String`	`ENCRYPT_PROPERTY` com.ontimize.locator.ReferenceLocator.InitSession.Encrypt property.
`static String`	`ENTITIES_CLASS` EntityClass property
`static String`	`ENTITIES_PROPERTIES` EntityProperties property
`protected Hashtable`	`entitiesProperties`
`protected String`	`entitiesPropertiesClass`
`protected ErrorAccessControl`	`errorAccessControl`
`protected String`	`formManagerProviderEntity`
`protected String`	`formManagerProviderEntityFormNameColumn`
`protected String`	`formManagerProviderEntityIdColumn`
`protected String`	`formManagerProviderEntityInteractionManagerColumn`
`protected String`	`formProviderEntity`
`protected String`	`formProviderEntityFormNameColumn`
`protected String`	`formProviderEntityFormRuleColumn`
`protected String`	`formProviderEntityFormXMLColumn`
`protected String`	`imageProviderEntity`
`protected String`	`imageProviderEntityImageBytesColumn`
`protected String`	`imageProviderEntityImageNameColumn`
`static String`	`IMPOSSIBLE_CONNECT_TO_SERVER` 'Cannot connect to server' message key
`protected List`	`initReferences`
`protected boolean`	`installSocketFactory`
`protected String`	`key`
`protected long`	`lastRemoteReferenceCheck`
`protected Hashtable<String,Entity>`	`loadedEntities`
`static String`	`LOCAL` Local property
`static String`	`LOCAL_ENTITIES` LocalEntities property
`static String`	`LOCAL_ENTITIES_PACKAGE` LocalEntityPackage property
`static String`	`LOCALE_ENTITY`
`static String`	`LOCALE_SUFFIX`
`protected String`	`localeEntity`
`protected Vector`	`localEntities`
`protected String`	`localEntitiesPackage`
`protected String`	`localeSuffix`
`protected boolean`	`localLocator`
`protected LocalRemoteReportStore`	`localRemoteReportStore`
`static String`	`LOGIN_ENTITY` LoginEntity property
`protected String`	`loginEntity` The name of the entity used for login.
`static String`	`M_NOT_AUTHORIZED` 'Unauthorized user' message key
`protected DatabaseConnectionManager`	`manager`
`protected String`	`menuProviderEntity`
`protected String`	`menuProviderEntityXMLColumn`
`protected int`	`messagesCheckTime`
`protected Map<String,List<String>>`	`moduleLocalEntities`
`static String`	`MULTICONNECTION_MANAGER`
`protected boolean`	`multiConnectionManager`
`protected String`	`multiConnectionManagerPath`
`static boolean`	`NEW_CHAT`
`static String`	`NOTICE_ENTITY_DESTINY_NAME`
`static String`	`NOTICE_ENTITY_NAME` Removed noticeEntity because it is not necessary this variable cached.
`protected String`	`noticesPath`
`protected boolean`	`noticeSystem`
`protected static String`	`NUMBER_ACCESS_ATTEMPTS`
`protected int`	`numberAccessAttemps`
`protected static int`	`offset`
`protected static String`	`offsetString`
`static String`	`PACKAGE_OR_HOSTNAME` PackageOrHostname property
`protected String`	`packageA`
`protected int`	`port`
`static String`	`PORT` Port property
`protected Entity`	`printingTemplateEntityInstance`
`protected String`	`printingTemplatesEntity`
`protected int`	`privilegedId` An integer used when needed as privileged identifier for querying entities
`protected String`	`propertiesPath`
`protected boolean`	`reconnectState`
`protected static String`	`REFERENCE_ELEMENT`
`protected Hashtable`	`referenceClassNames`
`protected Hashtable`	`referenceInstances`
`protected Object`	`referenceLocatorServer`
`protected String`	`referenceLocatorServerName` Name of the object that contains the references of the server entities.
`protected Hashtable`	`referenceParameters`
`protected static String`	`REFERENCES_ELEMENT`
`static String`	`REMOTE_OBJECT_NOT_REGISTERED` 'Server not ready' message key
`static String`	`REMOTE_REFERENCE_LOCATOR_NAME` RemoteLocatorName property
`long`	`remoteReferenceCheckCycle`
`protected static Hashtable`	`remoteReferenceClassNames`
`protected static Hashtable`	`remoteReferenceInstances`
`protected static Hashtable`	`remoteReferenceParameters`
`static String`	`REPORT_ENTITIES` ReportEntities property
`protected List`	`reportEntities`
`protected ReportStore`	`reportStore`
`protected RemoteOperationManager`	`rOperationManager`
`protected JScrollPane`	`s`
`protected TimeZone`	`serverTimeZone`
`protected HashMap<Integer,Locale>`	`sessionLocale`
`protected HashMap<Integer,Object>`	`sessionLocaleId`
`static String`	`SSO_PATH`
`protected boolean`	`startSession`
`protected JTextArea`	`text`
`protected SimpleAttributeSet`	`textAttribute`
`protected String`	`toolbarProviderEntity`
`protected String`	`toolbarProviderEntityXMLColumn`
`static String`	`UNKNOWN_ERROR` 'Unknown error' message key
`static String`	`UNKNOWN_HOST` 'Unknown host' message key
`protected String`	`user`
`protected int`	`userId`
`static String`	`VIEWER` Viewer property
`protected String`	`xmlDynamicMenu`
`protected String`	`xmlDynamicToolbar`

Fields inherited from interface com.ontimize.gui.RemotelyManageable
ADMINISTRATION_PERMISSION, CONNECTION_INFO, IS_MULTICONNECTION, LOADED_ENTITIES, MULTICONNECTION_IDLIST, MULTICONNECTION_INFO

Constructor Summary

Constructors
Constructor and Description
`ReferenceLocator(boolean local, String entitiesPackageOrRMIServer, String entitiesReferenceServerName, int port, URL databasePropertiesURL, URL autonumericalURL)` When application runs in local mode, references to entities will be obtained with `Class.forName()` and for remote applications with RMI.
`ReferenceLocator(boolean local, String entitiesPackageOrRMIServer, String entityReferenceServerName, int port, URL databasePropURL, URL autonumericalURL, String loginEntity)`
`ReferenceLocator(Hashtable param)` Initializes parameters.

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`addModuleMemoryEntity(String localEntityPackage, List<String> localEntities)`
`void`	`blockUserDB(String user)`
`EntityResult`	`changePassword(String password, int sessionId, Hashtable av, Hashtable kv)`
`boolean`	`checkBlockUserDB(String user)`
`void`	`checkNoticeAsSend(Object noticeKey)` This method marks the specified notice as sent
`void`	`checkNoticeSent(int sessionId, Object noticeKey)` This method sets a notices as sent
`boolean`	`checkToken(String token)`
`void`	`closeLockedConnections(String id, String databaseId)`
`boolean`	`closeSession(String id, int sessionId)` This method close the user's session with the given sessionID.
`protected DatabaseConnectionManager`	`configureConnectionManager(boolean bStatisticViewer, boolean writeConnectionInfoFile, URL databasePropertiesURL, URL autonumericalURL)`
`protected void`	`configureMultiConnectionManager()`
`protected void`	`configureReference(Node currentNode)`
`protected void`	`configureReferences(String xmlDefinitionResource)` The constructor of each reference must have the next parameters: EntityReferenceLocator: locator reference.
`protected void`	`configureRemoteReferences(String xmlDefinitionResource)`
`protected DatabaseConnectionManager`	`createConnectionManager(boolean bStatisticViewer, boolean writeConnectionInfoFile, URL databasePropertiesURL, URL autonumericalURL)`
`protected DatabaseEntityManager`	`createDatabaseEntityManager(Hashtable param)`
`protected Entity`	`createDynamicLocalEntity(String entityName)`
`protected Entity`	`createMemoryEntity(String localEntityPackage, String entityName)`
`protected Object`	`createReference(String className, Hashtable parameters)`
`protected Object`	`createRemoteReference(String className, Hashtable parameters)`
`void`	`endSession(int id)` This method finishes a client session.
`protected void`	`ensureRemoteReferenceLocator()`
`boolean`	`failure(Exception e)`
`protected void`	`finalize()` Override the finalize method to guarantee the end of the open session.
`void`	`finishAdministrationRemoteSession(String id)` Method that finishes the remote session.
`boolean`	`getAccessControl()`
`Entity`	`getAttachmentEntity(int sessionId)`
`int`	`getChatCheckTime()` Get the time between two verifications of new chat messages
`List`	`getConnectedSessionIds(int sessionId)`
`List`	`getConnectedUsers(int sessionId)`
`DatabaseConnectionManager`	`getConnectionManager()`
`protected Hashtable`	`getContextParams(String password)`
`DatabaseConnectionManager`	`getDatabaseConnectionManager()`
`boolean`	`getDEBUGValueRemote(String id, String v)` Method to obtain the current value of the DEBUG Server variables.
`String`	`getDefaultPackage()`
`protected DatabaseConnectionManager`	`getEntityConnectionManager(String entityName)`
`Entity`	`getEntityReference(String entityName)` This method gets an entity reference.
`ErrorAccessControl`	`getErrorAccessControl()`
`Hashtable`	`getFormManagerParameters(String formManagerId, int userid)`
`BytesBlock`	`getImage(String image, int userId)`
`InitialContext`	`getInitialContext()`
`EntityResult`	`getInternalNotices(int sessionId, boolean unsend, boolean unread, boolean deleted)` Method to get all notices for the specified user.
`String`	`getLastNCharactersFromLogFile(int characterNumber)` Method that recovers the n characters indicated from the log file.
`String`	`getLContent()`
`Object`	`getLInfoObject()`
`List`	`getLoadedEntities(int sessionId)`
`Locale`	`getLocale(int sessionId)`
`String`	`getLocaleEntity()`
`Object`	`getLocaleId(int sessionId)`
`protected Entity`	`getLocalEntity(String entityName)`
`protected Entity`	`getLocalEntity(String entityName, boolean checkDatabase)`
`String`	`getLoginEntityName(int sessionId)` Get the name of the login entity (LoginEntity parameter)
`String`	`getLValue(String name)`
`protected Entity`	`getMemoryEntity(String entityName)`
`protected Entity`	`getMemoryEntity(String localEntityPackage, String entityName)`
`int`	`getMessageCheckTime()`
`Vector`	`getMessages(int sessionIdTo, int sessionId)`
`EntityResult`	`getNewMailNotice()` This method allows to get all e-mail notices not yet sent
`protected String`	`getNodeValue(Node son)`
`protected Entity`	`getNoticeEntity(String entityName, boolean isDestinyEntity)`
`String`	`getNoticeEntityDestinyName()` Get the name of the notice destiny entity
`String`	`getNoticeEntityName()` Get the name of the notice entity
`Vector`	`getNoticeTypes()` Get the identifies for all notices types in the application
`protected String`	`getPasswordFromCert(Certificate cert)`
`String`	`getPasswordFromCert(String stringCertificate)`
`Entity`	`getPrintingTemplateEntity(int sessionId)`
`protected Entity`	`getPrivateEntity(String entityName)` Deprecated. @see `getMemoryEntity(String)`
`Object`	`getReference(String name)` Allows to get local references defined in 'references.xml' file when app is built in local mode.
`Vector`	`getRemoteAdministrationMessages(int sessionIdTo, int sessionId)`
`RemoteApplicationPreferences`	`getRemoteApplicationPreferences(int sessionId)` Get the application preferences stored in the server side
`IRemoteLogManager`	`getRemoteLogManager(String id)`
`RemoteOperationManager`	`getRemoteOperationManager(int sessionId)`
`Properties`	`getRemotePreferencesFile(String id)` Method to get remotely the Server Preferences file.
`Object`	`getRemoteReference(String name, int sessionId)` Gets a remote reference.
`List`	`getRemoteReportStore(int sessionId)`
`List`	`getReportEntityNames(int sessionId)`
`EntityResult`	`getSentNotices(int sessionId, Boolean deleted)` Method to query all notices sent by the specified user
`TimeZone`	`getServerTimeZone(int sessionId)` Get the Server TimeZone.
`int`	`getSessionId()` If the user has started a session always return a not negative integer.
`SessionInfo[]`	`getSessionInfo(String id)` This method returns the main information of all available user's sessions.
`protected Entity`	`getSpecialEntity(String entityName, String originalEntity)`
`Hashtable`	`getStartSessionTime(String id)` This method obtains a list with all the start times of all connections.
`String`	`getSuffixString()`
`Hashtable`	`getSystemInfo(String id, String key)` Method that returns system information about the connection with the database.
`String`	`getToken()`
`String`	`getUser()` Get the current user name
`protected String`	`getUserFromCert(Certificate cert)`
`String`	`getUserFromCert(String stringCertificate)`
`Object`	`getUserId(int sessionId)` Get the identification of the user that must be stored in the notice system to identify this application user.
`Hashtable`	`getUserIds(String id)` This method returns a Hashtable with the current list of users's IDs.
`String`	`getXMLForm(String form, int userid)`
`String`	`getXMLMenu(int userid)`
`String`	`getXMLRules(String form, int userid)`
`String`	`getXMLToolbar(int userid)`
`boolean`	`hasChat()` True when the application has a chat configured
`protected void`	`initServerNotice(Hashtable params)`
`protected void`	`installClientRMIFailureHandler()`
`protected void`	`installRMISocketFactory()`
`static boolean`	`isAllowCertificateLogin()`
`boolean`	`isDevelopementL()`
`protected boolean`	`isDynamicLocalEntity(String entityName)`
`boolean`	`isLocalMode()`
`boolean`	`isMultiConnectionManager()`
`protected Entity`	`loadEntity(String entityName, boolean checkDatabase, DatabaseConnectionManager entityConnectionManager)`
`boolean`	`ok()`
`boolean`	`ok(String number)`
`boolean`	`ping()` unimplemented.
`void`	`reloadXMLMenu(int userid)`
`void`	`reloadXMLToolbar(int userid)`
`void`	`removeEntity(String entityName, int sessionId)`
`void`	`removeEntity(String id, String entityName)`
`void`	`removeReceivedNotices(int sessionId, Vector idNotices)` This method removes the specified received notices for the user with this session identifier.
`protected void`	`removeRemoteReferences()`
`void`	`removeSentNotices(int sessionId, Vector idNotices)` This method sets the specified notices as deleted
`void`	`restartServer(String id)`
`InitialContext`	`retrieveInitialContext(int sessionId, Hashtable params)`
`protected void`	`selectTimeZone()` Get the server time zone.
`void`	`sendMessage(String message, String user, int sessionId)`
`void`	`sendMessage(UtilReferenceLocator.Message message, String user, int sessionId)`
`void`	`sendMessageToAll(String message, int sessionId)`
`void`	`sendNotice(Hashtable messageValues, int sessionId, boolean request)` Method used to send notices.
`void`	`sendRemoteAdministrationMessages(String message, int sessionId)`
`void`	`setDEBUGValueRemote(String id, String v, boolean b)` Method to set the DEBUG Server variables.
`protected void`	`setDefaultLocaleId(int sessionId)`
`void`	`setLocale(int sessionId, Locale locale)`
`void`	`setLocalEntities(Vector el)`
`void`	`setMultiConnectionManager(boolean multiConnectionManager)`
`void`	`setNoticesRead(int sessionId, Vector idNotices)` Method to set some notices as read
`void`	`setRemotePreferencesFile(String id, Properties prop)` Method to set remotely the Server Preferences file.
`void`	`setRemoteReportStore(ReportStore rs)`
`void`	`showMessageDialog(Component c)`
`Integer`	`ssoLogin(Boolean debug)`
`String`	`startAdministrationRemoteSession(String us, String pass)` This method starts a new remote session.
`protected void`	`startCheckMessagesThread()`
`protected void`	`startCheckRemoteAdministratorMessagesThread()`
`protected int`	`startLocalSession(String user, String password, ClientWatch cw)`
`protected int`	`startRemoteSession(String user, String password, ClientWatch cw)`
`int`	`startSession(String user, String password, ClientWatch client)` Start a new client session in local or remote mode.
`protected int`	`startUserPasswordSession(String user, String password, ClientWatch cw)`
`void`	`stopServer(String id)`
`boolean`	`supportChangePassword(String user, int sessionId)`
`int`	`testConnectionSpeed()` Bytes per second.
`int`	`testConnectionSpeed(int tam)`
`protected void`	`updateRemoteReferenceLocator()`
`protected void`	`waitServerForRestart(int maxTime)`

Methods inherited from class java.lang.Object
clone, equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

REMOTE_REFERENCE_LOCATOR_NAME
```
public static final String REMOTE_REFERENCE_LOCATOR_NAME
```
RemoteLocatorName property

See Also:
Constant Field Values

PACKAGE_OR_HOSTNAME
```
public static final String PACKAGE_OR_HOSTNAME
```
PackageOrHostname property

See Also:
Constant Field Values

LOCAL
```
public static final String LOCAL
```
Local property

See Also:
Constant Field Values

CHECK_SERVER_MESSAGES_PERIOD
```
public static final String CHECK_SERVER_MESSAGES_PERIOD
```
CheckServerMessagePeriod property

See Also:
Constant Field Values

CUSTOM_SOCKET
```
public static final String CUSTOM_SOCKET
```
CustomSocket property

See Also:
Constant Field Values

ATTACHMENT_ENTITY_PATH
```
public static final String ATTACHMENT_ENTITY_PATH
```
AttachmentEntityPath property

See Also:
Constant Field Values

ATTACHMENT_ENTITY
```
public static final String ATTACHMENT_ENTITY
```
AttachmentEntity property

See Also:
Constant Field Values

REPORT_ENTITIES
```
public static final String REPORT_ENTITIES
```
ReportEntities property

See Also:
Constant Field Values

ENTITIES_CLASS
```
public static final String ENTITIES_CLASS
```
EntityClass property

See Also:
Constant Field Values

ENTITIES_PROPERTIES
```
public static final String ENTITIES_PROPERTIES
```
EntityProperties property

See Also:
Constant Field Values

VIEWER
```
public static final String VIEWER
```
Viewer property

See Also:
Constant Field Values

LOGIN_ENTITY
```
public static final String LOGIN_ENTITY
```
LoginEntity property

See Also:
Constant Field Values

LOCAL_ENTITIES_PACKAGE
```
public static final String LOCAL_ENTITIES_PACKAGE
```
LocalEntityPackage property

See Also:
Constant Field Values

LOCAL_ENTITIES
```
public static final String LOCAL_ENTITIES
```
LocalEntities property

See Also:
Constant Field Values

PORT
```
public static final String PORT
```
Port property

See Also:
Constant Field Values

DB_PROPERTIES
```
public static final String DB_PROPERTIES
```
DatabaseProperties property

See Also:
Constant Field Values

DYNAMIC_LOCAL_ENTITY_PREFIX

protected static final String DYNAMIC_LOCAL_ENTITY_PREFIX

See Also:: Constant Field Values

AUTONUMERICAL_PROPERTIES
```
public static final String AUTONUMERICAL_PROPERTIES
```
AutonumericalProperties property

See Also:
Constant Field Values

MULTICONNECTION_MANAGER

public static final String MULTICONNECTION_MANAGER

See Also:: Constant Field Values

NEW_CHAT
```
public static boolean NEW_CHAT
```

SSO_PATH
```
public static final String SSO_PATH
```
See Also:
Constant Field Values

defaultValueUseServerTimezone
```
public static boolean defaultValueUseServerTimezone
```
Configuration variable used when client and server have different time zones.
If askUserChangeTimezone is false this is the default value to use.
If defaultValueUseServerTimezone is true client time zone will be set to the server value

askUserChangeTimezone
```
public static boolean askUserChangeTimezone
```
Configuration variable used when client and server have different time zones.
If askUserChangeTimezone is true a configuration dialog is showed when client starts a new session to select the time zone

ENCRYPT_PROPERTY
```
protected static final String ENCRYPT_PROPERTY
```
com.ontimize.locator.ReferenceLocator.InitSession.Encrypt property. Can be established as a System Property with value 'true' for setting this object's encrypt variable to true.

See Also:
Constant Field Values

DEBUG
```
public static boolean DEBUG
```
For debugging purposes

IMPOSSIBLE_CONNECT_TO_SERVER
```
public static String IMPOSSIBLE_CONNECT_TO_SERVER
```
'Cannot connect to server' message key

REMOTE_OBJECT_NOT_REGISTERED
```
public static String REMOTE_OBJECT_NOT_REGISTERED
```
'Server not ready' message key

UNKNOWN_ERROR
```
public static String UNKNOWN_ERROR
```
'Unknown error' message key

UNKNOWN_HOST
```
public static String UNKNOWN_HOST
```
'Unknown host' message key

M_NOT_AUTHORIZED
```
public static String M_NOT_AUTHORIZED
```
'Unauthorized user' message key

loginEntity
```
protected String loginEntity
```
The name of the entity used for login. By default, 'User'

privilegedId
```
protected int privilegedId
```
An integer used when needed as privileged identifier for querying entities

attachmentEntity
```
protected String attachmentEntity
```
The name of the entity for managing attachments

attachmentPath
```
protected String attachmentPath
```

printingTemplatesEntity

protected String printingTemplatesEntity

propertiesPath
```
protected String propertiesPath
```

reconnectState
```
protected boolean reconnectState
```

cw
```
protected ClientWatch cw
```

localEntities
```
protected Vector localEntities
```

moduleLocalEntities

protected Map<String,List<String>> moduleLocalEntities

localEntitiesPackage
```
protected String localEntitiesPackage
```

offset
```
protected static int offset
```

offsetString
```
protected static String offsetString
```

entitiesPropertiesClass

protected String entitiesPropertiesClass

reportEntities
```
protected List reportEntities
```

serverTimeZone
```
protected TimeZone serverTimeZone
```

localLocator
```
protected boolean localLocator
```

packageA
```
protected String packageA
```

port
```
protected int port
```

loadedEntities

protected Hashtable<String,Entity> loadedEntities

startSession
```
protected boolean startSession
```

formProviderEntity
```
protected String formProviderEntity
```

formProviderEntityFormNameColumn

protected String formProviderEntityFormNameColumn

formProviderEntityFormXMLColumn

protected String formProviderEntityFormXMLColumn

formProviderEntityFormRuleColumn

protected String formProviderEntityFormRuleColumn

databaseEntityManager

protected DatabaseEntityManager databaseEntityManager

formManagerProviderEntity

protected String formManagerProviderEntity

formManagerProviderEntityIdColumn

protected String formManagerProviderEntityIdColumn

formManagerProviderEntityFormNameColumn

protected String formManagerProviderEntityFormNameColumn

formManagerProviderEntityInteractionManagerColumn

protected String formManagerProviderEntityInteractionManagerColumn

imageProviderEntity
```
protected String imageProviderEntity
```

imageProviderEntityImageNameColumn

protected String imageProviderEntityImageNameColumn

imageProviderEntityImageBytesColumn

protected String imageProviderEntityImageBytesColumn

menuProviderEntity
```
protected String menuProviderEntity
```

menuProviderEntityXMLColumn

protected String menuProviderEntityXMLColumn

toolbarProviderEntity
```
protected String toolbarProviderEntity
```

toolbarProviderEntityXMLColumn

protected String toolbarProviderEntityXMLColumn

referenceLocatorServerName
```
protected String referenceLocatorServerName
```
Name of the object that contains the references of the server entities.
This name was registered in the rmi server.

referenceLocatorServer

protected Object referenceLocatorServer

manager

protected DatabaseConnectionManager manager

user
```
protected String user
```

key
```
protected String key
```

userId
```
protected int userId
```

installSocketFactory
```
protected boolean installSocketFactory
```

chatWindow
```
protected JDialog chatWindow
```

b
```
protected JButton b
```

text
```
protected JTextArea text
```

s
```
protected JScrollPane s
```

messagesCheckTime
```
protected int messagesCheckTime
```

chatCheckTime
```
protected int chatCheckTime
```

checkMessagesThread
```
protected Thread checkMessagesThread
```

checkRemoteAdministrationMessagesThread

protected Thread checkRemoteAdministrationMessagesThread

entitiesProperties
```
protected Hashtable entitiesProperties
```

multiConnectionManager

protected boolean multiConnectionManager

multiConnectionManagerPath

protected String multiConnectionManagerPath

NOTICE_ENTITY_NAME
```
public static String NOTICE_ENTITY_NAME
```
Removed noticeEntity because it is not necessary this variable cached. It is just stored in loadedentities variable.

Since:

5.2073EN-0.3

NOTICE_ENTITY_DESTINY_NAME

public static String NOTICE_ENTITY_DESTINY_NAME

noticesPath
```
protected String noticesPath
```

noticeSystem
```
protected boolean noticeSystem
```

defaultNoticeEntityClass

protected static String defaultNoticeEntityClass

defaultNoticeDestinyEntityClass

protected static String defaultNoticeDestinyEntityClass

sessionLocale

protected HashMap<Integer,Locale> sessionLocale

sessionLocaleId

protected HashMap<Integer,Object> sessionLocaleId

LOCALE_ENTITY

public static final String LOCALE_ENTITY

See Also:: Constant Field Values

LOCALE_SUFFIX

public static final String LOCALE_SUFFIX

See Also:: Constant Field Values

CONTROL_ACCESS_ATTEMPTS

protected static final String CONTROL_ACCESS_ATTEMPTS

See Also:: Constant Field Values

NUMBER_ACCESS_ATTEMPTS

protected static final String NUMBER_ACCESS_ATTEMPTS

See Also:: Constant Field Values

localeEntity
```
protected String localeEntity
```

localeSuffix
```
protected String localeSuffix
```

controlAccessAttempt
```
protected boolean controlAccessAttempt
```

numberAccessAttemps
```
protected int numberAccessAttemps
```

errorAccessControl

protected ErrorAccessControl errorAccessControl

lastRemoteReferenceCheck

protected long lastRemoteReferenceCheck

remoteReferenceCheckCycle
```
public long remoteReferenceCheckCycle
```

attachmentEntityInstance

protected Entity attachmentEntityInstance

printingTemplateEntityInstance

protected Entity printingTemplateEntityInstance

textAttribute

protected SimpleAttributeSet textAttribute

reportStore
```
protected ReportStore reportStore
```

localRemoteReportStore

protected LocalRemoteReportStore localRemoteReportStore

xmlDynamicMenu
```
protected String xmlDynamicMenu
```

xmlDynamicToolbar
```
protected String xmlDynamicToolbar
```

rOperationManager

protected RemoteOperationManager rOperationManager

remoteReferenceClassNames

protected static Hashtable remoteReferenceClassNames

remoteReferenceParameters

protected static Hashtable remoteReferenceParameters

remoteReferenceInstances

protected static Hashtable remoteReferenceInstances

referenceClassNames

protected Hashtable referenceClassNames

referenceParameters

protected Hashtable referenceParameters

referenceInstances
```
protected Hashtable referenceInstances
```

initReferences
```
protected List initReferences
```

REFERENCES_ELEMENT

protected static final String REFERENCES_ELEMENT

See Also:: Constant Field Values

REFERENCE_ELEMENT

protected static final String REFERENCE_ELEMENT

See Also:: Constant Field Values

Constructor Detail

ReferenceLocator

public ReferenceLocator(Hashtable param)

Initializes parameters.

Parameters:

param - the Hashtable with parameters

attribute	values	default	required	meaning
PackageOrHostname			yes	Entity package(for remote applications) and host name (for local applications).
RemoteLocatorName			no	Remote locator register name.
LoginEntity		User	no	Login entity name, this entity must contains a column 'User_' and a column'Password'.
DatabaseProperties			yes	Database properties configuration file
AutonumericalProperties			no	Autonumerical configuration file.
Port			yes	Locator port.
CustomSocket	yes/no		no	Indicates when RMI failures are handled by RMIFailureHandler interface implemented in this class.
LocalEntities	localent1;localent2;...;localentn		no	Names of the entities that must be loaded in local mode (used for entities in local memory)
LocalEntityPackage			no	Package of the entities that must be loaded in local mode (used for entities in local memory)
CheckServerMessagePeriod			no	For Ontimize chat utility. Default value -1, if this parameter has this default value, messages are not checked.
EntityProperties			no	This parameter specifies the properties file that contains the definition of some entities. This entities are implemented with `TableEntity` class and will be automatically generated. Each line in this file represents one entity.
ReportEntities			no	Entity names list for the report designer. Default value is empty. Format is: "entity_name:entity_properties_file".
LocaleEntity			no	Specify the locale entity (Which extends from LocaleEntity)
ControlAccessAttempts	true/false	false	no	'true' to block an user when insert its password 5 times wrong. Otherwise 'false' or if the property don't exist

ReferenceLocator

public ReferenceLocator(boolean local,
                String entitiesPackageOrRMIServer,
                String entitiesReferenceServerName,
                int port,
                URL databasePropertiesURL,
                URL autonumericalURL)

When application runs in local mode, references to entities will be obtained with Class.forName() and for remote applications with RMI.

ReferenceLocator

public ReferenceLocator(boolean local,
                String entitiesPackageOrRMIServer,
                String entityReferenceServerName,
                int port,
                URL databasePropURL,
                URL autonumericalURL,
                String loginEntity)

Method Detail

isAllowCertificateLogin

public static boolean isAllowCertificateLogin()

getInitialContext
```
public InitialContext getInitialContext()
```
Specified by:

getInitialContext in interface ClientReferenceLocator

isMultiConnectionManager

public boolean isMultiConnectionManager()

setMultiConnectionManager

public void setMultiConnectionManager(boolean multiConnectionManager)

createDatabaseEntityManager

protected DatabaseEntityManager createDatabaseEntityManager(Hashtable param)
                                                     throws Exception

Throws:: Exception

isDynamicLocalEntity

protected boolean isDynamicLocalEntity(String entityName)

createDynamicLocalEntity

protected Entity createDynamicLocalEntity(String entityName)
                                   throws Exception

Throws:: Exception

getEntityReference
```
public Entity getEntityReference(String entityName)
                          throws Exception
```
Description copied from interface: EntityReferenceLocator

This method gets an entity reference.

Specified by:

getEntityReference in interface EntityReferenceLocator

Parameters:
entityName - Entity name

Returns:

Throws:

Exception

removeEntity

public void removeEntity(String entityName,
                int sessionId)
                  throws Exception

Specified by:: removeEntity in interface UtilReferenceLocator
Throws:: Exception

getLoadedEntities
```
public List getLoadedEntities(int sessionId)
                       throws Exception
```
Specified by:

getLoadedEntities in interface UtilReferenceLocator

Throws:

Exception

getPrivateEntity

@Deprecated
protected Entity getPrivateEntity(String entityName)
                           throws Exception

Deprecated. @see getMemoryEntity(String)

Parameters:: entityName -
Returns:
Throws:: Exception

getMemoryEntity

protected Entity getMemoryEntity(String entityName)
                          throws Exception

Throws:: Exception

getMemoryEntity

protected Entity getMemoryEntity(String localEntityPackage,
                     String entityName)
                          throws Exception

Throws:: Exception

createMemoryEntity

protected Entity createMemoryEntity(String localEntityPackage,
                        String entityName)
                             throws Exception

Throws:: Exception

addModuleMemoryEntity

public void addModuleMemoryEntity(String localEntityPackage,
                         List<String> localEntities)

getSpecialEntity

protected Entity getSpecialEntity(String entityName,
                      String originalEntity)

getNoticeEntity

protected Entity getNoticeEntity(String entityName,
                     boolean isDestinyEntity)

getLocalEntity

protected Entity getLocalEntity(String entityName)
                         throws Exception

Throws:: Exception

getLocalEntity

protected Entity getLocalEntity(String entityName,
                    boolean checkDatabase)
                         throws Exception

Throws:: Exception

getEntityConnectionManager

protected DatabaseConnectionManager getEntityConnectionManager(String entityName)

loadEntity

protected Entity loadEntity(String entityName,
                boolean checkDatabase,
                DatabaseConnectionManager entityConnectionManager)
                     throws Exception

Throws:: Exception

startSession
```
public int startSession(String user,
               String password,
               ClientWatch client)
                 throws Exception
```
Start a new client session in local or remote mode.
If the application has remote server this method calls it.
In local mode the method needs to know the user entity (LoginEntity parameter) to make a query looking for the specified user and password (with keys 'User_' and 'Password' in the Hashtable used in the {#@link Entity.query(Hashtable, Vector, int) method). If this query return one record te session starts.

Specified by:

startSession in interface EntityReferenceLocator

Parameters:
user - User name
password - User password
client - Object to checks if this session is open

Returns:
Integer value not negative used to identifier this client and allows him to get entity references

Throws:

Exception

setDefaultLocaleId

protected void setDefaultLocaleId(int sessionId)

selectTimeZone
```
protected void selectTimeZone()
```
Get the server time zone.
When server and client have different time zones select one to use in the client
This depends on askUserChangeTimezone and defaultValueUseServerTimezone values

startLocalSession

protected int startLocalSession(String user,
                    String password,
                    ClientWatch cw)
                         throws Exception

Throws:: Exception

startUserPasswordSession

protected int startUserPasswordSession(String user,
                           String password,
                           ClientWatch cw)
                                throws Exception

Throws:: Exception

ensureRemoteReferenceLocator

protected void ensureRemoteReferenceLocator()
                                     throws Exception

Throws:: Exception

removeRemoteReferences

protected void removeRemoteReferences()

startRemoteSession

protected int startRemoteSession(String user,
                     String password,
                     ClientWatch cw)
                          throws Exception

Throws:: Exception

getSessionId
```
public int getSessionId()
```
If the user has started a session always return a not negative integer.

Specified by:

getSessionId in interface EntityReferenceLocator

Returns:
Client session identifier.

endSession
```
public void endSession(int id)
                throws Exception
```
Description copied from interface: EntityReferenceLocator

This method finishes a client session. When this method is called, the entity reference locator does not provide more entity references to this client identifier.

Specified by:

endSession in interface EntityReferenceLocator

Parameters:
id - Client session identifier

Throws:

Exception

getUser
```
public String getUser()
```
Description copied from interface: ClientReferenceLocator

Get the current user name

Specified by:

getUser in interface ClientReferenceLocator

Returns:

finalize
```
protected void finalize()
                 throws Throwable
```
Override the finalize method to guarantee the end of the open session.

Overrides:

finalize in class Object

Throws:

Throwable

isLocalMode
```
public boolean isLocalMode()
```

testConnectionSpeed
```
public int testConnectionSpeed()
```
Bytes per second. The compression threshold establishes if remote locator support it. The threshold establishes calculating the compression and transmission time. The better way is execute this in a separated thread because test a EntityResult with 25kb approximately.

testConnectionSpeed

public int testConnectionSpeed(int tam)

installRMISocketFactory

protected void installRMISocketFactory()

installClientRMIFailureHandler

protected void installClientRMIFailureHandler()

failure
```
public boolean failure(Exception e)
```
Specified by:

failure in interface RMIFailureHandler

setLocalEntities

public void setLocalEntities(Vector el)

updateRemoteReferenceLocator

protected void updateRemoteReferenceLocator()
                                     throws Exception

Throws:: Exception

getSessionInfo
```
public SessionInfo[] getSessionInfo(String id)
                             throws Exception
```
Description copied from interface: RemotelyManageable
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.
Specified by:

getSessionInfo in interface RemotelyManageable

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

Returns:
a SessionInfo[] with the information of the sessions.

Throws:

Exception

getLastNCharactersFromLogFile
```
public String getLastNCharactersFromLogFile(int characterNumber)
                                     throws Exception
```
Description copied from interface: RemotelyManageable

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.

Specified by:

getLastNCharactersFromLogFile in interface RemotelyManageable

Parameters:
characterNumber - int with the number of characters that will be recovered.

Returns:
a String with the characters of the log file.

Throws:

Exception

finishAdministrationRemoteSession
```
public void finishAdministrationRemoteSession(String id)
                                       throws Exception
```
Description copied from interface: RemotelyManageable

Method that finishes the remote session.

Specified by:

finishAdministrationRemoteSession in interface RemotelyManageable

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

Throws:

Exception

restartServer
```
public void restartServer(String id)
                   throws Exception
```
Specified by:

restartServer in interface RemotelyManageable

Throws:

Exception

waitServerForRestart

protected void waitServerForRestart(int maxTime)

stopServer
```
public void stopServer(String id)
                throws Exception
```
Specified by:

stopServer in interface RemotelyManageable

Throws:

Exception

getUserIds
```
public Hashtable getUserIds(String id)
                     throws Exception
```
Description copied from interface: RemotelyManageable

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

Specified by:

getUserIds in interface RemotelyManageable

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

Returns:
a Hashtable with the user's IDs.

Throws:

Exception

getConnectedUsers
```
public List getConnectedUsers(int sessionId)
                       throws Exception
```
Specified by:

getConnectedUsers in interface UtilReferenceLocator

Throws:

Exception

getConnectedSessionIds
```
public List getConnectedSessionIds(int sessionId)
                            throws Exception
```
Specified by:

getConnectedSessionIds in interface UtilReferenceLocator

Throws:

Exception

getStartSessionTime
```
public Hashtable getStartSessionTime(String id)
                              throws Exception
```
Description copied from interface: RemotelyManageable

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

Specified by:

getStartSessionTime in interface RemotelyManageable

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

Returns:
a Hashtable with the values.

Throws:

Exception

closeSession
```
public boolean closeSession(String id,
                   int sessionId)
                     throws Exception
```
Description copied from interface: RemotelyManageable

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

Specified by:

closeSession in interface RemotelyManageable

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

startAdministrationRemoteSession
```
public String startAdministrationRemoteSession(String us,
                                      String pass)
                                        throws Exception
```
Description copied from interface: RemotelyManageable

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.

Specified by:

startAdministrationRemoteSession in interface RemotelyManageable

Parameters:
us - String with the user.
pass - String with the password.

Returns:
a String with the administrator id of the remote session.

Throws:

Exception

getDatabaseConnectionManager

public DatabaseConnectionManager getDatabaseConnectionManager()

getAttachmentEntity

public Entity getAttachmentEntity(int sessionId)
                           throws Exception

Specified by:: getAttachmentEntity in interface UtilReferenceLocator
Throws:: Exception

getPrintingTemplateEntity

public Entity getPrintingTemplateEntity(int sessionId)
                                 throws Exception

Specified by:: getPrintingTemplateEntity in interface UtilReferenceLocator
Throws:: Exception

getMessages

public Vector getMessages(int sessionIdTo,
                 int sessionId)
                   throws Exception

Specified by:: getMessages in interface UtilReferenceLocator
Throws:: Exception

getRemoteAdministrationMessages

public Vector getRemoteAdministrationMessages(int sessionIdTo,
                                     int sessionId)
                                       throws Exception

Specified by:: getRemoteAdministrationMessages in interface UtilReferenceLocator
Throws:: Exception

sendMessage

public void sendMessage(UtilReferenceLocator.Message message,
               String user,
               int sessionId)
                 throws Exception

Specified by:: sendMessage in interface UtilReferenceLocator
Throws:: Exception

sendMessage

public void sendMessage(String message,
               String user,
               int sessionId)
                 throws Exception

Specified by:: sendMessage in interface UtilReferenceLocator
Throws:: Exception

sendMessageToAll

public void sendMessageToAll(String message,
                    int sessionId)
                      throws Exception

Specified by:: sendMessageToAll in interface UtilReferenceLocator
Throws:: Exception

sendRemoteAdministrationMessages

public void sendRemoteAdministrationMessages(String message,
                                    int sessionId)
                                      throws Exception

Specified by:: sendRemoteAdministrationMessages in interface UtilReferenceLocator
Throws:: Exception

getChatCheckTime
```
public int getChatCheckTime()
```
Description copied from interface: ClientReferenceLocator

Get the time between two verifications of new chat messages

Specified by:

getChatCheckTime in interface ClientReferenceLocator

Returns:

getMessageCheckTime
```
public int getMessageCheckTime()
```
Specified by:

getMessageCheckTime in interface ClientReferenceLocator

startCheckMessagesThread

protected void startCheckMessagesThread()

startCheckRemoteAdministratorMessagesThread

protected void startCheckRemoteAdministratorMessagesThread()

showMessageDialog
```
public void showMessageDialog(Component c)
```
Specified by:

showMessageDialog in interface ClientReferenceLocator

ping
```
public boolean ping()
             throws Exception
```
Description copied from interface: RemotelyManageable

unimplemented.

Specified by:

ping in interface RemotelyManageable

Returns:

Throws:

Exception

getRemoteReportStore
```
public List getRemoteReportStore(int sessionId)
                          throws Exception
```
Specified by:

getRemoteReportStore in interface RemoteReportReferencer

Throws:

Exception

getReportEntityNames
```
public List getReportEntityNames(int sessionId)
                          throws Exception
```
Specified by:

getReportEntityNames in interface RemoteReportReferencer

Throws:

Exception

setRemoteReportStore

public void setRemoteReportStore(ReportStore rs)
                          throws Exception

Throws:: Exception

getRemoteApplicationPreferences
```
public RemoteApplicationPreferences getRemoteApplicationPreferences(int sessionId)
                                                             throws Exception
```
Description copied from interface: RemoteApplicationPreferenceReferencer

Get the application preferences stored in the server side

Specified by:

getRemoteApplicationPreferences in interface RemoteApplicationPreferenceReferencer

Parameters:
sessionId - User session identifier

Returns:

Throws:

Exception

ok

public boolean ok()
           throws Exception

Specified by:: ok in interface LOk
Throws:: Exception

isDevelopementL

public boolean isDevelopementL()
                        throws Exception

Specified by:: isDevelopementL in interface LOk
Throws:: Exception

ok

public boolean ok(String number)
           throws Exception

Specified by:: ok in interface LOk
Throws:: Exception

getLValue

public String getLValue(String name)
                 throws Exception

Specified by:: getLValue in interface LOk
Throws:: Exception

getLContent

public String getLContent()
                   throws Exception

Specified by:: getLContent in interface LOk
Throws:: Exception

getLInfoObject

public Object getLInfoObject()
                      throws Exception

Specified by:: getLInfoObject in interface LOk
Throws:: Exception

sendNotice
```
public void sendNotice(Hashtable messageValues,
              int sessionId,
              boolean request)
                throws Exception
```
Description copied from interface: INoticeSystem

Method used to send notices. This method insert the notice in the notice entity and insert all destinies in the destiny notice entity

Specified by:

sendNotice in interface INoticeSystem

request - If this is true, the notices is a request notice. In this case the correct template must be selected

Throws:

Exception

getInternalNotices
```
public EntityResult getInternalNotices(int sessionId,
                              boolean unsend,
                              boolean unread,
                              boolean deleted)
                                throws Exception
```
Description copied from interface: INoticeSystem

Method to get all notices for the specified user.
In this method is possible specified if the user wants all messages or only unread ones

Specified by:

getInternalNotices in interface INoticeSystem

Parameters:
sessionId - User session identifier
unsend - When this is true only return the unsend notices
unread - When this is true ontly return the unread notices

Returns:

Throws:

Exception

setNoticesRead
```
public void setNoticesRead(int sessionId,
                  Vector idNotices)
                    throws Exception
```
Description copied from interface: INoticeSystem

Method to set some notices as read

Specified by:

setNoticesRead in interface INoticeSystem

Parameters:
sessionId - User session identifier
idNotices - Array with the notice keys

Throws:

Exception

getSentNotices
```
public EntityResult getSentNotices(int sessionId,
                          Boolean deleted)
                            throws Exception
```
Description copied from interface: INoticeSystem

Method to query all notices sent by the specified user

Specified by:

getSentNotices in interface INoticeSystem

Parameters:
sessionId - User session identifier
deleted - deleted = true only query the deleted notices
deleted = false only query not deleted notices
deleted = null query all sent notices

Returns:

Throws:

Exception

checkNoticeSent
```
public void checkNoticeSent(int sessionId,
                   Object noticeKey)
                     throws Exception
```
Description copied from interface: INoticeSystem

This method sets a notices as sent

Specified by:

checkNoticeSent in interface INoticeSystem

Parameters:
sessionId - User session identifier
noticeKey - Notice key.

Throws:

Exception

removeSentNotices
```
public void removeSentNotices(int sessionId,
                     Vector idNotices)
                       throws Exception
```
Description copied from interface: INoticeSystem

This method sets the specified notices as deleted

Specified by:

removeSentNotices in interface INoticeSystem

Parameters:
sessionId - User session identifier
idNotices - Keys of the notices to remove

Throws:

Exception

removeReceivedNotices
```
public void removeReceivedNotices(int sessionId,
                         Vector idNotices)
                           throws Exception
```
Description copied from interface: INoticeSystem

This method removes the specified received notices for the user with this session identifier.

Specified by:

removeReceivedNotices in interface INoticeSystem

Parameters:
sessionId - User session identifier
idNotices - Notice keys

Throws:

Exception

getNoticeTypes
```
public Vector getNoticeTypes()
                      throws Exception
```
Description copied from interface: INoticeSystem

Get the identifies for all notices types in the application

Specified by:

getNoticeTypes in interface INoticeSystem

Returns:

Throws:

Exception

getNoticeEntityName
```
public String getNoticeEntityName()
```
Description copied from interface: INoticeSystem

Get the name of the notice entity

Specified by:

getNoticeEntityName in interface INoticeSystem

Returns:

getNoticeEntityDestinyName
```
public String getNoticeEntityDestinyName()
```
Description copied from interface: INoticeSystem

Get the name of the notice destiny entity

Specified by:

getNoticeEntityDestinyName in interface INoticeSystem

Returns:

initServerNotice

protected void initServerNotice(Hashtable params)

getNewMailNotice
```
public EntityResult getNewMailNotice()
                              throws Exception
```
Description copied from interface: INoticeSendMails

This method allows to get all e-mail notices not yet sent

Specified by:

getNewMailNotice in interface INoticeSendMails

Returns:

Throws:

Exception

checkNoticeAsSend
```
public void checkNoticeAsSend(Object noticeKey)
                       throws Exception
```
Description copied from interface: INoticeSendMails

This method marks the specified notice as sent

Specified by:

checkNoticeAsSend in interface INoticeSendMails

Parameters:
noticeKey - Notice key

Throws:

Exception

getUserId
```
public Object getUserId(int sessionId)
                 throws Exception
```
Description copied from interface: INoticeSystem

Get the identification of the user that must be stored in the notice system to identify this application user. In this way the identification of a user can be not only a string.

Specified by:

getUserId in interface INoticeSystem

Parameters:
sessionId - User session identifier

Returns:

Throws:

Exception

getConnectionManager

public DatabaseConnectionManager getConnectionManager()

getXMLForm

public String getXMLForm(String form,
                int userid)
                  throws Exception

Specified by:: getXMLForm in interface XMLFormProvider
Throws:: Exception

getImage

public BytesBlock getImage(String image,
                  int userId)
                    throws Exception

Specified by:: getImage in interface XMLClientProvider
Throws:: Exception

getXMLRules

public String getXMLRules(String form,
                 int userid)
                   throws Exception

Specified by:: getXMLRules in interface XMLClientProvider
Throws:: Exception

getFormManagerParameters

public Hashtable getFormManagerParameters(String formManagerId,
                                 int userid)
                                   throws Exception

Specified by:: getFormManagerParameters in interface XMLClientProvider
Throws:: Exception

reloadXMLMenu
```
public void reloadXMLMenu(int userid)
                   throws Exception
```
Specified by:

reloadXMLMenu in interface XMLClientProvider

Throws:

Exception

getXMLMenu

public String getXMLMenu(int userid)
                  throws Exception

Specified by:: getXMLMenu in interface XMLClientProvider
Throws:: Exception

reloadXMLToolbar
```
public void reloadXMLToolbar(int userid)
                      throws Exception
```
Specified by:

reloadXMLToolbar in interface XMLClientProvider

Throws:

Exception

getXMLToolbar

public String getXMLToolbar(int userid)
                     throws Exception

Specified by:: getXMLToolbar in interface XMLClientProvider
Throws:: Exception

hasChat
```
public boolean hasChat()
```
Description copied from interface: ClientReferenceLocator

True when the application has a chat configured

Specified by:

hasChat in interface ClientReferenceLocator

Returns:

getRemoteOperationManager

public RemoteOperationManager getRemoteOperationManager(int sessionId)
                                                 throws Exception

Specified by:: getRemoteOperationManager in interface UtilReferenceLocator
Throws:: Exception

getRemoteReference
```
public Object getRemoteReference(String name,
                        int sessionId)
                          throws Exception
```
Description copied from interface: UtilReferenceLocator

Gets a remote reference.

Specified by:

getRemoteReference in interface UtilReferenceLocator

Returns:

Throws:

Exception
See Also:
SecureReferenceLocator#configureRemoteReferences(String)}

createReference

protected Object createReference(String className,
                     Hashtable parameters)
                          throws Exception

Throws:: Exception

getReference
```
public Object getReference(String name)
                    throws Exception
```
Allows to get local references defined in 'references.xml' file when app is built in local mode. . For remote references is used getRemoteReference(String, int)

Specified by:

getReference in interface ClientReferenceLocator

Parameters:
name - The name of reference defined in 'references.xml' file.

Returns:
Object for this reference

Throws:

Exception - When application is not in local mode or when something fails.
Since:

5.2073EN-0.2

configureReferences

protected void configureReferences(String xmlDefinitionResource)

The constructor of each reference must have the next parameters:

EntityReferenceLocator: locator reference.
Hashtable: Entry parameters

Example of xml definition.


 <References>
        <Reference>
                <Name>name</Name>
                <Class>className</Class>
                <Param>
                        <Name>paramName1</Name>
                        <Value>paramValue1</Value>
                </Param>
                <Param>
                        <Name>paramName2</Name>
                        <Value>paramValue2</Value>
                </Param>
        </Reference>
 </References>

Parameters:: xmlDefinitionResource - resource path where is loaded the xml definition in.

configureReference

protected void configureReference(Node currentNode)
                           throws Exception

Throws:: Exception

createRemoteReference

protected Object createRemoteReference(String className,
                           Hashtable parameters)
                                throws Exception

Throws:: Exception

configureRemoteReferences

protected void configureRemoteReferences(String xmlDefinitionResource)

getNodeValue

protected String getNodeValue(Node son)

getServerTimeZone
```
public TimeZone getServerTimeZone(int sessionId)
                           throws Exception
```
Description copied from interface: UtilReferenceLocator

Get the Server TimeZone. If is local mode get the Application Time Zone

Specified by:

getServerTimeZone in interface UtilReferenceLocator

Returns:

Throws:

Exception

getLoginEntityName
```
public String getLoginEntityName(int sessionId)
                          throws Exception
```
Description copied from interface: UtilReferenceLocator

Get the name of the login entity (LoginEntity parameter)

Specified by:

getLoginEntityName in interface UtilReferenceLocator

Returns:
The name of the Login Entity

Throws:

Exception

getDefaultPackage
```
public String getDefaultPackage()
```

configureConnectionManager

protected DatabaseConnectionManager configureConnectionManager(boolean bStatisticViewer,
                                                   boolean writeConnectionInfoFile,
                                                   URL databasePropertiesURL,
                                                   URL autonumericalURL)
                                                        throws Exception

Throws:: Exception

createConnectionManager

protected DatabaseConnectionManager createConnectionManager(boolean bStatisticViewer,
                                                boolean writeConnectionInfoFile,
                                                URL databasePropertiesURL,
                                                URL autonumericalURL)
                                                     throws Exception

Throws:: Exception

configureMultiConnectionManager

protected void configureMultiConnectionManager()

getDEBUGValueRemote
```
public boolean getDEBUGValueRemote(String id,
                          String v)
                            throws Exception
```
Description copied from interface: RemotelyManageable

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

Specified by:

getDEBUGValueRemote in interface RemotelyManageable

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

getSystemInfo

public Hashtable getSystemInfo(String id,
                      String key)
                        throws Exception

Description copied from interface: RemotelyManageable

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.

Specified by:: getSystemInfo in interface RemotelyManageable
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

setDEBUGValueRemote
```
public void setDEBUGValueRemote(String id,
                       String v,
                       boolean b)
                         throws Exception
```
Description copied from interface: RemotelyManageable

Method to set the DEBUG Server variables.

Specified by:

setDEBUGValueRemote in interface RemotelyManageable

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

removeEntity

public void removeEntity(String id,
                String entityName)
                  throws Exception

Specified by:: removeEntity in interface RemotelyManageable
Throws:: Exception

getRemotePreferencesFile
```
public Properties getRemotePreferencesFile(String id)
                                    throws Exception
```
Description copied from interface: RemotelyManageable

Method to get remotely the Server Preferences file.

Specified by:

getRemotePreferencesFile in interface RemotelyManageable

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

Returns:
a Properties with the preferences.

Throws:

Exception

setRemotePreferencesFile
```
public void setRemotePreferencesFile(String id,
                            Properties prop)
                              throws Exception
```
Description copied from interface: RemotelyManageable

Method to set remotely the Server Preferences file.

Specified by:

setRemotePreferencesFile in interface RemotelyManageable

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

closeLockedConnections

public void closeLockedConnections(String id,
                          String databaseId)
                            throws Exception

Specified by:: closeLockedConnections in interface RemotelyManageable
Throws:: Exception

getRemoteLogManager

public IRemoteLogManager getRemoteLogManager(String id)
                                      throws Exception

Specified by:: getRemoteLogManager in interface RemotelyManageable
Throws:: Exception

getToken
```
public String getToken()
                throws Exception
```
Specified by:

getToken in interface UtilReferenceLocator

Specified by:

getToken in interface TokenLogin

Throws:

Exception

getUserFromCert
```
public String getUserFromCert(String stringCertificate)
                       throws Exception
```
Specified by:

getUserFromCert in interface UtilReferenceLocator

Specified by:

getUserFromCert in interface TokenLogin

Throws:

Exception

getPasswordFromCert
```
public String getPasswordFromCert(String stringCertificate)
                           throws Exception
```
Specified by:

getPasswordFromCert in interface UtilReferenceLocator

Specified by:

getPasswordFromCert in interface TokenLogin

Throws:

Exception

checkToken

public boolean checkToken(String token)
                   throws Exception

Throws:: Exception

getPasswordFromCert

protected String getPasswordFromCert(Certificate cert)
                              throws Exception

Throws:: Exception

getUserFromCert

protected String getUserFromCert(Certificate cert)
                          throws Exception

Throws:: Exception

getContextParams

protected Hashtable getContextParams(String password)

retrieveInitialContext

public InitialContext retrieveInitialContext(int sessionId,
                                    Hashtable params)
                                      throws Exception

Specified by:: retrieveInitialContext in interface UtilReferenceLocator
Throws:: Exception

ssoLogin

public Integer ssoLogin(Boolean debug)
                 throws Exception

Throws:: Exception

getLocale

public Locale getLocale(int sessionId)
                 throws Exception

Specified by:: getLocale in interface UtilReferenceLocator
Throws:: Exception

setLocale

public void setLocale(int sessionId,
             Locale locale)
               throws Exception

Specified by:: setLocale in interface UtilReferenceLocator
Throws:: Exception

getSuffixString
```
public String getSuffixString()
```
Specified by:

getSuffixString in interface UtilReferenceLocator

getLocaleId
```
public Object getLocaleId(int sessionId)
                   throws Exception
```
Specified by:

getLocaleId in interface ClientReferenceLocator

Throws:

Exception

getLocaleEntity
```
public String getLocaleEntity()
                       throws Exception
```
Specified by:

getLocaleEntity in interface UtilReferenceLocator

Throws:

Exception

supportChangePassword

public boolean supportChangePassword(String user,
                            int sessionId)
                              throws Exception

Specified by:: supportChangePassword in interface UtilReferenceLocator
Throws:: Exception

changePassword

public EntityResult changePassword(String password,
                          int sessionId,
                          Hashtable av,
                          Hashtable kv)
                            throws Exception

Specified by:: changePassword in interface UtilReferenceLocator
Throws:: Exception

getAccessControl
```
public boolean getAccessControl()
                         throws Exception
```
Specified by:

getAccessControl in interface UtilReferenceLocator

Throws:

Exception

getErrorAccessControl

public ErrorAccessControl getErrorAccessControl()
                                         throws Exception

Specified by:: getErrorAccessControl in interface UtilReferenceLocator
Throws:: Exception

blockUserDB
```
public void blockUserDB(String user)
                 throws Exception
```
Specified by:

blockUserDB in interface UtilReferenceLocator

Throws:

Exception

checkBlockUserDB
```
public boolean checkBlockUserDB(String user)
                         throws Exception
```
Specified by:

checkBlockUserDB in interface UtilReferenceLocator

Throws:

Exception

Class ReferenceLocator

Nested Class Summary

Nested classes/interfaces inherited from interface com.ontimize.locator.UtilReferenceLocator

Field Summary

Fields inherited from interface com.ontimize.gui.RemotelyManageable

Fields inherited from interface com.ontimize.util.notice.INoticeSystem

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

REMOTE_REFERENCE_LOCATOR_NAME

PACKAGE_OR_HOSTNAME

LOCAL

CHECK_SERVER_MESSAGES_PERIOD

CUSTOM_SOCKET

ATTACHMENT_ENTITY_PATH

ATTACHMENT_ENTITY

REPORT_ENTITIES

ENTITIES_CLASS

ENTITIES_PROPERTIES

VIEWER

LOGIN_ENTITY

LOCAL_ENTITIES_PACKAGE

LOCAL_ENTITIES

PORT

DB_PROPERTIES

DYNAMIC_LOCAL_ENTITY_PREFIX

AUTONUMERICAL_PROPERTIES

MULTICONNECTION_MANAGER

NEW_CHAT

SSO_PATH

defaultValueUseServerTimezone

askUserChangeTimezone

ENCRYPT_PROPERTY

DEBUG

IMPOSSIBLE_CONNECT_TO_SERVER

REMOTE_OBJECT_NOT_REGISTERED

UNKNOWN_ERROR

UNKNOWN_HOST

M_NOT_AUTHORIZED

loginEntity

privilegedId

attachmentEntity

attachmentPath

printingTemplatesEntity

propertiesPath

reconnectState

cw

localEntities

moduleLocalEntities

localEntitiesPackage

offset

offsetString

entitiesPropertiesClass

reportEntities

serverTimeZone

localLocator

packageA

port

loadedEntities

startSession

formProviderEntity

formProviderEntityFormNameColumn

formProviderEntityFormXMLColumn

formProviderEntityFormRuleColumn

databaseEntityManager

formManagerProviderEntity

formManagerProviderEntityIdColumn

formManagerProviderEntityFormNameColumn

formManagerProviderEntityInteractionManagerColumn

imageProviderEntity

imageProviderEntityImageNameColumn

imageProviderEntityImageBytesColumn

menuProviderEntity

menuProviderEntityXMLColumn

toolbarProviderEntity

toolbarProviderEntityXMLColumn

referenceLocatorServerName

referenceLocatorServer

manager