com.ontimize.util.notice
Class NoticeEntity

java.lang.Object
  java.rmi.server.RemoteObject
      java.rmi.server.RemoteServer
          java.rmi.server.UnicastRemoteObject
              com.ontimize.db.TableEntity
                  com.ontimize.db.DefaultTableEntity
                      com.ontimize.util.notice.NoticeEntity

All Implemented Interfaces:

AdvancedEntity, AdvancedQueryEntity, Entity, EntityDataChangeNotifier, FileManagementEntity, IdentifiedEntity, PrivilegedSecurityEntity, java.rmi.Remote, SecureEntity, java.io.Serializable, TransactionalEntity

public class NoticeEntity

extends DefaultTableEntity

See Also:

Serialized Form

Nested Class Summary

Nested classes inherited from class com.ontimize.db.TableEntity

TableEntity.AttachmentReceiving, TableEntity.Receiving

Field Summary

protected java.lang.String	entityDestinyName
static java.lang.String	INTERNAL_NOTICE_PERIOD
static java.lang.String	MAIL_CONF_PROPERTIES
static java.lang.String	NOTICE_CONTENT Notice entity column name which specifies the notice content
static java.lang.String	NOTICE_CREATE_DATE Notice entity column name that specifies the notice generation date
static java.lang.String	NOTICE_DELETE_RECEIVE_NOTICE This column sets the received notice as deleted
static java.lang.String	NOTICE_DELETE_SEND_NOTICE This column sets the sent notices as deleted
static java.lang.String	NOTICE_DESTINY_KEY Key name of the notice destiny entity.
static java.lang.String	NOTICE_ENTITY_DESTINY_TABLE_DB
static java.lang.String	NOTICE_ENTITY_TABLE_DB
static java.lang.String	NOTICE_FORCE_READ Notice entity column name which indicates if this is a mandatory read notice
static java.lang.String	NOTICE_FROM_PARAMETER Column name of the notices entity where is stored the name of the user that generates the notice
static java.lang.String	NOTICE_KEY Notice entity key
static java.lang.String	NOTICE_MAILTO_PARAMETER Destiny entity column name which the mail addresses the notices are send to are stored in
static java.lang.String	NOTICE_MESSAGE_COLUMN_NAME
static java.lang.String	NOTICE_MESSAGE_TYPE_COLUMN_NAME
static java.lang.String	NOTICE_OTHER_COLUMNS
static java.lang.String	NOTICE_READ Destiny entity column name which indicates if this notice has been read (this column is only used for internal notices)
static java.lang.String	NOTICE_READ_DATE Destiny entity column name which indicates the notice read date
static java.lang.String	NOTICE_RESPONSE_REQUEST Notices entity column name which indicates if this notice requests confirmation (0 = without response request)
static java.lang.String	NOTICE_SEND Destiny entity column name which indicates if this notice has been sent, when notice is internal notice this columns indicates if destiny user has queried the notice.
static java.lang.String	NOTICE_SEND_DATE Destiny entity column name which specifies the notice sent date
static java.lang.String	NOTICE_SEND_MAIL Destiny entity column name which indicates if this notice must be send in a email (0 = internal notice, 1= email notice)
static java.lang.String	NOTICE_SUBJECT Notice entity column name which specifies se notice subject
static java.lang.String	NOTICE_SYSTEM Parameter that must exists in the reference locator (local and remote) to allow that all notices threads start.
static java.lang.String	NOTICE_TO_PARAMETER Column name of the destiny entity where user name is stored
static java.lang.String	PROP_NOTICE_CLASS_MAIL
static java.lang.String	PROP_NOTICE_CONFIG_DEFAULT_TEMPLATE
static java.lang.String	PROP_NOTICE_CONFIG_MAIL
static java.lang.String	PROP_NOTICE_CONFIG_REQUEST_TEMPLATE
static java.lang.String	PROP_NOTICE_CONFIG_TEMPLATES
static java.lang.String	PROP_NOTICE_ENTITY_DESTINY_NAME
static java.lang.String	PROP_NOTICE_ENTITY_NAME
static java.lang.String	SEND_MAIL_PERIOD

Fields inherited from class com.ontimize.db.DefaultTableEntity

props

Fields inherited from class com.ontimize.db.TableEntity

alias, aliasPropertiesParser, aliasReverse, ASTERISK, ATTACHMENT_FILE_DESCRIPTION_COLUMN, ATTACHMENT_FILE_NAME_COLUMN, ATTACHMENT_FILE_NAME_KEYS, ATTACHMENT_FILE_ORIGINAL_NAME_COLUMN, ATTACHMENT_FILE_ORIGINAL_PATH_COLUMN, ATTACHMENT_FILE_PATH, ATTACHMENT_FILE_SIZE_COLUMN, ATTACHMENT_SEPARATOR, ATTACHMENT_TABLE, attachmentFileNameColumn, attachmentFileNameKeys, attachmentFilePath, attachmentFileSizeColumn, attachTable, AUTOCONFIGURATION, AUTONUMERICAL, autonumericalColumn, calendar, checkOperationResult, columnNames, COLUMNS, connectionRequestTime, dataChangeListeners, dBLocalErrorMessage, DEBUG, DEBUG_DETAILS, DEBUG_TIMES, DEFAULT_MAX_CONNECTION_WAIT_TIME, defaultEntityScriptManagerClassName, DELETE_ACTION, DELETE_KEYS, deleteKeys, descendantColumnsOrder, descriptionAttachmentFileColumn, enableScripting, entitiesPropertiesParser, entitiesTableAttribute, entityName, entityScripting, FETCH_SIZE, fetchSize, FILE_COLUMNS, fileInfoList, FORCE_DISTINCT, forceDistinct, INSERT_ACTION, INSERT_AUTOMATICLY_ATTACHMENT, INSERT_COLUMNS, INSERT_KEYS, insertAttachmentAutomatically, insertColumn, insertKeys, INTERROG, keys, KEYS, LIMIT_QUERY_OTHERS_ENTITIES, limitQueryOthersEntities, locator, LOG_KEYS, logDelete, logInsert, logkeys, logQuery, logUpdate, M_ERROR_OPERATION, M_IT_HAS_NOT_CHANGED_ANY_RECORD, M_LICENSE_PERMISSION_ERROR, M_TEMPORALY_RESTRICTED_BY_PERMISSION_ACTION, M_YOU_DO_NOT_HAVE_PERMISSION_TO_EXECUTE_ACTION, manager, maxConnectionWaitTime, oneToOneMode, orderColumns, originalAttachmentFileNameColumn, originalAttachmentFilePathColumn, OTHER_ENTITIES, othersEntities, PERCENT, PRINCIPAL_COLUMNS, PRINCIPAL_KEYS, PRINCIPAL_TABLE, principalColumnNames, principalKeyName, principalTable, privilegedId, properties, propertiesPath, QUERY_ACTION, QUERY_TABLE, queryTable, receivedAttachmentFile, receivedTempFiles, RECORD_OPERATIONS, registeredDispatcher, REPORT_ADVANCED_QUERY_COLUMNS, REPORT_ADVANCED_QUERY_TYPES, reportAvancedQueryColumns, reportAvancedQueryTypes, SECONDARY_COLUMNS, SECONDARY_KEYS, SECONDARY_TABLE, secondaryColumnsNames, secondaryKeyName, secondaryTable, sendAttachmentFile, SORT, SORT_DESC, table, TABLE, TABLE_ATTRIBUTE_ENTITIES, tempFiles, TIME_BETWEEN_DEFAULT_CONNECTION_REQUEST, TRUNCATE_DATE_DEFAULT_VALUE, TRUNCATE_DATES, truncateDates, UNDERSCORE, UPDATE_ACTION, UPDATE_COLUMNS, UPDATE_KEYS, updateColumn, updateKeys, USE_SETSTRING_LONG_STRINGS, useAlwaysTableAttributeEntities, WILDCARD_COLUMNS, wildcardColumns

Fields inherited from class java.rmi.server.RemoteObject

ref

Constructor Summary

NoticeEntity(EntityReferenceLocator locator, DatabaseConnectionManager databaseManager, int port, java.lang.String props)

Method Summary

void	checkNoticeSent(java.lang.Object idNotice) Marks a notices as sent and update the date sent
void	checkNoticeSent(java.lang.Object idNotice, TableEntity entityTo, int sessionId, java.sql.Connection con) Marks a notices as sent and update the date sent
EntityResult	getInternalNotices(int sessionId, boolean unsend, boolean unread, boolean deleted) Gets all the records for the user with the specified sessionId and set these messages as read and update the sent date
EntityResult	getInternalNotices(int sessionId, boolean unsend, boolean unread, boolean deleted, java.sql.Connection con)
EntityResult	getNewMailNotice() Get the information about e-mail notices that have not been already sent
EntityResult	getNewMailNotice(int sessionId, java.sql.Connection con)
EntityResult	getSentNotices(int sessionId, java.lang.Boolean deleted)
EntityResult	getSentNotices(int sessionId, java.lang.Boolean deleted, java.sql.Connection con)
protected void	insertDestiny(java.util.Hashtable kv, java.lang.Object noticeKey, int sessionId, java.sql.Connection con) Insert all the destinations of the notice
protected EntityResult	joinInformation(EntityResult noticesData, EntityResult destinationParams, java.lang.String[] simpleParams, java.lang.Object unionKey) Completes the information of the notice data with the destination values.
protected void	readProperties(java.lang.String path) Loads a Properties object located in path using this.getClass().getClassLoader().getResource(path).
protected void	readPropertiesChanges(java.net.URL urlProp)
void	removeReceivedNotices(int sessionId, java.util.Vector noticeskeys)
void	removeReceivedNotices(int sessionId, java.util.Vector noticeskeys, java.sql.Connection con) Sets the specified notices for the specified user as removed.
void	removeSentNotices(int sessionId, java.util.Vector noticesKeys) Set the specified notices as deleted but does not remove them from the database
void	removeSentNotices(int sessionId, java.util.Vector noticesKeys, java.sql.Connection con)
void	sentNotices(java.util.Hashtable kv, int sessionId, boolean request) Inserts the notice in the notice table and insert all destinies in destiny notice table All message fields are inserted and a new field using the template for this notice type is created and also inserted in the notice table
void	sentNotices(java.util.Hashtable kv, int sessionId, boolean request, java.sql.Connection con)
protected EntityResult	setMessageAddress(EntityResult noticesData, EntityResult destinyParams) Sets a vector with the addresses to send a notice (mail or not)
void	setNoticesRead(int sessionId, java.util.Vector readNotices) Set all the specified notices as read
void	setNoticesRead(int sessionId, java.util.Vector readNotices, java.sql.Connection con)

Methods inherited from class com.ontimize.db.DefaultTableEntity

getExtendedAliasPropertiesName, getExtendedPropertiesName, loadAliasFile, readProperties, setName

Methods inherited from class com.ontimize.db.TableEntity

addEntityDataChangeListener, buildConditionsString, cancelReceiving, checkDeleteKeys, checkFinishedSession, checkInsertKeys, checkOrderColumns, checkPermissions, checkUpdateKeys, configureReverseAlias, connect, connect, createAdvancedEntityResultForSessionId, createAdvancedEntityResultForSessionId, createEntityResultForSessionId, createEntityResultForSessionId, createEntityResultForSessionId, createEntityResultForSessionId, createEntityResultForSessionId, createEntityScriptManager, delete, delete, deleteAttachmentFile, deleteAttachmentFile, deleteMultipleTableAttributesColumns, disconnect, disconnect, dispatcherAttribute, executePreparedStatement, executePreparedStatement, executePreparedStatement, executePreparedStatement, executePreparedStatement, executePreparedStatement, executePreparedStatement, executeStatement, finishReceiving, fireDataChangeEvent, fireDataChangeEvent, fireTransactionDataChangeEvent, fireTransactionDataChangeEvent, generateRandomId, getActions, getAliasForColumn, getAttachmentFileNameForKeys, getAttachmentFilePath, getAttachmentFilePath, getAutonumericalColumn, getBytes, getColumnForAlias, getColumnListForAvancedQuery, getColumns, getDatabaseConnectionManager, getDescOrderColumns, getDescription, getEntityPrivilegedId, getEntityReference, getErrorMessage, getExtension, getName, getOrderColumns, getPrivilegedId, getPropertiesPath, getQueryRecordNumber, getQueryTable, getSize, getSQLTypesFromMetaData, getStringsOn, getSubGroupValues, getSubGroupValues, getTable, getUpdateColumns, getUser, getValidAttributes, getValidDeletingKeysValues, getValidInsertingAttributesValues, getValidQueryingKeysValues, getValidUpdatingAttributesValues, getValidUpdatingKeysValues, getWildCardColumns, insert, insert, insertAutonumericalAlias, isBinaryType, loadAliasFile, logToLogKeys, logUpdate, parseStringValue, performExtendedAliasProperties, performExtendedProperties, postDelete, postInsert, postUpdate, preDelete, preInsert, prepareToReceive, prepareToReceive, prepareToReceive, prepareToTransfer, prepareToTransfer, preUpdate, processFileColumnsAttributes, processFileColumnsAttributes, processFileResults, processingMultipleValueAttributes, processingReferenceDataFieldAttributes, processingReferenceDataFieldAttributes, processMultipleAttributeKey, processMultipleTableAttribute, processMultipleTableAttribute, putBytes, query, query, query, query, query, queryOtherEntities, readProperties, registerAttributeDispatcher, reloadScripts, removeEntityDataChangeListener, replaceAliasByColumn, replaceAliasByColumn, replaceAliasByColumn, replaceAliasByColumn, replaceAliasByColumn, replaceColumnByAlias, replaceColumnByAlias, replaceColumnByAlias, replaceColumnByAlias, replaceColumnByAliasKeepColumns, resultSetToEntityResult, resultSetToEntityResult, resultSetToEntityResult, setLimitQueryOthersEntities, setObject, setObject, setPrivilegedId, toVectorOfBooleans, truncateDataToHour_00_00_00, truncateDateToMinutes, update, update, updateAttachmentValues, vectorToStringSeparateBySemicolon

Methods inherited from class java.rmi.server.UnicastRemoteObject

clone, exportObject, exportObject, exportObject, unexportObject

Methods inherited from class java.rmi.server.RemoteServer

getClientHost, getLog, setLog

Methods inherited from class java.rmi.server.RemoteObject

equals, getRef, hashCode, toString, toStub

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

entityDestinyName

protected java.lang.String entityDestinyName

NOTICE_SYSTEM

public static java.lang.String NOTICE_SYSTEM

Parameter that must exists in the reference locator (local and remote) to allow that all notices threads start.

PROP_NOTICE_ENTITY_NAME

public static java.lang.String PROP_NOTICE_ENTITY_NAME

PROP_NOTICE_ENTITY_DESTINY_NAME

public static java.lang.String PROP_NOTICE_ENTITY_DESTINY_NAME

PROP_NOTICE_CONFIG_MAIL

public static java.lang.String PROP_NOTICE_CONFIG_MAIL

PROP_NOTICE_CLASS_MAIL

public static java.lang.String PROP_NOTICE_CLASS_MAIL

PROP_NOTICE_CONFIG_TEMPLATES

public static java.lang.String PROP_NOTICE_CONFIG_TEMPLATES

PROP_NOTICE_CONFIG_DEFAULT_TEMPLATE

public static java.lang.String PROP_NOTICE_CONFIG_DEFAULT_TEMPLATE

PROP_NOTICE_CONFIG_REQUEST_TEMPLATE

public static java.lang.String PROP_NOTICE_CONFIG_REQUEST_TEMPLATE

MAIL_CONF_PROPERTIES

public static java.lang.String MAIL_CONF_PROPERTIES

INTERNAL_NOTICE_PERIOD

public static java.lang.String INTERNAL_NOTICE_PERIOD

SEND_MAIL_PERIOD

public static java.lang.String SEND_MAIL_PERIOD

NOTICE_ENTITY_TABLE_DB

public static java.lang.String NOTICE_ENTITY_TABLE_DB

NOTICE_ENTITY_DESTINY_TABLE_DB

public static java.lang.String NOTICE_ENTITY_DESTINY_TABLE_DB

NOTICE_MESSAGE_TYPE_COLUMN_NAME

public static java.lang.String NOTICE_MESSAGE_TYPE_COLUMN_NAME

NOTICE_OTHER_COLUMNS

public static java.lang.String NOTICE_OTHER_COLUMNS

NOTICE_KEY

public static java.lang.String NOTICE_KEY

Notice entity key

NOTICE_DESTINY_KEY

public static java.lang.String NOTICE_DESTINY_KEY

Key name of the notice destiny entity.

NOTICE_TO_PARAMETER

public static java.lang.String NOTICE_TO_PARAMETER

Column name of the destiny entity where user name is stored

NOTICE_FROM_PARAMETER

public static java.lang.String NOTICE_FROM_PARAMETER

Column name of the notices entity where is stored the name of the user that generates the notice

NOTICE_MAILTO_PARAMETER

public static java.lang.String NOTICE_MAILTO_PARAMETER

Destiny entity column name which the mail addresses the notices are send to are stored in

NOTICE_RESPONSE_REQUEST

public static java.lang.String NOTICE_RESPONSE_REQUEST

Notices entity column name which indicates if this notice requests confirmation (0 = without response request)

NOTICE_SEND_MAIL

public static java.lang.String NOTICE_SEND_MAIL

Destiny entity column name which indicates if this notice must be send in a email (0 = internal notice, 1= email notice)

NOTICE_READ

public static java.lang.String NOTICE_READ

Destiny entity column name which indicates if this notice has been read (this column is only used for internal notices)

NOTICE_READ_DATE

public static java.lang.String NOTICE_READ_DATE

Destiny entity column name which indicates the notice read date

NOTICE_SEND

public static java.lang.String NOTICE_SEND

Destiny entity column name which indicates if this notice has been sent, when notice is internal notice this columns indicates if destiny user has queried the notice.

NOTICE_CREATE_DATE

public static java.lang.String NOTICE_CREATE_DATE

Notice entity column name that specifies the notice generation date

NOTICE_SEND_DATE

public static java.lang.String NOTICE_SEND_DATE

Destiny entity column name which specifies the notice sent date

NOTICE_SUBJECT

public static java.lang.String NOTICE_SUBJECT

Notice entity column name which specifies se notice subject

NOTICE_CONTENT

public static java.lang.String NOTICE_CONTENT

Notice entity column name which specifies the notice content

NOTICE_FORCE_READ

public static java.lang.String NOTICE_FORCE_READ

Notice entity column name which indicates if this is a mandatory read notice

NOTICE_DELETE_SEND_NOTICE

public static java.lang.String NOTICE_DELETE_SEND_NOTICE

This column sets the sent notices as deleted

NOTICE_DELETE_RECEIVE_NOTICE

public static java.lang.String NOTICE_DELETE_RECEIVE_NOTICE

This column sets the received notice as deleted

NOTICE_MESSAGE_COLUMN_NAME

public static java.lang.String NOTICE_MESSAGE_COLUMN_NAME

Constructor Detail

NoticeEntity

public NoticeEntity(EntityReferenceLocator locator,
                    DatabaseConnectionManager databaseManager,
                    int port,
                    java.lang.String props)
             throws java.lang.Exception

Method Detail

readProperties

protected void readProperties(java.lang.String path)
                       throws java.lang.Exception

Description copied from class: TableEntity

Loads a Properties object located in path using this.getClass().getClassLoader().getResource(path).
Then calls TableEntity.readProperties(Properties, URL)

Overrides:

readProperties in class TableEntity

Parameters:

path - path from which the properties will be loaded

Throws:

java.lang.Exception

readPropertiesChanges

protected void readPropertiesChanges(java.net.URL urlProp)

getSentNotices

public EntityResult getSentNotices(int sessionId,
                                   java.lang.Boolean deleted,
                                   java.sql.Connection con)
                            throws java.lang.Exception

Parameters:

sessionId -

deleted -

Returns:

Throws:

java.lang.Exception

getSentNotices

public EntityResult getSentNotices(int sessionId,
                                   java.lang.Boolean deleted)
                            throws java.lang.Exception

Parameters:

sessionId -

deleted -

Returns:

Throws:

java.lang.Exception

sentNotices

public void sentNotices(java.util.Hashtable kv,
                        int sessionId,
                        boolean request)
                 throws java.lang.Exception

Inserts the notice in the notice table and insert all destinies in destiny notice table
All message fields are inserted and a new field using the template for this notice type is created and also inserted in the notice table

Parameters:

kv -

sessionId -

Returns:

Throws:

java.lang.Exception

sentNotices

public void sentNotices(java.util.Hashtable kv,
                        int sessionId,
                        boolean request,
                        java.sql.Connection con)
                 throws java.lang.Exception

Throws:

java.lang.Exception

insertDestiny

protected void insertDestiny(java.util.Hashtable kv,
                             java.lang.Object noticeKey,
                             int sessionId,
                             java.sql.Connection con)
                      throws java.lang.Exception

Insert all the destinations of the notice

Parameters:

kv - notice information including the NOTICE TO parameter

noticeKey - Key of the inserted notice

sessionId -

con -

Throws:

java.lang.Exception

getInternalNotices

public EntityResult getInternalNotices(int sessionId,
                                       boolean unsend,
                                       boolean unread,
                                       boolean deleted)
                                throws java.lang.Exception

Gets all the records for the user with the specified sessionId and set these messages as read and update the sent date

Parameters:

sessionId -

unsend -

unread -

deleted -

Returns:

Throws:

java.lang.Exception

getInternalNotices

public EntityResult getInternalNotices(int sessionId,
                                       boolean unsend,
                                       boolean unread,
                                       boolean deleted,
                                       java.sql.Connection con)
                                throws java.lang.Exception

Throws:

java.lang.Exception

setNoticesRead

public void setNoticesRead(int sessionId,
                           java.util.Vector readNotices)
                    throws java.lang.Exception

Set all the specified notices as read

Parameters:

sessionId - User identifier

readNotices - List with the keys of the notices to update

Throws:

java.lang.Exception

setNoticesRead

public void setNoticesRead(int sessionId,
                           java.util.Vector readNotices,
                           java.sql.Connection con)
                    throws java.lang.Exception

Throws:

java.lang.Exception

getNewMailNotice

public EntityResult getNewMailNotice()
                              throws java.lang.Exception

Get the information about e-mail notices that have not been already sent

Returns:

Throws:

java.lang.Exception

getNewMailNotice

public EntityResult getNewMailNotice(int sessionId,
                                     java.sql.Connection con)
                              throws java.lang.Exception

Throws:

java.lang.Exception

checkNoticeSent

public void checkNoticeSent(java.lang.Object idNotice,
                            TableEntity entityTo,
                            int sessionId,
                            java.sql.Connection con)
                     throws java.lang.Exception

Marks a notices as sent and update the date sent

Parameters:

idNotice -

entityTo -

sessionId -

con -

Throws:

java.lang.Exception

checkNoticeSent

public void checkNoticeSent(java.lang.Object idNotice)
                     throws java.lang.Exception

Marks a notices as sent and update the date sent

Parameters:

idNotice -

Throws:

java.lang.Exception

removeSentNotices

public void removeSentNotices(int sessionId,
                              java.util.Vector noticesKeys)
                       throws java.lang.Exception

Set the specified notices as deleted but does not remove them from the database

Parameters:

sessionId -

noticesKeys -

Throws:

java.lang.Exception

removeSentNotices

public void removeSentNotices(int sessionId,
                              java.util.Vector noticesKeys,
                              java.sql.Connection con)
                       throws java.lang.Exception

Throws:

java.lang.Exception

removeReceivedNotices

public void removeReceivedNotices(int sessionId,
                                  java.util.Vector noticeskeys)
                           throws java.lang.Exception

Throws:

java.lang.Exception

removeReceivedNotices

public void removeReceivedNotices(int sessionId,
                                  java.util.Vector noticeskeys,
                                  java.sql.Connection con)
                           throws java.lang.Exception

Sets the specified notices for the specified user as removed. Update the database but does not remove the notices

Parameters:

sessionId -

noticeskeys -

con -

Throws:

java.lang.Exception

joinInformation

protected EntityResult joinInformation(EntityResult noticesData,
                                       EntityResult destinationParams,
                                       java.lang.String[] simpleParams,
                                       java.lang.Object unionKey)

Completes the information of the notice data with the destination values. Include the values of the parameters in the simpleParams list and if this parameters already exist uses only the first occurrence.

Parameters:

noticesData - EntityReusult to complete

destinationParams - New information to add

simpleParams - Keys of the parameters to add from the destinationParams to noticeData

unionKey - Name of the key to math the both Objects

Returns:

setMessageAddress

protected EntityResult setMessageAddress(EntityResult noticesData,
                                         EntityResult destinyParams)

Sets a vector with the addresses to send a notice (mail or not)

Parameters:

noticesData -

destinyParams -

Returns: