oracle.panama.portal
Class DeviceController

java.lang.Object
oracle.panama.portal.DeviceController

All Implemented Interfaces:

java.io.Serializable

public class DeviceController

extends java.lang.Object

implements java.io.Serializable

DeviceController handles User's Device management

See Also:

Serialized Form

Field Summary

static java.lang.String[][]	CONFIG_ATTRIB_NAMES
static java.lang.String	CONTROLNUMBER Key for retrieving is-default value from the alert device parameter Hashtable passing to/from the portal pages.
static java.lang.String	DELIVERYTYPE Key for retrieving address device type from the alert device parameter Hashtable passing to/from the portal pages.
static java.lang.String	DEVICEADDRESS Key for retrieving address value from the alert device parameter Hashtable passing to/from the portal pages.
static java.lang.String	DEVICEAPD Key for retrieving alerts-per-day value from the alert device parameter Hashtable passing to/from the portal pages.
static java.lang.String	DEVICECARRIER Key for retrieving carrier value from the alert device parameter Hashtable passing to/from the portal pages.
static java.lang.String	DEVICEDEFAULT Key for retrieving is-default value from the alert device parameter Hashtable passing to/from the portal pages.
static java.lang.String	DEVICEDEPEND Key for retrieving hasDepandency value from the alert device parameter Hashtable passing to/from the portal pages.
static java.lang.String	DEVICEID Key for retrieving validated value from the alert device parameter Hashtable passing to/from the portal pages.
static java.lang.String	DEVICEMODEL Key for retrieving model value from the alert device parameter Hashtable passing to/from the portal pages.
static java.lang.String	DEVICENAME Key for retrieving device name from the parameter Hashtable passing to/from the portal pages.
static java.lang.String	DEVICEVALIDATED Key for retrieving validated value from the alert device parameter Hashtable passing to/from the portal pages.
static java.lang.String	TESTMESSAGE Key for retrieving is-default value from the alert device parameter Hashtable passing to/from the portal pages.
static java.lang.String	WAP_ACCESS Key for retrieving validated value from the alert device parameter Hashtable passing to/from the portal pages.
static java.lang.String	WAP_AUTHTYPE Key for retrieving validated value from the alert device parameter Hashtable passing to/from the portal pages.
static java.lang.String	WAP_BEARER Key for retrieving validated value from the alert device parameter Hashtable passing to/from the portal pages.
static java.lang.String	WAP_CALLTYPE Key for retrieving validated value from the alert device parameter Hashtable passing to/from the portal pages.
static java.lang.String	WAP_GATEWAYIP Key for retrieving validated value from the alert device parameter Hashtable passing to/from the portal pages.
static java.lang.String	WAP_GATEWAYPORT Key for retrieving validated value from the alert device parameter Hashtable passing to/from the portal pages.
static java.lang.String	WAP_HOMEPAGE Key for retrieving validated value from the alert device parameter Hashtable passing to/from the portal pages.
static java.lang.String	WAP_ISP Key for retrieving validated value from the alert device parameter Hashtable passing to/from the portal pages.
static java.lang.String	WAP_ISP_PASSWORD Key for retrieving validated value from the alert device parameter Hashtable passing to/from the portal pages.
static java.lang.String	WAP_ISP_USERNAME Key for retrieving validated value from the alert device parameter Hashtable passing to/from the portal pages.
static java.lang.String	WAP_MODEL Key for retrieving validated value from the alert device parameter Hashtable passing to/from the portal pages.
static java.lang.String	WAP_PROFILE Key for retrieving validated value from the alert device parameter Hashtable passing to/from the portal pages.
static java.lang.String	WAP_PROXYTYPE Key for retrieving validated value from the alert device parameter Hashtable passing to/from the portal pages.
static java.lang.String	WAP_SECURE Key for retrieving validated value from the alert device parameter Hashtable passing to/from the portal pages.
static java.lang.String	WAP_SERVICECODE Key for retrieving validated value from the alert device parameter Hashtable passing to/from the portal pages.
static java.lang.String	WAP_SMSCADDRESS Key for retrieving validated value from the alert device parameter Hashtable passing to/from the portal pages.
static java.lang.String	WAP_SPEED Key for retrieving validated value from the alert device parameter Hashtable passing to/from the portal pages.
static java.lang.String	WAP_TIMEOUT Key for retrieving validated value from the alert device parameter Hashtable passing to/from the portal pages.

Method Summary

DeviceAddress	createNewDeviceAddress(java.lang.String name, java.lang.String address, java.lang.String deliveryTypeIdStr, Request apiRequest) create a new device address.
void	deleteDeviceAddress(long deviceAddressId) delete a device address
void	disableAllAlerts(Request apiRequest, long deviceId) disable all AlertServiceSubscriptions using this device
void	disableUserAlertSubscriptions(oracle.panama.alert.AlertService alertService, User user) disable User's AlertServiceSubscriptions on an AlertService
void	doWapProvisioning(Request apiRequest, long deviceId, java.util.Hashtable pAttrs) Wap device provisioning
DeliveryType[]	getAllDeliveryTypes() Get all of the delivery types
static DeliveryType	getDeliveryType(long deviceId) Get DeliveryType object by the object ID
static DeviceController	getInstance() The singleton thread-safe getter.
java.util.Hashtable	getWapProvisionProfiles(Request apiRequest) Get the Wap device provisioning profiles
boolean	hasAlertDependency(Request apiRequest, long deviceId) check if there's any alert service using this device
DeliveryType	lookupDeliveryType(int deliveryTypeIntVal) Lookup DeliveryType object by the DeliveryType integer value
DeviceAddress	lookupDeviceAddress(long deviceAddressId) lookup a device address
java.lang.String	sendValidationMessage(long deviceAddressId, java.lang.String subjectText, java.lang.String messageText) Send validation messages to specified DeviceAddress
void	setParameters(long deviceAddressId, java.util.Hashtable paramHash) set parameter values of a device address.
boolean	validate(long deviceAddressId, java.lang.String controlNumberStr) Validate the specified DeviceAddress with the control number

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

CONFIG_ATTRIB_NAMES

public static final java.lang.String[][] CONFIG_ATTRIB_NAMES

CONTROLNUMBER

public static final java.lang.String CONTROLNUMBER

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

See Also:

Constant Field Values

DELIVERYTYPE

public static final java.lang.String DELIVERYTYPE

Key for retrieving address device type from the alert device parameter Hashtable passing to/from the portal pages.

See Also:

Constant Field Values

DEVICEADDRESS

public static final java.lang.String DEVICEADDRESS

Key for retrieving address value from the alert device parameter Hashtable passing to/from the portal pages.

See Also:

Constant Field Values

DEVICEAPD

public static final java.lang.String DEVICEAPD

Key for retrieving alerts-per-day value from the alert device parameter Hashtable passing to/from the portal pages.

See Also:

Constant Field Values

DEVICECARRIER

public static final java.lang.String DEVICECARRIER

Key for retrieving carrier value from the alert device parameter Hashtable passing to/from the portal pages.

See Also:

Constant Field Values

DEVICEDEFAULT

public static final java.lang.String DEVICEDEFAULT

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

See Also:

Constant Field Values

DEVICEDEPEND

public static final java.lang.String DEVICEDEPEND

Key for retrieving hasDepandency value from the alert device parameter Hashtable passing to/from the portal pages.

See Also:

Constant Field Values

DEVICEID

public static final java.lang.String DEVICEID

Key for retrieving validated value from the alert device parameter Hashtable passing to/from the portal pages.

See Also:

Constant Field Values

DEVICEMODEL

public static final java.lang.String DEVICEMODEL

Key for retrieving model value from the alert device parameter Hashtable passing to/from the portal pages.

See Also:

Constant Field Values

DEVICENAME

public static final java.lang.String DEVICENAME

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

See Also:

Constant Field Values

DEVICEVALIDATED

public static final java.lang.String DEVICEVALIDATED

Key for retrieving validated value from the alert device parameter Hashtable passing to/from the portal pages.

See Also:

Constant Field Values

TESTMESSAGE

public static final java.lang.String TESTMESSAGE

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

See Also:

Constant Field Values

WAP_ACCESS

public static final java.lang.String WAP_ACCESS

Key for retrieving validated value from the alert device parameter Hashtable passing to/from the portal pages.

See Also:

Constant Field Values

WAP_AUTHTYPE

public static final java.lang.String WAP_AUTHTYPE

Key for retrieving validated value from the alert device parameter Hashtable passing to/from the portal pages.

See Also:

Constant Field Values

WAP_BEARER

public static final java.lang.String WAP_BEARER

Key for retrieving validated value from the alert device parameter Hashtable passing to/from the portal pages.

See Also:

Constant Field Values

WAP_CALLTYPE

public static final java.lang.String WAP_CALLTYPE

Key for retrieving validated value from the alert device parameter Hashtable passing to/from the portal pages.

See Also:

Constant Field Values

WAP_GATEWAYIP

public static final java.lang.String WAP_GATEWAYIP

Key for retrieving validated value from the alert device parameter Hashtable passing to/from the portal pages.

See Also:

Constant Field Values

WAP_GATEWAYPORT

public static final java.lang.String WAP_GATEWAYPORT

Key for retrieving validated value from the alert device parameter Hashtable passing to/from the portal pages.

See Also:

Constant Field Values

WAP_HOMEPAGE

public static final java.lang.String WAP_HOMEPAGE

Key for retrieving validated value from the alert device parameter Hashtable passing to/from the portal pages.

See Also:

Constant Field Values

WAP_ISP

public static final java.lang.String WAP_ISP

Key for retrieving validated value from the alert device parameter Hashtable passing to/from the portal pages.

See Also:

Constant Field Values

WAP_ISP_PASSWORD

public static final java.lang.String WAP_ISP_PASSWORD

Key for retrieving validated value from the alert device parameter Hashtable passing to/from the portal pages.

See Also:

Constant Field Values

WAP_ISP_USERNAME

public static final java.lang.String WAP_ISP_USERNAME

Key for retrieving validated value from the alert device parameter Hashtable passing to/from the portal pages.

See Also:

Constant Field Values

WAP_MODEL

public static final java.lang.String WAP_MODEL

Key for retrieving validated value from the alert device parameter Hashtable passing to/from the portal pages.

See Also:

Constant Field Values

WAP_PROFILE

public static final java.lang.String WAP_PROFILE

Key for retrieving validated value from the alert device parameter Hashtable passing to/from the portal pages.

See Also:

Constant Field Values

WAP_PROXYTYPE

public static final java.lang.String WAP_PROXYTYPE

Key for retrieving validated value from the alert device parameter Hashtable passing to/from the portal pages.

See Also:

Constant Field Values

WAP_SECURE

public static final java.lang.String WAP_SECURE

Key for retrieving validated value from the alert device parameter Hashtable passing to/from the portal pages.

See Also:

Constant Field Values

WAP_SERVICECODE

public static final java.lang.String WAP_SERVICECODE

Key for retrieving validated value from the alert device parameter Hashtable passing to/from the portal pages.

See Also:

Constant Field Values

WAP_SMSCADDRESS

public static final java.lang.String WAP_SMSCADDRESS

Key for retrieving validated value from the alert device parameter Hashtable passing to/from the portal pages.

See Also:

Constant Field Values

WAP_SPEED

public static final java.lang.String WAP_SPEED

Key for retrieving validated value from the alert device parameter Hashtable passing to/from the portal pages.

See Also:

Constant Field Values

WAP_TIMEOUT

public static final java.lang.String WAP_TIMEOUT

Key for retrieving validated value from the alert device parameter Hashtable passing to/from the portal pages.

See Also:

Constant Field Values

Method Detail

createNewDeviceAddress

public DeviceAddress createNewDeviceAddress(java.lang.String name,
                                            java.lang.String address,
                                            java.lang.String deliveryTypeIdStr,
                                            Request apiRequest)
                                     throws PortalException

create a new device address.

Parameters:

name - new device address name.

apiRequest - current validated Request.

Throws:

PortalException

deleteDeviceAddress

public void deleteDeviceAddress(long deviceAddressId)
                         throws PortalException

delete a device address

Parameters:

deviceAddressId - deleted device address ID.

Throws:

PortalException

disableAllAlerts

public void disableAllAlerts(Request apiRequest,
                             long deviceId)
                      throws PortalException

disable all AlertServiceSubscriptions using this device

Parameters:

apiRequest - current validated Request.

deviceId - DeviceAddress object ID.

Throws:

PortalException

disableUserAlertSubscriptions

public void disableUserAlertSubscriptions(oracle.panama.alert.AlertService alertService,
                                          User user)

disable User's AlertServiceSubscriptions on an AlertService

Parameters:

alertService - AlertService object.

user - User object.

doWapProvisioning

public void doWapProvisioning(Request apiRequest,
                              long deviceId,
                              java.util.Hashtable pAttrs)

Wap device provisioning

Parameters:

apiRequest - current validated Request.

deviceId - DeviceAddress object ID.

pAttrs - values for all the message attributes.

getAllDeliveryTypes

public DeliveryType[] getAllDeliveryTypes()
                                   throws PortalException

Get all of the delivery types

Returns:

array of supported DeliveryType objects.

Throws:

PortalException

getDeliveryType

public static DeliveryType getDeliveryType(long deviceId)

Get DeliveryType object by the object ID

Returns:

DeliveryType object.

getInstance

public static DeviceController getInstance()

The singleton thread-safe getter.

Returns:

the DeviceController singleton interface.

getWapProvisionProfiles

public java.util.Hashtable getWapProvisionProfiles(Request apiRequest)

Get the Wap device provisioning profiles

Parameters:

apiRequest - current validated Request.

hasAlertDependency

public boolean hasAlertDependency(Request apiRequest,
                                  long deviceId)
                           throws PortalException

check if there's any alert service using this device

Parameters:

apiRequest - current validated Request.

deviceId - DeviceAddress object ID.

Returns:

true : has dependencies, false: no dependency

Throws:

PortalException

lookupDeliveryType

public DeliveryType lookupDeliveryType(int deliveryTypeIntVal)
                                throws PortalException

Lookup DeliveryType object by the DeliveryType integer value

Parameters:

deliveryTypeIntVal - DeliveryType integer value.

Returns:

DeliveryType object.

Throws:

PortalException

lookupDeviceAddress

public DeviceAddress lookupDeviceAddress(long deviceAddressId)
                                  throws PortalException

lookup a device address

Parameters:

deviceAddressId - device address ID.

Throws:

PortalException

sendValidationMessage

public java.lang.String sendValidationMessage(long deviceAddressId,
                                              java.lang.String subjectText,
                                              java.lang.String messageText)
                                       throws PortalException

Send validation messages to specified DeviceAddress

Parameters:

deviceAddressId - DeviceAddress object ID.

messageText - message to be sent.

Returns:

the sent message string

Throws:

PortalException

setParameters

public void setParameters(long deviceAddressId,
                          java.util.Hashtable paramHash)
                   throws PortalException

set parameter values of a device address.

Parameters:

deviceAddressId - queried device address ID.

paramHash - parameter name-value Hashtable to update

Throws:

PortalException

validate

public boolean validate(long deviceAddressId,
                        java.lang.String controlNumberStr)
                 throws PortalException

Validate the specified DeviceAddress with the control number

Parameters:

deviceAddressId - DeviceAddress object ID.

controlNumberStr - control number.

Returns:

true : succeeded, false: failed

Throws:

PortalException