|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
Controls access to the WebADE datastore for a single WebADE application, and loads WebADE data from the datastore. This interface is to allow for non-database WebADE configurations to potentially exist.
| Field Summary | |
static java.lang.String |
ID_BUSINESS_PARTNER_TYPE
The user and group type defining a business partner user or group |
static java.lang.String |
ID_CITIZEN_TYPE
The user and group type defining an individual user or group |
static java.lang.String |
ID_GOVERNMENT_TYPE
The user and group type defining a government user or group |
| Method Summary | |
UserSearchQuery |
createUserSearchQuery(UserTypeCode userType)
Returns the UserSearchQuery metadata object to perform user searching for this application on the provided user type. |
java.util.List |
findGroups(GroupSearchObject searchObject)
Deprecated. |
java.util.List |
findOrganizations(OrganizationSearchObject searchObject)
Returns the set of organization records that match the given ministry-specific organization info. |
java.util.List |
findUsers(UserSearchObject searchObject)
Deprecated. |
WebADEUserInfo[] |
findUsers(UserSearchQuery searchQuery)
Finds the set of WebADEUserInfo objects that match the provided search criteria. |
WebADEUserInfo[] |
findWebADEUsers(UserSearchObject searchObject)
Deprecated. Use findUsers() instead, passing
in the target user search query to search on. |
Action[] |
getApplicationActions()
Returns the set of actions defined for the given application code, regardless of role assignment. |
java.lang.String |
getApplicationCode()
Returns the current application code set for the WebADE datastore. |
Preferences |
getApplicationPreferences()
Deprecated. Use WebADEDatastore.getWebADEApplicationPreferences() instead. |
Role[] |
getApplicationRoles()
Returns the set of roles for the given application code. |
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.lang.String |
getDatastoreEnvironment()
Returns the environment code value for the datastore (DEV, TEST, or PROD). |
ElectronicAgreement |
getElectronicAgreement(java.lang.String agreementName)
Returns the target agreement, based on the given agreement name. |
Preferences |
getGlobalPreferences()
Deprecated. Use WebADEDatastore.getWebADEGlobalPreferences() instead. |
Group |
getGroupByGUID(java.lang.String guid)
Deprecated. |
java.util.List |
getGroupSearchMetadata()
Deprecated. This method is no longer supported. |
java.lang.String |
getJavaEnvironment()
Returns the environment code value for the Java API (DEV, TEST, or PROD). |
OrganizationSearchObject |
getOrganizationSearchMetadata()
Returns an instance of the appropriate OrganizationSearchObject to be used to search for organizations. |
java.util.Properties |
getPooledResourceProperties(java.lang.String roleName)
Retrieves the set of configuration properties for a pooled resource. |
WebADEUserPermissions |
getPublicWebADEPermissions()
Returns the public permissions from the datastore. |
java.lang.String |
getSourceDirectoryForUserType(UserTypeCode userType)
Returns the source directory for the given user type if it is supported by this provider. |
java.lang.String[] |
getSupportedSourceDirectories()
|
UserTypeCode[] |
getSupportedUserTypes()
|
User |
getUserByGUID(java.lang.String guid)
Deprecated. |
User |
getUserById(java.lang.String userId)
Deprecated. |
Organization |
getUserDefaultOrganization(User user)
Deprecated. |
Organization |
getUserDefaultOrganization(UserCredentials userCredentials)
Gets the user's default organization. |
Preferences |
getUserPreferences(long euserId)
Deprecated. |
Preferences |
getUserPreferences(UserCredentials targetUserCredentials)
Deprecated. Use WebADEDatastore.getWebADEUserPreferences() instead. |
User[] |
getUsersByOrganization(long organizationId)
Deprecated. |
User[] |
getUsersByRole(java.lang.String roleName)
Deprecated. |
User[] |
getUsersByRoleAndOrganization(java.lang.String roleName,
long organizationId)
Deprecated. |
java.util.List |
getUserSearchMetadata()
Deprecated. Use createUserSearchQuery() instead, passing
in the target user type code to search on. |
UserTypeCode |
getUserTypeForSourceDirectory(java.lang.String sourceDirectory)
Returns the user type for the given source directory if it is supported by this provider. |
WebADEPreferences |
getWebADEApplicationPreferences()
Returns the application preferences defined for the current WebADE application. |
WebADEPreferences |
getWebADEExtensionPreferences()
Returns the application's WebADE extensions preferences defined for the current WebADE application. |
WebADEPreferences |
getWebADEGlobalPreferences()
Returns the global preferences defined for all of WebADE. |
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 |
handlesSourceDirectory(java.lang.String sourceDirectory)
Returns true if the given sourceDirectory is one of the ones supported by this provider. |
boolean |
handlesUserType(UserTypeCode userType)
Returns true if the given user type is one of the ones supported by this provider. |
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. |
boolean |
isApplicationEnabled()
Checks the enabled flag for the application. |
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. |
ApplicationConfig |
loadApplicationConfig()
Takes the given application code and retrieves the configuration settings, roles, actions, and pooled resource settings. |
void |
loadExtension(java.lang.String extensionName,
Application app)
Loads the given Extension by loading the extensions preferences, loads an instance of the extension class, using the given class loader, and initializing the extension using the loaded preferences. |
Organization |
loadOrganization(long organizationId)
Loads the organization info for the given organization id. |
WebADEPreferences |
saveWebADEUserPreferences(UserCredentials targetUserCredentials,
WebADEPreferences preferences)
Saves the given user preferences for this user and this application. |
void |
setApplicationCode(java.lang.String appCode)
Sets the current application code set for the WebADE datastore. |
void |
setApplicationEnabled(boolean enabled)
Sets the application's enabled flag to the given value. |
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. |
void |
setUserDefaultOrganization(UserCredentials userCredentials,
Organization organization)
Sets the user's default organization to the given organization. |
void |
setUserDefaultOrganization(User user,
Organization organization)
Deprecated. |
void |
shutdown()
Shuts down the datastore. |
| Field Detail |
public static final java.lang.String ID_GOVERNMENT_TYPE
public static final java.lang.String ID_BUSINESS_PARTNER_TYPE
public static final java.lang.String ID_CITIZEN_TYPE
| Method Detail |
public void setApplicationCode(java.lang.String appCode)
throws WebADEException
appCode - The application code value.
WebADEException - Thrown if the appCode value is null or empty string.public java.lang.String getApplicationCode()
public Preferences getGlobalPreferences()
throws WebADEException
WebADEException - Thrown when an error occurs while trying to retrieve the
information from the datastore.
public WebADEPreferences getWebADEGlobalPreferences()
throws WebADEException
WebADEException - Thrown when an error occurs while trying to retrieve the
information from the datastore.
public Preferences getApplicationPreferences()
throws WebADEException
WebADEException - Thrown when an error occurs while trying to retrieve the
information from the datastore.
public WebADEPreferences getWebADEApplicationPreferences()
throws WebADEException
WebADEException - Thrown when an error occurs while trying to retrieve the
information from the datastore.
public WebADEPreferences getWebADEExtensionPreferences()
throws WebADEException
WebADEException - Thrown when an error occurs while trying to retrieve the
information from the datastore.
public Preferences getUserPreferences(UserCredentials targetUserCredentials)
throws WebADEException
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 java.lang.String getJavaEnvironment()
public java.lang.String getDatastoreEnvironment()
throws WebADEException
WebADEException - Thrown when an error occurs while trying to retrieve the
information from the datastore.
public ApplicationConfig loadApplicationConfig()
throws WebADEException
WebADEException - Thrown when an error occurs while trying to retrieve the
information from the datastore.
public void loadExtension(java.lang.String extensionName,
Application app)
throws WebADEException,
WebADEExtensionException
extensionName - The unique code of the extension.app - The application owner to register the extension to.
WebADEException - Thrown when an error occurs while trying to retrieve the
information from the datastore.
WebADEExtensionException - Thrown when an error occurs while trying to initialize the
extension.
public boolean isApplicationEnabled()
throws WebADEException
WebADEException - Thrown when an error occurs while trying to retrieve the
information from the datastore.
public void setApplicationEnabled(boolean enabled)
throws WebADEException
enabled - Enabled flag.
WebADEException - Thrown when an error occurs while trying to retrieve the
information from the datastore.
public Organization getUserDefaultOrganization(UserCredentials userCredentials)
throws WebADEException
userCredentials - The credentials of the user to load.
WebADEException - Thrown if an error occurs while getting the default
organization.
public void setUserDefaultOrganization(UserCredentials userCredentials,
Organization organization)
throws WebADEException
userCredentials - The credentials of the user to load.organization - The selected organization.
WebADEException - Thrown if an error occurs while setting the default
organization.
public Role[] getApplicationRoles()
throws WebADEException
WebADEException - Thrown when an error occurs while trying to retrieve the
information from the datastore.
public java.util.Properties getPooledResourceProperties(java.lang.String roleName)
throws WebADEException
roleName - The role that the resource is assigned to.
WebADEException - Thrown when an error occurs while trying to retrieve the
information from the datastore.
public Action[] getApplicationActions()
throws WebADEException
WebADEException - Thrown when an error occurs while trying to retrieve the
information from the datastore.
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
userCredentials - The user's identifying credentials.
WebADEException
public WebADEUserInfo getWebADEUserInfo(UserCredentials userCredentials,
boolean ignoreSessionCache)
throws WebADEException
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 UserSearchQuery createUserSearchQuery(UserTypeCode userType)
throws WebADEException
userType - The user type to perform searching for.
WebADEException - Thrown when an error occurs while trying to create the search
query from the user provider for the given user type.
public WebADEUserInfo[] findUsers(UserSearchQuery searchQuery)
throws WebADEException
searchQuery - The search query.
WebADEException - Thrown when an error occurs while trying to retrieve the
information from the datastore.public java.util.List getUserSearchMetadata()
createUserSearchQuery() instead, passing
in the target user type code to search on.
public WebADEUserInfo[] findWebADEUsers(UserSearchObject searchObject)
throws WebADEException
findUsers() instead, passing
in the target user search query to search on.
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 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 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 OrganizationSearchObject getOrganizationSearchMetadata()
public Organization loadOrganization(long organizationId)
throws WebADEException
organizationId - The organization to load the organization info for.
WebADEException - Thrown if an unexpected error occurs while retrieving the
info.
public java.util.List findOrganizations(OrganizationSearchObject searchObject)
throws WebADEException
searchObject - The organization info to match Organization records for.
WebADEException - Thrown if an unexpected error occurs while retrieving the
info.
public GUID[] isUserInGroups(UserCredentials userCredentials,
GUID[] groupGuids)
throws WebADEException
userCredentials - The user's credentials.groupGuids - The unique GUID values of the target groups.
WebADEException - Thrown if an error occurs while processing the request.
public boolean hasIndeterminateAuthorizations(Role role,
Organization organization)
throws WebADEException
role - The WebADE role in this application (optional).organization - The organization to load users of this application for
(optional).
WebADEException - Thrown 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 boolean handlesSourceDirectory(java.lang.String sourceDirectory)
throws WebADEException
sourceDirectory - The target sourceDirectory name.
WebADEException
public boolean handlesUserType(UserTypeCode userType)
throws WebADEException
userType - The target user type.
WebADEException
public java.lang.String getSourceDirectoryForUserType(UserTypeCode userType)
throws WebADEException
userType - The target user type.
WebADEException
public UserTypeCode getUserTypeForSourceDirectory(java.lang.String sourceDirectory)
throws WebADEException
sourceDirectory - The target sourceDirectory name.
WebADEException
public java.lang.String[] getSupportedSourceDirectories()
throws WebADEException
WebADEException
public UserTypeCode[] getSupportedUserTypes()
throws WebADEException
WebADEException
public void shutdown()
throws java.lang.SecurityException
java.lang.SecurityException - Thrown if an unauthorized class calls this method.
public Preferences getUserPreferences(long euserId)
throws WebADEException
euserId - The unique id of the target user.
WebADEException - Thrown when an error occurs while trying to retrieve the
information from the datastore.
public User[] getUsersByRole(java.lang.String roleName)
throws WebADEException
roleName - The target role name.
WebADEException
public User[] getUsersByOrganization(long organizationId)
throws WebADEException
organizationId - The target organizationId.
WebADEException
public User[] getUsersByRoleAndOrganization(java.lang.String roleName,
long organizationId)
throws WebADEException
roleName - The target role name.organizationId - The target organizationId.
WebADEException
public User getUserById(java.lang.String userId)
throws WebADEException
userId - The full userid, including domain.
WebADEException - Thrown when an error occurs while trying to retrieve the
information from the datastore.
public User getUserByGUID(java.lang.String guid)
throws WebADEException
guid - The unique guid identifying the user.
WebADEException - Thrown when an error occurs while trying to retrieve the
information from the datastore.public java.util.List getGroupSearchMetadata()
public Group getGroupByGUID(java.lang.String guid)
throws WebADEException
guid - The unique guid identifying the group.
WebADEException - Thrown when an error occurs while trying to retrieve the
information from the datastore.
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 java.lang.String[] isUserInGroups(User user,
java.lang.String[] groupGuids)
throws WebADEException
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 Organization getUserDefaultOrganization(User user)
throws WebADEException
user - The target user.
WebADEException - Thrown if an error occurs while getting the default
organization.
public void setUserDefaultOrganization(User user,
Organization organization)
throws WebADEException
user - The target user.organization - The selected organization.
WebADEException - Thrown if an error occurs while setting the default
organization.
public java.util.List findUsers(UserSearchObject 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
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
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.
|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||