Establishing Security Bridges for Your Business Intelligence Tool

RoleCollection(JDBCConnection dbCon)

Nothing

JDBCConnection dbCon. A valid JDBC Connection.

This is the constructor used to instantiate the Role collection.

LoadAllRoles()

Nothing

None

This method clears out the current elements in the collection and load it with all the currently defined Roles in EPM.

Role(JDBCConnection dbCon, String Name);

Nothing

JDBCConnection dbCon. A valid JDBC Connection.

The constructor for the Role class. Takes JDBC Connection and RoleName as parameters. Given a rolename, the constructor will fill up the other properties such as Type and Description.

getUsers();

List of UserNames

None

The method will return a List of User Names that belong to this Role. A standard Java List object can be used to implement this.

getAccessibleDimensions();

List of Dimension Names

None

The method will return a List Dimension names that this Role can access.

hasAccess (String DimName);

integer 0 or 1

Dimension Name

The method returns a Boolean specifying whether the Dimension referenced by DimensionName parameter is available to the Role or not.

hasAccess(String DimName, int DimValue);

integer 0 or 1

Dimension Name, A surrogate key value

The method returns 0 or 1 specifying whether this Role has access to a particular value in a dimension.

hasAllAccess(String DimName);

integer 0 or 1

Dimension Name

The method returns a Boolean specifying whether this Role has ALL access to the Dimension referenced by DimensionName parameter.

getDimensionValues(String DimName);

List of Values

Dimension Name

The method returns a List of values in the Dimension referenced by DimName that are available to the Role. The method will first check to ensure that the Dimension Name is a valid Secured dimension in the system, and it is accessible to the Role. The method will retun a List of values from the appropriate security join table. If the Role has ALL access to this dimension, the List will contain only one value with the pre-determined surrogate key value for ALL. Will return an empty List if the dimension is not available to the Role.

getName();

String Name

None

Get method for Name

getType();

String Name

None

Get method for Type

getDescription();

Stirng Descr

None

Get method for Description

getLongDescription();

String Description

None

Getter method for Long Description

User(JDBCConnection dbCon, String Name);

Nothing

JDBC Connection, String UserName

The constructor for the User class. Takes Name as the one and only parameter.

getRoles();

List of RoleNames

None

The method will instantiate a List of Role Names that contain this User.

getAccessibleDimensions();

List of Dimension Names

None

The method will return a List of Dimension names that this User can access. This will be a combined list of all dimensions that the user can access via all his roles.

hasAccess (String DimName);

getAccessibleMetrics()

integer 0 or 1

Dimension Name

The method returns a Boolean specifying whether the Dimension referenced by DimensionName parameter is available to the User or not. This method queries all the Roles for this user to determine if the user has access to the dimension.

hasAccess(String DimName, int DimValue);

integer 0 or 1

Dimension Name, A surrogate key value

The method returns 0 or 1 specifying whether this User has access to a particular value in a dimension. This method queries all the Roles for this user to determine if the user has access to the dimension and value.

hasAllAccess(String DimName);

integer 0 or 1

Dimension Name

The method returns a Boolean specifying whether this User has ALL access to the Dimension referenced by DimensionName parameter. If any of the user's Roles has ALL access, the user is deemed to have ALL access.

getDimensionValues(String DimName);

List of Values

Dimension Name

The method returns a List of values in the Dimension referenced by DimName that are available to the User. The method first checks to ensure that the Dimension Name is a valid Secured dimension in the system, and it is accessible to the User. This is a combined list of values from all the user's Roles. The method returns a List of values from the appropriate SJT. If the User has "all" access to this dimension, the List will contain only one value with the pre-determined surrogate key value for "all". Will return an empty List if the dimension is not available to the User.

getName();

String Name

None

Get method for Name

DimensionCollection(JDBCConenction dbCon)

Nothing

JDBC Connection

This is the constructor used to instantiate the Dimension collection. This class is derived from one of the Java Collection classes, possibly ArrayList, or LinkedList. Most of the methods needed are inherited from the Collection class, Next(), Previous(), HasNext(), size() and so forth. The constructor will instantiate an empty collection.

LoadAllDimensions()

Nothing

None

This method will clear out the current elements in the collection and load it with all the currently secured dimensions in EPM.

Dimension (JDBC Connection, String Name)

String Name

JDBC Connection

This is the constructor for this class. Takes a Dimension Name as parameter. The constructor will validate that the dimension specified by Name is a valid secured dimension in EPM. If it is an invalid name, or the dimension is not secured, the constructor will fail.

getRoles()

List of Role Names

Nothing

This method will return a list of all Role names that have access to this dimension.

getUsers()

List of User Names

Nothing

This method will return a list of all User names that have access to this dimension.

getDimName()

Stirng Name

None

Get method for Name.

getDimTableName()

String TableName

None

Get method for Table Name.

getDimKeyName()

String KeyName

None

Get method for Key Name.

isSecured()

Boolean

None

Get method for isSecured.

MetricCollection(JDBCConnection dbCon)

Nothing

A valid JDBCConnection

This is the constructor used to instantiate the Metric collection. The constructor will instantiate an empty collection.

LoadAllMetrics()

Nothing

None

This method will clear out the current elements in the collection and load it with all the currently secured metrics in EPM.

Metric(JDBCConnection dbCon , String Name)

Nothing

JDBCConnection dbCon , String Name

This is the constructor for this class. Takes a Dimension Name as parameter. There is no other public constructor. You need at least a Dimension Name to instantiate this class. The constructor will validate that the dimension specified by Name is a valid secured dimension in EPM. If it is an invalid name, or the dimension is not secured, the constructor will fail.

getColName()

String Column Name

None.

This method will return the column name that the metric defines.

getRecName()

String Record Name

None

This method will return the Record name that the metric defines.

makeConnection()

Nothing

None

This method will connect to a JDBC database. The parameters needed to connect will be read from jdbcconnection.property file.

makeConnection(String theDriverName, String theDbURL)

Nothing

Driver Name, DB URL string

This method will connect to a JDBC database. The parameters needed to connect are passed into the method.

makeConnection(String theDriverName, String theDbURL, String theUserName, String thePassword)

Nothing

JDBC Driver Name to be used to attempt the connection, URL for database to connect, User Name, Password

This method will connect to a JDBC database. The parameters needed to connect are passed into the method.

closeConnection()

Nothing

None

This method will close the connection.

getDbResultSet(String pTheQuery)

ResultSet

Query sent to the database.

This method will execute the query and return a ResultSet object.