oracle.lite.resource

Class Device

java.lang.Object

oracle.lite.resource.Resource

oracle.lite.resource.Device

All Implemented Interfaces:

ResourceConst, oracle.lite.util.Sortable

public class Device
extends Resource

Instances of this class are the logical representations of client devices in the Mobile Server.

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
Device(java.lang.String name, Platform platform, java.lang.String type) Create a new logical device in the Mobile Server Repository.
Device(java.lang.String name, Platform platform, java.lang.String type, java.lang.String udid, byte[] token, java.lang.String pushMagic, byte[] unlockToken) Create a new logic device in the repository.
Device(java.lang.String name, java.lang.String type, User user) Create an in memory logical device.

Method Summary

Methods

Modifier and Type	Method and Description
void	addLog(java.lang.String desc, java.sql.Timestamp time, java.lang.String msg) Add a new entry in the device log table.
boolean	canUpdate() Check if this device has enough privilege for software/data update
Address	createAddress(java.lang.String addr, java.lang.String provId) Create a new address for this device.
long	getAccessCount() Get access count.
java.sql.Timestamp	getAccessTime() Get last access time.
Address	getAddress(java.lang.String addr) Retrieve a device address from the repository.
java.util.Enumeration	getAddresses() Retrieve all adresses of this device.
java.lang.String	getClientId() Get device generated client id.
DeviceCommand	getCommand(java.lang.String cmdId) Retrieve a specific device command from the repository.
java.util.Vector	getCommands() Retrieve device command objects from the repository.
java.lang.String	getDirectory(boolean create) Retrieve device' directory path.
long	getLastSequence() Get last sequence id.
java.util.Enumeration	getLogs() Retrieve Device log from the repository.
java.lang.String	getName() Get device name
Platform	getPlatform() Retrieve Platform object
java.lang.String	getPlatformVersion() Retrieve current version of the Oracle Lite Platform installed on the device.
java.lang.String	getPushMagic()
java.util.Vector	getQueuedMessages() Retrieve all queued message for this device.
java.lang.String	getServerId() Get system generated server id.
byte[]	getToken()
java.lang.String	getType() Retrieve device type.
java.lang.String	getUdid()
byte[]	getUnlockToken()
User	getUser() Return owner 'User' object.
java.lang.String	getUserId() Get User Id (or device Owner's Id).
boolean	isType(java.lang.String type) Check if the device type matches given type.
void	queueMessage(java.lang.String msg, java.lang.String type, long expire) Put a message in the device queue.
void	resetDeviceSeqHistory(long seq)
void	saveProfile(java.lang.String name, byte[] value) Save profile information in the repository.
void	setAccessTime() Modifiy the last access time of the device.
void	setAccessTime(java.lang.String ver) Modifiy the last access time of the device.
void	setEnabled(boolean val) Enable or Disable device object.
void	setName(java.lang.String name) Set a new device name.
void	setPlatform(Platform platform) Set Platform for this device.
void	setPrimaryAddress(Address addr) Set the given address as the primary address of the device.
void	setPushMagic(java.lang.String pm)
void	setTemporary() Temporariliy enable the device.
void	setToken(byte[] token)
void	setType(java.lang.String type) Change device type.
void	setUdid(java.lang.String udid)
void	setUnlockToken(byte[] ut)
boolean	updateType() Update the device type if the curernt platform is obsoleted.
void	validate() Check if the device is enabled or not.
boolean	verifyRequest(long time, java.lang.String agent, java.lang.String ctxt) Check if the request is valid or not.
boolean	verifyRequest(long currentSeq, java.lang.String agent, java.lang.String ctxt, boolean seqBased)

Methods inherited from class oracle.lite.resource.Resource

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

Methods inherited from class java.lang.Object

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

Constructor Detail

Device

public Device(java.lang.String name,
      Platform platform,
      java.lang.String type)
       throws ResourceException

Create a new logical device in the Mobile Server Repository. A user can not have more than one devices with the same Oracle Lite Platform registered with Mobile server. When this API is used to create a second device for the same user, Mobile server will delete the previously registered device. To retrieve an existing device, use oracle.lite.resource.User.getDeviceByName() or oracle.lite.resource.ResourceManager.getDevice()

Parameters:

name - Device name

platform - Device platform

type - Device type

Throws:

oracle.lite.resource.ResourceException

ResourceException

Device

public Device(java.lang.String name,
      Platform platform,
      java.lang.String type,
      java.lang.String udid,
      byte[] token,
      java.lang.String pushMagic,
      byte[] unlockToken)

Create a new logic device in the repository.

Parameters:

name - Device name

platform - Device platform

type - Device type

udid - Unique device id

token - push notification token

pushMagic - push notification

unlockToken - send ClearPasscode command

Device

public Device(java.lang.String name,
      java.lang.String type,
      User user)

Create an in memory logical device. This object will not be persisted in the Mobile Server Repository.

Parameters:

name - Device name

type - Device type

user - Device user

Method Detail

addLog

public void addLog(java.lang.String desc,
          java.sql.Timestamp time,
          java.lang.String msg)
            throws ResourceException

Add a new entry in the device log table.

Parameters:

desc - Short description of the log message.

time - Log time

msg - Log message.

Throws:

oracle.lite.resource.ResourceException

ResourceException

canUpdate

public boolean canUpdate()
                  throws ResourceException

Check if this device has enough privilege for software/data update

Throws:

oracle.lite.resource.ResourceException

ResourceException

createAddress

public Address createAddress(java.lang.String addr,
                    java.lang.String provId)
                      throws ResourceException

Create a new address for this device.

Parameters:

addr - Address string (phone number, URL etc)

provId - Id of the Provider (MUST be pre-registered).

Returns:

oracle.lite.resource.Address object.

Throws:

oracle.lite.resource.ResourceException

ResourceException

getAccessCount

public long getAccessCount()

Get access count.

getAccessTime

public java.sql.Timestamp getAccessTime()

Get last access time.

Returns:

java.sql.Timestamp object

getAddress

public Address getAddress(java.lang.String addr)
                   throws ResourceException

Retrieve a device address from the repository. If the value of 'addr' is 'null', this method will retrieve the primary Address.

Parameters:

addr - Address string.

Returns:

Address of the device.

Throws:

oracle.lite.resource.ResourceException

ResourceException

getAddresses

public java.util.Enumeration getAddresses()
                                   throws ResourceException

Retrieve all adresses of this device. If there are multiple adresses, then first 'Address' is the primary address.

Returns:

A java.util.Enumeration object containing all adresses.

Throws:

oracle.lite.resource.ResourceException

ResourceException

getClientId

public java.lang.String getClientId()

Get device generated client id.

Returns:

Client Id String

getCommand

public DeviceCommand getCommand(java.lang.String cmdId)
                         throws ResourceException

Retrieve a specific device command from the repository.

Parameters:

cmdId - Device Command's id

Returns:

oracle.lite.resource.dm.DeviceCommand object

Throws:

oracle.lite.resource.ResourceException

ResourceException

getCommands

public java.util.Vector getCommands()
                             throws ResourceException

Retrieve device command objects from the repository.

Returns:

java.util.Vector object containing all oracle.lite.resource.dm.DeviceCommand objects.

Throws:

oracle.lite.resource.ResourceException

ResourceException

getDirectory

public java.lang.String getDirectory(boolean create)

Retrieve device' directory path. This directory is used to store all the files uploaded from the client device.

Parameters:

create - Create directory name if it does not exist

getLastSequence

public long getLastSequence()

Get last sequence id.

Returns:

long object

getLogs

public java.util.Enumeration getLogs()
                              throws ResourceException

Retrieve Device log from the repository.

Returns:

Enumeraion of all device logs

Throws:

oracle.lite.resource.ResourceException

ResourceException

getName

public java.lang.String getName()

Get device name

getPlatform

public Platform getPlatform()
                     throws ResourceException

Retrieve Platform object

Returns:

oracle.lite.resource.Platform object

Throws:

oracle.lite.resource.ResourceException

ResourceException

getPlatformVersion

public java.lang.String getPlatformVersion()
                                    throws ResourceException

Retrieve current version of the Oracle Lite Platform installed on the device.

Throws:

oracle.lite.resource.ResourceException

ResourceException

getPushMagic

public java.lang.String getPushMagic()

getQueuedMessages

public java.util.Vector getQueuedMessages()
                                   throws ResourceException

Retrieve all queued message for this device.

Returns:

java.util.Vector object containing queued messages.

Throws:

oracle.lite.resource.ResourceException

ResourceException

getServerId

public java.lang.String getServerId()

Get system generated server id.

Returns:

Server Id String

getToken

public byte[] getToken()

getType

public java.lang.String getType()

Retrieve device type.

getUdid

public java.lang.String getUdid()

getUnlockToken

public byte[] getUnlockToken()

getUser

public User getUser()
             throws ResourceException

Return owner 'User' object. This value may be 'null' if the device is not assigned to any user.

Throws:

ResourceException

getUserId

public java.lang.String getUserId()

Get User Id (or device Owner's Id).

Returns:

User Id

isType

public boolean isType(java.lang.String type)

Check if the device type matches given type.

Parameters:

type - Type string to be checked

queueMessage

public void queueMessage(java.lang.String msg,
                java.lang.String type,
                long expire)
                  throws ResourceException

Put a message in the device queue. Client device will de-queue messages from time to time.

Parameters:

msg - Message string

type - Message type

expire - Expiration time (in minutes)

Throws:

oracle.lite.resource.ResourceException

ResourceException

resetDeviceSeqHistory

public void resetDeviceSeqHistory(long seq)

Parameters:

seq -

saveProfile

public void saveProfile(java.lang.String name,
               byte[] value)

Save profile information in the repository. All the profile information are name/value pairs.

Parameters:

name - Name of the profile information

value - Profile information as an array of bytes

setAccessTime

public void setAccessTime()
                   throws ResourceException

Modifiy the last access time of the device.

Throws:

ResourceException

setAccessTime

public void setAccessTime(java.lang.String ver)
                   throws ResourceException

Modifiy the last access time of the device.

Parameters:

ver - Oracle Lite version number

Throws:

oracle.lite.resource.ResourceException

ResourceException

setEnabled

public void setEnabled(boolean val)
                throws ResourceException

Enable or Disable device object.

Overrides:

setEnabled in class Resource

Parameters:

val - true to enable the device

Throws:

oracle.lite.resource.ResourceException

ResourceException

setName

public void setName(java.lang.String name)
             throws ResourceException

Set a new device name. Caller must call 'save' method to persist the information.

Parameters:

name - Device name

Throws:

oracle.lite.resource.ResourceException

ResourceException

setPlatform

public void setPlatform(Platform platform)
                 throws ResourceException

Set Platform for this device.

Parameters:

platform - Platform object

Throws:

oracle.lite.resource.ResourceException

ResourceException

setPrimaryAddress

public void setPrimaryAddress(Address addr)
                       throws ResourceException

Set the given address as the primary address of the device.

Parameters:

addr - oracle.lite.resource.Address object.

Throws:

oracle.lite.resource.ResourceException

ResourceException

setPushMagic

public void setPushMagic(java.lang.String pm)

setTemporary

public void setTemporary()

Temporariliy enable the device. This method will not persist the device status.

setToken

public void setToken(byte[] token)

setType

public void setType(java.lang.String type)
             throws ResourceException

Change device type. Caller must call 'save' method to persist the change.

Parameters:

type - Device type string

Throws:

ResourceException

setUdid

public void setUdid(java.lang.String udid)

setUnlockToken

public void setUnlockToken(byte[] ut)

updateType

public boolean updateType()

Update the device type if the curernt platform is obsoleted. This wraps around the setType(platform) call. If an exception is thrown internally, return false,

validate

public void validate()
              throws ResourceException

Check if the device is enabled or not. For a device to be considered as 'enabled', the device must be valid and enabled.

Throws:

ResourceException - if device is not enabled.

ResourceException

verifyRequest

public boolean verifyRequest(long time,
                    java.lang.String agent,
                    java.lang.String ctxt)

Check if the request is valid or not.

Parameters:

time - Request time

agent - Name of the request originator

ctxt - Context Id of the request Modifiy the last access time of the device.

verifyRequest

public boolean verifyRequest(long currentSeq,
                    java.lang.String agent,
                    java.lang.String ctxt,
                    boolean seqBased)