com.goldencode.p2j.util

Class MetadataSecurityOps

java.lang.Object

com.goldencode.p2j.util.MetadataSecurityOps

All Implemented Interfaces:

CustomSecurityOps

public class MetadataSecurityOps
extends java.lang.Object
implements CustomSecurityOps

Implementation of user security functions of P4GL using the _User metadata from database. From my tests, Progress does not use locks when executing setuserid and userid functions. If a user is exclusive-locking the _user table, another one can get/set userid for the same database. However, attempting to execute a FIND query on the _user meta-table it will be put on hold until the first user releases the lock. TODO: Err 709: "-P and -U startup parameters require _User file records."

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	META_TABLE_USER Constant used for accessing the converted _User meta-table.
private static java.util.Map<java.lang.String,java.lang.String>	metaFieldDomain The domain field name, per ldb.
private static java.util.Map<java.lang.String,java.lang.String>	metaFieldPassword The password field name, per ldb.
private static java.util.Map<java.lang.String,java.lang.String>	metaFieldUserId The user ID field name, per ldb.

Constructor Summary

Constructors

Constructor and Description
MetadataSecurityOps()

Method Summary

Modifier and Type	Method and Description
int	getAuthLevel(java.lang.String ldbname) Check the access level for a database.
static java.lang.String	getMetaFieldDomain(java.lang.String ldbName) Compute the name of the domain field, depending if the conversion for this ldb is minimal or not.
static java.lang.String	getMetaFieldPassword(java.lang.String ldbName) Compute the name of the password field, depending if the conversion for this ldb is minimal or not.
static java.lang.String	getMetaFieldUserid(java.lang.String ldbName) Compute the name of the user ID field, depending if the conversion for this ldb is minimal or not.
java.lang.String	getUserId() Returns the userid associated with the current connected database.
java.lang.String	getUserIdFromDB(java.lang.String dbname) Returns the userid associated with the current user of the given logical database.
boolean	hasAccessToDatabase(java.lang.String ldbName) Checks if the currently authenticated user has access to a database.
boolean	setUserId(java.lang.String userid, java.lang.String password) Authenticates the user for specified DB connection.
boolean	setUserId(java.lang.String userid, java.lang.String password, java.lang.String dbname) Authenticates the user for specified DB connection.
void	setUserIdDirect(java.lang.String userid, java.lang.String dbname, boolean lock) Sets the specified user ID directly, without authentication, for the given database.

Methods inherited from class java.lang.Object

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

Field Detail

META_TABLE_USER

public static final java.lang.String META_TABLE_USER

Constant used for accessing the converted _User meta-table.

See Also:

Constant Field Values

metaFieldUserId

private static java.util.Map<java.lang.String,java.lang.String> metaFieldUserId

The user ID field name, per ldb.

metaFieldDomain

private static java.util.Map<java.lang.String,java.lang.String> metaFieldDomain

The domain field name, per ldb.

metaFieldPassword

private static java.util.Map<java.lang.String,java.lang.String> metaFieldPassword

The password field name, per ldb.

Constructor Detail

MetadataSecurityOps

public MetadataSecurityOps()

Method Detail

getMetaFieldUserid

public static java.lang.String getMetaFieldUserid(java.lang.String ldbName)

Compute the name of the user ID field, depending if the conversion for this ldb is minimal or not.

Returns:

The field name.

getMetaFieldDomain

public static java.lang.String getMetaFieldDomain(java.lang.String ldbName)

Compute the name of the domain field, depending if the conversion for this ldb is minimal or not.

Returns:

The field name.

getMetaFieldPassword

public static java.lang.String getMetaFieldPassword(java.lang.String ldbName)

Compute the name of the password field, depending if the conversion for this ldb is minimal or not.

Returns:

The field name.

getUserId

public java.lang.String getUserId()

Returns the userid associated with the current connected database. If no database is connected or there are at least two databases connected empty string is returned.

Specified by:

getUserId in interface CustomSecurityOps

Returns:

The current user context's userid or the empty string in the case of any problem.

getUserIdFromDB

public java.lang.String getUserIdFromDB(java.lang.String dbname)

Returns the userid associated with the current user of the given logical database.

Specified by:

getUserIdFromDB in interface CustomSecurityOps

Parameters:

dbname - Logical database name.

Returns:

The current user context's userid for specified database. If database is not known or not connected, the empty string is returned. If an unknown parameter is provided the method returns unknown value.

setUserId

public boolean setUserId(java.lang.String userid,
                         java.lang.String password)

Authenticates the user for specified DB connection. Checks if the user login account match the corresponding record of the _User table of the database. If there are multiple database connections or none is connected, an error is issued.

Specified by:

setUserId in interface CustomSecurityOps

Parameters:

userid - The name of the user to set as UserID.

password - The users password.

Returns:

The true in case of valid user match false otherwise.

setUserId

public boolean setUserId(java.lang.String userid,
                         java.lang.String password,
                         java.lang.String dbname)

Authenticates the user for specified DB connection. Checks if the user login account match the corresponding record of the _User table of the database. If the specified database is not connected, an error is issued. The user/password comparing operation is done as 4GL:

• user: is case-insensitive, trailing spaces are ignored (in upper(rtrim()) mode)
• password: must be an exact match: after applying ENCODE to password string it is compared to existing record from database in case sensitive, taking into consideration trailing spaces

Specified by:

setUserId in interface CustomSecurityOps

Parameters:

userid - The name of the user to set as UserID.

password - The users password.

dbname - Logical database name.

Returns:

The true in case of valid user match false otherwise.

setUserIdDirect

public void setUserIdDirect(java.lang.String userid,
                            java.lang.String dbname,
                            boolean lock)

Sets the specified user ID directly, without authentication, for the given database.

Specified by:

setUserIdDirect in interface CustomSecurityOps

Parameters:

userid - The name of the user to set as UserID.

dbname - Logical database name.

lock - Flag indicating that the database should be locked

getAuthLevel

public int getAuthLevel(java.lang.String ldbname)

Check the access level for a database. This will query the _User table and return the value.

Specified by:

getAuthLevel in interface CustomSecurityOps

Parameters:

ldbname - The logical database name to query.

Returns:

The access level to specified database.

hasAccessToDatabase

public boolean hasAccessToDatabase(java.lang.String ldbName)

Checks if the currently authenticated user has access to a database.

If the database does not have any users defined in _user meta table the authentication is not enforced so any user can access it. Otherwise, the user must have entered a correct combination of userid / password to get access to respective database.

Specified by:

hasAccessToDatabase in interface CustomSecurityOps

Parameters:

ldbName - The logical name of the database.

Returns:

true if access to requested database is granted