oracle.lite.resource

Class User

java.lang.Object

oracle.lite.resource.Resource

oracle.lite.resource.Entity

oracle.lite.resource.User

All Implemented Interfaces:

java.lang.Cloneable, ResourceConst, oracle.lite.util.Sortable

public class User
extends Entity
implements java.lang.Cloneable

Represents a logical User object in the Oracle Lite Mobile Server repository.

Field Summary

Fields inherited from interface oracle.lite.resource.ResourceConst

AUTH_TYPE, CONN_MAX_EXCEEDED, DEVICE_DELETE, DEVICE_REGISTER, EMPTY_STR, INVALID_ADDRESS, INVALID_DEVICE, INVALID_DIR, INVALID_ID, INVALID_INF, INVALID_NAME, INVALID_PARAM, INVALID_PLATFORM, INVALID_PROVIDER, INVALID_RESOURCE, INVALID_TYPE, INVALID_URL, NOT_FOUND, NOT_INITIALIZED, NOTIFY_CLASS, NOTIFY_ON_STATUS, NOTIFY_ON_VERIFY, RESOURCE_ENABLED, RESOURCE_VALID, SEP, STR_ANY, STR_BASE_NAME, STR_DMC, STR_EMPTY, STR_FALSE, STR_INF, STR_INF_EXT, STR_ONE, STR_TRUE, STR_WILD, STR_ZERO, SYSTEM_ID, TIME, UPDATE_MAJOR, UPDATE_MINOR, UPDATE_SOFTWARE, UPDATE_SOFTWARE_APPS, UPDATE_SOFTWARE_DMC

Constructor Summary

Constructors

Constructor and Description
User(java.lang.String name, java.lang.String pwd, java.lang.String dispName) Construct a User object from the given information.

Method Summary

Methods

Modifier and Type	Method and Description
void	addLog(java.lang.String msg) Log a user level message.
boolean	canUpdate() Check if the User has enough privilege for software/data update
void	changePassword(java.lang.String pwd) Change the existing password of the user.
boolean	checkPassword(java.lang.String pwd) Check to see if the passwords are identical.
java.lang.Object	clone(oracle.lite.dm.Context ctx) Clone oracle.lite.resource.User object.
boolean	equals(java.lang.Object o) Check if the given Resource object is same as this object.
Application	getApplication(java.lang.String name, java.lang.String platform) Retrieve an application that matches the platform type.
java.util.Hashtable	getApplications() Retrieve all provisioned applications for this user.
oracle.lite.dm.Context	getAuthenticationContext() Retrieve the authentication context object associated with the User object.
byte[]	getContext() Retrieve the temporary context string as a byte array.
Device	getDevice(java.lang.String id) Retrieve a device object registered to this user; given a device id.
Device	getDeviceByName(java.lang.String name) Retrieve a device object registered to this user; given a device name.
Device	getDeviceByUdid(java.lang.String udid) Retrieve a iOS device object registered to this user; given a device udid.
java.util.Enumeration	getDevices() Retrieve all devices associated with this user object.
java.lang.String	getDisplayName() Retrieve the display name of the user
java.util.ArrayList	getGroups() Retrieve all group objects this user belongs to.
java.lang.String	getGUID() Get GUID of the user (Note: GUID may be null for some users)
java.util.Enumeration	getLogs() Retrieve all the logs of this user from the repository.
java.lang.String	getOldHash() Return the 'old' style password hash.
java.lang.String	getPassword() Get the encoded password string of the User.
java.lang.String	getRole() Get user's role as a string value.
boolean	hasAccess(Application app) Check if the user has access rights to a given Application.
int	hashCode()
boolean	hasMemberAssociation(User memberUser) Check if the given member user is associated with this user.
boolean	hasPolicy(java.lang.String name, java.lang.String val) Check if the user has the policy string set.
boolean	hasValidPassword() Check to see if the User has a valid password or not.
boolean	isExternal() Check if the user is external.
boolean	isMemberUser() Check if the user is a member user.
void	registerDevice(Device device, java.lang.String cid) Registration process makes this user as the owner of the device.
void	setDisplayName(java.lang.String name) Set a new display name
void	setExternal(boolean isExternal) Set a flag indicating if the user is external.
void	setGUID(java.lang.String guid) Set a new GUID.
void	setPassword(java.lang.String pwd) Set a temporary password for the user.
void	setRole(java.lang.String role) Set a new role.

Methods inherited from class oracle.lite.resource.Entity

getName, getPolicy, setPolicy

Methods inherited from class oracle.lite.resource.Resource

delete, getAttribute, getId, getKey, isEnabled, isSystemResource, isValid, removeAttribute, save, setAttribute, setEnabled, setNew, validateAttribute

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

User

public User(java.lang.String name,
    java.lang.String pwd,
    java.lang.String dispName)

Construct a User object from the given information. Caller must call 'save' method in order to persist this object in the repository.

Parameters:

name - User name (Unique short name)

pwd - Password string

dispName - Human readable name

Method Detail

addLog

public void addLog(java.lang.String msg)
            throws ResourceException

Log a user level message.

Parameters:

msg - Message string.

Throws:

oracle.lite.resource.ResourceException

ResourceException

canUpdate

public boolean canUpdate()

Check if the User has enough privilege for software/data update

changePassword

public void changePassword(java.lang.String pwd)
                    throws ResourceException

Change the existing password of the user. This method will persist the password change immediately.

Parameters:

pwd - Password string.

Throws:

oracle.lite.resource.ResourceException

ResourceException

checkPassword

public boolean checkPassword(java.lang.String pwd)

Check to see if the passwords are identical.

Parameters:

pwd - Password string to be checked against.

clone

public java.lang.Object clone(oracle.lite.dm.Context ctx)
                       throws java.lang.CloneNotSupportedException

Clone oracle.lite.resource.User object.

Parameters:

ctx - Context object

Throws:

CloneNotSupportedException

java.lang.CloneNotSupportedException

equals

public boolean equals(java.lang.Object o)

Description copied from class: Resource

Check if the given Resource object is same as this object.

Overrides:

equals in class Entity

getApplication

public Application getApplication(java.lang.String name,
                         java.lang.String platform)
                           throws ResourceException

Retrieve an application that matches the platform type.

Parameters:

name - Application name

platform - Platform type

Returns:

Application object or null if one does not exist

Throws:

oracle.lite.resource.ResourceException

ResourceException

getApplications

public java.util.Hashtable getApplications()
                                    throws ResourceException

Retrieve all provisioned applications for this user.

Overrides:

getApplications in class Entity

Throws:

oracle.lite.resource.ResourceException

ResourceException

getAuthenticationContext

public oracle.lite.dm.Context getAuthenticationContext()

Retrieve the authentication context object associated with the User object.

Returns:

oracle.lite.dm.Context object or null if a context does not exist.

getContext

public byte[] getContext()

Retrieve the temporary context string as a byte array. If an authentication context does not exist, this method will return null.

getDevice

public Device getDevice(java.lang.String id)
                 throws ResourceException

Retrieve a device object registered to this user; given a device id.

Parameters:

id - Device Id

Returns:

Device object

Throws:

oracle.lite.resource.ResourceException

ResourceException

getDeviceByName

public Device getDeviceByName(java.lang.String name)
                       throws ResourceException

Retrieve a device object registered to this user; given a device name.

Parameters:

name - Device name

Returns:

Device object

Throws:

oracle.lite.resource.ResourceException

ResourceException

getDeviceByUdid

public Device getDeviceByUdid(java.lang.String udid)
                       throws ResourceException

Retrieve a iOS device object registered to this user; given a device udid.

Parameters:

udid - Device udid

Returns:

Device object

Throws:

oracle.lite.resource.ResourceException

ResourceException

getDevices

public java.util.Enumeration getDevices()
                                 throws ResourceException

Retrieve all devices associated with this user object.

Returns:

java.util.Enumeration object containing all Devices.

Throws:

oracle.lite.resource.ResourceException

ResourceException

getDisplayName

public java.lang.String getDisplayName()

Retrieve the display name of the user

Returns:

Display Name String

getGroups

public java.util.ArrayList getGroups()
                              throws ResourceException

Retrieve all group objects this user belongs to.

Returns:

java.util.ArrayList containing Group objects.

Throws:

oracle.lite.resource.ResourceException

ResourceException

getGUID

public java.lang.String getGUID()

Get GUID of the user (Note: GUID may be null for some users)

Returns:

GUID String

getLogs

public java.util.Enumeration getLogs()
                              throws ResourceException

Retrieve all the logs of this user from the repository.

Returns:

Enumeration of all device logs

Throws:

oracle.lite.resource.ResourceException

ResourceException

getOldHash

public java.lang.String getOldHash()

Return the 'old' style password hash.

getPassword

public java.lang.String getPassword()

Get the encoded password string of the User.

Returns:

Encoded password String

getRole

public java.lang.String getRole()

Get user's role as a string value.

Returns:

Role String

hasAccess

public boolean hasAccess(Application app)

Check if the user has access rights to a given Application.

Specified by:

hasAccess in class Entity

Parameters:

app - Application object

hashCode

public int hashCode()

Overrides:

hashCode in class Entity

hasMemberAssociation

public boolean hasMemberAssociation(User memberUser)

Check if the given member user is associated with this user.

Parameters:

memberUser - member user

hasPolicy

public boolean hasPolicy(java.lang.String name,
                java.lang.String val)

Check if the user has the policy string set.

Parameters:

name - Policy name

val - Expected value

Returns:

true if the policy string exists

hasValidPassword

public boolean hasValidPassword()

Check to see if the User has a valid password or not.

isExternal

public boolean isExternal()

Check if the user is external.

Returns:

true for an external user, false for an internal user

isMemberUser

public boolean isMemberUser()

Check if the user is a member user.

Returns:

true if user is a member user else false

registerDevice

public void registerDevice(Device device,
                  java.lang.String cid)
                    throws ResourceException

Registration process makes this user as the owner of the device. If the device is already registered to another user, this method will throw a ResourceException.

Parameters:

device - Device object

cid - Device generated client id

Throws:

oracle.lite.resource.ResourceException

ResourceException

setDisplayName

public void setDisplayName(java.lang.String name)

Set a new display name

Parameters:

name - Display Name

setExternal

public void setExternal(boolean isExternal)

Set a flag indicating if the user is external.

Parameters:

isExternal - true for external users, false for internal users

setGUID

public void setGUID(java.lang.String guid)

Set a new GUID. Caller must call 'save' method to persist the new value.

Parameters:

guid - GUID of the user

setPassword

public void setPassword(java.lang.String pwd)

Set a temporary password for the user. Temporary password will not be saved in the repository.

Parameters:

pwd - Password string.

setRole

public void setRole(java.lang.String role)

Set a new role. Caller must call 'save' method to persist the new value.

Parameters:

role - String value of user role.