|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
| Method Summary | |
java.util.List |
findGroups(GroupSearchObject searchObject)
Deprecated. All group search functionality in no longer supported. |
java.util.List |
findOrganizations(OrganizationSearchObject searchObject)
Finds the set of Organization objects that match the provided search criteria. |
java.util.List |
findUsers(UserSearchObject searchObject)
Deprecated. Use UserInfoService.findUsers(ca.bc.gov.webade.user.search.UserSearchQuery) instead. |
WebADEUserInfo[] |
findWebADEUsers(UserSearchObject searchObject)
Deprecated. Use UserInfoService.findUsers(ca.bc.gov.webade.user.search.UserSearchQuery) instead. |
User |
getAnonymousUser()
Deprecated. No replacement API for this method. To obtain the set of permissions granted to all users (authenticated and unauthenticated), see getPublicWebADEPermissions(). |
java.lang.String |
getApplicationCode()
Get the code (acronym) for the application. |
java.lang.String |
getApplicationEnvironment()
Get the deployment environment this application is deployed in. |
Preferences |
getApplicationPreferences()
Deprecated. Use getWebADEApplicationPreferences() instead. |
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)
Deprecated. Use getConnection(ca.bc.gov.webade.user.WebADEUserPermissions, ca.bc.gov.webade.Role) instead. |
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)
Deprecated. Use getConnectionByAction(ca.bc.gov.webade.user.WebADEUserPermissions, ca.bc.gov.webade.Action) instead. |
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)
Deprecated. Use getConnectionByAction(ca.bc.gov.webade.user.WebADEUserPermissions, ca.bc.gov.webade.Action) instead. |
java.sql.Connection |
getConnectionByPriviledgedAction(Action action)
Gets a Connection for the given priviledged action. |
java.sql.Connection |
getConnectionByPriviledgedAction(java.lang.String actionName)
Deprecated. Use getConnectionByPriviledgedAction(ca.bc.gov.webade.Action) instead. |
ElectronicAgreement |
getElectronicAgreement(java.lang.String agreementName)
Returns the target agreement, based on the given agreement name. |
Preferences |
getGlobalPreferences()
Deprecated. Use getWebADEGlobalPreferences() instead. |
Group |
getGroupByGUID(java.lang.String guid)
Deprecated. All group search functionality in no longer supported. |
java.util.List |
getGroupSearchMetadata()
Deprecated. All group search functionality in no longer supported. |
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 |
getUserByGUID(java.lang.String guid)
Deprecated. Use getWebADEUserPreferences(ca.bc.gov.webade.user.UserCredentials)
and
UserInfoService.getWebADEUserInfo(ca.bc.gov.webade.user.UserCredentials)
instead. |
User |
getUserByUserId(java.lang.String userId)
Deprecated. Use getWebADEUserPreferences(ca.bc.gov.webade.user.UserCredentials)
and
UserInfoService.getWebADEUserInfo(ca.bc.gov.webade.user.UserCredentials)
instead. |
Organization |
getUserDefaultOrganization(User user)
Deprecated. Use getUserDefaultOrganization(ca.bc.gov.webade.user.UserCredentials) instead. |
Organization |
getUserDefaultOrganization(UserCredentials userCredentials)
Gets the user's default organization. |
UserInfoService |
getUserInfoService()
Returns the UserInfoService object for this application. |
Preferences |
getUserPreferences(User targetUser)
Deprecated. Use getWebADEUserPreferences(ca.bc.gov.webade.user.UserCredentials) instead. |
Preferences |
getUserPreferences(UserCredentials targetUserCredentials)
Deprecated. Use getWebADEUserPreferences(ca.bc.gov.webade.user.UserCredentials) instead. |
User[] |
getUsersByOrganization(Organization organization)
Deprecated. Use getAuthorizedUsers(ca.bc.gov.webade.Organization) instead. |
User[] |
getUsersByRole(Role role)
Deprecated. Use getAuthorizedUsers(ca.bc.gov.webade.Role) instead. |
User[] |
getUsersByRoleAndOrganization(Role role,
Organization organization)
Deprecated. Use getAuthorizedUsers(ca.bc.gov.webade.Role, ca.bc.gov.webade.Organization) instead. |
java.util.List |
getUserSearchMetadata()
Deprecated. Use UserInfoService.createUserSearchQuery(ca.bc.gov.webade.user.UserTypeCode) instead, passing
in the target user type code to search on. |
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. |
WebADEUserInfo |
getWebADEUserInfo(UserCredentials userCredentials)
Deprecated. Use UserInfoService.getWebADEUserInfo(ca.bc.gov.webade.user.UserCredentials)
instead. |
WebADEUserInfo |
getWebADEUserInfo(UserCredentials userCredentials,
boolean ignoreSessionCache)
Deprecated. Use UserInfoService.getWebADEUserInfo(ca.bc.gov.webade.user.UserCredentials, boolean)
instead. |
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)
Deprecated. Use hasUserAcceptedAgreement(ca.bc.gov.webade.user.UserCredentials, java.lang.String) instead. |
boolean |
isAnonymousUser(User user)
Deprecated. See WebADECurrentUserPermissions.isUserAuthenticated() |
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)
Deprecated. Use isUserInGroup(ca.bc.gov.webade.user.UserCredentials, ca.bc.gov.webade.user.GUID) instead. |
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)
Deprecated. Use isUserInGroups(ca.bc.gov.webade.user.UserCredentials, ca.bc.gov.webade.user.GUID[]) instead. |
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)
Deprecated. Use setUserAcceptedAgreement(ca.bc.gov.webade.user.UserCredentials, java.lang.String, boolean) instead. |
void |
setUserDefaultOrganization(UserCredentials userCredentials,
Organization organization)
Sets the user's default organization to the given organization. |
void |
setUserDefaultOrganization(User user,
Organization organization)
Deprecated. Use setUserDefaultOrganization(ca.bc.gov.webade.user.UserCredentials, ca.bc.gov.webade.Organization) instead. |
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. |
| Method Detail |
public UserInfoService getUserInfoService()
public Preferences getApplicationPreferences()
getWebADEApplicationPreferences() instead.
public WebADEPreferences getWebADEApplicationPreferences()
throws WebADEException
WebADEException - Thrown when an error occurs while trying to retrieve the
WebADE application preferences.
public Preferences getUserPreferences(UserCredentials targetUserCredentials)
throws WebADEException
getWebADEUserPreferences(ca.bc.gov.webade.user.UserCredentials) instead.
targetUserCredentials - The user's identifying credentials.
WebADEException - Thrown when a WebADE error occurs.
public WebADEPreferences getWebADEUserPreferences(UserCredentials targetUserCredentials)
throws WebADEException
targetUserCredentials - The user's identifying credentials.
WebADEException - Thrown when a WebADE error occurs.
public WebADEPreferences saveWebADEUserPreferences(UserCredentials targetUserCredentials,
WebADEPreferences preferences)
throws WebADEException
targetUserCredentials - The user's identifying credentials.preferences - The user's User preferences.
WebADEException - Thrown when a WebADE error occurs.
public Preferences getGlobalPreferences()
throws WebADEException
getWebADEGlobalPreferences() instead.
WebADEException - Thrown when a WebADE error occurs.
public WebADEPreferences getWebADEGlobalPreferences()
throws WebADEException
WebADEException - Thrown when a WebADE error occurs.public java.lang.String getApplicationCode()
getApplicationCode in interface ApplicationMBeanpublic java.lang.String getApplicationEnvironment()
public AppRoles getRoles()
public WebADEUserPermissions getPublicWebADEPermissions()
throws WebADEException
WebADEException
public WebADEUserPermissions getWebADEUserPermissions(UserCredentials userCredentials)
throws WebADEException
userCredentials - The user's identifying credentials.
WebADEException
public WebADEUserPermissions getWebADEUserPermissions(UserCredentials userCredentials,
boolean ignoreSessionCache)
throws WebADEException
userCredentials - The user's identifying credentials.ignoreSessionCache - A flag indicating whether to ignore the session user permissions
object, should it match the given user credentials.
WebADEException
public WebADEUserInfo getWebADEUserInfo(UserCredentials userCredentials)
throws WebADEException
UserInfoService.getWebADEUserInfo(ca.bc.gov.webade.user.UserCredentials)
instead.
userCredentials - The user's identifying credentials.
WebADEException
public WebADEUserInfo getWebADEUserInfo(UserCredentials userCredentials,
boolean ignoreSessionCache)
throws WebADEException
UserInfoService.getWebADEUserInfo(ca.bc.gov.webade.user.UserCredentials, boolean)
instead.
userCredentials - The user's identifying credentials.ignoreSessionCache - A flag indicating whether to ignore the session user info
object, should it match the given user credentials.
WebADEException
public boolean isUserInGroup(UserCredentials userCredentials,
GUID groupGuid)
throws WebADEException
userCredentials - 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.
public GUID[] isUserInGroups(UserCredentials userCredentials,
GUID[] groupGuids)
throws WebADEException
userCredentials - 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.public java.util.List getUserSearchMetadata()
UserInfoService.createUserSearchQuery(ca.bc.gov.webade.user.UserTypeCode) instead, passing
in the target user type code to search on.
public WebADEUserInfo[] findWebADEUsers(UserSearchObject searchObject)
throws WebADEException
UserInfoService.findUsers(ca.bc.gov.webade.user.search.UserSearchQuery) instead.
searchObject - The search object.
WebADEException - Thrown when an error occurs while trying to retrieve the
information from the datastore.
public ElectronicAgreement getElectronicAgreement(java.lang.String agreementName)
throws WebADEException
agreementName - The name of the target agreement.
WebADEException - Thrown when an error occurs while trying to retrieve the
information from the datastore.
public boolean hasUserAcceptedAgreement(UserCredentials userCredentials,
java.lang.String agreementName)
throws WebADEException
userCredentials - 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.
public void setUserAcceptedAgreement(UserCredentials userCredentials,
java.lang.String agreementName,
boolean agreeFlag)
throws WebADEException
userCredentials - 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.
public Organization getOrganizationById(long organizationId)
throws WebADEException
organizationId - The unique organization id.
WebADEException - Thrown when an error occurs while trying to retrieve the
information from the datastore.public OrganizationSearchObject getOrganizationSearchMetadata()
public java.util.List findOrganizations(OrganizationSearchObject searchObject)
throws WebADEException
searchObject - The search object.
WebADEException - Thrown when an error occurs while trying to retrieve the
information from the datastore.
public void registerWebADEExtension(WebADEExtension extension)
throws WebADEExtensionException
extension - 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 registeredpublic void unregisterWebADEExtension(WebADEExtension extension)
extension - A singleton extension object to remove from the application's
extension list.public WebADEExtension getWebADEExtension(java.lang.String className)
className - The fully qualified class name(including package)
public WebADEExtension getWebADEExtension(java.lang.Class classObject)
classObject - The class of the extension singleton
public boolean isDisabled()
throws WebADEException
true if the application is currently disabled
WebADEException - Thrown if an error occurs while determining if the
application has been disabled.
public void setDisabled(boolean disable)
throws WebADEException
disable - Flag indicating whether to disable the application.
WebADEException
public Organization getUserDefaultOrganization(UserCredentials userCredentials)
throws WebADEException
userCredentials - The target user's credentials.
WebADEException - Thrown if an error occurs while getting the default
organization.
public void setUserDefaultOrganization(UserCredentials userCredentials,
Organization organization)
throws WebADEException
userCredentials - The target user's credentials.organization - The selected organization.
WebADEException - Thrown if an error occurs while setting the default
organization.
public java.sql.Connection getConnection(WebADEUserPermissions userAuthorizations,
Role role)
throws WebADEException,
java.sql.SQLException
userAuthorizations - The target user's authorizations.role - the role to get the Connection for
WebADEException - Thrown if an error occurs.
java.sql.SQLException - Thrown if an error occurs.
public java.sql.Connection getConnectionByAction(WebADEUserPermissions userAuthorizations,
Action action)
throws WebADEException,
java.sql.SQLException
userAuthorizations - The target user's authorizations.action - The action to get the Connection for.
connection a connection
WebADEException - Thrown if an error occurs.
java.sql.SQLException - Thrown if an error occurs.
public java.sql.Connection getConnectionByAction(WebADEUserPermissions userAuthorizations,
java.lang.String actionName)
throws WebADEException,
java.sql.SQLException
getConnectionByAction(ca.bc.gov.webade.user.WebADEUserPermissions, ca.bc.gov.webade.Action) instead.
userAuthorizations - The target user's authorizations.actionName - the actionname to get the Connection for
connection a connection
WebADEException - Thrown if an error occurs.
java.sql.SQLException - Thrown if an error occurs.
public java.sql.Connection getConnectionByPriviledgedAction(Action action)
throws WebADEException,
java.sql.SQLException
action - The action to get the Connection for.
connection a connection
WebADEException - Thrown if an error occurs, or if the action is not marked as
priviledged.
java.sql.SQLException - Thrown if an error occurs.
public java.sql.Connection getConnectionByPriviledgedAction(java.lang.String actionName)
throws WebADEException,
java.sql.SQLException
getConnectionByPriviledgedAction(ca.bc.gov.webade.Action) instead.
actionName - the action name to get the Connection for
connection a connection
WebADEException - Thrown if an error occurs, or if the action is not marked as
priviledged.
java.sql.SQLException - Thrown if an error occurs.
public boolean hasIndeterminateAuthorizations(Role role)
throws WebADEException
role - The WebADE role in this application.
WebADEException - Thrown if an error occurs while performing this query.
public boolean hasIndeterminateAuthorizations(Organization organization)
throws WebADEException
organization - The organization to load users of this application for.
WebADEException - Thrown if an error occurs while performing this query.
public boolean hasIndeterminateAuthorizations(Role role,
Organization organization)
throws WebADEException
role - 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.
public UserCredentials[] getAuthorizedUsers(Role role)
throws IndeterminateAuthorizationsException,
WebADEException
role - 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.
public UserCredentials[] getAuthorizedUsers(Role role,
boolean ignoreIndeterminateAuthorizationsErrors)
throws IndeterminateAuthorizationsException,
WebADEException
role - The role 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.
public UserCredentials[] getAuthorizedUsers(Organization organization)
throws IndeterminateAuthorizationsException,
WebADEException
organization - The organization 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.
public UserCredentials[] getAuthorizedUsers(Organization organization,
boolean ignoreIndeterminateAuthorizationsErrors)
throws IndeterminateAuthorizationsException,
WebADEException
organization - 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.
public UserCredentials[] getAuthorizedUsers(Role role,
Organization organization)
throws IndeterminateAuthorizationsException,
WebADEException
role - The role to load users for (optional).organization - The organization to load users for (optional).
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.
public UserCredentials[] getAuthorizedUsers(Role role,
Organization organization,
boolean ignoreIndeterminateAuthorizationsErrors)
throws IndeterminateAuthorizationsException,
WebADEException
role - 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.
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.
public void shutdown()
throws java.lang.SecurityException
java.lang.SecurityException - If the caller is not an instance of an authorized class, a
SecurityException is thrown.
public Preferences getUserPreferences(User targetUser)
throws WebADEException
getWebADEUserPreferences(ca.bc.gov.webade.user.UserCredentials) instead.
targetUser - The user to retrieve the preferences for.
WebADEException - Thrown when a WebADE error occurs.
public User getAnonymousUser()
throws WebADEException
getPublicWebADEPermissions().
WebADEException
public boolean isAnonymousUser(User user)
throws WebADEException
WebADECurrentUserPermissions.isUserAuthenticated()
user - The user to compare to the anonymous user.
WebADEException
public User getUserByGUID(java.lang.String guid)
throws WebADEException
getWebADEUserPreferences(ca.bc.gov.webade.user.UserCredentials)
and
UserInfoService.getWebADEUserInfo(ca.bc.gov.webade.user.UserCredentials)
instead.
searchForUserByGUID
method to indicate to the developer that this call is less efficient than
the application's getUser() methods.
guid - The guid of the user to load.
WebADEException
public User getUserByUserId(java.lang.String userId)
throws WebADEException
getWebADEUserPreferences(ca.bc.gov.webade.user.UserCredentials)
and
UserInfoService.getWebADEUserInfo(ca.bc.gov.webade.user.UserCredentials)
instead.
userId - The userId of the user, including domain, to load.
WebADEException
public User[] getUsersByRole(Role role)
throws WebADEException
getAuthorizedUsers(ca.bc.gov.webade.Role) instead.
role - The role to load users for.
WebADEException
public User[] getUsersByOrganization(Organization organization)
throws WebADEException
getAuthorizedUsers(ca.bc.gov.webade.Organization) instead.
organization - The organization to load users for.
WebADEException
public User[] getUsersByRoleAndOrganization(Role role,
Organization organization)
throws WebADEException
getAuthorizedUsers(ca.bc.gov.webade.Role, ca.bc.gov.webade.Organization) instead.
role - The role to load users for.organization - The organization to load users for.
WebADEException
public boolean isUserInGroup(User user,
java.lang.String groupGuid)
throws WebADEException
isUserInGroup(ca.bc.gov.webade.user.UserCredentials, ca.bc.gov.webade.user.GUID) instead.
user - 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.
public java.lang.String[] isUserInGroups(User user,
java.lang.String[] groupGuids)
throws WebADEException
isUserInGroups(ca.bc.gov.webade.user.UserCredentials, ca.bc.gov.webade.user.GUID[]) instead.
user - 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.
public java.util.List findUsers(UserSearchObject searchObject)
throws WebADEException
UserInfoService.findUsers(ca.bc.gov.webade.user.search.UserSearchQuery) instead.
searchObject - The search object.
WebADEException - Thrown when an error occurs while trying to retrieve the
information from the datastore.
public Group getGroupByGUID(java.lang.String guid)
throws WebADEException
guid - The guid of the group to load.
WebADEExceptionpublic java.util.List getGroupSearchMetadata()
public java.util.List findGroups(GroupSearchObject searchObject)
throws WebADEException
searchObject - The search object.
WebADEException - Thrown when an error occurs while trying to retrieve the
information from the datastore.
public boolean hasUserAcceptedAgreement(User user,
java.lang.String agreementName)
throws WebADEException
hasUserAcceptedAgreement(ca.bc.gov.webade.user.UserCredentials, java.lang.String) instead.
user - 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.
public void setUserAcceptedAgreement(User user,
java.lang.String agreementName,
boolean agreeFlag)
throws WebADEException
setUserAcceptedAgreement(ca.bc.gov.webade.user.UserCredentials, java.lang.String, boolean) instead.
user - 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.
public Organization getUserDefaultOrganization(User user)
throws WebADEException
getUserDefaultOrganization(ca.bc.gov.webade.user.UserCredentials) instead.
user - The target user.
WebADEException - Thrown if an error occurs while getting the default
organization.
public void setUserDefaultOrganization(User user,
Organization organization)
throws WebADEException
setUserDefaultOrganization(ca.bc.gov.webade.user.UserCredentials, ca.bc.gov.webade.Organization) instead.
user - The target user.organization - The selected organization.
WebADEException - Thrown if an error occurs while setting the default
organization.
public java.sql.Connection getConnection(User user,
Role role)
throws WebADEException,
java.sql.SQLException
getConnection(ca.bc.gov.webade.user.WebADEUserPermissions, ca.bc.gov.webade.Role) instead.
user - 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.
public java.sql.Connection getConnectionByAction(User user,
java.lang.String actionName)
throws WebADEException,
java.sql.SQLException
getConnectionByAction(ca.bc.gov.webade.user.WebADEUserPermissions, ca.bc.gov.webade.Action) instead.
user - 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.
|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||