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

ACCOUNTNUMBER

public static final java.lang.String ACCOUNTNUMBER

Key for retrieving account number value from the parameter Hashtable passing to/from the portal pages.

See Also:

Constant Field Values

allLocales

public static java.util.Vector allLocales

ALLUSER_CURRENTPAGE

public static final java.lang.String ALLUSER_CURRENTPAGE

session parameter key for storing current result page.

See Also:

Constant Field Values

ALLUSER_CURRENTPOSITION

public static final java.lang.String ALLUSER_CURRENTPOSITION

session parameter key for storing current result position.

See Also:

Constant Field Values

ALLUSER_RESULTSET

public static final java.lang.String ALLUSER_RESULTSET

session parameter key for storing current result set object.

See Also:

Constant Field Values

countryLocales

public static java.util.Vector countryLocales

DATEOFBIRTH

public static final java.lang.String DATEOFBIRTH

Key for retrieving user's date of birth from the parameter Hashtable passing to/from the portal pages.

See Also:

Constant Field Values

DISCLOSEIDENTITY

public static final java.lang.String DISCLOSEIDENTITY

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

See Also:

Constant Field Values

DISCLOSELOCATION

public static final java.lang.String DISCLOSELOCATION

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

See Also:

Constant Field Values

GENDER

public static final java.lang.String GENDER

Key for retrieving user's Gender from the parameter Hashtable passing to/from the portal pages.

See Also:

Constant Field Values

langLocales

public static java.util.Vector langLocales

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

MOBILEID

public static final java.lang.String MOBILEID

Key for retrieving user's MobileID value from the parameter Hashtable passing to/from the portal pages.

See Also:

Constant Field Values

PIN

public static final java.lang.String PIN

Key for retrieving numeric PIN value from the parameter Hashtable passing to/from the portal pages.

See Also:

Constant Field Values

PINCONFIRM

public static final java.lang.String PINCONFIRM

Key for retrieving numeric PIN value from the parameter Hashtable passing to/from the portal pages.

See Also:

Constant Field Values

timeZones

public static java.util.Vector timeZones

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

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

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

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

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

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

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

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

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

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

USERISDESIGNER

public static final java.lang.String USERISDESIGNER

Key for retrieving user isDesigner 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

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

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

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

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

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

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

USERVIEWPROFILEDEFAULT

public static final java.lang.String USERVIEWPROFILEDEFAULT

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

See Also:

Constant Field Values

USERVIEWPROFILEID

public static final java.lang.String USERVIEWPROFILEID

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

See Also:

Constant Field Values

USERVIEWPROFILENAME

public static final java.lang.String USERVIEWPROFILENAME

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

See Also:

Constant Field Values

Method Detail

checkWriteAccess

public boolean checkWriteAccess(long serviceId,
                                Request apiRequest)
                         throws PortalException

check to see whether current user has the write access to a service.

Parameters:

serviceId - checked service ID.

apiRequest - current validated Request.

Returns:

true if writable, otherwise false.

Throws:

PortalException

checkWriteAccess

public boolean checkWriteAccess(Service service,
                                Request apiRequest)
                         throws PortalException

check to see whether current user has the write access to a service.

Parameters:

service - checked service.

apiRequest - current validated Request.

Returns:

true if writable, otherwise false.

Throws:

PortalException

createNewProfile

public Profile createNewProfile(java.lang.String name,
                                Request apiRequest)
                         throws PortalException

create a new user view profile.

Parameters:

name - new profile name.

apiRequest - current validated Request.

Returns:

the new Profile.

Throws:

PortalException

createNewUser

public User createNewUser(java.lang.String name,
                          Request apiRequest)
                   throws PortalException

for administrator create a new user.

Parameters:

name - new user name.

apiRequest - current validated Request.

Returns:

the new User.

Throws:

PortalException

createPresets

public Presets createPresets(java.lang.String presetCatName,
                             java.lang.String presetName,
                             Request apiRequest)
                      throws PortalException

Throws:

PortalException

deleteCurrentQueryUsers

public int deleteCurrentQueryUsers(java.lang.String[] userIdStrings,
                                   Request apiRequest)
                            throws PortalException

for administrator delete users from the current page of queried multiple user list.

Parameters:

userIdStrings - user id strings to be deleted.

apiRequest - current validate Request.

Returns:

number of users deleted.

Throws:

PortalException

deletePresets

public void deletePresets(java.lang.String presetCatName,
                          long presetId,
                          Request apiRequest)
                   throws PortalException

delete presets value from the preset vategory with a given presets object ID.

Parameters:

presetCatName - preset category name.

apiRequest - current validate Request.

Throws:

PortalException

deleteUser

public void deleteUser(long userId,
                       Request apiRequest)
                throws PortalException

for administrator delete a user.

Parameters:

userId - deleted user ID.

Throws:

PortalException

fetchNextQueryUserPage

public void fetchNextQueryUserPage(int pageSize,
                                   Request apiRequest)
                            throws PortalException

for administrator Fecth next page of queried multiple user list.

Parameters:

apiRequest - current validate Request.

Throws:

PortalException

fetchPreviousQueryUserPage

public void fetchPreviousQueryUserPage(int pageSize,
                                       Request apiRequest)
                                throws PortalException

for administrator Fecth previous page of queried multiple user list.

Parameters:

apiRequest - current validate Request.

Throws:

PortalException

findUser

public User findUser(long userId,
                     Request apiRequest)
              throws PortalException

for administrator find the User

Parameters:

apiRequest - the current validated request

Returns:

the password hint

Throws:

PortalException

getAlertAddresses

public AlertAddress[] getAlertAddresses(Request apiRequest)
                                 throws PortalException

Deprecated.

get all the alert addresses of current effective user.

Parameters:

apiRequest - current validated request.

Returns:

alert address array of current effective user.

Throws:

PortalException

getAllAlerts

public Alert[] getAllAlerts(Request apiRequest)
                     throws PortalException

Deprecated.

get all the alerts of current effective user.

Parameters:

apiRequest - current validated request.

Returns:

alert array of current effective user.

Throws:

PortalException

getAllGenders

public Gender[] getAllGenders()

get all genders.

Returns:

array of supported gender objects.

getAllPrivacyDirectives

public java.lang.String[] getAllPrivacyDirectives(Request apiRequest)

Get all the location Privacy Directives

Parameters:

apiRequest - current validate Request.

getAllProfiles

public Profile[] getAllProfiles(Request apiRequest)
                         throws PortalException

get all of the user view profiles.

Parameters:

apiRequest - current validated Request.

Returns:

all of the user Profiles.

Throws:

PortalException

getAvailableCountryLocales

public java.util.Locale[] getAvailableCountryLocales()

get all the avaliable countries for locale.

Returns:

country locale array.

getAvailableLanguageLocales

public java.util.Locale[] getAvailableLanguageLocales()

get all the avaliable languages for locale.

Returns:

language locale array.

getAvailableLocales

public java.util.Locale[] getAvailableLocales()

getAvailableTimeZones

public java.lang.String[] getAvailableTimeZones()

get all the avaliable time zones.

Returns:

TimeZone array.

getCurrentLoginUser

public static User getCurrentLoginUser(Request apiRequest)
                                throws PortalException

get the current login user

Parameters:

apiRequest - current validated Request.

Returns:

the current login user.

Throws:

PortalException

getCurrentQueryUserPage

public User[] getCurrentQueryUserPage(Request apiRequest)
                               throws PortalException

for administrator Get the current page of the queried multiple user list.

Parameters:

apiRequest - current validate Request.

Returns:

user array of the current page of the queried multiple user list.

Throws:

PortalException

getCurrentQueryUserPosition

public int getCurrentQueryUserPosition(Request apiRequest)
                                throws PortalException

for administrator Get the current fetch position of the queried multiple user list.

Parameters:

apiRequest - current validate Request.

Returns:

the current position of the queried multiple user list.

Throws:

PortalException

getCurrentServerLocale

public java.util.Locale getCurrentServerLocale(javax.servlet.http.HttpServletRequest httpRequest)

get the current server locale before login or when session expire

Parameters:

httpRequest - current HttpServletRequest

Returns:

the current effective user locale.

getCurrentUser

public static User getCurrentUser(Request apiRequest)
                           throws PortalException

get the current effective user

Parameters:

apiRequest - current validated Request.

Returns:

the current effective user.

Throws:

PortalException

getCurrentUserLocale

public java.util.Locale getCurrentUserLocale(Request apiRequest)

get the current effective user locale

Parameters:

apiRequest - current validated Request.

Returns:

the current effective user locale.

getDefaultAlertAddress

public AlertAddress getDefaultAlertAddress(Request apiRequest)
                                    throws PortalException

Deprecated.

get the default alert address of the current effective user.

Parameters:

apiRequest - current validated request.

Returns:

default alert address of current effective user.

Throws:

PortalException

getDefaultDeviceAddress

public DeviceAddress getDefaultDeviceAddress(Request apiRequest)
                                      throws PortalException

get the default device address of the current effective user.

Parameters:

apiRequest - current validated request.

Returns:

default device address of current effective user.

Throws:

PortalException

getDefaultLocale

public java.util.Locale getDefaultLocale()

getDefaultLocationMark

public LocationMark getDefaultLocationMark(Request apiRequest)
                                    throws PortalException

get the default location mark of the current effective user.

Parameters:

apiRequest - current validated request.

Returns:

default location mark of current effective user.

Throws:

PortalException

getDefaultProfile

public Profile getDefaultProfile(Request apiRequest)
                          throws PortalException

get the default Profile of the current effective user.

Parameters:

apiRequest - current validated request.

Returns:

default Profile of current effective user.

Throws:

PortalException

getDefaultTimeZone

public java.lang.String getDefaultTimeZone()

getDeviceAddresses

public DeviceAddress[] getDeviceAddresses(Request apiRequest)
                                   throws PortalException

get all the device addresses of current effective user.

Parameters:

apiRequest - current validated request.

Returns:

device address array of current effective user.

Throws:

PortalException

getGroupRootFolders

public java.util.Vector getGroupRootFolders(Request apiRequest)
                                     throws PortalException

get the root folders of the current effective user's groups

Parameters:

apiRequest - current validated request

Returns:

root folders of ther current effective user's groups

Throws:

PortalException

getInstance

public static UserController getInstance()

The singleton thread-safe getter.

Returns:

the UserController singleton interface.

getLocationMarks

public LocationMark[] getLocationMarks(Request apiRequest)
                                throws PortalException

get all the location marks of current effective user.

Parameters:

apiRequest - current validated request.

Returns:

location mark array of current effective user.

Throws:

PortalException

getNewUserDefaultValue

public java.lang.String getNewUserDefaultValue(java.lang.String key)

getParametersHash

public java.util.Hashtable getParametersHash(long userId,
                                             Request apiRequest)
                                      throws PortalException

for administrator get parameter name-value Hashtable of a user.

Parameters:

userId - queried user ID.

Returns:

parameter name-value Hashtable of a user.

Throws:

PortalException

getParametersHash

public java.util.Hashtable getParametersHash(Request apiRequest)
                                      throws PortalException

get parameters of current effective user.

Parameters:

apiRequest - current vaidated Request.

Returns:

parameter Hashtable of current effective user.

Throws:

PortalException

getPresetCategories

public PresetCategory[] getPresetCategories()
                                     throws PortalException

get all the preset categories.

Returns:

array of preset category objects.

Throws:

PortalException

getPresetDescriptors

public PresetDescriptor[] getPresetDescriptors(java.lang.String presetCategoryName)
                                        throws PortalException

get all the preset descriptors for a preset category.

Parameters:

presetCategoryName - preset category name.

Returns:

array of preset descriptor objects.

Throws:

PortalException

getPresets

public Presets[] getPresets(java.lang.String presetCategoryName,
                            Request apiRequest)
                     throws PortalException

get all the presets objects for a preset category.

Parameters:

presetCategoryName - preset category name.

apiRequest - current validated request.

Returns:

array of presets objects.

Throws:

PortalException

getUserGender

public Gender getUserGender(Request apiRequest)
                     throws PortalException

get user's gender.

Parameters:

apiRequest - current validated request.

Returns:

user's gender object.

Throws:

PortalException

getUserHomeFolder

public Folder getUserHomeFolder(Request apiRequest)
                         throws PortalException

Throws:

PortalException

getUserPasswordHint

public java.lang.String getUserPasswordHint(java.lang.String userName)
                                     throws PortalException

get the password hint for a user

Parameters:

userName - the user name to lookup password

Returns:

the password hint

Throws:

PortalException

getUserPrivacyDirective

public java.lang.String getUserPrivacyDirective(Request apiRequest)
                                         throws PortalException

get user's privacy directive.

Parameters:

apiRequest - current validated request.

Returns:

user's privacy directive string.

Throws:

PortalException

getUserRootFolder

public Folder getUserRootFolder(Request apiRequest)
                         throws PortalException

get the root folder of the current effective user

Parameters:

apiRequest - current validated request

Returns:

root folder of ther current effective user

Throws:

PortalException

getUserTimeZone

public java.lang.String getUserTimeZone(Request apiRequest)
                                 throws PortalException

get user's TimeZone.

Parameters:

apiRequest - current validated request.

Returns:

user's TimeZone string.

Throws:

PortalException

getUserUpdatableFolders

public Folder[] getUserUpdatableFolders(Request apiRequest)
                                 throws PortalException

get all the updateble folders of the current effective user so that the user can creates object within that folder.

Parameters:

apiRequest - current validated request

Returns:

updatable folders of ther current effective user

Throws:

PortalException

getUserUpdatableFolders

public Folder[] getUserUpdatableFolders(java.lang.String username,
                                        Request apiRequest)
                                 throws PortalException

get all the folders and subfolders for a user

Parameters:

username - to be checked.

apiRequest - current validated api.

Returns:

folder array

Throws:

PortalException

getValidDeviceAddresses

public DeviceAddress[] getValidDeviceAddresses(Request apiRequest)
                                        throws PortalException

get the valid device addresses of current effective user.

Parameters:

apiRequest - current validated request.

Returns:

valid device address array of current effective user.

Throws:

PortalException

isCurrentAdministrator

public boolean isCurrentAdministrator(Request apiRequest)
                               throws PortalException

check to see whether the current login user is administrator.

Parameters:

apiRequest - current validated api.

Returns:

true if the current user is administrator, otherwise false.

Throws:

PortalException

isCurrentDesigner

public static boolean isCurrentDesigner(Request apiRequest)
                                 throws PortalException

check to see whether the current login user is designer.

Parameters:

apiRequest - current validated api.

Returns:

true if the current user is designer, otherwise false.

Throws:

PortalException

isNamePasswordMatched

public boolean isNamePasswordMatched(java.lang.String username,
                                     java.lang.String password)
                              throws PortalException

check to see user and password are matched.

Parameters:

username - to be checked.

password - to be checked.

Returns:

true if the current user is designer, otherwise false.

Throws:

PortalException

lookupProfile

public Profile lookupProfile(java.lang.String profileName,
                             Request apiRequest)
                      throws PortalException

Lookup user's view profile by name

Parameters:

profileName - user's view profile name.

apiRequest - current validated Request.

Returns:

user's view profile object.

Throws:

PortalException

QueryUserList

public void QueryUserList(java.util.Hashtable paramHash,
                          Request apiRequest)
                   throws PortalException

for administrator Start a multiple user query based on name and display name criteria

Parameters:

paramHash - name-value Hashtable with keys of name and display name

apiRequest - current validate Request.

Throws:

PortalException

registerSelf

public User registerSelf(java.lang.String name,
                         java.util.Hashtable paramHash,
                         Request apiRequest)
                  throws PortalException

self register by a user

Parameters:

name - new user name.

paramHash - parameter hashtable

Returns:

the new User.

Throws:

PortalException

removeProfile

public void removeProfile(long profileId,
                          Request apiRequest)
                   throws PortalException

remove a user view profile.

Parameters:

apiRequest - current validated Request.

Throws:

PortalException

setDefaultAlertAddress

public void setDefaultAlertAddress(long alertAddressId,
                                   Request apiRequest)
                            throws PortalException

set the default alert address of the current effective user.

Parameters:

alertAddressId - default alert address ID to set to.

apiRequest - current validated request.

Throws:

PortalException

setDefaultDeviceAddress

public void setDefaultDeviceAddress(long deviceAddressId,
                                    Request apiRequest)
                             throws PortalException

set the default device address of the current effective user.

Parameters:

deviceAddressId - default device address ID to set to.

apiRequest - current validated request.

Throws:

PortalException

setDefaultLocationMark

public void setDefaultLocationMark(long locationMarkId,
                                   Request apiRequest)
                            throws PortalException

set the default location mark of the current effective user.

Parameters:

locationMarkId - default location mark ID to set to.

apiRequest - current validated request.

Throws:

PortalException

setDefaultProfile

public void setDefaultProfile(java.lang.String profileName,
                              Request apiRequest)
                       throws PortalException

set the default Profile of the current effective user.

Parameters:

profileName - default Profile Name to set to.

apiRequest - current validated request.

Throws:

PortalException

setEffectiveUser

public void setEffectiveUser(long userId,
                             Request apiRequest)
                      throws PortalException

for administrator set effective user

Parameters:

userId - ID of the effective user to set to

apiRequest - current validated Request

Throws:

PortalException

setParameters

public void setParameters(java.util.Hashtable paramHash,
                          Request apiRequest)
                   throws PortalException

set parameters of current effective user.

Parameters:

paramHash - parameter Hashtable of current effective user.

apiRequest - current vaidated Request.

Throws:

PortalException

setParameters

public void setParameters(long userId,
                          java.util.Hashtable paramHash,
                          Request apiRequest)
                   throws PortalException

for administrator set parameter values of a user.

Parameters:

userId - queried user ID.

apiRequest - current validated Request.

Throws:

PortalException

setPresetsValues

public void setPresetsValues(long presetId,
                             java.lang.String presetCatName,
                             java.lang.String presetName,
                             java.util.Hashtable arguments,
                             Request apiRequest)
                      throws PortalException

Set Presets values

Parameters:

presetId - Presets object ID.

presetCatName - Presets category name.

presetName - Presets name.

arguments - Presets values.

apiRequest - current validated Request.

Throws:

PortalException

setProfileParameters

public void setProfileParameters(long profileId,
                                 java.lang.String name,
                                 java.util.Hashtable paramHash,
                                 Request apiRequest)
                          throws PortalException

set name parameter of a profile.

Parameters:

name - profile name.

paramHash - name parameter Hashtable of a profile

apiRequest - current validated Request.

Throws:

PortalException

unsetDefaultAlertAddress

public void unsetDefaultAlertAddress(Request apiRequest)
                              throws PortalException

Deprecated.

unset the default alert address of the current effective user.

Parameters:

apiRequest - current validated request.

Throws:

PortalException

unsetDefaultLocationMark

public void unsetDefaultLocationMark(Request apiRequest)
                              throws PortalException

unset the default location mark of the current effective user.

Parameters:

apiRequest - current validated request.

Throws:

PortalException

unSetEffectiveUser

public void unSetEffectiveUser(Request apiRequest)
                        throws PortalException

for administrator unset effective user, that is, set effective user back to login user.

Parameters:

apiRequest - current validated Request

Throws:

PortalException