|
Oracle Application Server Wireless Java API Reference B14043-01 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object
oracle.panama.portal.UserController
UserController handles user related operations, such as retrieving/updating parameters of a user, creating/deleting a user. Besides, UserController handles current session loginUser/effectiveUser operations. Querying multiple users based on their name and other paramters is also implemented in UserController.
Field Summary | |
static java.lang.String |
ACCOUNTNUMBER Key for retrieving account number value from the parameter Hashtable passing to/from the portal pages. |
static java.util.Vector |
allLocales |
static java.lang.String |
ALLUSER_CURRENTPAGE session parameter key for storing current result page. |
static java.lang.String |
ALLUSER_CURRENTPOSITION session parameter key for storing current result position. |
static java.lang.String |
ALLUSER_RESULTSET session parameter key for storing current result set object. |
static java.util.Vector |
countryLocales |
static java.lang.String |
DATEOFBIRTH Key for retrieving user's date of birth from the parameter Hashtable passing to/from the portal pages. |
static java.lang.String |
DISCLOSEIDENTITY Key for retrieving user isDesigner value from the parameter Hashtable passing to/from the portal pages. |
static java.lang.String |
DISCLOSELOCATION Key for retrieving user isDesigner value from the parameter Hashtable passing to/from the portal pages. |
static java.lang.String |
GENDER Key for retrieving user's Gender from the parameter Hashtable passing to/from the portal pages. |
static java.util.Vector |
langLocales |
static java.lang.String |
LOCATIONPRIVACY Key for retrieving location privacy value from the parameter Hashtable passing to/from the portal pages. |
static java.lang.String |
MOBILEID Key for retrieving user's MobileID value from the parameter Hashtable passing to/from the portal pages. |
static java.lang.String |
PIN Key for retrieving numeric PIN value from the parameter Hashtable passing to/from the portal pages. |
static java.lang.String |
PINCONFIRM Key for retrieving numeric PIN value from the parameter Hashtable passing to/from the portal pages. |
static java.util.Vector |
timeZones |
static java.lang.String |
USERAUTOLOCATE Key for retrieving user auto locate value from the parameter Hashtable passing to/from the portal pages. |
static java.lang.String |
USERCOUNTRY Key for retrieving user country value from the parameter Hashtable passing to/from the portal pages. |
static java.lang.String |
USERDEFAULTALERTADDRESS Key for retrieving user default address value from the parameter Hashtable passing to/from the portal pages. |
static java.lang.String |
USERDEFAULTDEVICE Key for retrieving user default device value from the parameter Hashtable passing to/from the portal pages. |
static java.lang.String |
USERDEFAULTLANDMARK Key for retrieving user default landmark value from the parameter Hashtable passing to/from the portal pages. |
static java.lang.String |
USERDEFAULTPROFILE Key for retrieving user default profile value from the parameter Hashtable passing to/from the portal pages. |
static java.lang.String |
USERDISPLAYNAME Key for retrieving user display name value from the parameter Hashtable passing to/from the portal pages. |
static java.lang.String |
USEREXTERNALID Key for retrieving user external id value from the parameter Hashtable passing to/from the portal pages. |
static java.lang.String |
USERGROUPS Key for retrieving user group value from the parameter Hashtable passing to/from the portal pages. |
static java.lang.String |
USERID Key for retrieving user id value from the parameter Hashtable passing to/from the portal pages. |
static java.lang.String |
USERISADMIN Key for retrieving user isAdministrator value from the parameter Hashtable passing to/from the portal pages. |
static java.lang.String |
USERISDESIGNER Key for retrieving user isDesigner value from the parameter Hashtable passing to/from the portal pages. |
static java.lang.String |
USERISENABLED Key for retrieving user isEnabled value from the parameter Hashtable passing to/from the portal pages. |
static java.lang.String |
USERLANGUAGE Key for retrieving user language value from the parameter Hashtable passing to/from the portal pages. |
static java.lang.String |
USERNAME Key for retrieving user name value from the parameter Hashtable passing to/from the portal pages. |
static java.lang.String |
USERPASSWORD Key for retrieving user password value from the parameter Hashtable passing to/from the portal pages. |
static java.lang.String |
USERPASSWORDCONFIRM Key for retrieving user password confirm value from the parameter Hashtable passing to/from the portal pages. |
static java.lang.String |
USERPASSWORDHINT Key for retrieving user password hint value from the parameter Hashtable passing to/from the portal pages. |
static java.lang.String |
USERPASSWORDNEW Key for retrieving user new password value from the parameter Hashtable passing to/from the portal pages. |
static java.lang.String |
USERTIMEZONE Key for retrieving user timezone value from the parameter Hashtable passing to/from the portal pages. |
static java.lang.String |
USERVIEWPROFILEDEFAULT Key for retrieving user isDesigner value from the parameter Hashtable passing to/from the portal pages. |
static java.lang.String |
USERVIEWPROFILEID Key for retrieving user isDesigner value from the parameter Hashtable passing to/from the portal pages. |
static java.lang.String |
USERVIEWPROFILENAME Key for retrieving user isDesigner value from the parameter Hashtable passing to/from the portal pages. |
Method Summary | |
boolean |
checkWriteAccess(long serviceId, Request apiRequest) check to see whether current user has the write access to a service. |
boolean |
checkWriteAccess(Service service, Request apiRequest) check to see whether current user has the write access to a service. |
Profile |
createNewProfile(java.lang.String name, Request apiRequest) create a new user view profile. |
User |
createNewUser(java.lang.String name, Request apiRequest) for administrator create a new user. |
Presets |
createPresets(java.lang.String presetCatName, java.lang.String presetName, Request apiRequest) |
int |
deleteCurrentQueryUsers(java.lang.String[] userIdStrings, Request apiRequest) for administrator delete users from the current page of queried multiple user list. |
void |
deletePresets(java.lang.String presetCatName, long presetId, Request apiRequest) delete presets value from the preset vategory with a given presets object ID. |
void |
deleteUser(long userId, Request apiRequest) for administrator delete a user. |
void |
fetchNextQueryUserPage(int pageSize, Request apiRequest) for administrator Fecth next page of queried multiple user list. |
void |
fetchPreviousQueryUserPage(int pageSize, Request apiRequest) for administrator Fecth previous page of queried multiple user list. |
User |
findUser(long userId, Request apiRequest) for administrator find the User |
AlertAddress[] |
getAlertAddresses(Request apiRequest) Deprecated. |
Alert[] |
getAllAlerts(Request apiRequest) Deprecated. |
Gender[] |
getAllGenders() get all genders. |
java.lang.String[] |
getAllPrivacyDirectives(Request apiRequest) Get all the location Privacy Directives |
Profile[] |
getAllProfiles(Request apiRequest) get all of the user view profiles. |
java.util.Locale[] |
getAvailableCountryLocales() get all the avaliable countries for locale. |
java.util.Locale[] |
getAvailableLanguageLocales() get all the avaliable languages for locale. |
java.util.Locale[] |
getAvailableLocales() |
java.lang.String[] |
getAvailableTimeZones() get all the avaliable time zones. |
static User |
getCurrentLoginUser(Request apiRequest) get the current login user |
User[] |
getCurrentQueryUserPage(Request apiRequest) for administrator Get the current page of the queried multiple user list. |
int |
getCurrentQueryUserPosition(Request apiRequest) for administrator Get the current fetch position of the queried multiple user list. |
java.util.Locale |
getCurrentServerLocale(javax.servlet.http.HttpServletRequest httpRequest) get the current server locale before login or when session expire |
static User |
getCurrentUser(Request apiRequest) get the current effective user |
java.util.Locale |
getCurrentUserLocale(Request apiRequest) get the current effective user locale |
AlertAddress |
getDefaultAlertAddress(Request apiRequest) Deprecated. |
DeviceAddress |
getDefaultDeviceAddress(Request apiRequest) get the default device address of the current effective user. |
java.util.Locale |
getDefaultLocale() |
LocationMark |
getDefaultLocationMark(Request apiRequest) get the default location mark of the current effective user. |
Profile |
getDefaultProfile(Request apiRequest) get the default Profile of the current effective user. |
java.lang.String |
getDefaultTimeZone() |
DeviceAddress[] |
getDeviceAddresses(Request apiRequest) get all the device addresses of current effective user. |
java.util.Vector |
getGroupRootFolders(Request apiRequest) get the root folders of the current effective user's groups |
static UserController |
getInstance() The singleton thread-safe getter. |
LocationMark[] |
getLocationMarks(Request apiRequest) get all the location marks of current effective user. |
java.lang.String |
getNewUserDefaultValue(java.lang.String key) |
java.util.Hashtable |
getParametersHash(long userId, Request apiRequest) for administrator get parameter name-value Hashtable of a user. |
java.util.Hashtable |
getParametersHash(Request apiRequest) get parameters of current effective user. |
PresetCategory[] |
getPresetCategories() get all the preset categories. |
PresetDescriptor[] |
getPresetDescriptors(java.lang.String presetCategoryName) get all the preset descriptors for a preset category. |
Presets[] |
getPresets(java.lang.String presetCategoryName, Request apiRequest) get all the presets objects for a preset category. |
Gender |
getUserGender(Request apiRequest) get user's gender. |
Folder |
getUserHomeFolder(Request apiRequest) |
java.lang.String |
getUserPasswordHint(java.lang.String userName) get the password hint for a user |
java.lang.String |
getUserPrivacyDirective(Request apiRequest) get user's privacy directive. |
Folder |
getUserRootFolder(Request apiRequest) get the root folder of the current effective user |
java.lang.String |
getUserTimeZone(Request apiRequest) get user's TimeZone. |
Folder[] |
getUserUpdatableFolders(Request apiRequest) get all the updateble folders of the current effective user so that the user can creates object within that folder. |
Folder[] |
getUserUpdatableFolders(java.lang.String username, Request apiRequest) get all the folders and subfolders for a user |
DeviceAddress[] |
getValidDeviceAddresses(Request apiRequest) get the valid device addresses of current effective user. |
boolean |
isCurrentAdministrator(Request apiRequest) check to see whether the current login user is administrator. |
static boolean |
isCurrentDesigner(Request apiRequest) check to see whether the current login user is designer. |
boolean |
isNamePasswordMatched(java.lang.String username, java.lang.String password) check to see user and password are matched. |
Profile |
lookupProfile(java.lang.String profileName, Request apiRequest) Lookup user's view profile by name |
void |
QueryUserList(java.util.Hashtable paramHash, Request apiRequest) for administrator Start a multiple user query based on name and display name criteria |
User |
registerSelf(java.lang.String name, java.util.Hashtable paramHash, Request apiRequest) self register by a user |
void |
removeProfile(long profileId, Request apiRequest) remove a user view profile. |
void |
setDefaultAlertAddress(long alertAddressId, Request apiRequest) set the default alert address of the current effective user. |
void |
setDefaultDeviceAddress(long deviceAddressId, Request apiRequest) set the default device address of the current effective user. |
void |
setDefaultLocationMark(long locationMarkId, Request apiRequest) set the default location mark of the current effective user. |
void |
setDefaultProfile(java.lang.String profileName, Request apiRequest) set the default Profile of the current effective user. |
void |
setEffectiveUser(long userId, Request apiRequest) for administrator set effective user |
void |
setParameters(java.util.Hashtable paramHash, Request apiRequest) set parameters of current effective user. |
void |
setParameters(long userId, java.util.Hashtable paramHash, Request apiRequest) for administrator set parameter values of a user. |
void |
setPresetsValues(long presetId, java.lang.String presetCatName, java.lang.String presetName, java.util.Hashtable arguments, Request apiRequest) Set Presets values |
void |
setProfileParameters(long profileId, java.lang.String name, java.util.Hashtable paramHash, Request apiRequest) set name parameter of a profile. |
void |
unsetDefaultAlertAddress(Request apiRequest) Deprecated. |
void |
unsetDefaultLocationMark(Request apiRequest) unset the default location mark of the current effective user. |
void |
unSetEffectiveUser(Request apiRequest) for administrator unset effective user, that is, set effective user back to login user. |
Methods inherited from class java.lang.Object |
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
public static final java.lang.String ACCOUNTNUMBER
public static java.util.Vector allLocales
public static final java.lang.String ALLUSER_CURRENTPAGE
public static final java.lang.String ALLUSER_CURRENTPOSITION
public static final java.lang.String ALLUSER_RESULTSET
public static java.util.Vector countryLocales
public static final java.lang.String DATEOFBIRTH
public static final java.lang.String DISCLOSEIDENTITY
public static final java.lang.String DISCLOSELOCATION
public static final java.lang.String GENDER
public static java.util.Vector langLocales
public static final java.lang.String LOCATIONPRIVACY
public static final java.lang.String MOBILEID
public static final java.lang.String PIN
public static final java.lang.String PINCONFIRM
public static java.util.Vector timeZones
public static final java.lang.String USERAUTOLOCATE
public static final java.lang.String USERCOUNTRY
public static final java.lang.String USERDEFAULTALERTADDRESS
public static final java.lang.String USERDEFAULTDEVICE
public static final java.lang.String USERDEFAULTLANDMARK
public static final java.lang.String USERDEFAULTPROFILE
public static final java.lang.String USERDISPLAYNAME
public static final java.lang.String USEREXTERNALID
public static final java.lang.String USERGROUPS
public static final java.lang.String USERID
public static final java.lang.String USERISADMIN
public static final java.lang.String USERISDESIGNER
public static final java.lang.String USERISENABLED
public static final java.lang.String USERLANGUAGE
public static final java.lang.String USERNAME
public static final java.lang.String USERPASSWORD
public static final java.lang.String USERPASSWORDCONFIRM
public static final java.lang.String USERPASSWORDHINT
public static final java.lang.String USERPASSWORDNEW
public static final java.lang.String USERTIMEZONE
public static final java.lang.String USERVIEWPROFILEDEFAULT
public static final java.lang.String USERVIEWPROFILEID
public static final java.lang.String USERVIEWPROFILENAME
Method Detail |
public boolean checkWriteAccess(long serviceId, Request apiRequest) throws PortalException
serviceId
- checked service ID.apiRequest
- current validated Request.PortalException
public boolean checkWriteAccess(Service service, Request apiRequest) throws PortalException
service
- checked service.apiRequest
- current validated Request.PortalException
public Profile createNewProfile(java.lang.String name, Request apiRequest) throws PortalException
name
- new profile name.apiRequest
- current validated Request.PortalException
public User createNewUser(java.lang.String name, Request apiRequest) throws PortalException
name
- new user name.apiRequest
- current validated Request.PortalException
public Presets createPresets(java.lang.String presetCatName, java.lang.String presetName, Request apiRequest) throws PortalException
PortalException
public int deleteCurrentQueryUsers(java.lang.String[] userIdStrings, Request apiRequest) throws PortalException
userIdStrings
- user id strings to be deleted.apiRequest
- current validate Request.PortalException
public void deletePresets(java.lang.String presetCatName, long presetId, Request apiRequest) throws PortalException
presetCatName
- preset category name.apiRequest
- current validate Request.PortalException
public void deleteUser(long userId, Request apiRequest) throws PortalException
userId
- deleted user ID.PortalException
public void fetchNextQueryUserPage(int pageSize, Request apiRequest) throws PortalException
apiRequest
- current validate Request.PortalException
public void fetchPreviousQueryUserPage(int pageSize, Request apiRequest) throws PortalException
apiRequest
- current validate Request.PortalException
public User findUser(long userId, Request apiRequest) throws PortalException
apiRequest
- the current validated requestPortalException
public AlertAddress[] getAlertAddresses(Request apiRequest) throws PortalException
apiRequest
- current validated request.PortalException
public Alert[] getAllAlerts(Request apiRequest) throws PortalException
apiRequest
- current validated request.PortalException
public Gender[] getAllGenders()
public java.lang.String[] getAllPrivacyDirectives(Request apiRequest)
apiRequest
- current validate Request.public Profile[] getAllProfiles(Request apiRequest) throws PortalException
apiRequest
- current validated Request.PortalException
public java.util.Locale[] getAvailableCountryLocales()
public java.util.Locale[] getAvailableLanguageLocales()
public java.util.Locale[] getAvailableLocales()
public java.lang.String[] getAvailableTimeZones()
public static User getCurrentLoginUser(Request apiRequest) throws PortalException
apiRequest
- current validated Request.PortalException
public User[] getCurrentQueryUserPage(Request apiRequest) throws PortalException
apiRequest
- current validate Request.PortalException
public int getCurrentQueryUserPosition(Request apiRequest) throws PortalException
apiRequest
- current validate Request.PortalException
public java.util.Locale getCurrentServerLocale(javax.servlet.http.HttpServletRequest httpRequest)
httpRequest
- current HttpServletRequestpublic static User getCurrentUser(Request apiRequest) throws PortalException
apiRequest
- current validated Request.PortalException
public java.util.Locale getCurrentUserLocale(Request apiRequest)
apiRequest
- current validated Request.public AlertAddress getDefaultAlertAddress(Request apiRequest) throws PortalException
apiRequest
- current validated request.PortalException
public DeviceAddress getDefaultDeviceAddress(Request apiRequest) throws PortalException
apiRequest
- current validated request.PortalException
public java.util.Locale getDefaultLocale()
public LocationMark getDefaultLocationMark(Request apiRequest) throws PortalException
apiRequest
- current validated request.PortalException
public Profile getDefaultProfile(Request apiRequest) throws PortalException
apiRequest
- current validated request.PortalException
public java.lang.String getDefaultTimeZone()
public DeviceAddress[] getDeviceAddresses(Request apiRequest) throws PortalException
apiRequest
- current validated request.PortalException
public java.util.Vector getGroupRootFolders(Request apiRequest) throws PortalException
apiRequest
- current validated requestPortalException
public static UserController getInstance()
public LocationMark[] getLocationMarks(Request apiRequest) throws PortalException
apiRequest
- current validated request.PortalException
public java.lang.String getNewUserDefaultValue(java.lang.String key)
public java.util.Hashtable getParametersHash(long userId, Request apiRequest) throws PortalException
userId
- queried user ID.PortalException
public java.util.Hashtable getParametersHash(Request apiRequest) throws PortalException
apiRequest
- current vaidated Request.PortalException
public PresetCategory[] getPresetCategories() throws PortalException
PortalException
public PresetDescriptor[] getPresetDescriptors(java.lang.String presetCategoryName) throws PortalException
presetCategoryName
- preset category name.PortalException
public Presets[] getPresets(java.lang.String presetCategoryName, Request apiRequest) throws PortalException
presetCategoryName
- preset category name.apiRequest
- current validated request.PortalException
public Gender getUserGender(Request apiRequest) throws PortalException
apiRequest
- current validated request.PortalException
public Folder getUserHomeFolder(Request apiRequest) throws PortalException
PortalException
public java.lang.String getUserPasswordHint(java.lang.String userName) throws PortalException
userName
- the user name to lookup passwordPortalException
public java.lang.String getUserPrivacyDirective(Request apiRequest) throws PortalException
apiRequest
- current validated request.PortalException
public Folder getUserRootFolder(Request apiRequest) throws PortalException
apiRequest
- current validated requestPortalException
public java.lang.String getUserTimeZone(Request apiRequest) throws PortalException
apiRequest
- current validated request.PortalException
public Folder[] getUserUpdatableFolders(Request apiRequest) throws PortalException
apiRequest
- current validated requestPortalException
public Folder[] getUserUpdatableFolders(java.lang.String username, Request apiRequest) throws PortalException
username
- to be checked.apiRequest
- current validated api.PortalException
public DeviceAddress[] getValidDeviceAddresses(Request apiRequest) throws PortalException
apiRequest
- current validated request.PortalException
public boolean isCurrentAdministrator(Request apiRequest) throws PortalException
apiRequest
- current validated api.PortalException
public static boolean isCurrentDesigner(Request apiRequest) throws PortalException
apiRequest
- current validated api.PortalException
public boolean isNamePasswordMatched(java.lang.String username, java.lang.String password) throws PortalException
username
- to be checked.password
- to be checked.PortalException
public Profile lookupProfile(java.lang.String profileName, Request apiRequest) throws PortalException
profileName
- user's view profile name.apiRequest
- current validated Request.PortalException
public void QueryUserList(java.util.Hashtable paramHash, Request apiRequest) throws PortalException
paramHash
- name-value Hashtable with keys of name and display nameapiRequest
- current validate Request.PortalException
public User registerSelf(java.lang.String name, java.util.Hashtable paramHash, Request apiRequest) throws PortalException
name
- new user name.paramHash
- parameter hashtablePortalException
public void removeProfile(long profileId, Request apiRequest) throws PortalException
apiRequest
- current validated Request.PortalException
public void setDefaultAlertAddress(long alertAddressId, Request apiRequest) throws PortalException
alertAddressId
- default alert address ID to set to.apiRequest
- current validated request.PortalException
public void setDefaultDeviceAddress(long deviceAddressId, Request apiRequest) throws PortalException
deviceAddressId
- default device address ID to set to.apiRequest
- current validated request.PortalException
public void setDefaultLocationMark(long locationMarkId, Request apiRequest) throws PortalException
locationMarkId
- default location mark ID to set to.apiRequest
- current validated request.PortalException
public void setDefaultProfile(java.lang.String profileName, Request apiRequest) throws PortalException
profileName
- default Profile Name to set to.apiRequest
- current validated request.PortalException
public void setEffectiveUser(long userId, Request apiRequest) throws PortalException
userId
- ID of the effective user to set toapiRequest
- current validated RequestPortalException
public void setParameters(java.util.Hashtable paramHash, Request apiRequest) throws PortalException
paramHash
- parameter Hashtable of current effective user.apiRequest
- current vaidated Request.PortalException
public void setParameters(long userId, java.util.Hashtable paramHash, Request apiRequest) throws PortalException
userId
- queried user ID.apiRequest
- current validated Request.PortalException
public void setPresetsValues(long presetId, java.lang.String presetCatName, java.lang.String presetName, java.util.Hashtable arguments, Request apiRequest) throws PortalException
presetId
- Presets object ID.presetCatName
- Presets category name.presetName
- Presets name.arguments
- Presets values.apiRequest
- current validated Request.PortalException
public void setProfileParameters(long profileId, java.lang.String name, java.util.Hashtable paramHash, Request apiRequest) throws PortalException
name
- profile name.paramHash
- name parameter Hashtable of a profileapiRequest
- current validated Request.PortalException
public void unsetDefaultAlertAddress(Request apiRequest) throws PortalException
apiRequest
- current validated request.PortalException
public void unsetDefaultLocationMark(Request apiRequest) throws PortalException
apiRequest
- current validated request.PortalException
public void unSetEffectiveUser(Request apiRequest) throws PortalException
apiRequest
- current validated RequestPortalException
|
Oracle Application Server Wireless Java API Reference B14043-01 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |