com.ibm.dse.applsrv.aa
Class SecurityObject

java.lang.Object
  |
  +--com.ibm.dse.applsrv.aa.SecurityObject
Direct Known Subclasses:
SecurityConfiguration, SecurityContext, SecurityGroup, SecurityLimit, SecurityRight, SecurityRole, SecurityService, SecurityUser

public abstract class SecurityObject
extends java.lang.Object
implements SecurityConstants, java.io.Serializable

This class represents the abstract parent of security object.

See Also:
Serialized Form

Field Summary
static java.lang.String fs
           
 
Fields inherited from interface com.ibm.dse.applsrv.aa.SecurityConstants
ACTIVE_CONTEXTS, ALL_CONTEXTS, AUDIT_FILE, CBTF_TRACING, CONFIGURATION, CONFIGURATIONS_DATABASE, CONTEXT_ACTIVE, CONTEXT_DATABASE, CONTEXT_INACTIVE, CONTEXT_INVALID, CONTEXTS, CONTROLLER, DEFAULT_CONFIGURATIONS_DATABASE, DEFAULT_CONTEXT_DATABASE, DEFAULT_GROUPS_DATABASE, DEFAULT_RIGHTS_DATABASE, DEFAULT_ROLES_DATABASE, DEFAULT_SERVICES_DATABASE, DEFAULT_USER_DATABASE, ENCRYPTION, GLOBAL_CONTEXTS, GROUPS, GROUPS_DATABASE, INACTIVE_CONTEXTS, JDBC_DATABASE, JDBC_DRIVER, JDBC_MAX_DATA, JDBC_MAX_GROUPS, JDBC_MAX_HANDLER, JDBC_MAX_ID, JDBC_MAX_PASSWORD, JDBC_MAX_RIGHT_TIMES, JDBC_MAX_RIGHTS, JDBC_MAX_ROLE_TIMES, JDBC_MAX_ROLES, JDBC_MAX_USER_ID, JDBC_MAX_USERS, JDBC_PASSWORD, JDBC_URL, JDBC_USER_ID, LIMIT_DATABASE, LIMITS, LOGGING_HANDLER, LOGGING_OPTIONS, PERSIST_CONTEXTS, PERSISTENCE, QUERY_PASSWORDS, RIGHTS, RIGHTS_DATABASE, ROLES, ROLES_DATABASE, SECURITY_DIRECTORY, SECURITY_MANAGER, SERVICES, SERVICES_DATABASE, SPECIFIC_CONTEXTS, TEST_ADD_RIGHT_TO_USER, TEST_ADD_RIGHTS_TO_USER, TEST_AUDIT, TEST_CONTEXT_IDS, TEST_DISABLE_PERSISTENCE, TEST_EXPORT, TEST_GET_CONFIGURATION, TEST_GET_CONTEXTS, TEST_GET_GROUPS, TEST_GET_PASSWORD_ACCESS, TEST_GET_PERSISTENCE, TEST_GET_RIGHTS, TEST_GET_ROLES, TEST_GET_SERVICES, TEST_GET_UNIQUE_LOGON, TEST_GET_USERS, TEST_GROUP_IDS, TEST_IMPORT, TEST_IMPORT2, TEST_LOAD_CONFIGURATIONS, TEST_LOAD_CONTEXTS, TEST_LOAD_GROUPS, TEST_LOAD_RIGHTS, TEST_LOAD_ROLES, TEST_LOAD_SERVICES, TEST_LOAD_USERS, TEST_PERSISTENCE, TEST_QUERY_SM, TEST_REMOVE_ALL_RIGHTS_FROM_USER, TEST_RESET, TEST_RIGHT_IDS, TEST_ROLE_IDS, TEST_SAVE, TEST_SERVICE_IDS, TEST_SET_CONFIGURATION, TEST_SET_PASSWORD_ACCESS, TEST_SET_PERSISTENCE, TEST_SET_UNIQUE_LOGON, TEST_TEST1, TEST_TEST2, TEST_TEST3, TEST_TRACE, TEST_USER_IDS, TRACE_EXCEPTIONS, TRACE_FILE, TRACE_LOGGER, UNIQUE_LOGONS, USE_LIMITS, USER_DATABASE, USERS
 
Constructor Summary
SecurityObject()
           
 
Method Summary
protected abstract  void _save()
          Set the dictionary of data associations.
 Dictionary getData()
          Return a copy of the dictionary of data associations.
 java.lang.String getData(java.lang.String key)
          Return the value associated with specified name.
 Dictionary getDataOrNull()
          Return a copy of the dictionary of data associations.
 java.lang.String getName()
          Return the name of this security object.
static java.lang.String home()
          Return the Visual Banker home directory.
protected static java.lang.String prefix()
          Return the pathname prefix of the current database.
 void putData(Dictionary newData)
          Set the dictionary of data associations.
 boolean putData(java.lang.String key, java.lang.String value)
          Set the value of the specified data name.
protected static void save()
          Save the current state of these types of security objects to the database.
protected  void setName(java.lang.String name)
          Set the name of this security object.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

fs

public static final java.lang.String fs
Constructor Detail

SecurityObject

public SecurityObject()
Method Detail

_save

protected abstract void _save()
                       throws DSESecurityException
Set the dictionary of data associations.
Throws:
DSESecurityException - - database error.

getData

public Dictionary getData()
Return a copy of the dictionary of data associations.
Returns:
Dictionary - the copy of the data dictionary.

getData

public java.lang.String getData(java.lang.String key)
Return the value associated with specified name.
Parameters:
key - String - the name of the data item.
Returns:
String - the associated value or null if the key is not found.

getDataOrNull

public Dictionary getDataOrNull()
Return a copy of the dictionary of data associations.
Returns:
Dictionary - the copy of the data dictionary.

getName

public java.lang.String getName()
Return the name of this security object.
Returns:
String - the name.

home

public static java.lang.String home()
Return the Visual Banker home directory.
Returns:
String - the home directory.

prefix

protected static java.lang.String prefix()
Return the pathname prefix of the current database.
Returns:
String - the prefix for the database path.

putData

public void putData(Dictionary newData)
             throws DSESecurityException
Set the dictionary of data associations.
Parameters:
newData - Dictionary - the new data set.
Throws:
DSESecurityException - - database error.

putData

public boolean putData(java.lang.String key,
                       java.lang.String value)
                throws DSESecurityException
Set the value of the specified data name.
Parameters:
key - String - the name of the data item.
value - String - the value to associate with the name.
Returns:
boolean - true if the dictionary was updated else false.
Throws:
DSESecurityException - - database error.

save

protected static void save()
                    throws DSESecurityException
Save the current state of these types of security objects to the database. This is a dummy method - the real method must be implemented within each subclass.
Throws:
DSESecurityException - - abstract method.

setName

protected void setName(java.lang.String name)
Set the name of this security object.
Parameters:
name - String - the name of this security object.