com.ibm.dse.applsrv.aa
Interface SecurityManagerInterface

All Known Implementing Classes:
SecurityManager

public interface SecurityManagerInterface

This interface defines the APIs for a security manager.


Method Summary
 void addRightsToRole(java.lang.String nameOfRole, java.lang.String[] rights, int id)
          A security manager must defined a method to Add rights to a role.
 void addRightsToService(java.lang.String nameOfService, java.lang.String[] rights, int id)
          A security manager must define a method to add rights to a service.
 void addRightsToUser(java.lang.String nameOfUser, java.lang.String[] rights, int id)
          A security manager must define a method to add rights to a user.
 void addRightToRole(java.lang.String nameOfRole, java.lang.String right, int id)
          A security manager must define a method to add a right to a role.
 void addRightToService(java.lang.String nameOfService, java.lang.String right, int id)
          A security manager must define a method to add a right to a service.
 void addRightToUser(java.lang.String nameOfUser, java.lang.String right, int id)
          A security manager must define a method to add a right to a user.
 void addRoleToUser(java.lang.String userId, java.lang.String role, int id)
          A security manager must define a method to add a role to a user.
 void addSubGroup(java.lang.String superGroup, java.lang.String subGroup, int id)
          A security manager must define a method to add a child group to a parent group.
 void addSubRole(java.lang.String superRole, java.lang.String subRole, int id)
          A security manager must define a method to add a child role to a parent role.
 void addUserToGroup(java.lang.String nameOfGroup, java.lang.String user, int id)
          A security manager must define a method to add a user to a group.
 void audit(java.lang.String message)
          A security manager must defne a method to write a message to the audit log.
 boolean canLogOn(java.lang.String user, java.lang.String password)
          A security manager must define a method to check validity of user id and password.
 void changeOwnPassword(java.lang.String oldpassword, java.lang.String newpassword, int id)
          A security manager must define a method to change a user's own password.
 void changePassword(java.lang.String userid, java.lang.String password, int id)
          A security manager must define a method to change the password of a user.
 boolean checkAccess(java.lang.String nameOfService, int id)
          A security manager must define a method to check the accessability of a service by the current user.
 void createGroup(java.lang.String group, int id)
          A security manager must define a method to create a group.
 void createRight(java.lang.String right, int id)
          A security manager must define a method to create a right.
 void createRole(java.lang.String role, int id)
          A security manager must define a method to create a role.
 void createRole(java.lang.String role, RoleHandlerInterface handler, int id)
          A security manager must define a method to create a role with an associated handler.
 void createRole(java.lang.String role, java.lang.String handler, int id)
          A security manager must define a method to create a role with an associated handler.
 void createRoles(java.lang.String[] roles, int id)
          A security manager must define a method to create the roles named by the argument.
 void createRoles(java.lang.String[] roles, RoleHandlerInterface[] handlers, int id)
          A security manager must define a method to create the roles named by the argument.
 void createRoles(java.lang.String[] roles, java.lang.String[] handlers, int id)
          A security manager must define a method to create the roles named by the argument.
 void createService(java.lang.String service, int id)
          A security manager must define a method to create a service.
 void createUser(java.lang.String user, java.lang.String password, int id)
          A security manager must create a method to create a user with the specified password.
 void exportSecurity(java.lang.String userId, java.lang.String password, java.lang.String fileName, Dictionary options)
          A security manager must define a method to export the specified security databases into a text file.
 void forcedSignOff(int signoffContext, int callerContext)
          A security manager must define a method to disable a context.
 void forcedSignOn(java.lang.String userId, java.lang.String password, int id)
          A security manager must define a method to signon onto another user's context - raising an exception if it fails.
 java.lang.String get(java.lang.String key)
          A security manager must define a method to return the value of the named configuration attribute.
 java.lang.Object[] getActivationIntervalForUser(java.lang.String userId, int id)
          A security manager must define a method to return the activation time, duration and enable flag for the specified user.
 Dictionary getAllDataFromContext(int queryContext, int callerContext)
          A security manager must define a method to return all data items from the specified context.
 Dictionary getAllDataFromGroup(java.lang.String nameOfGroup, int id)
          A security manager must define a method to return all data items from the specified group.
 Dictionary getAllDataFromRight(java.lang.String nameOfRight, int id)
          A security manager must define a method to return all data items from the specified right.
 Dictionary getAllDataFromRole(java.lang.String nameOfRole, int id)
          A security manager must define a method to return all data items from the specified role.
 Dictionary getAllDataFromService(java.lang.String nameOfService, int id)
          A security manager must define a method to return all data items from the specified service.
 Dictionary getAllDataFromUser(java.lang.String userId, int id)
          A security manager must define a method to return all data items from the specified user.
 Dictionary getAllInheritedDataFromUser(java.lang.String userId, int id)
          A security manager must define a method to return all Inherited data items from the specified user.
 java.lang.String[] getAllMembersOfGroup(java.lang.String nameOfGroup, int id)
          A security manager must define a method to return a list of all direct or indirect members (users) of the specified group.
 java.lang.String[] getAllRightsOfUser(java.lang.String userId, int id)
          A security manager must define a method to return the list of names of all rights assigned to this user either directly or indirectly via roles or subroles thereof.
 java.lang.String[] getAllSubgroups(java.lang.String nameOfGroup, boolean include, int id)
          A security manager must define a method to return a list of all the subgroups (direct or indirect) of the specified group.
 Dictionary getAttributesOfUser(java.lang.String userId, int id)
          A security manager must define a method to return a list of the attributes of the specified user.
 boolean getAudit()
          A security manager must define a method to get the audit control flag.
 java.lang.String[] getAvailableServices(int id)
          A security manager must define a method to return the list of all services that the current user is authorized to access.
 java.lang.String[] getChildrenOfRole(java.lang.String nameOfRole, int id)
          A security manager must define a method to return the list of child roles of the specified role.
 Dictionary getConfiguration(int id)
          A security manager must define a method to return a dictionary of the current state of the system configurations.
 Dictionary getConfigurationAttributes()
          A security manager must define a method to return the table of all configuration attributes.
 Dictionary getContainerLmt(SecurityLimit aLimit)
          Returns a copy of the container limit information of aLimit
 Dictionary getContainerLmt(java.lang.String userid, java.lang.String curCode, java.lang.String containerType, java.lang.String containerSubType)
          Returns a copy of the container limit information of the limit that matches the parameters request
 int[] getContexts(int id)
          A security manager must define a method to return a list of the ids of the contexts.
 int[] getContexts(java.lang.String userId, java.lang.String password, int type)
          A security manager must define a method to return the list of all the contexts.
 int[] getContextsOfUser(java.lang.String userId, int type, int id)
          A security manager must define a method to return a list of the ids of the contexts (active or inactive or both) of the specified user.
 Dictionary[] getContextsWithAttributes(int id)
          A security manager must define a method to return the list of attributes of all the contexts.
 Dictionary[] getContextsWithAttributes(int[] contexts, int id)
          A security manager must define a method to return the list of context attribute sets.
 java.lang.String[] getCreatedRights(int id)
          A security manager must define a method to return a list of the names of the user created rights.
 java.lang.String getDataFromContext(int contextId, java.lang.String dataName, int id)
          A security manager must define a method to return the named data item from the specified context.
 java.lang.String getDataFromGroup(java.lang.String nameOfGroup, java.lang.String dataName, int id)
          A security manager must define a method to return the named data item from the specified group.
 Dictionary getDataFromLimit(SecurityLimit aLimit)
          Returns the data item from the specified limit.
 java.lang.String getDataFromLimit(SecurityLimit aLimit, java.lang.String dataName)
          A security manager must define a method to return the named data item from the specified user.
 java.lang.String getDataFromRight(java.lang.String nameOfRight, java.lang.String dataName, int id)
          A security manager must define a method to return the named data item from the specified right.
 java.lang.String getDataFromRole(java.lang.String nameOfRole, java.lang.String dataName, int id)
          A security manager must define a method to return the named data item from the specified role.
 java.lang.String getDataFromService(java.lang.String nameOfService, java.lang.String dataName, int id)
          A security manager must define a method to return the named data item from the specified service.
 java.lang.String getDataFromUser(java.lang.String userId, java.lang.String dataName, int id)
          A security manager must define a method to return the named data item from the specified user.
 java.lang.String[] getGroups(int id)
          A security manager must define a method to return a list of the names of the groups.
 Dictionary[] getGroupsWithAttributes(int id)
          A security manager must define a method to return a list of attributes of all the groups.
 Dictionary[] getGroupsWithAttributes(java.lang.String[] groups, int id)
          A security manager must define a method to return a list of attributes of the specified groups.
 java.lang.String getHandler(java.lang.String nameOfRole, int id)
          A security manager must define a method to return the name of the handler class associated with the named role.
 java.lang.String getInheritedDataFromGroup(java.lang.String nameOfGroup, java.lang.String dataName, int id)
          A security manager must define a method to return the value associated with specified name in the specified group or the closest supergroup.
 java.lang.String getInheritedDataFromUser(java.lang.String nameOfUser, java.lang.String dataName, int id)
          A security manager must define a method to return the value associated with specified name in the specified user or the closest group.
 java.lang.String getJDBCDatabase()
          A security manager must define a method to return the name of the JDBC database.
 java.lang.String getJDBCDriver()
          A security manager must define a method to return the name of the JDBC driver.
 java.lang.String getJDBCURL()
          A security manager must define a method to return the name of the JDBC URL.
 Array getLimitsOfUser(java.lang.String userid)
          Returns all limits of the specified user.
 java.lang.String[] getMembersOfGroup(java.lang.String nameOfGroup, int id)
          A security manager must define a method to return the list of names of users that are direct members of the specified group.
 Dictionary[] getOwnAttributes(int id)
          A security manager must define a method to return the attributes of the current user and the current context.
 java.lang.String[] getRights(int id)
          A security manager must define a method to return a list of the names of the rights.
 java.lang.String[] getRightsOfRole(java.lang.String nameOfRole, int id)
          A security manager must define a method to return the list of names of rights of the specified role.
 java.lang.String[] getRightsOfService(java.lang.String nameOfService, int id)
          A security manager must define a method to return the list of names of rights of the specified service.
 java.lang.String[] getRightsOfUser(int id)
          A security manager must define a method to return the list of names of rights of the specified user.
 java.lang.String[] getRightsOfUser(java.lang.String userId, int id)
          A security manager must define a method to return the list of names of rights of the specified user.
 Dictionary[] getRightsWithAttributes(int id)
          A security manager must define a method to return the list of attributes of all the rights.
 Dictionary[] getRightsWithAttributes(java.lang.String[] rights, int id)
          A security manager must define a method to return the list of right attribute sets.
 java.lang.String[] getRoles(int id)
          A security manager must define a method to return a list of the names of the roles.
 java.lang.String[] getRolesOfUser(int id)
          A security manager must define a method to return the list of names of roles of the specified user.
 java.lang.String[] getRolesOfUser(java.lang.String userId, int id)
          A security manager must define a method to return the list of names of roles of the specified user.
 Dictionary[] getRolesWithAttributes(int id)
          A security manager must define a method to return the list of attributes of all the roles.
 Dictionary[] getRolesWithAttributes(java.lang.String[] roles, int id)
          A security manager must define a method to return the list of role attribute sets.
 java.lang.String[] getServices(int id)
          A security manager must define a method to return a list of the names of the services.
 Dictionary[] getServicesWithAttributes(int id)
          A security manager must define a method to return the list of attributes of all the services.
 Dictionary[] getServicesWithAttributes(java.lang.String[] services, int id)
          A security manager must define a method to return the list of service attribute sets.
 int getStatusOfContextId(int id)
          A security manager must define a method to return the status of the specified context.
 java.lang.String[] getSubGroups(java.lang.String nameOfGroup, int id)
          A security manager must define a method to return the list of subgroups of the specified group.
 java.lang.String[] getSystemRoles(int id)
          A security manager must define a method to return the names of the system-wide roles.
 boolean getTrace()
          A security manager must define a method to return the value of the trace flag.
 Dictionary getTransactionLmt(SecurityLimit aLimit)
          Returns a copy of the transaction limit information of aLimit
 Dictionary getTransactionLmt(java.lang.String userid, java.lang.String curCode, java.lang.String transType)
          Returns a copy of the transaction limit information of the limit that matches the parameters request
 java.lang.String getUser(int id)
          A security manager must define a method to return the login user id.
 java.lang.String[] getUsers(int id)
          A security manager must define a method to return a list of the ids of the configured users.
 Dictionary[] getUsersWithAttributes(int id)
          A security manager must define a method to return the list of attributes of all the users.
 Dictionary[] getUsersWithAttributes(java.lang.String[] users, int id)
          A security manager must define a method to return the list of user attribute sets.
 boolean hasRight(java.lang.String right, int id)
          A security manager must define a method to check if current user has the specified right (directly or indirectly) and that its active.
 boolean hasRight(java.lang.String userid, java.lang.String right, int id)
          A security manager must define a method to check if the specified user has the specified right (directly or indirectly) and that its active.
 boolean hasRight(java.lang.String userid, java.lang.String password, java.lang.String right, int id)
          A security manager must define a method to check if the specified user has the specified right (directly or indirectly) and that its active.
 boolean hasSubgroup(java.lang.String supergroup, java.lang.String subgroup, int id)
          A security manager must define a method to check if 'supergroup' has 'subgroup' as a subgroup.
 void importSecurity(java.lang.String userId, java.lang.String password, java.lang.String fileName, Dictionary options)
          A security manager must define a method to import the specified security databases from a text file.
 void initialize(Dictionary dictionary)
          A security manager must define a method to initialize the security manager.
 boolean isMemberOfGroup(java.lang.String nameOfGroup, java.lang.String userID, boolean direct, int id)
          A security manager must define a method to check if the specified user is a direct or indirect member of the specified group.
 void lock(java.lang.String userid, int id)
          A security manager must define a method to lockout the specified user.
 void logOff(int id)
          A security manager must define a method to log off the specified user.
 void logOff(java.lang.String userid, java.lang.String password, int options, int[] contexts)
          A security manager must define a method to logoff the specified contexts of the specified user.
 int logOn(java.lang.String user, java.lang.String password)
          A security manager must define a method to perform a logon.
 int logOn(java.lang.String userId, java.lang.String password, java.lang.Object object)
          A security manager must define a method to perform a logon.
 boolean queryForcedSignOff(int id)
          A security manager must define a method to return forced sign off status of the current context.
 boolean queryLock(java.lang.String userid, int id)
          A security manager must define a method to query the lock status of the specified user.
 void removeGroup(java.lang.String group, int id)
          A security manager must define a method to remove a group.
 void removeRight(java.lang.String right, int id)
          A security manager must define a method to remove a right.
 void removeRightFromRole(java.lang.String nameOfRole, java.lang.String right, int id)
          A security manager must define a method to remove a right from a role.
 void removeRightFromService(java.lang.String nameOfService, java.lang.String right, int id)
          A security manager must define a method to remove a right from a service.
 void removeRightFromUser(java.lang.String nameOfUser, java.lang.String right, int id)
          A security manager must define a method to remove the specified right from the user.
 void removeRightsFromRole(java.lang.String nameOfRole, java.lang.String[] rights, int id)
          A security manager must define a method to remove rights from a role.
 void removeRightsFromService(java.lang.String nameOfService, java.lang.String[] rights, int id)
          A security manager must define a method to remove rights from a service.
 void removeRightsFromUser(java.lang.String nameOfUser, java.lang.String[] rights, int id)
          A security manager must define a method to remove the specified rights from the user.
 void removeRole(java.lang.String role, int id)
          A security manager must define a method to remove a role.
 void removeRoleFromUser(java.lang.String userId, java.lang.String role, int id)
          A security manager must define a method to remove the specified role from the user.
 boolean removeRoles(java.lang.String[] rolesToDelete, java.lang.String[] options, int id)
          A security manager must define a method to delete the named roles subject to the specified options.
 void removeService(java.lang.String service, int id)
          A security manager must define a method to remove a service.
 void removeSubGroup(java.lang.String superGroup, java.lang.String subGroup, int id)
          A security manager must define a method to remove a child group from a parent group.
 void removeSubRole(java.lang.String superRole, java.lang.String subRole, int id)
          A security manager must define a method to remove a child role from a parent role.
 void removeUser(java.lang.String user, int id)
          A security manager must define a method to remove a user.
 void removeUserFromGroup(java.lang.String nameOfGroup, java.lang.String user, int id)
          A security manager must define a method to remove a user from a group.
 void save(boolean[] list, int id)
          A security manager must define a method to force a save of selected databases even if persistence is disabled.
 void setActivationIntervalForUser(java.lang.String userId, long startTime, long duration, boolean limit, int id)
          A security manager must define a method to set the activation time, duration and enable flag for the specified user.
 void setAllDataForContext(int contextId, Dictionary dictionary, int id)
          A security manager must define a method to set all data items for the context.
 void setAllDataForGroup(java.lang.String nameOfGroup, Dictionary dictionary, int id)
          A security manager must define a method to set all data items for the specified group.
 void setAllDataForRight(java.lang.String nameOfRight, Dictionary dictionary, int id)
          A security manager must define a method to set all data items for the specified right.
 void setAllDataForRole(java.lang.String nameOfRole, Dictionary dictionary, int id)
          A security manager must define a method to set all data items for the specified role.
 void setAllDataForService(java.lang.String nameOfService, Dictionary dictionary, int id)
          A security manager must define a method to set all data items for the specified service.
 void setAllDataForUser(java.lang.String userId, Dictionary dictionary, int id)
          A security manager must define a method to set all data items for the specified user.
 void setAttributesOfUser(java.lang.String userId, Dictionary attributes, boolean set, int id)
          A security manager must define a method to set the attributes of the specified user.
 void setAudit(boolean auditFlag)
          A security manager must define a method to set the audit control flag.
 void setConfiguration(Dictionary configurations, int id)
          A security manager must define a method to set the specified system configurations to the specified values.
 void setDataForContext(int contextId, java.lang.String key, java.lang.String value, int id)
          A security manager must define a method to add, change or remove the named data item for the specified context.
 void setDataForGroup(java.lang.String nameOfGroup, java.lang.String key, java.lang.String value, int id)
          A security manager must define a method to add, change or remove the named data item for the specified group.
 void setDataForRight(java.lang.String nameOfRight, java.lang.String key, java.lang.String value, int id)
          A security manager must define a method to add, change or remove the named data item for the specified right.
 void setDataForRole(java.lang.String nameOfRole, java.lang.String key, java.lang.String value, int id)
          A security manager must define a method to add, change or remove the named data item for the specified role.
 void setDataForService(java.lang.String nameOfService, java.lang.String key, java.lang.String value, int id)
          A security manager must define a method to add, change or remove the named data item for the specified service.
 void setDataForUser(java.lang.String userid, java.lang.String key, java.lang.String value, int id)
          A security manager must define a method to add, change or remove the named data item for the specified user.
 void setExpiryForRights(java.lang.String userid, java.lang.String[] rights, long start, long duration, int id)
          A security manager must define a method to define the lifetime of a set of rights associated with a user.
 void setExpiryForRoles(java.lang.String userid, java.lang.String[] roles, long start, long duration, int id)
          A security manager must define a method to define the lifetime of a set of roles associated with a user.
 void setHandler(java.lang.String nameOfRole, java.lang.String handler, int id)
          A security manager must define a method to set the handler for the named role.
 void setRightsForService(java.lang.String nameOfService, java.lang.String[] rights, int id)
          A security manager must define a method to set the required rights for a service.
 void setRightsForUser(java.lang.String userid, java.lang.String[] rights, int id)
          A security manager must define a method to set the rights for a user.
 void setRolesForUser(java.lang.String userid, java.lang.String[] roles, int id)
          A security manager must define a method to set the roles for a user.
 void setSystemRoles(java.lang.String[] roles, int id)
          A security manager must define a method to set the names of the system-wide roles.
 void setTrace(boolean tracing)
          A security manager must define a method to enable or disable tracing.
 void shutdown(int id)
          A security manager must define a method to shutdown the security component.
 void signOff(int id)
          A security manager must define a method to disable the user's current context.
 int signOn(java.lang.String userId, java.lang.String password)
          A security manager must define a method to signon the user - raising an exception if it fails.
 void signOn(java.lang.String userId, java.lang.String password, int id)
          A security manager must define a method to signon the user - raising an exception if it fails.
 java.lang.Object test(int cmd, Dictionary options, int id)
          A security manager must define a method to perform a test command.
 void unlock(java.lang.String userid, int id)
          A security manager must define a method to unlock the specified user.
 void verify(int id)
          A security manager must define a method to verify all security databases for consistency.
 

Method Detail

addRightsToRole

public void addRightsToRole(java.lang.String nameOfRole,
                            java.lang.String[] rights,
                            int id)
                     throws DSESecurityException
A security manager must defined a method to Add rights to a role.
Parameters:
nameOfRole - String - the name of the role to modify.
rights - String[] - the list of names of rights that are to be added to the role.
id - int - the context id of the requestor.
Throws:
DSESecurityException - - security violation or other error.

addRightsToService

public void addRightsToService(java.lang.String nameOfService,
                               java.lang.String[] rights,
                               int id)
                        throws DSESecurityException
A security manager must define a method to add rights to a service.
Parameters:
nameOfService - String - the name of the service to modify.
rights - String[] - the list of names of rights that are to be added to the service.
id - int - the context id of the requestor.
Throws:
DSESecurityException - - error in the request.

addRightsToUser

public void addRightsToUser(java.lang.String nameOfUser,
                            java.lang.String[] rights,
                            int id)
                     throws DSESecurityException
A security manager must define a method to add rights to a user.
Parameters:
nameOfUser - String - the name of the user that is to receive the new rights.
rights - String[] - the list of names of rights that are to be added to the user.
id - int - the context id of the requestor.
Throws:
DSESecurityException - - error in the request.

addRightToRole

public void addRightToRole(java.lang.String nameOfRole,
                           java.lang.String right,
                           int id)
                    throws DSESecurityException
A security manager must define a method to add a right to a role.
Parameters:
nameOfRole - String - the name of the role to modify.
right - String - the name of the right to add to the role.
id - int - the context id of the requestor.
Throws:
DSESecurityException - - error in the request.

addRightToService

public void addRightToService(java.lang.String nameOfService,
                              java.lang.String right,
                              int id)
                       throws DSESecurityException
A security manager must define a method to add a right to a service.
Parameters:
nameOfService - String - the name of the service to modify.
right - String - the name of the right to add to the service.
id - int - the context id of the requestor.
Throws:
DSESecurityException - - error in the request.

addRightToUser

public void addRightToUser(java.lang.String nameOfUser,
                           java.lang.String right,
                           int id)
                    throws DSESecurityException
A security manager must define a method to add a right to a user.
Parameters:
nameOfUser - String - the name of the user that is to receive the new right.
right - String - the name of the right that is to be added to the user.
id - int - the context id of the requestor.
Throws:
DSESecurityException - - error in the request.

addRoleToUser

public void addRoleToUser(java.lang.String userId,
                          java.lang.String role,
                          int id)
                   throws DSESecurityException
A security manager must define a method to add a role to a user.
Parameters:
userId - String - the name of the user that is to receive the new role.
role - String - the name of the role.
id - int - the context id of the requestor.
Throws:
DSESecurityException - - error in the request.

addSubGroup

public void addSubGroup(java.lang.String superGroup,
                        java.lang.String subGroup,
                        int id)
                 throws DSESecurityException
A security manager must define a method to add a child group to a parent group.
Parameters:
superGroup - String - the name of the parent group.
subGroup - String - the name of the child group.
id - int - the context id of the requestor.
Throws:
DSESecurityException - - error in the request.

addSubRole

public void addSubRole(java.lang.String superRole,
                       java.lang.String subRole,
                       int id)
                throws DSESecurityException
A security manager must define a method to add a child role to a parent role.
Parameters:
superRole - String - the name of the parent role.
subRole - String - the name of the child role.
id - int - the context id of the requestor.
Throws:
DSESecurityException - - error in the request.

addUserToGroup

public void addUserToGroup(java.lang.String nameOfGroup,
                           java.lang.String user,
                           int id)
                    throws DSESecurityException
A security manager must define a method to add a user to a group.
Parameters:
nameOfGroup - String - the name of the group that is to receive the new user.
user - String - the name of the user.
id - int - the context id of the requestor.
Throws:
DSESecurityException - - error in the request.

audit

public void audit(java.lang.String message)
A security manager must defne a method to write a message to the audit log.
Parameters:
message - String - the message to log.

canLogOn

public boolean canLogOn(java.lang.String user,
                        java.lang.String password)
                 throws DSESecurityException
A security manager must define a method to check validity of user id and password.
Parameters:
user - String - the user id.
password - String - the password.
Returns:
boolean - true if user id & password are valid else false.
Throws:
DSESecurityException - - error in the request.

changeOwnPassword

public void changeOwnPassword(java.lang.String oldpassword,
                              java.lang.String newpassword,
                              int id)
                       throws DSESecurityException
A security manager must define a method to change a user's own password.
Parameters:
oldpassword - String - the old password.
newpassword - String - the new password.
id - int - the context id of the requestor.
Throws:
DSESecurityException - - error in the request.

changePassword

public void changePassword(java.lang.String userid,
                           java.lang.String password,
                           int id)
                    throws DSESecurityException
A security manager must define a method to change the password of a user.
Parameters:
userid - String - the name of the user.
password - String - the new password to associate with the user.
id - int - the context id of the requestor.
Throws:
DSESecurityException - - error in the request.

checkAccess

public boolean checkAccess(java.lang.String nameOfService,
                           int id)
                    throws DSESecurityException
A security manager must define a method to check the accessability of a service by the current user.
Parameters:
nameOfService - String - the name of the service to check.
id - int - the context id of the requestor.
Returns:
boolean - return true if access is allowed to the service else return false.
Throws:
DSESecurityException - - error in the request.

createGroup

public void createGroup(java.lang.String group,
                        int id)
                 throws DSESecurityException
A security manager must define a method to create a group.
Parameters:
group - String - the name of the group to create.
id - int - the context id of the requestor.
Throws:
DSESecurityException - - error in the request.

createRight

public void createRight(java.lang.String right,
                        int id)
                 throws DSESecurityException
A security manager must define a method to create a right.
Parameters:
right - String - the name of the right to create.
id - int - the context id of the requestor.
Throws:
DSESecurityException - - error in the request.

createRole

public void createRole(java.lang.String role,
                       int id)
                throws DSESecurityException
A security manager must define a method to create a role.
Parameters:
role - String - the name of the role to create.
id - int - the context id of the requestor.
Throws:
DSESecurityException - - error in the request.

createRole

public void createRole(java.lang.String role,
                       RoleHandlerInterface handler,
                       int id)
                throws DSESecurityException
A security manager must define a method to create a role with an associated handler.
Parameters:
role - String - the name of the role to create.
handler - RoleHandlerInterface - the role handler.
id - int - the context id of the requestor.
Throws:
DSESecurityException - - error in the request.

createRole

public void createRole(java.lang.String role,
                       java.lang.String handler,
                       int id)
                throws DSESecurityException
A security manager must define a method to create a role with an associated handler.
Parameters:
role - String - the name of the role to create.
handler - String - the name of the class of the role handler.
id - int - the context id of the requestor.
Throws:
DSESecurityException - - error in the request.

createRoles

public void createRoles(java.lang.String[] roles,
                        RoleHandlerInterface[] handlers,
                        int id)
                 throws DSESecurityException
A security manager must define a method to create the roles named by the argument. If any of the named roles already exists then return an exception (no further roles are created).
Parameters:
roles - String[] - the names of the roles to create.
handlers - RoleHandlerInterface[] - the role handlers or null if you don't want to associate handlers with the roles.
id - int - the context id of the requestor.
Throws:
DSESecurityException - - error in the request.

createRoles

public void createRoles(java.lang.String[] roles,
                        java.lang.String[] handlers,
                        int id)
                 throws DSESecurityException
A security manager must define a method to create the roles named by the argument. If any of the named roles already exists then return an exception (no further roles are created).
Parameters:
roles - String[] - the names of the roles to create.
handlers - String[] - the role handlers or null if you don't want to associate handlers with the roles.
id - int - the context id of the requestor.
Throws:
DSESecurityException - - error in the request.

createRoles

public void createRoles(java.lang.String[] roles,
                        int id)
                 throws DSESecurityException
A security manager must define a method to create the roles named by the argument. If any of the named roles already exists then return an exception (no further roles are created).
Parameters:
roles - String[] - the names of the roles to create.
id - int - the context id of the requestor.
Throws:
DSESecurityException - - error in the request.

createService

public void createService(java.lang.String service,
                          int id)
                   throws DSESecurityException
A security manager must define a method to create a service.
Parameters:
service - String - the name of the service to create.
id - int - the context id of the requestor.
Throws:
DSESecurityException - - error in the request.

createUser

public void createUser(java.lang.String user,
                       java.lang.String password,
                       int id)
                throws DSESecurityException
A security manager must create a method to create a user with the specified password.
Parameters:
user - String - the name of the user to create.
password - String - the password to associate with the user.
id - int - the context id of the requestor.
Throws:
DSESecurityException - - error in the request.

exportSecurity

public void exportSecurity(java.lang.String userId,
                           java.lang.String password,
                           java.lang.String fileName,
                           Dictionary options)
                    throws DSESecurityException
A security manager must define a method to export the specified security databases into a text file.
Parameters:
userId - String - the user id of the requestor.
password - String - the password of the requestor.
fileName - String - the name of the text file.
options - Dictionary - the list of options for this operation.
Throws:
DSESecurityException - - error in the request.

forcedSignOff

public void forcedSignOff(int signoffContext,
                          int callerContext)
                   throws DSESecurityException
A security manager must define a method to disable a context.
Parameters:
signoffContext - int - the id of the context to sign off.
callerContext - int - the id of the context of the caller.
Throws:
DSESecurityException - - error in the request.

forcedSignOn

public void forcedSignOn(java.lang.String userId,
                         java.lang.String password,
                         int id)
                  throws DSESecurityException
A security manager must define a method to signon onto another user's context - raising an exception if it fails.
Parameters:
userId - String - your user id.
password - String - your password.
id - int - the context id of the other user.
Throws:
DSESecurityException - - error in the request.

get

public java.lang.String get(java.lang.String key)
A security manager must define a method to return the value of the named configuration attribute.
Parameters:
key - String - the name of the configuration attribute.
Returns:
String - the value of the named configuration attribute.

getActivationIntervalForUser

public java.lang.Object[] getActivationIntervalForUser(java.lang.String userId,
                                                       int id)
                                                throws DSESecurityException
A security manager must define a method to return the activation time, duration and enable flag for the specified user.
Parameters:
userId - String - the name of the user to access.
id - int - the context id of the requestor.
Returns:
Object[] - the enable flag, the activation time and the activation duration.
Throws:
DSESecurityException - - error in the request.

getAllDataFromContext

public Dictionary getAllDataFromContext(int queryContext,
                                        int callerContext)
                                 throws DSESecurityException
A security manager must define a method to return all data items from the specified context.
Parameters:
queryContext - int - the context id to query.
callerContext - int - the context id of the requestor.
Returns:
Dictionary - the dictionary of data items.
Throws:
DSESecurityException - - error in the request.

getAllDataFromGroup

public Dictionary getAllDataFromGroup(java.lang.String nameOfGroup,
                                      int id)
                               throws DSESecurityException
A security manager must define a method to return all data items from the specified group.
Parameters:
nameOfGroup - String - the name of the group to access.
id - int - the context id of the requestor.
Returns:
Dictionary - the dictionary of data items.
Throws:
DSESecurityException - - error in the request.

getAllDataFromRight

public Dictionary getAllDataFromRight(java.lang.String nameOfRight,
                                      int id)
                               throws DSESecurityException
A security manager must define a method to return all data items from the specified right.
Parameters:
nameOfRight - String - the name of the right to access.
id - int - the context id of the requestor.
Returns:
Dictionary - the dictionary of data items.
Throws:
DSESecurityException - - error in the request.

getAllDataFromRole

public Dictionary getAllDataFromRole(java.lang.String nameOfRole,
                                     int id)
                              throws DSESecurityException
A security manager must define a method to return all data items from the specified role.
Parameters:
nameOfRole - String - the name of the role to access.
id - int - the context id of the requestor.
Returns:
Dictionary - the dictionary of data items.
Throws:
DSESecurityException - - error in the request.

getAllDataFromService

public Dictionary getAllDataFromService(java.lang.String nameOfService,
                                        int id)
                                 throws DSESecurityException
A security manager must define a method to return all data items from the specified service.
Parameters:
nameOfService - String - the name of the service to access.
id - int - the context id of the requestor.
Returns:
Dictionary - the dictionary of data items.
Throws:
DSESecurityException - - error in the request.

getAllDataFromUser

public Dictionary getAllDataFromUser(java.lang.String userId,
                                     int id)
                              throws DSESecurityException
A security manager must define a method to return all data items from the specified user.
Parameters:
userId - String - the name of the user to access.
id - int - the context id of the requestor.
Returns:
Dictionary - the dictionary of data items.
Throws:
DSESecurityException - - error in the request.

getAllInheritedDataFromUser

public Dictionary getAllInheritedDataFromUser(java.lang.String userId,
                                              int id)
                                       throws DSESecurityException
A security manager must define a method to return all Inherited data items from the specified user.
Parameters:
userId - String - the name of the user to access.
id - int - the context id of the requestor.
Returns:
Dictionary - the dictionary of data items.
Throws:
DSESecurityException - - error in the request.

getAllMembersOfGroup

public java.lang.String[] getAllMembersOfGroup(java.lang.String nameOfGroup,
                                               int id)
                                        throws DSESecurityException
A security manager must define a method to return a list of all direct or indirect members (users) of the specified group.
Parameters:
nameOfGroup - String - the name of the group to access.
id - int - the context id of the requestor.
Returns:
String[] - list of all direct or indirect members of the current group.
Throws:
DSESecurityException - - error in the request.

getAllRightsOfUser

public java.lang.String[] getAllRightsOfUser(java.lang.String userId,
                                             int id)
                                      throws DSESecurityException
A security manager must define a method to return the list of names of all rights assigned to this user either directly or indirectly via roles or subroles thereof.
Parameters:
userId - String - the name of the user to access.
id - int - the context id of the requestor.
Returns:
String[] - the list of names of all rights assigned to this user either directly or indirectly via roles or subroles thereof.
Throws:
DSESecurityException - - error in the request.

getAllSubgroups

public java.lang.String[] getAllSubgroups(java.lang.String nameOfGroup,
                                          boolean include,
                                          int id)
                                   throws DSESecurityException
A security manager must define a method to return a list of all the subgroups (direct or indirect) of the specified group.
Parameters:
nameOfGroup - String - the name of the group to access.
include - boolean - true or false to include or exclude the specified group respectively.
id - int - the context id of the requestor.
Returns:
String[] - the list of all the subgroups of the current group.
Throws:
DSESecurityException - - error in the request.

getAttributesOfUser

public Dictionary getAttributesOfUser(java.lang.String userId,
                                      int id)
                               throws DSESecurityException
A security manager must define a method to return a list of the attributes of the specified user.
Parameters:
userId - String - the user who's attributes are to be queried.
id - int - the context id of the requestor.
Returns:
Dictionary - the attributes of the specified user.
Throws:
DSESecurityException - - error in the request.

getAudit

public boolean getAudit()
A security manager must define a method to get the audit control flag.
Parameters:
auditFlag - boolean - the audit flag.

getAvailableServices

public java.lang.String[] getAvailableServices(int id)
                                        throws DSESecurityException
A security manager must define a method to return the list of all services that the current user is authorized to access.
Parameters:
id - int - the context id of the requestor.
Returns:
String[] - the list of names of services available to the current user.
Throws:
DSESecurityException - - error in the request.

getChildrenOfRole

public java.lang.String[] getChildrenOfRole(java.lang.String nameOfRole,
                                            int id)
                                     throws DSESecurityException
A security manager must define a method to return the list of child roles of the specified role.
Parameters:
nameOfRole - String - the name of the role to access.
id - int - the context id of the requestor.
Returns:
String[] - the list of children of the specified role.
Throws:
DSESecurityException - - error in the request.

getConfiguration

public Dictionary getConfiguration(int id)
                            throws DSESecurityException
A security manager must define a method to return a dictionary of the current state of the system configurations.
Parameters:
id - int - the context id of the requestor.
Returns:
Dictionary - dictionary of the current state of the system configurations.
Throws:
DSESecurityException - - error in the request.

getConfigurationAttributes

public Dictionary getConfigurationAttributes()
A security manager must define a method to return the table of all configuration attributes.
Returns:
Dictionary - the table of all configuration attributes.

getContainerLmt

public Dictionary getContainerLmt(SecurityLimit aLimit)
                           throws DSESecurityException
Returns a copy of the container limit information of aLimit
Parameters:
aLimit - SecurityLimit - The limit to take container information from.
Returns:
com.ibm.dse.applsrv.aa.Dictionary - a copy of the container limit information
Throws:
DSESecurityException - - thrown when a problem occurs while retrieving limit information

getContainerLmt

public Dictionary getContainerLmt(java.lang.String userid,
                                  java.lang.String curCode,
                                  java.lang.String containerType,
                                  java.lang.String containerSubType)
                           throws DSESecurityException
Returns a copy of the container limit information of the limit that matches the parameters request
Parameters:
userid - java.lang.String - The user the limit belongs to.
curCode - java.lang.String - The currency Code of the limit.
containerType - java.lang.String - The containerType of the limit
containerSubType - java.lang.String - The containerSubType of the limit
Returns:
com.ibm.dse.applsrv.aa.Dictionary - a copy of the container limit information
Throws:
DSESecurityException - - thrown when a problem occurs while retrieving limit information

getContexts

public int[] getContexts(int id)
                  throws DSESecurityException
A security manager must define a method to return a list of the ids of the contexts.
Parameters:
id - int - the context id of the requestor.
Returns:
int[] - the list of ids of contexts.
Throws:
DSESecurityException - - error in the request.

getContexts

public int[] getContexts(java.lang.String userId,
                         java.lang.String password,
                         int type)
                  throws DSESecurityException
A security manager must define a method to return the list of all the contexts.
Parameters:
userId - String - the user id.
password - String - the password.
type - int - the type of contexts to query.
Returns:
int[] - the list of context ids.
Throws:
DSESecurityException - - error in the request.

getContextsOfUser

public int[] getContextsOfUser(java.lang.String userId,
                               int type,
                               int id)
                        throws DSESecurityException
A security manager must define a method to return a list of the ids of the contexts (active or inactive or both) of the specified user.
Parameters:
userId - String - the name of the user to query.
type - int - type of query: SecurityConstants.AllContexts, SecurityConstants.ActiveContexts or SecurityConstants.InactiveContexts.
id - int - the context id of the requestor.
Returns:
int[] - the list of ids of contexts.
Throws:
DSESecurityException - - error in the request.

getContextsWithAttributes

public Dictionary[] getContextsWithAttributes(int[] contexts,
                                              int id)
                                       throws DSESecurityException
A security manager must define a method to return the list of context attribute sets.
Parameters:
contexts - int[] - the list of contexts to interrogate.
id - int - the context id of the requestor.
Returns:
Dictionary[] - the list of context attribute sets.
Throws:
DSESecurityException - - error in the request.

getContextsWithAttributes

public Dictionary[] getContextsWithAttributes(int id)
                                       throws DSESecurityException
A security manager must define a method to return the list of attributes of all the contexts.
Parameters:
id - int - the context id of the requestor.
Returns:
Dictionary[] - the list of attributes of all the contexts.
Throws:
DSESecurityException - - error in the request.

getCreatedRights

public java.lang.String[] getCreatedRights(int id)
                                    throws DSESecurityException
A security manager must define a method to return a list of the names of the user created rights.
Parameters:
id - int - the context id of the requestor.
Returns:
String[] - the list of names of the user created rights.
Throws:
DSESecurityException - - error in the request.

getDataFromContext

public java.lang.String getDataFromContext(int contextId,
                                           java.lang.String dataName,
                                           int id)
                                    throws DSESecurityException
A security manager must define a method to return the named data item from the specified context.
Parameters:
contextId - int - the id of the context to access.
dataName - String - the name of the data item.
id - int - the context id of the requestor.
Returns:
String - the requested data.
Throws:
DSESecurityException - - error in the request.

getDataFromGroup

public java.lang.String getDataFromGroup(java.lang.String nameOfGroup,
                                         java.lang.String dataName,
                                         int id)
                                  throws DSESecurityException
A security manager must define a method to return the named data item from the specified group.
Parameters:
nameOfGroup - String - the name of the group to access.
dataName - String - the name of the data item.
id - int - the context id of the requestor.
Returns:
String - the requested data.
Throws:
DSESecurityException - - error in the request.

getDataFromLimit

public Dictionary getDataFromLimit(SecurityLimit aLimit)
                            throws DSESecurityException
Returns the data item from the specified limit.
Parameters:
aLimit - SecurityLimit- the limit to retrieve information from.
Returns:
Dictionary - the obtained data.
Throws:
DSESecurityException - - error in the request.

getDataFromLimit

public java.lang.String getDataFromLimit(SecurityLimit aLimit,
                                         java.lang.String dataName)
                                  throws DSESecurityException
A security manager must define a method to return the named data item from the specified user.
Parameters:
aLimit - SecurityLimit - the limit to retrieve information from .
dataName - String - the name of the data item.
Returns:
String - the requested data.
Throws:
DSESecurityException - - error in the request.

getDataFromRight

public java.lang.String getDataFromRight(java.lang.String nameOfRight,
                                         java.lang.String dataName,
                                         int id)
                                  throws DSESecurityException
A security manager must define a method to return the named data item from the specified right.
Parameters:
nameOfRight - String - the name of the right to access.
dataName - String - the name of the data item.
id - int - the context id of the requestor.
Returns:
String - the requested data.
Throws:
DSESecurityException - - error in the request.

getDataFromRole

public java.lang.String getDataFromRole(java.lang.String nameOfRole,
                                        java.lang.String dataName,
                                        int id)
                                 throws DSESecurityException
A security manager must define a method to return the named data item from the specified role.
Parameters:
nameOfRole - String - the name of the role to access.
dataName - String - the name of the data item.
id - int - the context id of the requestor.
Returns:
String - the requested data.
Throws:
DSESecurityException - - error in the request.

getDataFromService

public java.lang.String getDataFromService(java.lang.String nameOfService,
                                           java.lang.String dataName,
                                           int id)
                                    throws DSESecurityException
A security manager must define a method to return the named data item from the specified service.
Parameters:
nameOfService - String - the name of the service to access.
dataName - String - the name of the data item.
id - int - the context id of the requestor.
Returns:
String - the requested data.
Throws:
DSESecurityException - - error in the request.

getDataFromUser

public java.lang.String getDataFromUser(java.lang.String userId,
                                        java.lang.String dataName,
                                        int id)
                                 throws DSESecurityException
A security manager must define a method to return the named data item from the specified user.
Parameters:
userId - String - the name of the user to access.
dataName - String - the name of the data item.
id - int - the context id of the requestor.
Returns:
String - the requested data.
Throws:
DSESecurityException - - error in the request.

getGroups

public java.lang.String[] getGroups(int id)
                             throws DSESecurityException
A security manager must define a method to return a list of the names of the groups.
Parameters:
id - int - the context id of the requestor.
Returns:
String[] - the list of names of groups.
Throws:
DSESecurityException - - error in the request.

getGroupsWithAttributes

public Dictionary[] getGroupsWithAttributes(java.lang.String[] groups,
                                            int id)
                                     throws DSESecurityException
A security manager must define a method to return a list of attributes of the specified groups.
Parameters:
groups - String[] - the list of groups to interrogate.
id - int - the context id of the requestor.
Returns:
Dictionary[] - the list of right attribute sets.
Throws:
DSESecurityException - - error in the request.

getGroupsWithAttributes

public Dictionary[] getGroupsWithAttributes(int id)
                                     throws DSESecurityException
A security manager must define a method to return a list of attributes of all the groups.
Parameters:
id - int - the context id of the requestor.
Returns:
Dictionary[] - the list of attributes of all the groups.
Throws:
DSESecurityException - - error in the request.

getHandler

public java.lang.String getHandler(java.lang.String nameOfRole,
                                   int id)
                            throws DSESecurityException
A security manager must define a method to return the name of the handler class associated with the named role.
Parameters:
nameOfRole - String - the name of the role to access.
id - int - the context id of the requestor.
Returns:
String - the name of the handler class associated with the named role.
Throws:
DSESecurityException - - error in the request.

getInheritedDataFromGroup

public java.lang.String getInheritedDataFromGroup(java.lang.String nameOfGroup,
                                                  java.lang.String dataName,
                                                  int id)
                                           throws DSESecurityException
A security manager must define a method to return the value associated with specified name in the specified group or the closest supergroup.
Parameters:
nameOfGroup - String - the name of the group to access.
dataName - String - the name of the data item.
id - int - the context id of the requestor.
Returns:
String - the requested data.
Throws:
DSESecurityException - - error in the request.

getInheritedDataFromUser

public java.lang.String getInheritedDataFromUser(java.lang.String nameOfUser,
                                                 java.lang.String dataName,
                                                 int id)
                                          throws DSESecurityException
A security manager must define a method to return the value associated with specified name in the specified user or the closest group.
Parameters:
nameOfUser - String - the name of the user to access.
dataName - String - the name of the data item.
id - int - the context id of the requestor.
Returns:
String - the requested data.
Throws:
DSESecurityException - - error in the request.

getJDBCDatabase

public java.lang.String getJDBCDatabase()
A security manager must define a method to return the name of the JDBC database.
Returns:
String - the name of the JDBC database.

getJDBCDriver

public java.lang.String getJDBCDriver()
A security manager must define a method to return the name of the JDBC driver.
Returns:
String - the name of the JDBC driver.

getJDBCURL

public java.lang.String getJDBCURL()
A security manager must define a method to return the name of the JDBC URL.
Returns:
String - the name of the JDBC URL.

getLimitsOfUser

public Array getLimitsOfUser(java.lang.String userid)
                      throws DSESecurityException
Returns all limits of the specified user.
Parameters:
userid - java.lang.String - the userid the limits belong to
Returns:
Array - the Array of limits belonging to userid
Throws:
DSESecurityException - - error in the request.

getMembersOfGroup

public java.lang.String[] getMembersOfGroup(java.lang.String nameOfGroup,
                                            int id)
                                     throws DSESecurityException
A security manager must define a method to return the list of names of users that are direct members of the specified group.
Parameters:
nameOfGroup - String - the name of the group to access.
id - int - the context id of the requestor.
Returns:
String[] - the list of names of users that are direct members of the specified group.
Throws:
DSESecurityException - - error in the request.

getOwnAttributes

public Dictionary[] getOwnAttributes(int id)
                              throws DSESecurityException
A security manager must define a method to return the attributes of the current user and the current context.
Parameters:
id - int - the context id of the requestor.
Returns:
Dictionary[] - the list of user attribute sets.
Throws:
DSESecurityException - - error in the request.

getRights

public java.lang.String[] getRights(int id)
                             throws DSESecurityException
A security manager must define a method to return a list of the names of the rights.
Parameters:
id - int - the context id of the requestor.
Returns:
String[] - the list of names of rights.
Throws:
DSESecurityException - - error in the request.

getRightsOfRole

public java.lang.String[] getRightsOfRole(java.lang.String nameOfRole,
                                          int id)
                                   throws DSESecurityException
A security manager must define a method to return the list of names of rights of the specified role.
Parameters:
nameOfRole - String - the name of the role to access.
id - int - the context id of the requestor.
Returns:
String[] - the list of names of rights of the specified role.
Throws:
DSESecurityException - - error in the request.

getRightsOfService

public java.lang.String[] getRightsOfService(java.lang.String nameOfService,
                                             int id)
                                      throws DSESecurityException
A security manager must define a method to return the list of names of rights of the specified service.
Parameters:
nameOfService - String - the name of the service to access.
id - int - the context id of the requestor.
Returns:
String[] - the list of names of rights of the specified service.
Throws:
DSESecurityException - - error in the request.

getRightsOfUser

public java.lang.String[] getRightsOfUser(int id)
                                   throws DSESecurityException
A security manager must define a method to return the list of names of rights of the specified user.
Parameters:
id - int - the context id of the requestor.
Returns:
String[] - the list of names rights of the current user.
Throws:
DSESecurityException - - error in the request.

getRightsOfUser

public java.lang.String[] getRightsOfUser(java.lang.String userId,
                                          int id)
                                   throws DSESecurityException
A security manager must define a method to return the list of names of rights of the specified user.
Parameters:
userId - String - the name of the user to access.
id - int - the context id of the requestor.
Returns:
String[] - the list of names of rights of the specified user.
Throws:
DSESecurityException - - error in the request.

getRightsWithAttributes

public Dictionary[] getRightsWithAttributes(java.lang.String[] rights,
                                            int id)
                                     throws DSESecurityException
A security manager must define a method to return the list of right attribute sets.
Parameters:
rights - String[] - the list of rights to interrogate.
id - int - the context id of the requestor.
Returns:
Dictionary[] - the list of right attribute sets.
Throws:
DSESecurityException - - error in the request.

getRightsWithAttributes

public Dictionary[] getRightsWithAttributes(int id)
                                     throws DSESecurityException
A security manager must define a method to return the list of attributes of all the rights.
Parameters:
id - int - the context id of the requestor.
Returns:
Dictionary[] - the list of attributes of all the rights.
Throws:
DSESecurityException - - error in the request.

getRoles

public java.lang.String[] getRoles(int id)
                            throws DSESecurityException
A security manager must define a method to return a list of the names of the roles.
Parameters:
id - int - the context id of the requestor.
Returns:
String[] - the list of names of roles.
Throws:
DSESecurityException - - error in the request.

getRolesOfUser

public java.lang.String[] getRolesOfUser(int id)
                                  throws DSESecurityException
A security manager must define a method to return the list of names of roles of the specified user.
Parameters:
id - int - the context id of the requestor.
Returns:
String[] - the list of names of roles of the current user.
Throws:
DSESecurityException - - error in the request.

getRolesOfUser

public java.lang.String[] getRolesOfUser(java.lang.String userId,
                                         int id)
                                  throws DSESecurityException
A security manager must define a method to return the list of names of roles of the specified user.
Parameters:
userId - String - the name of the user to access.
id - int - the context id of the requestor.
Returns:
String[] - the list of names of roles of the specified user.
Throws:
DSESecurityException - - error in the request.

getRolesWithAttributes

public Dictionary[] getRolesWithAttributes(java.lang.String[] roles,
                                           int id)
                                    throws DSESecurityException
A security manager must define a method to return the list of role attribute sets.
Parameters:
roles - String[] - the list of roles to interrogate.
id - int - the context id of the requestor.
Returns:
Dictionary[] - the list of role attribute sets.
Throws:
DSESecurityException - - error in the request.

getRolesWithAttributes

public Dictionary[] getRolesWithAttributes(int id)
                                    throws DSESecurityException
A security manager must define a method to return the list of attributes of all the roles.
Parameters:
id - int - the context id of the requestor.
Returns:
Dictionary[] - the list of attributes of all the roles.
Throws:
DSESecurityException - - error in the request.

getServices

public java.lang.String[] getServices(int id)
                               throws DSESecurityException
A security manager must define a method to return a list of the names of the services.
Parameters:
id - int - the context id of the requestor.
Returns:
String[] - the list of names of services.
Throws:
DSESecurityException - - error in the request.

getServicesWithAttributes

public Dictionary[] getServicesWithAttributes(java.lang.String[] services,
                                              int id)
                                       throws DSESecurityException
A security manager must define a method to return the list of service attribute sets.
Parameters:
services - String[] - the list of services to interrogate.
id - int - the context id of the requestor.
Returns:
Dictionary[] - the list of service attribute sets.
Throws:
DSESecurityException - - error in the request.

getServicesWithAttributes

public Dictionary[] getServicesWithAttributes(int id)
                                       throws DSESecurityException
A security manager must define a method to return the list of attributes of all the services.
Parameters:
id - int - the context id of the requestor.
Returns:
Dictionary[] - the list of attributes of all the services.
Throws:
DSESecurityException - - error in the request.

getStatusOfContextId

public int getStatusOfContextId(int id)
                         throws DSESecurityException
A security manager must define a method to return the status of the specified context.
Parameters:
id - int - the context id to check.
Returns:
int - return CONTEXT_ACTIVE, CONTEXT_INACTIVE or CONTEXT_INVALID if the context is active, inactive or invalid respectively.
Throws:
DSESecurityException - - error in the request.

getSubGroups

public java.lang.String[] getSubGroups(java.lang.String nameOfGroup,
                                       int id)
                                throws DSESecurityException
A security manager must define a method to return the list of subgroups of the specified group.
Parameters:
nameOfGroup - String - the name of the group to access.
id - int - the context id of the requestor.
Returns:
String[] - the list of subgroups of the specified group.
Throws:
DSESecurityException - - error in the request.

getSystemRoles

public java.lang.String[] getSystemRoles(int id)
                                  throws DSESecurityException
A security manager must define a method to return the names of the system-wide roles.
Parameters:
id - int - the context id of the requestor.
Returns:
String[] - the names of the system-wide roles.
Throws:
DSESecurityException - - error in the request.

getTrace

public boolean getTrace()
A security manager must define a method to return the value of the trace flag.
Returns:
boolean - true if tracing is enabled, false if tracing is disabled.

getTransactionLmt

public Dictionary getTransactionLmt(SecurityLimit aLimit)
                             throws DSESecurityException
Returns a copy of the transaction limit information of aLimit
Parameters:
aLimit - SecurityLimit - The limit to take transaction information from.
Returns:
com.ibm.dse.applsrv.aa.Dictionary - a copy of the transaction limit information
Throws:
DSESecurityException - - thrown when a problem occurs while retrieving limit information

getTransactionLmt

public Dictionary getTransactionLmt(java.lang.String userid,
                                    java.lang.String curCode,
                                    java.lang.String transType)
                             throws DSESecurityException
Returns a copy of the transaction limit information of the limit that matches the parameters request
Parameters:
userid - java.lang.String - The user the limit belongs to.
curCode - java.lang.String - The currency Code of the limit.
transactionType - java.lang.String - The transactionType of the limit
Returns:
com.ibm.dse.applsrv.aa.Dictionary - a copy of the transaction limit information
Throws:
DSESecurityException - - thrown when a problem occurs while retrieving limit information

getUser

public java.lang.String getUser(int id)
                         throws DSESecurityException
A security manager must define a method to return the login user id.
Parameters:
id - int - the context id of the requestor.
Returns:
String - the login user id.
Throws:
DSESecurityException - - error in the request.

getUsers

public java.lang.String[] getUsers(int id)
                            throws DSESecurityException
A security manager must define a method to return a list of the ids of the configured users.
Parameters:
id - int - the context id of the requestor.
Returns:
String[] - the list of ids of configured users.
Throws:
DSESecurityException - - error in the request.

getUsersWithAttributes

public Dictionary[] getUsersWithAttributes(java.lang.String[] users,
                                           int id)
                                    throws DSESecurityException
A security manager must define a method to return the list of user attribute sets.
Parameters:
users - String[] - the list of users to interrogate.
id - int - the context id of the requestor.
Returns:
Dictionary[] - the list of user attribute sets.
Throws:
DSESecurityException - - error in the request.

getUsersWithAttributes

public Dictionary[] getUsersWithAttributes(int id)
                                    throws DSESecurityException
A security manager must define a method to return the list of attributes of all the users.
Parameters:
id - int - the context id of the requestor.
Returns:
Dictionary[] - the list of attributes of all the users.
Throws:
DSESecurityException - - error in the request.

hasRight

public boolean hasRight(java.lang.String right,
                        int id)
                 throws DSESecurityException
A security manager must define a method to check if current user has the specified right (directly or indirectly) and that its active.
Parameters:
right - String - the name of the right to check.
id - int - the context id of the requestor.
Returns:
boolean - true if the requestor has the specified right and its active, false otherwise.
Throws:
DSESecurityException - - error in the request.

hasRight

public boolean hasRight(java.lang.String userid,
                        java.lang.String right,
                        int id)
                 throws DSESecurityException
A security manager must define a method to check if the specified user has the specified right (directly or indirectly) and that its active.
Parameters:
userid - String - the name of the user to check.
right - String - the name of the right to check.
id - int - the context id of the requestor.
Returns:
boolean - true if the specified user has the specified right and its active, false otherwise.
Throws:
DSESecurityException - - error in the request.

hasRight

public boolean hasRight(java.lang.String userid,
                        java.lang.String password,
                        java.lang.String right,
                        int id)
                 throws DSESecurityException
A security manager must define a method to check if the specified user has the specified right (directly or indirectly) and that its active.
Parameters:
userid - String - the name of the user to check.
password - String - the password for the specified user.
right - String - the name of the right to check.
id - int - the context id of the requestor.
Returns:
boolean - true if the specified user has the specified right and its active, false otherwise.
Throws:
DSESecurityException - - error in the request.

hasSubgroup

public boolean hasSubgroup(java.lang.String supergroup,
                           java.lang.String subgroup,
                           int id)
                    throws DSESecurityException
A security manager must define a method to check if 'supergroup' has 'subgroup' as a subgroup.
Parameters:
supergroup - String - the name of the supergroup.
subgroup - String - the name of the subgroup.
id - int - the context id of the requestor.
Returns:
boolean - true if 'supergroup' has 'subgroup' as a subgroup, false otherwise.
Throws:
DSESecurityException - - error in the request.

importSecurity

public void importSecurity(java.lang.String userId,
                           java.lang.String password,
                           java.lang.String fileName,
                           Dictionary options)
                    throws DSESecurityException
A security manager must define a method to import the specified security databases from a text file.
Parameters:
userId - String - the user id of the requestor.
password - String - the password of the requestor.
fileName - String - the name of the text file.
options - Dictionary - the list of options for this operation.
Throws:
DSESecurityException - - error in the request.

initialize

public void initialize(Dictionary dictionary)
                throws DSESecurityException
A security manager must define a method to initialize the security manager. Should throw a DSESecurityException if called more than once.
Parameters:
dictionary - Dictionary - the configuration parameters.
Throws:
DSESecurityException - - initialization error.

isMemberOfGroup

public boolean isMemberOfGroup(java.lang.String nameOfGroup,
                               java.lang.String userID,
                               boolean direct,
                               int id)
                        throws DSESecurityException
A security manager must define a method to check if the specified user is a direct or indirect member of the specified group. An indirect member of a specified group must be a direct member of a direct or indirect subgroup of that specified group.
Parameters:
nameOfGroup - String - the name of the group.
userID - String - the name of the user.
direct - boolean - if true then check only direct membership, if false then check direct/indirect membership.
id - int - the context id of the requestor.
Returns:
boolean - true of the specified user is a direct/indirect member of the specified group.
Throws:
DSESecurityException - - error in the request.

lock

public void lock(java.lang.String userid,
                 int id)
          throws DSESecurityException
A security manager must define a method to lockout the specified user. A locked user cannot log on.
Parameters:
userid - String - the name of the user to lock.
id - int - the context id of the requestor.
Throws:
DSESecurityException - - error in the request.

logOff

public void logOff(int id)
            throws DSESecurityException
A security manager must define a method to log off the specified user.
Parameters:
id - int - the context id of the requestor.
Throws:
DSESecurityException - - error in the request.

logOff

public void logOff(java.lang.String userid,
                   java.lang.String password,
                   int options,
                   int[] contexts)
            throws DSESecurityException
A security manager must define a method to logoff the specified contexts of the specified user. This operation is NOT atomic!
Parameters:
userid - String - the user to be affected.
password - String - the password of the specified user.
options - int - the type of contexts to logoff.
contexts - int[] - the list of specified contexts to logoff.
Throws:
DSESecurityException - - error in the request.

logOn

public int logOn(java.lang.String user,
                 java.lang.String password)
          throws DSESecurityException
A security manager must define a method to perform a logon.
Parameters:
user - String - the name of the user to logon.
password - String - the password.
Returns:
int - the new context id.
Throws:
DSESecurityException - - error in the request.

logOn

public int logOn(java.lang.String userId,
                 java.lang.String password,
                 java.lang.Object object)
          throws DSESecurityException
A security manager must define a method to perform a logon.
Parameters:
userId - String - the name of the user to logon.
password - String - the password.
object - Object - an arbitrary object which is passed on to the role handlers. The default code ignores it.
Returns:
int - the new context id.
Throws:
DSESecurityException - - error in the request.

queryForcedSignOff

public boolean queryForcedSignOff(int id)
                           throws DSESecurityException
A security manager must define a method to return forced sign off status of the current context.
Parameters:
id - int - the context id of the requestor.
Returns:
boolean - true if the last signoff of this context was a forced signoff else false.
Throws:
DSESecurityException - - error in the request.

queryLock

public boolean queryLock(java.lang.String userid,
                         int id)
                  throws DSESecurityException
A security manager must define a method to query the lock status of the specified user.
Parameters:
userid - String - the name of the user to query.
id - int - the context id of the requestor.
Returns:
boolean - true if user is locked, false if user is unlocked.
Throws:
DSESecurityException - - error in the request.

removeGroup

public void removeGroup(java.lang.String group,
                        int id)
                 throws DSESecurityException
A security manager must define a method to remove a group.
Parameters:
group - String - the name of the group to remove.
id - int - the context id of the requestor.
Throws:
DSESecurityException - - error in the request.

removeRight

public void removeRight(java.lang.String right,
                        int id)
                 throws DSESecurityException
A security manager must define a method to remove a right.
Parameters:
right - String - the name of the right to remove.
id - int - the context id of the requestor.
Throws:
DSESecurityException - - error in the request.

removeRightFromRole

public void removeRightFromRole(java.lang.String nameOfRole,
                                java.lang.String right,
                                int id)
                         throws DSESecurityException
A security manager must define a method to remove a right from a role.
Parameters:
nameOfRole - String - the name of the role to modify.
right - String - the name of the right to remove from the role.
id - int - the context id of the requestor.
Throws:
DSESecurityException - - error in the request.

removeRightFromService

public void removeRightFromService(java.lang.String nameOfService,
                                   java.lang.String right,
                                   int id)
                            throws DSESecurityException
A security manager must define a method to remove a right from a service.
Parameters:
nameOfService - String - the name of the service to modify.
right - String - the name of the right to remove from the service.
id - int - the context id of the requestor.
Throws:
DSESecurityException - - error in the request.

removeRightFromUser

public void removeRightFromUser(java.lang.String nameOfUser,
                                java.lang.String right,
                                int id)
                         throws DSESecurityException
A security manager must define a method to remove the specified right from the user.
Parameters:
nameOfUser - String - the name of the user to change.
right - String - the name of the right to remove.
id - int - the context id of the requestor.
Throws:
DSESecurityException - - error in the request.

removeRightsFromRole

public void removeRightsFromRole(java.lang.String nameOfRole,
                                 java.lang.String[] rights,
                                 int id)
                          throws DSESecurityException
A security manager must define a method to remove rights from a role.
Parameters:
nameOfRole - String - the name of the role to modify.
rights - String[] - the list of names of rights that are to be removed from the role.
id - int - the context id of the requestor.
Throws:
DSESecurityException - - error in the request.

removeRightsFromService

public void removeRightsFromService(java.lang.String nameOfService,
                                    java.lang.String[] rights,
                                    int id)
                             throws DSESecurityException
A security manager must define a method to remove rights from a service.
Parameters:
nameOfService - String - the name of the service to modify.
rights - String[] - the list of names of rights that are to be removed from the service.
id - int - the context id of the requestor.
Throws:
DSESecurityException - - error in the request.

removeRightsFromUser

public void removeRightsFromUser(java.lang.String nameOfUser,
                                 java.lang.String[] rights,
                                 int id)
                          throws DSESecurityException
A security manager must define a method to remove the specified rights from the user.
Parameters:
nameOfUser - String - the name of the user to change.
rights - String[] - the list of names of rights to remove.
id - int - the context id of the requestor.
Throws:
DSESecurityException - - error in the request.

removeRole

public void removeRole(java.lang.String role,
                       int id)
                throws DSESecurityException
A security manager must define a method to remove a role.
Parameters:
role - String - the name of the role to remove.
id - int - the context id of the requestor.
Throws:
DSESecurityException - - error in the request.

removeRoleFromUser

public void removeRoleFromUser(java.lang.String userId,
                               java.lang.String role,
                               int id)
                        throws DSESecurityException
A security manager must define a method to remove the specified role from the user.
Parameters:
userId - String - the name of the user to change.
role - String - the name of the role to remove.
id - int - the context id of the requestor.
Throws:
DSESecurityException - - error in the request.

removeRoles

public boolean removeRoles(java.lang.String[] rolesToDelete,
                           java.lang.String[] options,
                           int id)
                    throws DSESecurityException
A security manager must define a method to delete the named roles subject to the specified options. OPTIONS: atomic , exception , local , nosave , references , safe , skip.
Parameters:
rolesToDelete - String[] - the names of the roles to delete.
options - String[] - the options for this command.
id - int - the context id of the requestor.
Returns:
boolean - true if the deletes succeeded else false.
Throws:
DSESecurityException - - error in the request.

removeService

public void removeService(java.lang.String service,
                          int id)
                   throws DSESecurityException
A security manager must define a method to remove a service.
Parameters:
service - String - the name of the service to remove.
id - int - the context id of the requestor.
Throws:
DSESecurityException - - error in the request.

removeSubGroup

public void removeSubGroup(java.lang.String superGroup,
                           java.lang.String subGroup,
                           int id)
                    throws DSESecurityException
A security manager must define a method to remove a child group from a parent group.
Parameters:
superGroup - String - the name of the parent group.
subGroup - String - the name of the child group.
id - int - the context id of the requestor.
Throws:
DSESecurityException - - error in the request.

removeSubRole

public void removeSubRole(java.lang.String superRole,
                          java.lang.String subRole,
                          int id)
                   throws DSESecurityException
A security manager must define a method to remove a child role from a parent role.
Parameters:
superRole - String - the name of the role to modify.
subRole - String - the name of the role to be removed.
id - int - the context id of the requestor.
Throws:
DSESecurityException - - error in the request.

removeUser

public void removeUser(java.lang.String user,
                       int id)
                throws DSESecurityException
A security manager must define a method to remove a user.
Parameters:
user - String - the name of the user to remove.
id - int - the context id of the requestor.
Throws:
DSESecurityException - - error in the request.

removeUserFromGroup

public void removeUserFromGroup(java.lang.String nameOfGroup,
                                java.lang.String user,
                                int id)
                         throws DSESecurityException
A security manager must define a method to remove a user from a group.
Parameters:
nameOfGroup - String - the name of the group.
user - String - the name of the user.
id - int - the context id of the requestor.
Throws:
DSESecurityException - - error in the request.

save

public void save(boolean[] list,
                 int id)
          throws DSESecurityException
A security manager must define a method to force a save of selected databases even if persistence is disabled.
Parameters:
list - boolean[] - for each true - force a save of the corresponding database.
id - int - the context id of the requestor.
Throws:
DSESecurityException - - error in the request.

setActivationIntervalForUser

public void setActivationIntervalForUser(java.lang.String userId,
                                         long startTime,
                                         long duration,
                                         boolean limit,
                                         int id)
                                  throws DSESecurityException
A security manager must define a method to set the activation time, duration and enable flag for the specified user.
Parameters:
userId - String - the name of the user to access.
startTime - long - this user's activation time as milliseconds since January 1, 1970, 00:00:00 GMT.
duration - long - this user's duration of activation in milliseconds.
limit - boolean - if true then temporary user else permanent user.
id - int - the context id of the requestor.
Throws:
DSESecurityException - - error in the request.

setAllDataForContext

public void setAllDataForContext(int contextId,
                                 Dictionary dictionary,
                                 int id)
                          throws DSESecurityException
A security manager must define a method to set all data items for the context.
Parameters:
contextId - int - the id of the context to access.
dictionary - Dictionary - the data dictionary.
id - int - the context id of the requestor.
Throws:
DSESecurityException - - error in the request.

setAllDataForGroup

public void setAllDataForGroup(java.lang.String nameOfGroup,
                               Dictionary dictionary,
                               int id)
                        throws DSESecurityException
A security manager must define a method to set all data items for the specified group.
Parameters:
nameOfGroup - String - the name of the group to access.
dictionary - Dictionary - the data dictionary.
id - int - the context id of the requestor.
Throws:
DSESecurityException - - error in the request.

setAllDataForRight

public void setAllDataForRight(java.lang.String nameOfRight,
                               Dictionary dictionary,
                               int id)
                        throws DSESecurityException
A security manager must define a method to set all data items for the specified right.
Parameters:
nameOfRight - String - the name of the right to access.
dictionary - Dictionary - the data dictionary.
id - int - the context id of the requestor.
Throws:
DSESecurityException - - error in the request.

setAllDataForRole

public void setAllDataForRole(java.lang.String nameOfRole,
                              Dictionary dictionary,
                              int id)
                       throws DSESecurityException
A security manager must define a method to set all data items for the specified role.
Parameters:
nameOfRole - String - the name of the role to access.
dictionary - Dictionary - the data dictionary.
id - int - the context id of the requestor.
Throws:
DSESecurityException - - error in the request.

setAllDataForService

public void setAllDataForService(java.lang.String nameOfService,
                                 Dictionary dictionary,
                                 int id)
                          throws DSESecurityException
A security manager must define a method to set all data items for the specified service.
Parameters:
nameOfService - String - the name of the service to access.
dictionary - Dictionary - the data dictionary.
id - int - the context id of the requestor.
Throws:
DSESecurityException - - error in the request.

setAllDataForUser

public void setAllDataForUser(java.lang.String userId,
                              Dictionary dictionary,
                              int id)
                       throws DSESecurityException
A security manager must define a method to set all data items for the specified user.
Parameters:
userId - String - the name of the user to access.
dictionary - Dictionary - the data dictionary.
id - int - the context id of the requestor.
Throws:
DSESecurityException - - error in the request.

setAttributesOfUser

public void setAttributesOfUser(java.lang.String userId,
                                Dictionary attributes,
                                boolean set,
                                int id)
                         throws DSESecurityException
A security manager must define a method to set the attributes of the specified user.
Parameters:
userId - String - the user who's attributes are to be changed.
attributes - Dictionary - the new attributes.
set - boolean - if true then set all the attributes else change the specified attributes only.
id - int - the context id of the requestor.
Throws:
DSESecurityException - - error in the request.

setAudit

public void setAudit(boolean auditFlag)
A security manager must define a method to set the audit control flag. Note - the audit file must be open otherwise this call is ignored.
Parameters:
auditFlag - boolean - the audit flag.

setConfiguration

public void setConfiguration(Dictionary configurations,
                             int id)
                      throws DSESecurityException
A security manager must define a method to set the specified system configurations to the specified values. Currently invalid keys or values are ignored [this may change].
Parameters:
configurations - Dictionary - the configuration dictionary.
id - int - the context id of the requestor.
Throws:
DSESecurityException - - error in the request.

setDataForContext

public void setDataForContext(int contextId,
                              java.lang.String key,
                              java.lang.String value,
                              int id)
                       throws DSESecurityException
A security manager must define a method to add, change or remove the named data item for the specified context.
Parameters:
contextId - int - the id of the context to access.
key - String - the name of the data item.
value - String - the data item (null removes the item).
id - int - the context id of the requestor.
Throws:
DSESecurityException - - error in the request.

setDataForGroup

public void setDataForGroup(java.lang.String nameOfGroup,
                            java.lang.String key,
                            java.lang.String value,
                            int id)
                     throws DSESecurityException
A security manager must define a method to add, change or remove the named data item for the specified group.
Parameters:
nameOfGroup - String - the name of the group to access.
key - String - the name of the data item.
value - String - the data item (null removes the item).
id - int - the context id of the requestor.
Throws:
DSESecurityException - - error in the request.

setDataForRight

public void setDataForRight(java.lang.String nameOfRight,
                            java.lang.String key,
                            java.lang.String value,
                            int id)
                     throws DSESecurityException
A security manager must define a method to add, change or remove the named data item for the specified right.
Parameters:
nameOfRight - String - the name of the right to access.
key - String - the name of the data item.
value - String - the data item (null removes the item).
id - int - the context id of the requestor.
Throws:
DSESecurityException - - error in the request.

setDataForRole

public void setDataForRole(java.lang.String nameOfRole,
                           java.lang.String key,
                           java.lang.String value,
                           int id)
                    throws DSESecurityException
A security manager must define a method to add, change or remove the named data item for the specified role.
Parameters:
nameOfRole - String - the name of the role to access.
key - String - the name of the data item.
value - String - the data item (null removes the item).
id - int - the context id of the requestor.
Throws:
DSESecurityException - - error in the request.

setDataForService

public void setDataForService(java.lang.String nameOfService,
                              java.lang.String key,
                              java.lang.String value,
                              int id)
                       throws DSESecurityException
A security manager must define a method to add, change or remove the named data item for the specified service.
Parameters:
nameOfService - String - the name of the service to access.
key - String - the name of the data item.
value - String - the data item (null removes the item).
id - int - the context id of the requestor.
Throws:
DSESecurityException - - error in the request.

setDataForUser

public void setDataForUser(java.lang.String userid,
                           java.lang.String key,
                           java.lang.String value,
                           int id)
                    throws DSESecurityException
A security manager must define a method to add, change or remove the named data item for the specified user.
Parameters:
userid - String - the name of the user to access.
key - String - the name of the data item.
value - String - the data item (null removes the item).
id - int - the context id of the requestor.
Throws:
DSESecurityException - - error in the request.

setExpiryForRights

public void setExpiryForRights(java.lang.String userid,
                               java.lang.String[] rights,
                               long start,
                               long duration,
                               int id)
                        throws DSESecurityException
A security manager must define a method to define the lifetime of a set of rights associated with a user. If the duration is not positive then remove these attributes.
Parameters:
userid - String - the name of the user to change.
rights - String[] - the set of names of rights to affect.
start - long - the enable time for the rights (milliseconds since epoch).
duration - long - the duration of validity for the rights (in milliseconds).
id - int - the context id of the requestor.
Throws:
DSESecurityException - - error in the request.

setExpiryForRoles

public void setExpiryForRoles(java.lang.String userid,
                              java.lang.String[] roles,
                              long start,
                              long duration,
                              int id)
                       throws DSESecurityException
A security manager must define a method to define the lifetime of a set of roles associated with a user. If the duration is not positive then remove these attributes.
Parameters:
userid - String - the name of the user to change.
roles - String[] - the set of names of roles to affect.
start - long - the enable time for the roles (milliseconds since epoch).
duration - long - the duration of validity for the roles (in milliseconds).
id - int - the context id of the requestor.
Throws:
DSESecurityException - - error in the request.

setHandler

public void setHandler(java.lang.String nameOfRole,
                       java.lang.String handler,
                       int id)
                throws DSESecurityException
A security manager must define a method to set the handler for the named role.
Parameters:
nameOfRole - String - the name of the role to modify.
handler - String - the name of the class of the handler.
id - int - the context id of the requestor.
Throws:
DSESecurityException - - error in the request.

setRightsForService

public void setRightsForService(java.lang.String nameOfService,
                                java.lang.String[] rights,
                                int id)
                         throws DSESecurityException
A security manager must define a method to set the required rights for a service.
Parameters:
nameOfService - String - the name of the service to change.
rights - String[] - the list of names of rights to set.
id - int - the context id of the requestor.
Throws:
DSESecurityException - - error in the request.

setRightsForUser

public void setRightsForUser(java.lang.String userid,
                             java.lang.String[] rights,
                             int id)
                      throws DSESecurityException
A security manager must define a method to set the rights for a user.
Parameters:
userid - String - the name of the user that is to receive the new rights.
rights - String[] - the list of names of rights that the user is now to have.
id - int - the context id of the requestor.
Throws:
DSESecurityException - - error in the request.

setRolesForUser

public void setRolesForUser(java.lang.String userid,
                            java.lang.String[] roles,
                            int id)
                     throws DSESecurityException
A security manager must define a method to set the roles for a user.
Parameters:
userid - String - the name of the user that is to receive the new roles.
roles - String[] - the list of names of roles that the user is now to have.
id - int - the context id of the requestor.
Throws:
DSESecurityException - - error in the request.

setSystemRoles

public void setSystemRoles(java.lang.String[] roles,
                           int id)
                    throws DSESecurityException
A security manager must define a method to set the names of the system-wide roles.
Parameters:
roles - String[] - the names of the system-wide roles.
id - int - the context id of the requestor.
Throws:
DSESecurityException - - error in the request.

setTrace

public void setTrace(boolean tracing)
A security manager must define a method to enable or disable tracing. Note - this only applies to API tracing.
Parameters:
tracing - boolean - if true then enable tracing, if false then disable tracing.

shutdown

public void shutdown(int id)
              throws DSESecurityException
A security manager must define a method to shutdown the security component.
Parameters:
id - int - the context id of the requestor.
Throws:
DSESecurityException - - error in the request.

signOff

public void signOff(int id)
             throws DSESecurityException
A security manager must define a method to disable the user's current context.
Parameters:
id - int - the context id of the requestor.
Throws:
DSESecurityException - - error in the request.

signOn

public int signOn(java.lang.String userId,
                  java.lang.String password)
           throws DSESecurityException
A security manager must define a method to signon the user - raising an exception if it fails.
Parameters:
userId - String - the user id.
password - String - the password.
Returns:
int - the id of the context that was signon on.
Throws:
DSESecurityException - - error in the request.

signOn

public void signOn(java.lang.String userId,
                   java.lang.String password,
                   int id)
            throws DSESecurityException
A security manager must define a method to signon the user - raising an exception if it fails.
Parameters:
userId - String - the user id.
password - String - the password.
id - int - the id of the context to signon.
Throws:
DSESecurityException - - error in the request.

test

public java.lang.Object test(int cmd,
                             Dictionary options,
                             int id)
                      throws DSESecurityException
A security manager must define a method to perform a test command.
Parameters:
cmd - int - the command id.
options - Dictionary - the options to the command.
id - int - the context id of the requestor.
Returns:
Object - the return value.
Throws:
DSESecurityException - - error in the request.

unlock

public void unlock(java.lang.String userid,
                   int id)
            throws DSESecurityException
A security manager must define a method to unlock the specified user. An unlocked user can log in.
Parameters:
userid - String - the name of the user to unlock.
id - int - the context id of the requestor.
Throws:
DSESecurityException - - error in the request.

verify

public void verify(int id)
            throws DSESecurityException
A security manager must define a method to verify all security databases for consistency.
Parameters:
id - int - the context id of the requestor.
Throws:
DSESecurityException - - error in the request.