|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectca.bc.gov.webade.WebADEDatabaseApplication
This class encapsulates the information about a single Web application.
It does the following:
User object for anonymous
users
| Field Summary | |
static java.lang.String |
WEBADE_MBEAN_DOMAIN
The WebADE MBean domain for JMX. |
| Method Summary | |
void |
dispose()
closes all connection caches gracefully. |
java.util.List |
findGroups(GroupSearchObject searchObject)
Finds the set of Group objects that match the provided group search attributes. |
java.util.List |
findOrganizations(OrganizationSearchObject searchObject)
Finds the set of Organization objects that match the provided search criteria. |
java.util.List |
findUsers(UserSearchObject searchObject)
Finds the set of User objects that match the provided search criteria. |
WebADEUserInfo[] |
findWebADEUsers(UserSearchObject searchObject)
Finds the set of WebADEUserInfo objects that match the provided search criteria. |
User |
getAnonymousUser()
Get the singleton anonymous User object. |
java.lang.String |
getApplicationCode()
Get the code (acronym) for the application. |
java.lang.String |
getApplicationEnvironment()
Get the deployment environment this application is deployed in. |
ApplicationManager |
getApplicationManager()
Returns the application manager singleton, or null, if not configured. |
Preferences |
getApplicationPreferences()
Returns the set of application preferences. |
UserCredentials[] |
getAuthorizedUsers(Organization organization)
Loads all users from the datastore that are members of roles via an authorization associated with the given organization. |
UserCredentials[] |
getAuthorizedUsers(Organization organization,
boolean ignoreIndeterminateAuthorizationsErrors)
Loads all users from the datastore that are members of roles via an authorization associated with the given organization. |
UserCredentials[] |
getAuthorizedUsers(Role role)
Loads all users from the datastore that are members of the given role. |
UserCredentials[] |
getAuthorizedUsers(Role role,
boolean ignoreIndeterminateAuthorizationsErrors)
Loads all users from the datastore that are members of the given role. |
UserCredentials[] |
getAuthorizedUsers(Role role,
Organization organization)
Loads all users from the datastore that are members the given roles via an authorization associated with the given organization. |
UserCredentials[] |
getAuthorizedUsers(Role role,
Organization organization,
boolean ignoreIndeterminateAuthorizationsErrors)
Loads all users from the datastore that are members the given roles via an authorization associated with the given organization. |
java.sql.Connection |
getConnection(User user,
Role role)
gets a Connection for the given role. |
java.sql.Connection |
getConnection(WebADEUserPermissions userAuthorizations,
Role role)
gets a Connection for the given role. |
java.sql.Connection |
getConnectionByAction(User user,
java.lang.String actionName)
gets a Connection for the given action. |
java.sql.Connection |
getConnectionByAction(WebADEUserPermissions userAuthorizations,
Action action)
Gets a Connection for the given action. |
java.sql.Connection |
getConnectionByAction(WebADEUserPermissions userAuthorizations,
java.lang.String actionName)
Gets a Connection for the given action. |
java.sql.Connection |
getConnectionByPriviledgedAction(Action action)
Gets a Connection for the given priviledged action. |
java.sql.Connection |
getConnectionByPriviledgedAction(java.lang.String actionName)
Gets a Connection for the given priviledged action. |
ElectronicAgreement |
getElectronicAgreement(java.lang.String agreementName)
Returns the target agreement, based on the given agreement name. |
Preferences |
getGlobalPreferences()
Returns the global preferences for WebADE. |
Group |
getGroupByGUID(java.lang.String guid)
Loads the target group from the datastore, or returns null if the group is not found. |
java.util.List |
getGroupSearchMetadata()
Returns a List of GroupSearchObject metadata objects for all configured directories for this application. |
Organization |
getOrganizationById(long organizationId)
Returns the organization with the given organization id. |
OrganizationSearchObject |
getOrganizationSearchMetadata()
Returns the OrganizationSearchObject metadata object that allows the searching of ministry organizations. |
WebADEUserPermissions |
getPublicWebADEPermissions()
Returns the public unauthenticated permissions from the datastore. |
AppRoles |
getRoles()
get the roles used by this application. |
User |
getUserByEUserId(long euserId)
Deprecated. |
User |
getUserByGUID(java.lang.String guid)
Loads the target user from the datastore, or returns null if the user is not found. |
User |
getUserByUserId(java.lang.String userId)
Loads the target user from the datastore, or returns null if the user is not found. |
Organization |
getUserDefaultOrganization(User user)
Gets the user's default organization. |
Organization |
getUserDefaultOrganization(UserCredentials userCredentials)
Gets the user's default organization. |
UserInfoService |
getUserInfoService()
Returns the UserInfoService object for this application. |
Preferences |
getUserPreferences(User targetUser)
Returns the set of user preferences for this user and this application. |
Preferences |
getUserPreferences(UserCredentials targetUserCredentials)
Returns the set of user preferences for this user and this application. |
User[] |
getUsersByOrganization(Organization organization)
Loads all users from the datastore that are members of roles via an authorization associated with the given organization. |
User[] |
getUsersByRole(Role role)
Loads all users from the datastore that are members of the given role. |
User[] |
getUsersByRoleAndOrganization(Role role,
Organization organization)
Loads all users from the datastore that are members the given roles via an authorization associated with the given organization. |
java.util.List |
getUserSearchMetadata()
Returns a List of UserSearchObject metadata objects for all configured directories for this application. |
WebADEPreferences |
getWebADEApplicationPreferences()
Returns the set of WebADE application preferences. |
WebADEExtension |
getWebADEExtension(java.lang.Class classObject)
Retrieves the registered extension singleton from the list of extensions which is an instance of the provided class object. |
WebADEExtension |
getWebADEExtension(java.lang.String className)
Retrieves the registered extension singleton from the list of extensions whose fully qualified class name is the one provided. |
WebADEPreferences |
getWebADEGlobalPreferences()
Returns the global preferences for WebADE. |
WebADEPreferences |
getWebADEPreferences()
Returns the WebADE preferences for the application. |
WebADEUserInfo |
getWebADEUserInfo(UserCredentials userCredentials)
Loads the target user's personal information from the datastore, or returns null if the user is not found. |
WebADEUserInfo |
getWebADEUserInfo(UserCredentials userCredentials,
boolean ignoreSessionCache)
Loads the target user's personal information from the datastore, or returns null if the user is not found. |
WebADEUserPermissions |
getWebADEUserPermissions(UserCredentials userCredentials)
Loads the target user's permissions from the datastore, or returns null if the user is not found. |
WebADEUserPermissions |
getWebADEUserPermissions(UserCredentials userCredentials,
boolean ignoreSessionCache)
Loads the target user's permissions from the datastore, or returns null if the user is not found. |
WebADEPreferences |
getWebADEUserPreferences(UserCredentials targetUserCredentials)
Returns the set of user preferences for this user and this application. |
boolean |
hasIndeterminateAuthorizations(Organization organization)
Checks to see if a call to getUsersByRole() will throw a IndeterminateAuthorizationsException for the given organization. |
boolean |
hasIndeterminateAuthorizations(Role role)
Checks to see if a call to getUsersByRole() will throw a IndeterminateAuthorizationsException for the given role. |
boolean |
hasIndeterminateAuthorizations(Role role,
Organization organization)
Checks to see if a call to getUsersByRole() will throw a IndeterminateAuthorizationsException for the given role and organization. |
boolean |
hasUserAcceptedAgreement(UserCredentials userCredentials,
java.lang.String agreementName)
Returns a flag indicating whether the user has previously agreed to the given agreement. |
boolean |
hasUserAcceptedAgreement(User user,
java.lang.String agreementName)
Returns a flag indicating whether the user has previously agreed to the given agreement. |
boolean |
isAnonymousUser(User user)
Tests if the given user is the anonymous user for this application. |
boolean |
isDisabled()
Tests if the application is currently disabled. |
boolean |
isUserInGroup(UserCredentials userCredentials,
GUID groupGuid)
Checks to see if the user is a member of the group identified by the given GUID. |
boolean |
isUserInGroup(User user,
java.lang.String groupGuid)
Checks to see if the user is a member of the group identified by the given GUID. |
GUID[] |
isUserInGroups(UserCredentials userCredentials,
GUID[] groupGuids)
Checks to see if the user is a member of the groups identified by the given array of GUID values. |
java.lang.String[] |
isUserInGroups(User user,
java.lang.String[] groupGuids)
Checks to see if the user is a member of the groups identified by the given array of GUID values. |
void |
registerWebADEExtension(WebADEExtension extension)
Registers a new WebADE Extension with the Application object. |
WebADEPreferences |
saveWebADEUserPreferences(UserCredentials targetUserCredentials,
WebADEPreferences preferences)
Saves the given user preferences for this user and this application. |
void |
setDisabled(boolean disable)
Sets the disabled status of this application in the current execution environment. |
void |
setUserAcceptedAgreement(UserCredentials userCredentials,
java.lang.String agreementName,
boolean agreeFlag)
Sets the user's "accepted" flag on the given agreement to the given flag value. |
void |
setUserAcceptedAgreement(User user,
java.lang.String agreementName,
boolean agreeFlag)
Sets the user's "accepted" flag on the given agreement to the given flag value. |
void |
setUserDefaultOrganization(UserCredentials userCredentials,
Organization organization)
Sets the user's default organization to the given organization. |
void |
setUserDefaultOrganization(User user,
Organization organization)
Sets the user's default organization to the given organization. |
void |
shutdown()
Notifies the application singleton to shutdown, stopping monitoring threads and closing dependant resources. |
void |
unregisterWebADEExtension(WebADEExtension extension)
Unregisters a WebADE Extension from the Application object. |
| Methods inherited from class java.lang.Object |
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Field Detail |
public static final java.lang.String WEBADE_MBEAN_DOMAIN
| Method Detail |
public UserInfoService getUserInfoService()
getUserInfoService in interface Applicationpublic Preferences getApplicationPreferences()
Application
getApplicationPreferences in interface ApplicationApplication.getApplicationPreferences()
public WebADEPreferences getWebADEApplicationPreferences()
throws WebADEException
Application
getWebADEApplicationPreferences in interface ApplicationWebADEException - Thrown when an error occurs while trying to retrieve the
WebADE application preferences.Application.getWebADEApplicationPreferences()
public Preferences getGlobalPreferences()
throws WebADEException
Application
getGlobalPreferences in interface ApplicationWebADEException - Thrown when a WebADE error occurs.Application.getGlobalPreferences()
public WebADEPreferences getWebADEGlobalPreferences()
throws WebADEException
Application
getWebADEGlobalPreferences in interface ApplicationWebADEException - Thrown when a WebADE error occurs.Application.getWebADEGlobalPreferences()public java.lang.String getApplicationCode()
Application
getApplicationCode in interface ApplicationApplication.getApplicationCode()public java.lang.String getApplicationEnvironment()
Application
getApplicationEnvironment in interface ApplicationApplication.getApplicationEnvironment()public AppRoles getRoles()
Application
getRoles in interface ApplicationApplication.getRoles()
public WebADEUserPermissions getPublicWebADEPermissions()
throws WebADEException
Application
getPublicWebADEPermissions in interface ApplicationWebADEExceptionApplication.getPublicWebADEPermissions()
public WebADEUserPermissions getWebADEUserPermissions(UserCredentials userCredentials)
throws WebADEException
Application
getWebADEUserPermissions in interface ApplicationuserCredentials - The user's identifying credentials.
WebADEExceptionApplication.getWebADEUserPermissions(ca.bc.gov.webade.user.UserCredentials)
public WebADEUserPermissions getWebADEUserPermissions(UserCredentials userCredentials,
boolean ignoreSessionCache)
throws WebADEException
Application
getWebADEUserPermissions in interface ApplicationuserCredentials - The user's identifying credentials.ignoreSessionCache - A flag indicating whether to ignore the session user permissions
object, should it match the given user credentials.
WebADEExceptionApplication.getWebADEUserPermissions(ca.bc.gov.webade.user.UserCredentials, boolean)
public WebADEUserInfo getWebADEUserInfo(UserCredentials userCredentials)
throws WebADEException
UserInfoService.getWebADEUserInfo(ca.bc.gov.webade.user.UserCredentials).
Application
getWebADEUserInfo in interface ApplicationuserCredentials - The user's identifying credentials.
WebADEExceptionApplication.getWebADEUserInfo(ca.bc.gov.webade.user.UserCredentials)
public WebADEUserInfo getWebADEUserInfo(UserCredentials userCredentials,
boolean ignoreSessionCache)
throws WebADEException
UserInfoService.getWebADEUserInfo(ca.bc.gov.webade.user.UserCredentials, boolean).
Application
getWebADEUserInfo in interface ApplicationuserCredentials - The user's identifying credentials.ignoreSessionCache - A flag indicating whether to ignore the session user info
object, should it match the given user credentials.
WebADEExceptionApplication.getWebADEUserInfo(ca.bc.gov.webade.user.UserCredentials, boolean)public java.util.List getUserSearchMetadata()
UserInfoService.createUserSearchQuery(ca.bc.gov.webade.user.UserTypeCode)
Application
getUserSearchMetadata in interface ApplicationApplication.getUserSearchMetadata()
public WebADEUserInfo[] findWebADEUsers(UserSearchObject searchObject)
throws WebADEException
UserInfoService.findUsers(ca.bc.gov.webade.user.search.UserSearchQuery)
Application
findWebADEUsers in interface ApplicationsearchObject - The search object.
WebADEException - Thrown when an error occurs while trying to retrieve the
information from the datastore.Application.findWebADEUsers(ca.bc.gov.webade.UserSearchObject)
public Organization getUserDefaultOrganization(UserCredentials userCredentials)
throws WebADEException
Application
getUserDefaultOrganization in interface ApplicationuserCredentials - The target user's credentials.
WebADEException - Thrown if an error occurs while getting the default
organization.Application.getUserDefaultOrganization(ca.bc.gov.webade.user.UserCredentials)
public Preferences getUserPreferences(UserCredentials targetUserCredentials)
throws WebADEException
Application
getUserPreferences in interface ApplicationtargetUserCredentials - The user's identifying credentials.
WebADEException - Thrown when a WebADE error occurs.Application.getUserPreferences(ca.bc.gov.webade.user.UserCredentials)
public WebADEPreferences getWebADEUserPreferences(UserCredentials targetUserCredentials)
throws WebADEException
Application
getWebADEUserPreferences in interface ApplicationtargetUserCredentials - The user's identifying credentials.
WebADEException - Thrown when a WebADE error occurs.Application.getWebADEUserPreferences(ca.bc.gov.webade.user.UserCredentials)
public WebADEPreferences saveWebADEUserPreferences(UserCredentials targetUserCredentials,
WebADEPreferences preferences)
throws WebADEException
Application
saveWebADEUserPreferences in interface ApplicationtargetUserCredentials - The user's identifying credentials.preferences - The user's User preferences.
WebADEException - Thrown when a WebADE error occurs.Application.saveWebADEUserPreferences(ca.bc.gov.webade.user.UserCredentials, ca.bc.gov.webade.preferences.WebADEPreferences)
public boolean hasUserAcceptedAgreement(UserCredentials userCredentials,
java.lang.String agreementName)
throws WebADEException
Application
hasUserAcceptedAgreement in interface ApplicationuserCredentials - The target user's credentials.agreementName - The unique name of the target agreement.
WebADEException - Thrown when an error occurs while trying to retrieve the
information from the datastore.Application.hasUserAcceptedAgreement(ca.bc.gov.webade.user.UserCredentials,
java.lang.String)
public boolean isUserInGroup(UserCredentials userCredentials,
GUID groupGuid)
throws WebADEException
Application
isUserInGroup in interface ApplicationuserCredentials - The target user's credentials.groupGuid - The unique GUID of the target group.
WebADEException - Thrown if the group is not found or an error occurs while
processing the request.Application.isUserInGroup(ca.bc.gov.webade.user.UserCredentials,
ca.bc.gov.webade.user.GUID)
public GUID[] isUserInGroups(UserCredentials userCredentials,
GUID[] groupGuids)
throws WebADEException
Application
isUserInGroups in interface ApplicationuserCredentials - The target user's credentials.groupGuids - The unique GUID values of the target groups.
WebADEException - Thrown if ant of the groups are not found or an error occurs
while processing the request.Application.isUserInGroups(ca.bc.gov.webade.user.UserCredentials,
ca.bc.gov.webade.user.GUID[])
public void setUserAcceptedAgreement(UserCredentials userCredentials,
java.lang.String agreementName,
boolean agreeFlag)
throws WebADEException
Application
setUserAcceptedAgreement in interface ApplicationuserCredentials - The target user's credentials.agreementName - The unique name of the target agreement.agreeFlag - A flag indicating whether the user accepts or refuses the
given agreement.
WebADEException - Thrown when an error occurs while trying to save the flag to
the datastore.Application.setUserAcceptedAgreement(ca.bc.gov.webade.user.UserCredentials,
java.lang.String, boolean)
public void setUserDefaultOrganization(UserCredentials userCredentials,
Organization organization)
throws WebADEException
Application
setUserDefaultOrganization in interface ApplicationuserCredentials - The target user's credentials.organization - The selected organization.
WebADEException - Thrown if an error occurs while setting the default
organization.Application.setUserDefaultOrganization(ca.bc.gov.webade.user.UserCredentials,
ca.bc.gov.webade.Organization)
public ElectronicAgreement getElectronicAgreement(java.lang.String agreementName)
throws WebADEException
Application
getElectronicAgreement in interface ApplicationagreementName - The name of the target agreement.
WebADEException - Thrown when an error occurs while trying to retrieve the
information from the datastore.Application.getElectronicAgreement(java.lang.String)
public Organization getOrganizationById(long organizationId)
throws WebADEException
Application
getOrganizationById in interface ApplicationorganizationId - The unique organization id.
WebADEException - Thrown when an error occurs while trying to retrieve the
information from the datastore.Application.getOrganizationById(long)public OrganizationSearchObject getOrganizationSearchMetadata()
Application
getOrganizationSearchMetadata in interface ApplicationApplication.getOrganizationSearchMetadata()
public java.util.List findOrganizations(OrganizationSearchObject searchObject)
throws WebADEException
Application
findOrganizations in interface ApplicationsearchObject - The search object.
WebADEException - Thrown when an error occurs while trying to retrieve the
information from the datastore.Application.findOrganizations(ca.bc.gov.webade.OrganizationSearchObject)
public void registerWebADEExtension(WebADEExtension extension)
throws WebADEExtensionException
Application
registerWebADEExtension in interface Applicationextension - A singleton extension object to initialize and store in the
application object
WebADEExtensionException - Thrown if the extension object is null or an instance of the
class has already been registeredApplication.registerWebADEExtension(ca.bc.gov.webade.WebADEExtension)public void unregisterWebADEExtension(WebADEExtension extension)
Application
unregisterWebADEExtension in interface Applicationextension - A singleton extension object to remove from the application's
extension list.Application.unregisterWebADEExtension(ca.bc.gov.webade.WebADEExtension)public WebADEExtension getWebADEExtension(java.lang.String className)
Application
getWebADEExtension in interface ApplicationclassName - The fully qualified class name(including package)
Application.getWebADEExtension(java.lang.String)public WebADEExtension getWebADEExtension(java.lang.Class classObject)
Application
getWebADEExtension in interface ApplicationclassObject - The class of the extension singleton
Application.getWebADEExtension(java.lang.Class)
public boolean isDisabled()
throws WebADEException
Application
isDisabled in interface Applicationtrue if the application is currently disabled
WebADEException - Thrown if an error occurs while determining if the
application has been disabled.Application.isDisabled()
public void setDisabled(boolean disable)
throws WebADEException
Application
setDisabled in interface Applicationdisable - Flag indicating whether to disable the application.
WebADEExceptionApplication.setDisabled(boolean)
public java.sql.Connection getConnection(WebADEUserPermissions userAuthorizations,
Role role)
throws WebADEException,
java.sql.SQLException
Application
getConnection in interface ApplicationuserAuthorizations - The target user's authorizations.role - the role to get the Connection for
java.sql.SQLException - Thrown if an error occurs.
WebADEException - Thrown if an error occurs.Application.getConnection(ca.bc.gov.webade.user.WebADEUserPermissions,
ca.bc.gov.webade.Role)
public java.sql.Connection getConnectionByAction(WebADEUserPermissions userAuthorizations,
Action action)
throws WebADEException,
java.sql.SQLException
Application
getConnectionByAction in interface ApplicationuserAuthorizations - The target user's authorizations.action - The action to get the Connection for.
connection a connection
java.sql.SQLException - Thrown if an error occurs.
WebADEException - Thrown if an error occurs.Application.getConnectionByAction(ca.bc.gov.webade.user.WebADEUserPermissions, ca.bc.gov.webade.Action)
public java.sql.Connection getConnectionByAction(WebADEUserPermissions userAuthorizations,
java.lang.String actionName)
throws WebADEException,
java.sql.SQLException
Application
getConnectionByAction in interface ApplicationuserAuthorizations - The target user's authorizations.actionName - the actionname to get the Connection for
connection a connection
java.sql.SQLException - Thrown if an error occurs.
WebADEException - Thrown if an error occurs.Application.getConnectionByAction(ca.bc.gov.webade.user.WebADEUserPermissions,
java.lang.String)
public java.sql.Connection getConnectionByPriviledgedAction(Action action)
throws WebADEException,
java.sql.SQLException
Application
getConnectionByPriviledgedAction in interface Applicationaction - The action to get the Connection for.
connection a connection
java.sql.SQLException - Thrown if an error occurs.
WebADEException - Thrown if an error occurs, or if the action is not marked as
priviledged.Application.getConnectionByPriviledgedAction(ca.bc.gov.webade.Action)
public java.sql.Connection getConnectionByPriviledgedAction(java.lang.String actionName)
throws WebADEException,
java.sql.SQLException
Application
getConnectionByPriviledgedAction in interface ApplicationactionName - the action name to get the Connection for
connection a connection
java.sql.SQLException - Thrown if an error occurs.
WebADEException - Thrown if an error occurs, or if the action is not marked as
priviledged.Application.getConnectionByPriviledgedAction(java.lang.String)public ApplicationManager getApplicationManager()
public boolean hasIndeterminateAuthorizations(Role role)
throws WebADEException
Application
hasIndeterminateAuthorizations in interface Applicationrole - The WebADE role in this application.
WebADEException - Thrown if an error occurs while performing this query.Application.hasIndeterminateAuthorizations(ca.bc.gov.webade.Role)
public boolean hasIndeterminateAuthorizations(Organization organization)
throws WebADEException
Application
hasIndeterminateAuthorizations in interface Applicationorganization - The organization to load users of this application for.
WebADEException - Thrown if an error occurs while performing this query.Application.hasIndeterminateAuthorizations(ca.bc.gov.webade.Organization)
public boolean hasIndeterminateAuthorizations(Role role,
Organization organization)
throws WebADEException
Application
hasIndeterminateAuthorizations in interface Applicationrole - The WebADE role in this application.organization - The organization to load users of this application for.
WebADEException - Thrown if an error occurs while performing this query.Application.hasIndeterminateAuthorizations(ca.bc.gov.webade.Role,
ca.bc.gov.webade.Organization)
public UserCredentials[] getAuthorizedUsers(Role role)
throws IndeterminateAuthorizationsException,
WebADEException
Application
getAuthorizedUsers in interface Applicationrole - The role to load users for.
IndeterminateAuthorizationsException - Throws IndeterminateAuthorizationsException if the list of
users cannot be completely loaded.
WebADEException - Throws a base WebADEException if an error occurs while
performing this query.Application.getAuthorizedUsers(ca.bc.gov.webade.Role)
public UserCredentials[] getAuthorizedUsers(Role role,
boolean ignoreIndeterminateAuthorizationsErrors)
throws IndeterminateAuthorizationsException,
WebADEException
Application
getAuthorizedUsers in interface Applicationrole - The role to load users for.ignoreIndeterminateAuthorizationsErrors - If set to true, prevents the
IndeterminateAuthorizationsException from being thrown, if it
occurs.
WebADEException - Throws a base WebADEException if an error occurs while
performing this query.
IndeterminateAuthorizationsException - Throws IndeterminateAuthorizationsException if the list of
users cannot be completely loaded.Application.getAuthorizedUsers(ca.bc.gov.webade.Role,
boolean)
public UserCredentials[] getAuthorizedUsers(Organization organization)
throws IndeterminateAuthorizationsException,
WebADEException
Application
getAuthorizedUsers in interface Applicationorganization - The organization to load users for.
WebADEException - Throws a base WebADEException if an error occurs while
performing this query.
IndeterminateAuthorizationsException - Throws IndeterminateAuthorizationsException if the list of
users cannot be completely loaded.Application.getAuthorizedUsers(ca.bc.gov.webade.Organization)
public UserCredentials[] getAuthorizedUsers(Organization organization,
boolean ignoreIndeterminateAuthorizationsErrors)
throws IndeterminateAuthorizationsException,
WebADEException
Application
getAuthorizedUsers in interface Applicationorganization - The organization to load users for.ignoreIndeterminateAuthorizationsErrors - If set to true, prevents the
IndeterminateAuthorizationsException from being thrown, if it
occurs.
IndeterminateAuthorizationsException - Throws IndeterminateAuthorizationsException if the list of
users cannot be completely loaded.
WebADEException - Throws a base WebADEException if an error occurs while
performing this query.Application.getAuthorizedUsers(ca.bc.gov.webade.Organization,
boolean)
public UserCredentials[] getAuthorizedUsers(Role role,
Organization organization)
throws WebADEException
Application
getAuthorizedUsers in interface Applicationrole - The role to load users for (optional).organization - The organization to load users for (optional).
WebADEException - Throws a base WebADEException if an error occurs while
performing this query.Application.getAuthorizedUsers(ca.bc.gov.webade.Role,
ca.bc.gov.webade.Organization)
public UserCredentials[] getAuthorizedUsers(Role role,
Organization organization,
boolean ignoreIndeterminateAuthorizationsErrors)
throws IndeterminateAuthorizationsException,
WebADEException
Application
getAuthorizedUsers in interface Applicationrole - The role to load users for (optional).organization - The organization to load users for (optional).ignoreIndeterminateAuthorizationsErrors - If set to true, prevents the
IndeterminateAuthorizationsException from being thrown, if it
occurs.
WebADEException - Throws a base WebADEException if an error occurs while
performing this query.
IndeterminateAuthorizationsException - Throws IndeterminateAuthorizationsException if the list of
users cannot be completely loaded.Application.getAuthorizedUsers(ca.bc.gov.webade.Role,
ca.bc.gov.webade.Organization, boolean)
public void shutdown()
throws java.lang.SecurityException
Application
shutdown in interface Applicationjava.lang.SecurityException - If the caller is not an instance of an authorized class, a
SecurityException is thrown.Application.shutdown()public void dispose()
public User getUserByEUserId(long euserId)
throws WebADEException
euserId - The unique database key of the record in the EUser database
table.
WebADEException - Thrown if an error occurs while retrieving the user record.
public Preferences getUserPreferences(User targetUser)
throws WebADEException
Application
getUserPreferences in interface ApplicationtargetUser - The user to retrieve the preferences for.
WebADEException - Thrown when a WebADE error occurs.Application.getUserPreferences(ca.bc.gov.webade.User)
public User getAnonymousUser()
throws WebADEException
Application
getAnonymousUser in interface ApplicationWebADEExceptionApplication.getAnonymousUser()
public boolean isAnonymousUser(User user)
throws WebADEException
Application
isAnonymousUser in interface Applicationuser - The user to compare to the anonymous user.
WebADEExceptionApplication.isAnonymousUser(ca.bc.gov.webade.User)
public User getUserByGUID(java.lang.String guid)
throws WebADEException
ApplicationsearchForUserByGUID
method to indicate to the developer that this call is less efficient than
the application's getUser() methods.
getUserByGUID in interface Applicationguid - The guid of the user to load.
WebADEExceptionApplication.getUserByGUID(java.lang.String)
public User getUserByUserId(java.lang.String userId)
throws WebADEException
Application
getUserByUserId in interface ApplicationuserId - The userId of the user, including domain, to load.
WebADEExceptionApplication.getUserByUserId(java.lang.String)
public User[] getUsersByRole(Role role)
throws WebADEException
Application
getUsersByRole in interface Applicationrole - The role to load users for.
WebADEExceptionApplication.getUsersByRole(ca.bc.gov.webade.Role)
public User[] getUsersByOrganization(Organization organization)
throws WebADEException
Application
getUsersByOrganization in interface Applicationorganization - The organization to load users for.
WebADEExceptionApplication.getUsersByOrganization(ca.bc.gov.webade.Organization)
public User[] getUsersByRoleAndOrganization(Role role,
Organization organization)
throws WebADEException
Application
getUsersByRoleAndOrganization in interface Applicationrole - The role to load users for.organization - The organization to load users for.
WebADEExceptionApplication.getUsersByRoleAndOrganization(ca.bc.gov.webade.Role,
ca.bc.gov.webade.Organization)
public boolean isUserInGroup(User user,
java.lang.String groupGuid)
throws WebADEException
Application
isUserInGroup in interface Applicationuser - The target user object.groupGuid - The unique GUID of the target group.
WebADEException - Thrown if the group is not found or an error occurs while
processing the request.Application.isUserInGroup(ca.bc.gov.webade.User,
java.lang.String)
public java.lang.String[] isUserInGroups(User user,
java.lang.String[] groupGuids)
throws WebADEException
Application
isUserInGroups in interface Applicationuser - The target user object.groupGuids - The unique GUID values of the target groups.
WebADEException - Thrown if ant of the groups are not found or an error occurs
while processing the request.Application.isUserInGroups(ca.bc.gov.webade.User,
java.lang.String[])
public java.util.List findUsers(UserSearchObject searchObject)
throws WebADEException
Application
findUsers in interface ApplicationsearchObject - The search object.
WebADEException - Thrown when an error occurs while trying to retrieve the
information from the datastore.Application.findUsers(ca.bc.gov.webade.UserSearchObject)
public Group getGroupByGUID(java.lang.String guid)
throws WebADEException
Application
getGroupByGUID in interface Applicationguid - The guid of the group to load.
WebADEExceptionApplication.getGroupByGUID(java.lang.String)public java.util.List getGroupSearchMetadata()
Application
getGroupSearchMetadata in interface ApplicationApplication.getGroupSearchMetadata()
public java.util.List findGroups(GroupSearchObject searchObject)
throws WebADEException
Application
findGroups in interface ApplicationsearchObject - The search object.
WebADEException - Thrown when an error occurs while trying to retrieve the
information from the datastore.Application.findGroups(ca.bc.gov.webade.GroupSearchObject)
public boolean hasUserAcceptedAgreement(User user,
java.lang.String agreementName)
throws WebADEException
Application
hasUserAcceptedAgreement in interface Applicationuser - The user.agreementName - The unique name of the target agreement.
WebADEException - Thrown when an error occurs while trying to retrieve the
information from the datastore.Application.hasUserAcceptedAgreement(ca.bc.gov.webade.User,
java.lang.String)
public void setUserAcceptedAgreement(User user,
java.lang.String agreementName,
boolean agreeFlag)
throws WebADEException
Application
setUserAcceptedAgreement in interface Applicationuser - The user.agreementName - The unique name of the target agreement.agreeFlag - A flag indicating whether the user accepts or refuses the
given agreement.
WebADEException - Thrown when an error occurs while trying to save the flag to
the datastore.Application.setUserAcceptedAgreement(ca.bc.gov.webade.User,
java.lang.String, boolean)
public Organization getUserDefaultOrganization(User user)
throws WebADEException
Application
getUserDefaultOrganization in interface Applicationuser - The target user.
WebADEException - Thrown if an error occurs while getting the default
organization.Application.getUserDefaultOrganization(ca.bc.gov.webade.User)
public void setUserDefaultOrganization(User user,
Organization organization)
throws WebADEException
Application
setUserDefaultOrganization in interface Applicationuser - The target user.organization - The selected organization.
WebADEException - Thrown if an error occurs while setting the default
organization.Application.setUserDefaultOrganization(ca.bc.gov.webade.User,
ca.bc.gov.webade.Organization)
public java.sql.Connection getConnection(User user,
Role role)
throws WebADEException,
java.sql.SQLException
Application
getConnection in interface Applicationuser - the user the connection is being obtained forrole - the role to get the Connection for
WebADEException - Thrown if an error occurs.
java.sql.SQLException - Thrown if an error occurs.Application.getConnection(ca.bc.gov.webade.User,
ca.bc.gov.webade.Role)
public java.sql.Connection getConnectionByAction(User user,
java.lang.String actionName)
throws WebADEException,
java.sql.SQLException
Application
getConnectionByAction in interface Applicationuser - the user the connection is being obtained foractionName - the actionname to get the Connection for
connection a connection
WebADEException - Thrown if an error occurs.
java.sql.SQLException - Thrown if an error occurs.Application.getConnectionByAction(ca.bc.gov.webade.User,
java.lang.String)
public WebADEPreferences getWebADEPreferences()
throws WebADEException
WebADEException
|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||