ca.bc.gov.webade.developer.provider.file.xml
Class XMLFileProvider
java.lang.Object
ca.bc.gov.webade.developer.provider.file.xml.XMLFileProvider
- All Implemented Interfaces:
- ca.bc.gov.webade.UserInfoProvider
- public final class XMLFileProvider
- extends java.lang.Object
- implements ca.bc.gov.webade.UserInfoProvider
The XMLFileProvider implements the WebADE UserInfoProvider interface and
returns user information. In the standard WebADE configuration a
UserInfoProvider retrieves information from government webservices and passes
this information back to the application. By altering the WebADE preferences
we can substitute this XMLFileProvider for the standard Web Services
UserInfoProvider. This enables the webade-developer module to emulate the
responses from web-services. This is useful when developing WebADE
applications outside the government extranet where the web services are
unavailable.
- Author:
- Vivid Solutions Inc
| Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
XMLFileProvider
public XMLFileProvider()
- Default Constructor.
init
public final void init(ca.bc.gov.webade.PreferenceSet ps)
throws ca.bc.gov.webade.WebADEException
- Specified by:
init in interface ca.bc.gov.webade.UserInfoProvider
- Throws:
ca.bc.gov.webade.WebADEException- See Also:
UserInfoProvider.init(ca.bc.gov.webade.PreferenceSet)
getUserInfoFile
public static java.io.File getUserInfoFile()
throws WebADEDeveloperException
- Throws:
WebADEDeveloperException
handlesSourceDirectory
public final boolean handlesSourceDirectory(java.lang.String sourceDirectory)
- Specified by:
handlesSourceDirectory in interface ca.bc.gov.webade.UserInfoProvider
- See Also:
UserInfoProvider.handlesSourceDirectory(java.lang.String)
handlesUserType
public final boolean handlesUserType(ca.bc.gov.webade.user.UserTypeCode userType)
- Specified by:
handlesUserType in interface ca.bc.gov.webade.UserInfoProvider
- See Also:
UserInfoProvider.handlesUserType(ca.bc.gov.webade.user.UserTypeCode)
getSupportedSourceDirectories
public final java.lang.String[] getSupportedSourceDirectories()
- Specified by:
getSupportedSourceDirectories in interface ca.bc.gov.webade.UserInfoProvider
- See Also:
UserInfoProvider.getSupportedSourceDirectories()
getSupportedUserTypes
public final ca.bc.gov.webade.user.UserTypeCode[] getSupportedUserTypes()
- Specified by:
getSupportedUserTypes in interface ca.bc.gov.webade.UserInfoProvider
- See Also:
UserInfoProvider.getSupportedUserTypes()
getUser
public final ca.bc.gov.webade.user.WebADEUserInfo getUser(ca.bc.gov.webade.user.UserCredentials credentials)
throws ca.bc.gov.webade.WebADEException
- Specified by:
getUser in interface ca.bc.gov.webade.UserInfoProvider
- Throws:
ca.bc.gov.webade.WebADEException- See Also:
UserInfoProvider.getUser(ca.bc.gov.webade.user.UserCredentials)
isUserInGroups
public final ca.bc.gov.webade.user.GUID[] isUserInGroups(ca.bc.gov.webade.user.UserCredentials user,
ca.bc.gov.webade.user.GUID[] groupGuids)
throws ca.bc.gov.webade.WebADEException
- Specified by:
isUserInGroups in interface ca.bc.gov.webade.UserInfoProvider
- Throws:
ca.bc.gov.webade.WebADEException- See Also:
UserInfoProvider.isUserInGroups(
ca.bc.gov.webade.user.UserCredentials, ca.bc.gov.webade.user.GUID[])
getUserSearchMetadata
public final java.util.List getUserSearchMetadata()
- Specified by:
getUserSearchMetadata in interface ca.bc.gov.webade.UserInfoProvider
- See Also:
UserInfoProvider.getUserSearchMetadata()
findUsers
public final java.util.List findUsers(ca.bc.gov.webade.UserSearchObject searchObject)
throws ca.bc.gov.webade.WebADEException
- Specified by:
findUsers in interface ca.bc.gov.webade.UserInfoProvider
- Throws:
ca.bc.gov.webade.WebADEException- See Also:
UserInfoProvider.findUsers(
ca.bc.gov.webade.UserSearchObject)
getResponseDelay
public static java.lang.String getResponseDelay()
setResponseDelay
public static void setResponseDelay(java.lang.String responseDelay)
getUserInfoFileLocation
public static java.lang.String getUserInfoFileLocation()
setUserInfoFileLocation
public static void setUserInfoFileLocation(java.lang.String userInfoFileLocation)