com.ontimize.locator

Class PermissionReferenceLocator

java.lang.Object

com.ontimize.locator.ReferenceLocator

com.ontimize.locator.PermissionReferenceLocator

All Implemented Interfaces:

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

Direct Known Subclasses:

DelegationPermissionReferenceLocator

public class PermissionReferenceLocator
extends ReferenceLocator
implements ClientPermissionManager, ServerPermissionManager, LControl

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected class	PermissionReferenceLocator.TimeThread

Nested classes/interfaces inherited from class com.ontimize.locator.ReferenceLocator

ReferenceLocator.DefaultClientSocketFactory, ReferenceLocator.DefaultSSLClientSocketFactory

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

UtilReferenceLocator.Message

Field Summary

Fields

Modifier and Type	Field and Description
static String	BUSINESS_CALENDAR_FILE
protected String	businessCalendarFile
static String	CLIENT_PERMISSION_COLUMN
protected String	clientPermissionsColumn
protected boolean	clientPermissionsInstalled
protected long	currentServerTime
protected static int	DEFAULT_TIME_THREAD_SLEEP
static String	ENTITIES
protected Vector	entityNames
static String	PERMISSION_ENTITY
static String	PERMISSION_GROUP_KEY_COLUMN
protected String	permissionGroupKeyColumnName
protected String	permissionsEntity
static String	PROFILE_COLUMN
static String	PROFILE_ENTITY
protected String	profileColumn
protected String	profileEntity
static String	SERVER_PERMISSION_COLUMN
static String	SERVER_SECURITY_MANAGER_CLASS
protected String	serverPermissionsColumn
protected String	serverSecurityManagerClass
protected PermissionReferenceLocator.TimeThread	updateHourServerThread
static String	USER_GROUP_ENTITY
protected String	userGroupsEntityName

Fields inherited from class com.ontimize.locator.ReferenceLocator

askUserChangeTimezone, ATTACHMENT_ENTITY, ATTACHMENT_ENTITY_PATH, attachmentEntity, attachmentEntityInstance, attachmentPath, AUTONUMERICAL_PROPERTIES, b, chatCheckTime, chatWindow, CHECK_SERVER_MESSAGES_PERIOD, checkMessagesThread, checkRemoteAdministrationMessagesThread, CONTROL_ACCESS_ATTEMPTS, controlAccessAttempt, CUSTOM_SOCKET, cw, databaseEntityManager, DB_PROPERTIES, DEBUG, defaultNoticeDestinyEntityClass, defaultNoticeEntityClass, defaultValueUseServerTimezone, DYNAMIC_LOCAL_ENTITY_PREFIX, ENCRYPT_PROPERTY, ENTITIES_CLASS, ENTITIES_PROPERTIES, entitiesProperties, entitiesPropertiesClass, errorAccessControl, formManagerProviderEntity, formManagerProviderEntityFormNameColumn, formManagerProviderEntityIdColumn, formManagerProviderEntityInteractionManagerColumn, formProviderEntity, formProviderEntityFormNameColumn, formProviderEntityFormRuleColumn, formProviderEntityFormXMLColumn, imageProviderEntity, imageProviderEntityImageBytesColumn, imageProviderEntityImageNameColumn, IMPOSSIBLE_CONNECT_TO_SERVER, initReferences, installSocketFactory, key, lastRemoteReferenceCheck, loadedEntities, LOCAL, LOCAL_ENTITIES, LOCAL_ENTITIES_PACKAGE, LOCALE_ENTITY, LOCALE_SUFFIX, localeEntity, localEntities, localEntitiesPackage, localeSuffix, localLocator, localRemoteReportStore, LOGIN_ENTITY, loginEntity, M_NOT_AUTHORIZED, manager, menuProviderEntity, menuProviderEntityXMLColumn, messagesCheckTime, moduleLocalEntities, MULTICONNECTION_MANAGER, multiConnectionManager, multiConnectionManagerPath, NEW_CHAT, NOTICE_ENTITY_DESTINY_NAME, NOTICE_ENTITY_NAME, noticesPath, noticeSystem, NUMBER_ACCESS_ATTEMPTS, numberAccessAttemps, offset, offsetString, PACKAGE_OR_HOSTNAME, packageA, port, PORT, printingTemplateEntityInstance, printingTemplatesEntity, privilegedId, propertiesPath, reconnectState, REFERENCE_ELEMENT, referenceClassNames, referenceInstances, referenceLocatorServer, referenceLocatorServerName, referenceParameters, REFERENCES_ELEMENT, REMOTE_OBJECT_NOT_REGISTERED, REMOTE_REFERENCE_LOCATOR_NAME, remoteReferenceCheckCycle, remoteReferenceClassNames, remoteReferenceInstances, remoteReferenceParameters, REPORT_ENTITIES, reportEntities, reportStore, rOperationManager, s, serverTimeZone, sessionLocale, sessionLocaleId, SSO_PATH, startSession, text, textAttribute, toolbarProviderEntity, toolbarProviderEntityXMLColumn, UNKNOWN_ERROR, UNKNOWN_HOST, user, userId, VIEWER, xmlDynamicMenu, xmlDynamicToolbar

Fields inherited from interface com.ontimize.security.ClientPermissionManager

PERMISSIONS_KEY

Fields inherited from interface com.ontimize.gui.ServerPermissionManager

ENTITY_LIST_KEY, USER_PERMISSIONS_KEY, USER_PROFILE_PERMISSIONS_KEY

Fields inherited from interface com.ontimize.gui.RemotelyManageable

ADMINISTRATION_PERMISSION, CONNECTION_INFO, IS_MULTICONNECTION, LOADED_ENTITIES, MULTICONNECTION_IDLIST, MULTICONNECTION_INFO

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

INTERNAL_NOTICE_PERIOD, MAIL_CONF_PROPERTIES, NOTICE_CONTENT, NOTICE_CREATE_DATE, NOTICE_DELETE_RECEIVE_NOTICE, NOTICE_DELETE_SEND_NOTICE, NOTICE_DESTINY_KEY, NOTICE_ENTITY_DESTINY_TABLE_DB, NOTICE_ENTITY_TABLE_DB, NOTICE_FORCE_READ, NOTICE_FROM_PARAMETER, NOTICE_KEY, NOTICE_MAILTO_PARAMETER, NOTICE_MESSAGE_COLUMN_NAME, NOTICE_MESSAGE_TYPE_COLUMN_NAME, NOTICE_OTHER_COLUMNS, NOTICE_READ, NOTICE_READ_DATE, NOTICE_RESPONSE_REQUEST, NOTICE_SEND, NOTICE_SEND_DATE, NOTICE_SEND_MAIL, NOTICE_SUBJECT, NOTICE_SYSTEM, NOTICE_TO_PARAMETER, PROP_NOTICE_CLASS_MAIL, PROP_NOTICE_CONFIG_DEFAULT_TEMPLATE, PROP_NOTICE_CONFIG_MAIL, PROP_NOTICE_CONFIG_REQUEST_TEMPLATE, PROP_NOTICE_CONFIG_TEMPLATES, PROP_NOTICE_ENTITY_DESTINY_NAME, PROP_NOTICE_ENTITY_NAME, SEND_MAIL_PERIOD

Constructor Summary

Constructors

Constructor and Description
PermissionReferenceLocator(boolean local, String entityPackageOrRMIServer, String entityReferenceLocatorName, int port, URL dbPropertiesUrl, URL autonumericalUrl)
PermissionReferenceLocator(boolean local, String entityPackageOrRMIServer, String entityReferenceLocatorName, int port, URL dbPropertiesUrl, URL autonumericalUrl, String loginEntity)
PermissionReferenceLocator(boolean local, String entityPackageOrRMIServer, String entityReferenceLocatorName, int port, URL dbPropertiesUrl, URL autonumericalUrl, String permissionEntity, String clientPermissionColumn)
PermissionReferenceLocator(boolean local, String entityPackageOrRMIServer, String entityReferenceLocatorName, int port, URL dbPropertiesUrl, URL autonumericalUrl, String loginEntity, String permissionEntity, String clientPermissionColumn)
PermissionReferenceLocator(Hashtable params) Calls to super() to initialize some parameters and additionally checks permission and profile parameters.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	checkActionPermission(String entity, String action, int sessionId, long time) Checks if the specified user has permissions to execute an action in the specified entity
String	getBussinesCalendarFile()
String	getClientPermissionColumn()
EntityResult	getClientPermissions(Hashtable userKeys, int userId) userKeys contains the value for user keys.
protected Hashtable	getContextParams(String password)
EntityResult	getEntityList(int sessionId)
Hashtable	getParameters()
PermissionGroupInfo[]	getPermissionGroupsInfo()
PermissionInfo	getPermissionInfo(String entity, String action, int sessionId)
protected StringBuffer	getServerPermissions(Hashtable userKeys)
EntityResult	getServerPermissions(Hashtable userKeys, int sessionId) Get the user permissions
long	getTime()
EntityResult	getUserProfileServerPermissions(Hashtable profileKeys, int sessionId) Get the permission definition for a specified profile
void	installClientPermissions(Hashtable keys, int sessionId) Sets the client permissions.
protected void	installServerPermissions(int sessionId, StringBuffer permissions)
protected void	installServerSecurityManager()
protected Hashtable	joinClientPermissions(List permissions)
protected Hashtable	joinServerPermissions(List permissions)
protected EntityResult	queryGroupPermission(Hashtable userKeys, String columnName)
InitialContext	retrieveInitialContext(int sessionId, Hashtable params)
EntityResult	setServerPermissions(Hashtable keys, int sessionId, Hashtable permissions)
EntityResult	setServerPermissions(Hashtable keys, int sessionId, StringBuffer permissions) Sets the server permissions value
EntityResult	setUserProfileServerPermissions(Hashtable profileKeys, StringBuffer permissions, int sessionId)
int	startSession(String user, String password, ClientWatch cw) Start a new client session in local or remote mode.
Hashtable	updateL(Hashtable h)

Methods inherited from class com.ontimize.locator.ReferenceLocator

addModuleMemoryEntity, blockUserDB, changePassword, checkBlockUserDB, checkNoticeAsSend, checkNoticeSent, checkToken, closeLockedConnections, closeSession, configureConnectionManager, configureMultiConnectionManager, configureReference, configureReferences, configureRemoteReferences, createConnectionManager, createDatabaseEntityManager, createDynamicLocalEntity, createMemoryEntity, createReference, createRemoteReference, endSession, ensureRemoteReferenceLocator, failure, finalize, finishAdministrationRemoteSession, getAccessControl, getAttachmentEntity, getChatCheckTime, getConnectedSessionIds, getConnectedUsers, getConnectionManager, getDatabaseConnectionManager, getDEBUGValueRemote, getDefaultPackage, getEntityConnectionManager, getEntityReference, getErrorAccessControl, getFormManagerParameters, getImage, getInitialContext, getInternalNotices, getLastNCharactersFromLogFile, getLContent, getLInfoObject, getLoadedEntities, getLocale, getLocaleEntity, getLocaleId, getLocalEntity, getLocalEntity, getLoginEntityName, getLValue, getMemoryEntity, getMemoryEntity, getMessageCheckTime, getMessages, getNewMailNotice, getNodeValue, getNoticeEntity, getNoticeEntityDestinyName, getNoticeEntityName, getNoticeTypes, getPasswordFromCert, getPasswordFromCert, getPrintingTemplateEntity, getPrivateEntity, getReference, getRemoteAdministrationMessages, getRemoteApplicationPreferences, getRemoteLogManager, getRemoteOperationManager, getRemotePreferencesFile, getRemoteReference, getRemoteReportStore, getReportEntityNames, getSentNotices, getServerTimeZone, getSessionId, getSessionInfo, getSpecialEntity, getStartSessionTime, getSuffixString, getSystemInfo, getToken, getUser, getUserFromCert, getUserFromCert, getUserId, getUserIds, getXMLForm, getXMLMenu, getXMLRules, getXMLToolbar, hasChat, initServerNotice, installClientRMIFailureHandler, installRMISocketFactory, isAllowCertificateLogin, isDevelopementL, isDynamicLocalEntity, isLocalMode, isMultiConnectionManager, loadEntity, ok, ok, ping, reloadXMLMenu, reloadXMLToolbar, removeEntity, removeEntity, removeReceivedNotices, removeRemoteReferences, removeSentNotices, restartServer, selectTimeZone, sendMessage, sendMessage, sendMessageToAll, sendNotice, sendRemoteAdministrationMessages, setDEBUGValueRemote, setDefaultLocaleId, setLocale, setLocalEntities, setMultiConnectionManager, setNoticesRead, setRemotePreferencesFile, setRemoteReportStore, showMessageDialog, ssoLogin, startAdministrationRemoteSession, startCheckMessagesThread, startCheckRemoteAdministratorMessagesThread, startLocalSession, startRemoteSession, startUserPasswordSession, stopServer, supportChangePassword, testConnectionSpeed, testConnectionSpeed, updateRemoteReferenceLocator, waitServerForRestart

Methods inherited from class java.lang.Object

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

Field Detail

ENTITIES

public static final String ENTITIES

See Also:

Constant Field Values

SERVER_SECURITY_MANAGER_CLASS

public static final String SERVER_SECURITY_MANAGER_CLASS

See Also:

Constant Field Values

PROFILE_COLUMN

public static final String PROFILE_COLUMN

See Also:

Constant Field Values

BUSINESS_CALENDAR_FILE

public static final String BUSINESS_CALENDAR_FILE

See Also:

Constant Field Values

SERVER_PERMISSION_COLUMN

public static final String SERVER_PERMISSION_COLUMN

See Also:

Constant Field Values

CLIENT_PERMISSION_COLUMN

public static final String CLIENT_PERMISSION_COLUMN

See Also:

Constant Field Values

PROFILE_ENTITY

public static final String PROFILE_ENTITY

See Also:

Constant Field Values

PERMISSION_ENTITY

public static final String PERMISSION_ENTITY

See Also:

Constant Field Values

PERMISSION_GROUP_KEY_COLUMN

public static String PERMISSION_GROUP_KEY_COLUMN

USER_GROUP_ENTITY

public static String USER_GROUP_ENTITY

serverSecurityManagerClass

protected String serverSecurityManagerClass

permissionsEntity

protected String permissionsEntity

profileEntity

protected String profileEntity

clientPermissionsColumn

protected String clientPermissionsColumn

serverPermissionsColumn

protected String serverPermissionsColumn

userGroupsEntityName

protected String userGroupsEntityName

permissionGroupKeyColumnName

protected String permissionGroupKeyColumnName

entityNames

protected Vector entityNames

profileColumn

protected String profileColumn

businessCalendarFile

protected String businessCalendarFile

clientPermissionsInstalled

protected boolean clientPermissionsInstalled

currentServerTime

protected long currentServerTime

DEFAULT_TIME_THREAD_SLEEP

protected static int DEFAULT_TIME_THREAD_SLEEP

updateHourServerThread

protected PermissionReferenceLocator.TimeThread updateHourServerThread

Constructor Detail

PermissionReferenceLocator

public PermissionReferenceLocator(Hashtable params)

Calls to super() to initialize some parameters and additionally checks permission and profile parameters.

Parameters:

params - the Hashtable with parameters

attribute	values	default	required	meaning
PermissionEntity		User	yes	Permission entity name
ProfileEntity		UserProfile	no	Profile entity name
ProfileColumn		Profile	no	User profile column name. Usually this is a common column between user entity and profile entity.
ClientPermissionColumn		ClientPermission	yes	Name of the column which stores the xml with client permission description
ServerPermissionColumn		ServerPermission	yes	Name of the column which stores the xml with the server permission description
Entities	entityname1;entityname2;...;entitynameN		no	Entity names separated by ';' . This names are used to ask for the references. Only informative value.
BusinessCalendarFile			no	File name for the business calendar, the file format is the same as bundles, for example: com.ontimize.filename.

PermissionReferenceLocator

public PermissionReferenceLocator(boolean local,
                          String entityPackageOrRMIServer,
                          String entityReferenceLocatorName,
                          int port,
                          URL dbPropertiesUrl,
                          URL autonumericalUrl,
                          String loginEntity,
                          String permissionEntity,
                          String clientPermissionColumn)

PermissionReferenceLocator

public PermissionReferenceLocator(boolean local,
                          String entityPackageOrRMIServer,
                          String entityReferenceLocatorName,
                          int port,
                          URL dbPropertiesUrl,
                          URL autonumericalUrl,
                          String permissionEntity,
                          String clientPermissionColumn)

PermissionReferenceLocator

public PermissionReferenceLocator(boolean local,
                          String entityPackageOrRMIServer,
                          String entityReferenceLocatorName,
                          int port,
                          URL dbPropertiesUrl,
                          URL autonumericalUrl,
                          String loginEntity)

PermissionReferenceLocator

public PermissionReferenceLocator(boolean local,
                          String entityPackageOrRMIServer,
                          String entityReferenceLocatorName,
                          int port,
                          URL dbPropertiesUrl,
                          URL autonumericalUrl)

Method Detail

startSession

public int startSession(String user,
               String password,
               ClientWatch cw)
                 throws Exception

Description copied from class: ReferenceLocator

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

Overrides:

startSession in class ReferenceLocator

Parameters:

user - User name

password - User password

cw - 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

installServerSecurityManager

protected void installServerSecurityManager()

installServerPermissions

protected void installServerPermissions(int sessionId,
                            StringBuffer permissions)
                                 throws Exception

Throws:

Exception

queryGroupPermission

protected EntityResult queryGroupPermission(Hashtable userKeys,
                                String columnName)
                                     throws Exception

Throws:

Exception

getClientPermissions

public EntityResult getClientPermissions(Hashtable userKeys,
                                int userId)
                                  throws Exception

userKeys contains the value for user keys. This values are not needed when is a local locator, in this case this object can be null.

Specified by:

getClientPermissions in interface ClientPermissionManager

Parameters:

userKeys - This parameters allow to identify the user. In local locator is not needed and can be a null value.

Returns:

Throws:

Exception

getClientPermissionColumn

public String getClientPermissionColumn()

installClientPermissions

public void installClientPermissions(Hashtable keys,
                            int sessionId)
                              throws Exception

Description copied from interface: ClientPermissionManager

Sets the client permissions. Creates a ClientSecurityManager object with all permissions information for the specified user.

Specified by:

installClientPermissions in interface ClientPermissionManager

Parameters:

keys - Keys to identify the user

sessionId - User session identifier

Throws:

Exception

getTime

public long getTime()
             throws Exception

Specified by:

getTime in interface ClientPermissionManager

Throws:

Exception

getEntityList

public EntityResult getEntityList(int sessionId)
                           throws Exception

Specified by:

getEntityList in interface ServerPermissionManager

Throws:

Exception

setServerPermissions

public EntityResult setServerPermissions(Hashtable keys,
                                int sessionId,
                                StringBuffer permissions)
                                  throws Exception

Description copied from interface: ServerPermissionManager

Sets the server permissions value

Specified by:

setServerPermissions in interface ServerPermissionManager

Parameters:

keys - Keys to identify the user

sessionId - User session identifier

permissions - XML value to describes the server permissions

Returns:

Throws:

Exception

setServerPermissions

public EntityResult setServerPermissions(Hashtable keys,
                                int sessionId,
                                Hashtable permissions)
                                  throws Exception

Throws:

Exception

getServerPermissions

protected StringBuffer getServerPermissions(Hashtable userKeys)

joinServerPermissions

protected Hashtable joinServerPermissions(List permissions)
                                   throws Exception

Throws:

Exception

joinClientPermissions

protected Hashtable joinClientPermissions(List permissions)
                                   throws Exception

Throws:

Exception

getServerPermissions

public EntityResult getServerPermissions(Hashtable userKeys,
                                int sessionId)
                                  throws Exception

Description copied from interface: ServerPermissionManager

Get the user permissions

Specified by:

getServerPermissions in interface ServerPermissionManager

Parameters:

userKeys - Keys to identify the user

sessionId - User session identifier

Returns:

Throws:

Exception

setUserProfileServerPermissions

public EntityResult setUserProfileServerPermissions(Hashtable profileKeys,
                                           StringBuffer permissions,
                                           int sessionId)
                                             throws Exception

Specified by:

setUserProfileServerPermissions in interface ServerPermissionManager

Throws:

Exception

getUserProfileServerPermissions

public EntityResult getUserProfileServerPermissions(Hashtable profileKeys,
                                           int sessionId)
                                             throws Exception

Description copied from interface: ServerPermissionManager

Get the permission definition for a specified profile

Specified by:

getUserProfileServerPermissions in interface ServerPermissionManager

Parameters:

profileKeys - Keys to identify a profile

sessionId - User session identifier

Returns:

Throws:

Exception

checkActionPermission

public boolean checkActionPermission(String entity,
                            String action,
                            int sessionId,
                            long time)
                              throws Exception

Description copied from interface: ServerPermissionManager

Checks if the specified user has permissions to execute an action in the specified entity

Specified by:

checkActionPermission in interface ServerPermissionManager

Parameters:

entity - Entity name

action - Action to check

sessionId - User session identifier

Returns:

Throws:

Exception

getPermissionGroupsInfo

public PermissionGroupInfo[] getPermissionGroupsInfo()
                                              throws Exception

Specified by:

getPermissionGroupsInfo in interface ServerPermissionManager

Throws:

Exception

getBussinesCalendarFile

public String getBussinesCalendarFile()

getPermissionInfo

public PermissionInfo getPermissionInfo(String entity,
                               String action,
                               int sessionId)
                                 throws Exception

Specified by:

getPermissionInfo in interface ServerPermissionManager

Throws:

Exception

getParameters

public Hashtable getParameters()
                        throws Exception

Specified by:

getParameters in interface LControl

Throws:

Exception

updateL

public Hashtable updateL(Hashtable h)
                  throws Exception

Specified by:

updateL in interface LControl

Throws:

Exception

getContextParams

protected Hashtable getContextParams(String password)

Overrides:

getContextParams in class ReferenceLocator

retrieveInitialContext

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

Specified by:

retrieveInitialContext in interface UtilReferenceLocator

Overrides:

retrieveInitialContext in class ReferenceLocator

Throws:

Exception