intradoc.shared
Class SecurityUtils

java.lang.Object
  |
  +--intradoc.shared.SecurityUtils

public class SecurityUtils

extends java.lang.Object

Constructor Summary

SecurityUtils()

Method Summary

static void	addAccountsFiltered(UserData userData, java.util.Vector presentationAccounts, java.util.Vector knownAccounts, java.lang.String[] allowedAccounts, boolean isSpecial, boolean doTranslate, ExecutionContext cxt)
static void	addDefaultAccounts(UserData userData, java.util.Vector accounts)
static int	computeAccountPrivilege(UserData userData, java.lang.String account, int priv) Service to do various computations of privilege relative to accounts.
static int	determineBestAccountPrivilege(UserData userData, java.lang.String account)
static int	determineGroupPrivilege(UserData userData, java.lang.String group) Determines what level of access the user has to a specific group.
static boolean[]	determineGroupsAccessible(UserData userData, int desiredPriv, java.util.Vector allGroups, java.util.Hashtable groupsAccessible) The 'allGroups' array is filled up with a list of all the security groups.
static java.util.Vector	getAccessibleAccounts(UserData userData, boolean addSpecialAccounts, int priv, ExecutionContext cxt) This service returns an array of the "presentation strings" for display in the user interface.
static java.lang.String	getAccountPackagedList(UserData userData)
static java.lang.String	getAccountPackagedListEx(UserData userData, boolean optimize)
static java.lang.String	getFullExportedAccountslist(UserData userData)
static java.lang.String[]	getPrivilegedAccounts(UserData userData, int priv, boolean optimize)
static java.util.Vector	getRoleList(UserData userData)
static java.lang.String	getRolePackagedList(UserData userData)
static java.lang.String	getRolePackagedList(UserData userData, boolean isDelimited)
static java.lang.String	getRolePackagedListEx(UserData userData, boolean isDelimited)
static java.util.Vector	getUserAccountsWithPrivilege(UserData userData, int priv, boolean optimize)
static UserDocumentAccessFilter	getUserDocumentAccessFilter(UserData userData, int priv) Returns an object holding security information that optimizes the security checks against application entities with document security credentials.
static java.util.Vector	getUserGroupsWithPrivilege(UserData userData, int priv) Returns the security groups accessible by the user at the desired privilege level.
static boolean	isAccountAccessible(UserData userData, java.lang.String account, int priv)
static boolean	isUserOfRole(UserData userData, java.lang.String role) Checks to see if a user has a specific role.
static void	loadExternalSecurityAttributes(UserData userData, java.lang.String attribName, java.util.Vector attribs, RoleDefinitions roleDefs, boolean isRegisteredUser)
static java.lang.String[]	parseSecurityFlags(java.lang.String attribVal, java.lang.String defFlag)
static java.lang.String	stripEntitySymbols(java.lang.String entityStr, java.lang.String entityType)

Methods inherited from class java.lang.Object

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

Constructor Detail

SecurityUtils

public SecurityUtils()

Method Detail

getUserDocumentAccessFilter

public static UserDocumentAccessFilter getUserDocumentAccessFilter(UserData userData,
                                                                   int priv)
                                                            throws DataException,
                                                                   ServiceException

Returns an object holding security information that optimizes the security checks against application entities with document security credentials.

DataException

ServiceException

getUserGroupsWithPrivilege

public static java.util.Vector getUserGroupsWithPrivilege(UserData userData,
                                                          int priv)
                                                   throws ServiceException

Returns the security groups accessible by the user at the desired privilege level.

ServiceException

determineGroupPrivilege

public static int determineGroupPrivilege(UserData userData,
                                          java.lang.String group)
                                   throws DataException,
                                          ServiceException

Determines what level of access the user has to a specific group.

DataException

ServiceException

isUserOfRole

public static boolean isUserOfRole(UserData userData,
                                   java.lang.String role)

Checks to see if a user has a specific role.

getRoleList

public static java.util.Vector getRoleList(UserData userData)

getRolePackagedList

public static java.lang.String getRolePackagedList(UserData userData,
                                                   boolean isDelimited)

getRolePackagedList

public static java.lang.String getRolePackagedList(UserData userData)

getRolePackagedListEx

public static java.lang.String getRolePackagedListEx(UserData userData,
                                                     boolean isDelimited)

determineGroupsAccessible

public static boolean[] determineGroupsAccessible(UserData userData,
                                                  int desiredPriv,
                                                  java.util.Vector allGroups,
                                                  java.util.Hashtable groupsAccessible)
                                           throws ServiceException

The 'allGroups' array is filled up with a list of all the security groups. The 'groupsAccessible' hashtable contains entries only for those groups that are accessible. Returns boolean array with values set to true for groups accessible in 'allGroups' array.

ServiceException

getAccessibleAccounts

public static java.util.Vector getAccessibleAccounts(UserData userData,
                                                     boolean addSpecialAccounts,
                                                     int priv,
                                                     ExecutionContext cxt)
                                              throws ServiceException

This service returns an array of the "presentation strings" for display in the user interface. Note: only accounts that are defined in the system are returned. The user can still make up his own account names without reference to existing accounts.

ServiceException

getPrivilegedAccounts

public static java.lang.String[] getPrivilegedAccounts(UserData userData,
                                                       int priv,
                                                       boolean optimize)
                                                throws ServiceException

ServiceException

getUserAccountsWithPrivilege

public static java.util.Vector getUserAccountsWithPrivilege(UserData userData,
                                                            int priv,
                                                            boolean optimize)

getAccountPackagedList

public static java.lang.String getAccountPackagedList(UserData userData)

getAccountPackagedListEx

public static java.lang.String getAccountPackagedListEx(UserData userData,
                                                        boolean optimize)

getFullExportedAccountslist

public static java.lang.String getFullExportedAccountslist(UserData userData)

isAccountAccessible

public static boolean isAccountAccessible(UserData userData,
                                          java.lang.String account,
                                          int priv)
                                   throws ServiceException

ServiceException

determineBestAccountPrivilege

public static int determineBestAccountPrivilege(UserData userData,
                                                java.lang.String account)
                                         throws ServiceException

ServiceException

computeAccountPrivilege

public static int computeAccountPrivilege(UserData userData,
                                          java.lang.String account,
                                          int priv)
                                   throws ServiceException

Service to do various computations of privilege relative to accounts. 1. If priv == 0 then service returns best privilege allowable for account. If priv != 0, then service returns zero if that privilege level is not obtainable, otherwise it returns priv (the service aborts as soon as it has determined that the privilege level has been reached). 2. If account == null, then service returns best privilege available for any of the accessible accounts (following rule 1.).

ServiceException

addDefaultAccounts

public static void addDefaultAccounts(UserData userData,
                                      java.util.Vector accounts)

addAccountsFiltered

public static void addAccountsFiltered(UserData userData,
                                       java.util.Vector presentationAccounts,
                                       java.util.Vector knownAccounts,
                                       java.lang.String[] allowedAccounts,
                                       boolean isSpecial,
                                       boolean doTranslate,
                                       ExecutionContext cxt)

loadExternalSecurityAttributes

public static void loadExternalSecurityAttributes(UserData userData,
                                                  java.lang.String attribName,
                                                  java.util.Vector attribs,
                                                  RoleDefinitions roleDefs,
                                                  boolean isRegisteredUser)

parseSecurityFlags

public static java.lang.String[] parseSecurityFlags(java.lang.String attribVal,
                                                    java.lang.String defFlag)

stripEntitySymbols

public static java.lang.String stripEntitySymbols(java.lang.String entityStr,
                                                  java.lang.String entityType)