com.edgeti.VisibilityServer.UsersAndRoles

Class UsersAndRoles

java.lang.Object

com.edgeti.VisibilityServer.UsersAndRoles.UsersAndRoles

Direct Known Subclasses:

UserAndRolesFakeData, UsersAndRolesTests

public class UsersAndRoles
extends java.lang.Object

Class to manage user information and user roles.

Author:

phil.feldman

Field Summary

Fields

Modifier and Type	Field and Description
protected DbHelper	dbHelper The db helper.
protected org.apache.log4j.Logger	logger The logger.
protected static java.lang.String	PROP_FILE The Constant PROP_FILE.
protected static TraceLogBuffer	trace The trace.

Constructor Summary

Constructors

Constructor and Description
UsersAndRoles() Default ctor.
UsersAndRoles(java.lang.String host, java.lang.String database, java.lang.String driver, java.lang.String user, java.lang.String password) Connect to the database.

Method Summary

Methods

Modifier and Type	Method and Description
DashInfoObject	addDashboard(DashInfoObject dio) Insert a user dashboard (Standalone).
protected int	addDashboard(java.lang.String name, int owner, byte[] bytes, int published) Insert a dashboard (Standalone).
DashInfoObject	addGroupDashboard(DashInfoObject dio) Insert a group dashboard (Standalone).
SlideShowInfoObject	addSlideShow(SlideShowInfoObject ssio) Adds the slide show.
protected int	addSlideShow(java.lang.String name, int owner, java.util.ArrayList<DashInfoObject> views, boolean published) Adds the slide show.
boolean	addUser(UserInfoObject user) Add a user to the table.
boolean	addUserRole(int userID, int roleID) Standalone (Connect/Disconnect) Add a relationship between a user and a role.
protected boolean	addUserRolePrivate(int userID, int roleID) Add a relationship between a user and a role.
UserInfoObject	attemptAutoLogin() Attempt auto login.
protected RoleTree	buildRoleHierarchy() Build a java tree based on the information in the role table (Standalone).
void	checkForColumn(java.lang.String columnName, java.lang.String tableName, java.lang.String properties) Check to see that a column in a table exists.
protected void	connect() Connect to the database using the properties file or default data
protected void	connect(java.lang.String host, java.lang.String database, java.lang.String driver, java.lang.String user, java.lang.String password) Connect to the database
void	createDatabase() (Standalone) Create database.
void	createTables() (Standalone) Create all the tables for this database.
java.lang.String	deleteDashboard(DashInfoObject dio) Delete dashboard.
boolean	deleteDashboard(int id) Delete dashboard.
boolean	deleteRoleDashboards(int roleId) Delete role dashboards.
boolean	deleteSlideShow(int id) Delete slide show.
boolean	deleteUser(int id) Delete the user information, based on id
protected void	disconnect() Disconnect from the database.
void	dropDatabase() (Standalone) Create database.
void	dropTables() (Standalone) Delete all the tables in this database.
java.util.List<RoleInfoObject>	getAllRoles() return all roles and related data (users and tables) from database
protected DbTable	getAllRolesTable() Return a DbTable with all role information (Not Standalone).
java.util.List<TableInfoObject>	getAllTables() return all Tables and related data (users and roles) from database
java.util.List<UserInfoObject>	getAllUsers() return all users and related data (roles and tables) from database
java.util.List<UserInfoObject>	getAllUsersInfo() return all users with roles and table information
java.util.List<UserInfoObject>	getAllUsersRoles() return all users and roles
DashInfoObject	getDashboard(int id) (Standalone).
FlexTreeObject	getDashboardTree(java.lang.String mode) (Standalone) Get a tree that organizes the dashboards by user.
DashInfoObject	getGroupDashboard(int id) (Standalone).
FlexTreeObject	getGroupDashboardTree(UserInfoObject uio) (Standalone) Get a tree that organizes the dashboards by role visible to user.
private java.lang.String	getLoginByDN(java.lang.String userDN) Gets the login by Distinguished Name.
int	getRoleId(java.lang.String name) Get the UID for a role by name (Standalone).
RoleInfoObject	getRoleRoot() (Standalone) get the Role Tree.
protected java.util.List<RoleInfoObject>	getRolesByTable(int tableId) return all roles matching table id
protected java.util.List<RoleInfoObject>	getRolesByUser(int userId) return all roles related to the UserId
java.util.List<java.lang.String>	getRoleTables(RoleInfoObject role) Gets the role tables.
FlexTreeObject	getRoleTree() Deprecated.
SlideShowInfoObject	getSlideShow(int id) Gets the slide show.
FlexTreeObject	getSlideShowTree(java.lang.String mode) Gets the slide show tree.
protected java.util.List<TableInfoObject>	getTablesByRole(int roleId) Gets the tables by role.
protected java.util.List<TableInfoObject>	getTablesByUser(int userId) return all tables matching user ID
FlexTreeObject	getTablesTree(java.lang.String mode) (Standalone) Get a tree that organises the dashboards.
protected UserInfoObject	getUIO(java.lang.String login) Gets the UserInfoObject associated with a login.
FlexTreeObject	getUserDashboardTree(int id, java.lang.String mode) (Standalone).
private java.lang.String	getUserDNfromSession(flex.messaging.FlexSession mySession) Retrieves the user's Distinguished Name from the session.
UserInfoObject	getUserInfo(java.lang.String login) Gets the UserInfoObject associated with a login.
UserInfoObject	getUserInfo(java.lang.String login, boolean updateDN) Gets the UserInfoObject associated with a login.
java.util.List<java.lang.String>	getUserRoles(UserInfoObject user) Gets the user roles.
protected java.util.List<UserInfoObject>	getUsersByRole(int roleId) returns all users matching role ID
protected java.util.List<UserInfoObject>	getUsersByTable(int tableId) return all users matching table ID
java.util.List<java.lang.String>	getUserTables(UserInfoObject user) returns list of tables matching users roles.
java.lang.String	getVersion() Simple method just to make sure that everything is working.
static void	main(java.lang.String[] args) The main method.
void	printTable(java.lang.String tableName) Print out the values of a table in the databse.
protected void	saveSlides(java.sql.Connection conn, int ssID, java.util.ArrayList<DashInfoObject> slides) Save slides.
void	setRoleRoot(RoleInfoObject root) Clear and repopulate the role table.
private boolean	setUserDN(java.lang.String loginID, java.lang.String userDN) Updates the user_DN entry in the database.
DashInfoObject	updateDashboard(DashInfoObject dio) (Standalone) Update an existing dashboard.
RoleInfoObject	updateRoleRelation(RoleInfoObject role) Update role relation.
boolean	updateRoleRoot(RoleInfoObject newRoot) Update the current role tree based on the passed-in root.
boolean	updateRoleTree(RoleInfoObject newRoot, RoleInfoObject oldRoot) Update the old role tree based on the new role tree.
SlideShowInfoObject	updateSlideShow(SlideShowInfoObject ssio) Update slide show.
TableInfoObject	updateTableRelation(TableInfoObject table) Update table relation.
void	updateTables() (Standalone) Create new tables that have been added to the database lately.
boolean	updateUser(UserInfoObject user) Standalone (connect and disconnect).
boolean	updateUserPreferences(UserInfoObject user) Standalone method to update user's xml that contains their preferences.
UserInfoObject	updateUserRelation(UserInfoObject user) update user related data (roles and tables)
void	useConsoleLogger() Use console logger.

Methods inherited from class java.lang.Object

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

Field Detail

dbHelper

protected DbHelper dbHelper

The db helper.

trace

protected static TraceLogBuffer trace

The trace.

PROP_FILE

protected static final java.lang.String PROP_FILE

The Constant PROP_FILE.

See Also:

Constant Field Values

logger

protected org.apache.log4j.Logger logger

The logger.

Constructor Detail

UsersAndRoles

public UsersAndRoles()

Default ctor. Uses the properties file to determine the values to connect to the databse.

UsersAndRoles

public UsersAndRoles(java.lang.String host,
             java.lang.String database,
             java.lang.String driver,
             java.lang.String user,
             java.lang.String password)
              throws java.lang.Exception

Connect to the database.

Parameters:

host - the host

database - the database

driver - the driver

user - the user

password - the password

Throws:

java.lang.Exception - the exception

Method Detail

useConsoleLogger

public void useConsoleLogger()

Use console logger.

getVersion

public java.lang.String getVersion()

Simple method just to make sure that everything is working.

Returns:

the version

getAllUsers

public java.util.List<UserInfoObject> getAllUsers()

return all users and related data (roles and tables) from database

Returns:

List

getAllRoles

public java.util.List<RoleInfoObject> getAllRoles()

return all roles and related data (users and tables) from database

Returns:

List

getAllTables

public java.util.List<TableInfoObject> getAllTables()

return all Tables and related data (users and roles) from database

Returns:

List

getAllUsersRoles

public java.util.List<UserInfoObject> getAllUsersRoles()

return all users and roles

Returns:

List

getAllUsersInfo

public java.util.List<UserInfoObject> getAllUsersInfo()

return all users with roles and table information

Returns:

List

getRolesByUser

protected java.util.List<RoleInfoObject> getRolesByUser(int userId)

return all roles related to the UserId

Parameters:

userId - - User Id to match

Returns:

List

getRolesByTable

protected java.util.List<RoleInfoObject> getRolesByTable(int tableId)

return all roles matching table id

Parameters:

tableId - - table ID to match

Returns:

List

getTablesByUser

protected java.util.List<TableInfoObject> getTablesByUser(int userId)

return all tables matching user ID

Parameters:

userId - - user id to match

Returns:

List

getUsersByRole

protected java.util.List<UserInfoObject> getUsersByRole(int roleId)

returns all users matching role ID

Parameters:

roleId - - role ID to match

Returns:

List

getUsersByTable

protected java.util.List<UserInfoObject> getUsersByTable(int tableId)

return all users matching table ID

Parameters:

tableId - - table ID to match

Returns:

List

updateUserRelation

public UserInfoObject updateUserRelation(UserInfoObject user)

update user related data (roles and tables)

Parameters:

user - - user information to update

Returns:

UserInfoObject

getUIO

protected UserInfoObject getUIO(java.lang.String login)

Gets the UserInfoObject associated with a login.

Parameters:

login - the login

Returns:

the UserInfoObject

getUserInfo

public UserInfoObject getUserInfo(java.lang.String login)

Gets the UserInfoObject associated with a login.

Parameters:

login - the login

Returns:

UserInfoObject

getUserInfo

public UserInfoObject getUserInfo(java.lang.String login,
                         boolean updateDN)

Gets the UserInfoObject associated with a login. If updateDN is true, then the Distinguished Name of the user is automatically updated

Parameters:

login - the login

updateDN - the Distinguished Name flag

Returns:

the UserInfoObject

addUser

public boolean addUser(UserInfoObject user)

Add a user to the table. Ensure that the login is not duplicated

Parameters:

user - the user

Returns:

true, if successful

deleteUser

public boolean deleteUser(int id)

Delete the user information, based on id

Parameters:

id - the id of the user to delete

Returns:

true, if successful

updateUser

public boolean updateUser(UserInfoObject user)

Standalone (connect and disconnect).

Parameters:

user - the user

Returns:

true, if successful

updateUserPreferences

public boolean updateUserPreferences(UserInfoObject user)

Standalone method to update user's xml that contains their preferences.

Parameters:

user - the user

Returns:

true, if successful

addDashboard

public DashInfoObject addDashboard(DashInfoObject dio)

Insert a user dashboard (Standalone).

Parameters:

dio - - DashInfoObject

Returns:

the dash info object

addGroupDashboard

public DashInfoObject addGroupDashboard(DashInfoObject dio)

Insert a group dashboard (Standalone).

Parameters:

dio - - DashInfoObject

Returns:

the dash info object

addDashboard

protected int addDashboard(java.lang.String name,
               int owner,
               byte[] bytes,
               int published)

Insert a dashboard (Standalone).

Parameters:

name - the name

owner - the owner

bytes - the data

published - true if published, false otherwise

Returns:

the int

getDashboard

public DashInfoObject getDashboard(int id)

(Standalone).

Parameters:

id - the id

Returns:

the dashboard

getGroupDashboard

public DashInfoObject getGroupDashboard(int id)

(Standalone).

Parameters:

id - the id

Returns:

the group dashboard

deleteDashboard

public boolean deleteDashboard(int id)

Delete dashboard.

Parameters:

id - the id

Returns:

true, if successful

deleteRoleDashboards

public boolean deleteRoleDashboards(int roleId)

Delete role dashboards.

Parameters:

roleId - the role id

Returns:

true, if successful

updateDashboard

public DashInfoObject updateDashboard(DashInfoObject dio)

(Standalone) Update an existing dashboard.

Parameters:

dio - the dio

Returns:

the dash info object

deleteDashboard

public java.lang.String deleteDashboard(DashInfoObject dio)

Delete dashboard.

Parameters:

dio - the dio

Returns:

the string

getDashboardTree

public FlexTreeObject getDashboardTree(java.lang.String mode)

(Standalone) Get a tree that organizes the dashboards by user. Current option is "NAME", but "DATA" and other modes should be supported later

Parameters:

mode - the mode

Returns:

the dashboard tree

getTablesTree

public FlexTreeObject getTablesTree(java.lang.String mode)

(Standalone) Get a tree that organises the dashboards. Current option is "NAME", but "DATA" and other modes should be supported later

Parameters:

mode - the mode

Returns:

the tables tree

getUserDashboardTree

public FlexTreeObject getUserDashboardTree(int id,
                                  java.lang.String mode)

(Standalone).

Parameters:

id - the id

mode - the mode

Returns:

the user dashboard tree

getGroupDashboardTree

public FlexTreeObject getGroupDashboardTree(UserInfoObject uio)

(Standalone) Get a tree that organizes the dashboards by role visible to user. Current option is "NAME", but "DATA" and other modes should be supported later

Parameters:

uio - - UserInfoObject with role information

Returns:

the group dashboard tree

addSlideShow

public SlideShowInfoObject addSlideShow(SlideShowInfoObject ssio)

Adds the slide show.

Parameters:

ssio - the ssio

Returns:

the slide show info object

addSlideShow

protected int addSlideShow(java.lang.String name,
               int owner,
               java.util.ArrayList<DashInfoObject> views,
               boolean published)

Adds the slide show.

Parameters:

name - the name

owner - the owner

views - the views

published - the published

Returns:

the int

saveSlides

protected void saveSlides(java.sql.Connection conn,
              int ssID,
              java.util.ArrayList<DashInfoObject> slides)
                   throws java.lang.Exception

Save slides.

Parameters:

conn - the database connection

ssID - the slide show id

slides - ArrayList of 'slides'

Throws:

java.lang.Exception - if the DB prepared statement fails

deleteSlideShow

public boolean deleteSlideShow(int id)

Delete slide show.

Parameters:

id - the id of the slide show

Returns:

true, if successful

updateSlideShow

public SlideShowInfoObject updateSlideShow(SlideShowInfoObject ssio)

Update slide show.

Parameters:

ssio - the SlideShowInfoObject

Returns:

the updated SlideShowInfoObject

getSlideShow

public SlideShowInfoObject getSlideShow(int id)

Gets the slide show.

Parameters:

id - the id of the slide show

Returns:

the SlideShowInfoObject

getSlideShowTree

public FlexTreeObject getSlideShowTree(java.lang.String mode)

Gets the slide show tree.

Parameters:

mode - (unused)

Returns:

the slide show tree as FlexTreeObject

getTablesByRole

protected java.util.List<TableInfoObject> getTablesByRole(int roleId)

Gets the tables by role.

Parameters:

roleId - the role id

Returns:

the tables by role

updateTableRelation

public TableInfoObject updateTableRelation(TableInfoObject table)

Update table relation.

Parameters:

table - the table

Returns:

the table info object

updateRoleRelation

public RoleInfoObject updateRoleRelation(RoleInfoObject role)

Update role relation.

Parameters:

role - the role

Returns:

the role info object

addUserRole

public boolean addUserRole(int userID,
                  int roleID)

Standalone (Connect/Disconnect) Add a relationship between a user and a role. Note that a user can have multiple roles and a role will have multiple users

Parameters:

userID - the user id

roleID - the role id

Returns:

true, if successful

addUserRolePrivate

protected boolean addUserRolePrivate(int userID,
                         int roleID)

Add a relationship between a user and a role. Note that a user can have multiple roles and a role will have multiple users

Parameters:

userID - the user id

roleID - the role id

Returns:

true, if successful

getRoleId

public int getRoleId(java.lang.String name)

Get the UID for a role by name (Standalone).

Parameters:

name - the name

Returns:

the role id

getAllRolesTable

protected DbTable getAllRolesTable()

Return a DbTable with all role information (Not Standalone).

Returns:

the all roles table

getRoleTree

public FlexTreeObject getRoleTree()

Deprecated.

(Standalone) get the Role Tree as a FlexTreeObject. We need this for MUManager.as

Returns:

the role tree

getRoleRoot

public RoleInfoObject getRoleRoot()

(Standalone) get the Role Tree. Replaces getRoleTree

Returns:

the role root

setRoleRoot

public void setRoleRoot(RoleInfoObject root)

Clear and repopulate the role table.

Parameters:

root - the new role root

buildRoleHierarchy

protected RoleTree buildRoleHierarchy()

Build a java tree based on the information in the role table (Standalone).

Returns:

the role tree

updateRoleRoot

public boolean updateRoleRoot(RoleInfoObject newRoot)

Update the current role tree based on the passed-in root.

Parameters:

newRoot - the new root

Returns:

true, if successful

updateRoleTree

public boolean updateRoleTree(RoleInfoObject newRoot,
                     RoleInfoObject oldRoot)

Update the old role tree based on the new role tree.

Parameters:

newRoot - the new root

oldRoot - the old root

Returns:

true, if successful

getUserTables

public java.util.List<java.lang.String> getUserTables(UserInfoObject user)

returns list of tables matching users roles.

Parameters:

user - the user

Returns:

List - string list of tables

getUserRoles

public java.util.List<java.lang.String> getUserRoles(UserInfoObject user)

Gets the user roles.

Parameters:

user - the user

Returns:

the user roles

getRoleTables

public java.util.List<java.lang.String> getRoleTables(RoleInfoObject role)

Gets the role tables.

Parameters:

role - the role

Returns:

the role tables

connect

protected void connect()

Connect to the database using the properties file or default data

connect

protected void connect(java.lang.String host,
           java.lang.String database,
           java.lang.String driver,
           java.lang.String user,
           java.lang.String password)
                throws java.lang.Exception

Connect to the database

Parameters:

host - the host

database - the database

driver - the driver

user - the user

password - the password

Throws:

java.lang.Exception - the exception

disconnect

protected void disconnect()

Disconnect from the database.

checkForColumn

public void checkForColumn(java.lang.String columnName,
                  java.lang.String tableName,
                  java.lang.String properties)

Check to see that a column in a table exists. If not, add it

Parameters:

columnName - the column name

tableName - the table name

properties - the properties

dropTables

public void dropTables()

(Standalone) Delete all the tables in this database.

createDatabase

public void createDatabase()

(Standalone) Create database.

dropDatabase

public void dropDatabase()

(Standalone) Create database.

createTables

public void createTables()

(Standalone) Create all the tables for this database.

updateTables

public void updateTables()

(Standalone) Create new tables that have been added to the database lately.

attemptAutoLogin

public UserInfoObject attemptAutoLogin()

Attempt auto login.

Returns:

the user info object

getUserDNfromSession

private java.lang.String getUserDNfromSession(flex.messaging.FlexSession mySession)

Retrieves the user's Distinguished Name from the session.

Parameters:

mySession - the FlexSession

Returns:

the user Distinguished Name String

getLoginByDN

private java.lang.String getLoginByDN(java.lang.String userDN)

Gets the login by Distinguished Name.

Parameters:

userDN - the user Distinguished Name

Returns:

the login by Distinguished Name

setUserDN

private boolean setUserDN(java.lang.String loginID,
                java.lang.String userDN)

Updates the user_DN entry in the database.

Parameters:

loginID - the login id

userDN - the user Distinguished Name

Returns:

true, if successful

printTable

public void printTable(java.lang.String tableName)

Print out the values of a table in the databse.

Parameters:

tableName - the table name

main

public static void main(java.lang.String[] args)

The main method. For debugging only

Parameters:

args - the arguments