UserController ( Oracle Application Server Wireless Java API Reference)

Overview

Package

Class

Tree

Deprecated

Index

Help

Oracle Application Server Wireless Java API Reference
B10400-01

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

oracle.panama.portal
Class UserController

java.lang.Object
  |
  +--oracle.panama.portal.UserController

All Implemented Interfaces:: java.io.Serializable

public class UserController
extends java.lang.Object
implements java.io.Serializable

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.

See Also:: Serialized Form

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

USERID

public static final java.lang.String USERID

Key for retrieving user id value from the parameter Hashtable passing to/from the portal pages.

See Also:: Constant Field Values

USERNAME

public static final java.lang.String USERNAME

Key for retrieving user name value from the parameter Hashtable passing to/from the portal pages.

See Also:: Constant Field Values

USERDISPLAYNAME

public static final java.lang.String USERDISPLAYNAME

Key for retrieving user display name value from the parameter Hashtable passing to/from the portal pages.

See Also:: Constant Field Values

USEREXTERNALID

public static final java.lang.String USEREXTERNALID

Key for retrieving user external id value from the parameter Hashtable passing to/from the portal pages.

See Also:: Constant Field Values

USERPASSWORD

public static final java.lang.String USERPASSWORD

Key for retrieving user password value from the parameter Hashtable passing to/from the portal pages.

See Also:: Constant Field Values

USERPASSWORDNEW

public static final java.lang.String USERPASSWORDNEW

Key for retrieving user new password value from the parameter Hashtable passing to/from the portal pages.

See Also:: Constant Field Values

USERPASSWORDCONFIRM

public static final java.lang.String USERPASSWORDCONFIRM

Key for retrieving user password confirm value from the parameter Hashtable passing to/from the portal pages.

See Also:: Constant Field Values

USERPASSWORDHINT

public static final java.lang.String USERPASSWORDHINT

Key for retrieving user password hint value from the parameter Hashtable passing to/from the portal pages.

See Also:: Constant Field Values

USERGROUPS

public static final java.lang.String USERGROUPS

Key for retrieving user group value from the parameter Hashtable passing to/from the portal pages.

See Also:: Constant Field Values

USERLANGUAGE

public static final java.lang.String USERLANGUAGE

Key for retrieving user language value from the parameter Hashtable passing to/from the portal pages.

See Also:: Constant Field Values

USERCOUNTRY

public static final java.lang.String USERCOUNTRY

Key for retrieving user country value from the parameter Hashtable passing to/from the portal pages.

See Also:: Constant Field Values

USERTIMEZONE

public static final java.lang.String USERTIMEZONE

Key for retrieving user timezone value from the parameter Hashtable passing to/from the portal pages.

See Also:: Constant Field Values

USERDEFAULTDEVICE

public static final java.lang.String USERDEFAULTDEVICE

Key for retrieving user default device value from the parameter Hashtable passing to/from the portal pages.

See Also:: Constant Field Values

USERDEFAULTPROFILE

public static final java.lang.String USERDEFAULTPROFILE

Key for retrieving user default profile value from the parameter Hashtable passing to/from the portal pages.

See Also:: Constant Field Values

USERDEFAULTALERTADDRESS

public static final java.lang.String USERDEFAULTALERTADDRESS

Key for retrieving user default address value from the parameter Hashtable passing to/from the portal pages.

See Also:: Constant Field Values

USERDEFAULTLANDMARK

public static final java.lang.String USERDEFAULTLANDMARK

Key for retrieving user default landmark value from the parameter Hashtable passing to/from the portal pages.

See Also:: Constant Field Values

USERAUTOLOCATE

public static final java.lang.String USERAUTOLOCATE

Key for retrieving user auto locate value from the parameter Hashtable passing to/from the portal pages.

See Also:: Constant Field Values

LOCATIONPRIVACY

public static final java.lang.String LOCATIONPRIVACY

Key for retrieving location privacy value from the parameter Hashtable passing to/from the portal pages.

See Also:: Constant Field Values

USERISENABLED

public static final java.lang.String USERISENABLED

Key for retrieving user isEnabled value from the parameter Hashtable passing to/from the portal pages.

See Also:: Constant Field Values

USERISADMIN

public static final java.lang.String USERISADMIN

Key for retrieving user isAdministrator value from the parameter Hashtable passing to/from the portal pages.

See Also:: Constant Field Values