public class UDProxyDevice extends java.lang.Object implements IUpdateHandler
UDProxyDevice
is the proxy between the client
and ISY.
All operations to be performed on ISY must use the methods implemented herein to assure consistent behavior.
Modifier and Type | Field and Description |
---|---|
static char |
ADD_NODE_AND_CRAWL_NO_LINKS
Used as the 4th parameter in
addNode(String, String, String, char)
to signify that the newly added device shall
Retain all its links and
New devices shall be added based on those links as necessary
Groups/Scenes shall not be created based on the found links |
static char |
ADD_NODE_AND_CRAWL_WITH_LINKS
Used as the 4th parameter in
addNode(String, String, String, char)
to signify that the newly added device shall
Retain all its links and
New devices shall be added based on those links as necessary and
Every newly found device shall be scanned till all links are exhausted
Groups/Scenes shall be created based on the found links |
static char |
ADD_NODE_AND_RESET
Used as the 4th parameter in
addNode(String, String, String, char)
to signify that the newly added device shall be reset and overwritten
with new values/links |
java.util.Hashtable<java.lang.String,UDControl> |
controls
A
Hashtable of all the controls |
static char |
DISCOVER_NODE_AND_CRAWL_NO_LINKS
Used as the parameter in
cancelNodesDiscovery(char)
to signify that the newly linked device shall
Retain all its links and
New devices shall be added based on those links as necessary
Groups/Scenes shall not be created based on the found links |
static char |
DISCOVER_NODE_AND_CRAWL_WITH_LINKS
Used as parameter in
cancelNodesDiscovery(char)
to signify that the newly linked device shall
Retain all its links and
New devices shall be added based on those links as necessary and
Every newly found device shall be scanned till all links are exhausted
Groups/Scenes are created based on those links |
static char |
DISCOVER_NODE_AND_RESET
Used as the parameter in
cancelNodesDiscovery(char)
to signify that the newly linked device shall be reset and overwritten
with new values/links |
static char |
DISCOVER_NODE_FAMILY_RCS_ZIGBEE |
static char |
DISCOVER_NODE_FAMILY_ZWAVE_EXCLUDE
Used as the 4th parameter in
addNode(String, String, String, char)
to start excluding Z-Wave devices, and removing them from ISY if they exist. |
static char |
DISCOVER_NODE_FAMILY_ZWAVE_INCLUDE
Used as the 4th parameter in
addNode(String, String, String, char)
to start including/adding Z-Wave devices to the ISY. |
boolean |
isAuthenticated
Whether or not a session has been created and
authenticated.
|
boolean |
isOnline
Whether or not the device is on line
|
java.util.Hashtable<java.lang.String,UDNode> |
nodes
A
Hashtable of all the nodes (not groups/scenes)
associated/linked to ISY. |
static char |
RESTORE_CONF_FILES_ONLY
Used for UD Presentation Layer functionality only
|
static char |
RESTORE_NETWORK_WITH_LINKS
Used as the parameter in
restoreDevicesFromNodes(char)
to signify that groups/scenes will be regenerated from the logical
representations stored in ISY |
static char |
RESTORE_NETWORK_WITHOUT_LINKS
Used as the parameter in
restoreDevicesFromNodes(char)
to signify that groups/scenes will not be re-generated from the logical
representations stored in ISY. |
short |
securityLevel
UPnP Security levels which may be any of the following:
UPnPSecurity.NO_SECURITY UPnPSecurity.SECURITY_LEVEL_1 - clear text authentication, with xml signaturesUPnPSecurity.SECURITY_LEVEL_2 - encrypted (bulk key) authentication, with xml signaturesUPnPSecurity.SECURITY_LEVEL_3 - RSA cryptography with xml signatures |
UPnPSecurity |
upnpSecurity
The
UPnPSecurity object which handles all
UPnPSecurity transformations |
java.lang.String |
uuid
The uuid (uniquely identies the ISY on the network) of
ISY
|
Constructor and Description |
---|
UDProxyDevice(java.lang.String uuid,
java.lang.String descriptionURL,
UDDeviceStateListener deviceListener)
Constructor
|
UDProxyDevice(UDDeviceStateListener deviceListener)
Constructor
Called by
UDControlPoint when a new device is discovered |
Modifier and Type | Method and Description |
---|---|
boolean |
addDDNSHost(java.lang.String host,
java.lang.String ip) |
boolean |
addFolder(java.lang.String address,
java.lang.String name)
Adds a
UDFolder to ISY |
boolean |
addGroup(java.lang.String address,
java.lang.String name,
char flag)
Adds a
UDGroup to ISY |
boolean |
addNode(java.lang.String newAddress,
java.lang.String newName,
java.lang.String type,
char flag)
Adds a
UDNode to ISY |
boolean |
addNode(java.lang.String newAddress,
java.lang.String newName,
java.lang.String type,
java.lang.String family,
char flag)
Adds a
UDNode to ISY |
boolean |
addUserFile(java.lang.String path,
byte[] image) |
boolean |
authenticate(java.lang.String userid,
java.lang.String pwd)
Authenticates a userid/password pair with ISY.
|
boolean |
cancelNodesDiscovery(char action)
Cancels
UDNode discovery. |
boolean |
cancelNodesDiscovery(char action,
java.lang.String family)
Cancels
UDNode discovery. |
boolean |
clearConfiguration()
Deletes all the configuration files within ISY
|
boolean |
clearLastError() |
void |
clearSubscriptionID()
Clears the subscription id.
|
boolean |
configure()
Configures this object
|
boolean |
configureSecuritySystem(java.lang.String name,
java.lang.StringBuffer diml)
Configures an attached security system
|
boolean |
deleteFile(java.lang.String path,
IUpdaterClient view) |
boolean |
discoverNodes(java.lang.String type)
Starts
UDNode discovery. |
boolean |
discoverNodes(java.lang.String type,
char action)
Starts
UDNode discovery. |
boolean |
discoverNodes(java.lang.String type,
char action,
java.lang.String family)
Starts
UDNode discovery. |
boolean |
ensureSubscription() |
boolean |
expireSessionKeys()
Expires the session keys
|
boolean |
getAlgorithmsAndProtocols()
Gets supported security paramters
|
boolean |
getAllTriggerStatus(java.lang.String key,
com.universaldevices.common.xml.UDXmlParser parser) |
java.lang.String |
getApplication()
Returns the application name
|
java.lang.String |
getAppVersion()
Returns the application version
|
java.lang.String |
getArchivePath()
Returns the archive url
|
UDAutoUpdate.UDPlatform |
getAutoUpdateCode()
Returns the Update Code (for upgrades) if any
|
java.lang.String |
getBuildTimestamp()
Returns the firmware build timestamp
|
java.lang.String |
getContentList(java.lang.String path,
java.lang.String ext,
boolean summaryOnly)
Returns the summary of all content list entries for a given directory/fileExtension pair
|
DDNSHost |
getDDNSHost() |
java.lang.String |
getDebugLevel()
Returns the debug level which is used in the event viewer
|
java.lang.String |
getDescriptionURL() |
java.lang.String |
getDevicetype()
Returns ISY's device type
|
int |
getDriverVersion(java.lang.String driverName)
Return the current version for a given driver.
|
java.lang.String |
getErrorLog()
Returns ISY's current error log file
|
java.lang.String |
getExternalURL()
Returns ISY's external URL
|
java.lang.String |
getFile(java.lang.StringBuffer url)
Gets a file using REST
|
FileSystemStat |
getFileSystemStatus() |
java.lang.Object |
getFloorPlan()
Retrieves the floor plan from ISY
|
java.lang.String |
getFriendlyName()
Returns ISY's friendly name
|
java.net.InetSocketAddress |
getHostAddress()
Returns ISY's host address
|
java.lang.String |
getHostName()
Returns ISY's Host name String
|
java.lang.String |
getIcon()
Returns the application's Icon url
|
java.lang.String |
getInternalURL()
Returns ISY's Local/LAN URL
|
java.lang.Boolean |
getIsSubscribed() |
java.lang.String |
getISYConfig()
Convenience method:
Returns the ISY configuration as a string |
java.lang.String |
getIsyStartupTime() |
protected long |
getLastAlive()
Returns the last communications time with ISY
|
LastError |
getLastError() |
boolean |
getLifetimeSequenceBase()
Gets the LifeTimeSequenceBase from ISY
|
java.lang.String |
getLog()
Returns ISY's current log file
|
java.lang.String |
getMake()
Returns the application's make
|
java.lang.String |
getManufacturerURL()
Returns the application's manufacturer URL
|
protected int |
getMaxAge()
Returns the max age for this proxy
|
int |
getMaxSSLStrength() |
java.lang.String |
getModel()
Returns the application's model
|
NetworkConfig |
getNetworkConfig() |
java.lang.String |
getNetworkName()
Returns the network name
|
UDNode |
getNode(java.lang.String id)
Retrieves a
UDNode based on the given node address (String) |
boolean |
getNodeDeviceProperties(java.lang.String nodeAddr)
Gets Node Device Properties for the given node, using the registered parser.
|
boolean |
getNodeDeviceProperties(java.lang.String node,
UDNodeDevicePropertiesParser parser)
Retrieves the device properties for the given node
|
UDNodeProperties |
getNodeProperties(java.lang.String node)
Retrieves the node properties for the given node
|
java.lang.String |
getNodesConfig()
Convenience method:
Returns the nodes configuration as a string |
int |
getNumNotifications()
Deprecated.
|
boolean |
getNumPendingNotifications()
Deprecated.
|
java.lang.String |
getPlatform()
Returns the application's platform
|
UDNode |
getPrimaryNode(java.lang.String id)
Retrieves the primary
UDNode based on the given node address
for any node defined for the device. |
java.lang.String |
getProductDescription()
Returns the product description.
|
int |
getProductId()
Returns the product ID.
|
ProductInfo |
getProductInfo() |
com.universaldevices.device.model.programs.UDPrograms |
getPrograms() |
boolean |
getPublicKeys()
Retrieves the RSA Public Keys from ISY
|
UDNode |
getRootNode() |
java.lang.String |
getSCPDURL()
Returns UPnP's Service Descripton
|
java.lang.String |
getSecuritySystemConfig(java.lang.String name)
Returns the configuration for an attached security system
|
java.lang.String |
getSecuritySystemURLs(java.lang.String name)
Returns a diml representation of all the configured URLs to access an attached security
system |
java.lang.String |
getServiceType()
Returns the service type
|
com.universaldevices.model.notifications.SMTPConfig |
getSMTPConfig()
Retrieves the currently set
SMTPConfig in
ISY |
java.lang.String |
getSubscriptionID()
Returns the subscription id
|
java.lang.String |
getSystemConfiguration()
Returns a UDML/DIML list of all the ISY system configuration
|
java.lang.String |
getSystemConfiguration(java.lang.String path,
java.lang.String pattern)
Returns a UDML/DIML list of all the ISY system configuration
|
byte[] |
getSystemConfigurationFile(java.lang.String name)
Returns the contents of an ISY system configuration file
|
com.universaldevices.common.datetime.DateTime |
getSystemDateTime()
Returns ISY's system date/time related attributes
|
SystemOptions |
getSystemOptions()
Retrieves the currently set
SystemOptions in
ISY |
SystemStatus |
getSystemStatus()
Returns ISY's system status
|
UDControl |
getSysUpdateControl()
Returns the
UDControl for system updates |
java.net.URL |
getURLBase()
Returns ISY's URL base
|
java.lang.String |
getUserDirectoryListing(java.lang.String path,
java.lang.String pattern)
Returns directory listings for the user directory
|
java.lang.String |
getUserDirectoryListing(java.lang.String path,
java.lang.String pattern,
boolean recursive)
Returns directory listings for the user directory
|
byte[] |
getUserFile(java.lang.String name)
Returns the contents of an ISY user configuration file
|
java.lang.String |
getVariables(int varType)
Sets the debug level which is used in the event viewer
|
boolean |
installModule(java.lang.String mid)
Install the given Module from ISY's configuration.
|
boolean |
internetAccess(char flag)
Enables/disables internet access
|
boolean |
is27Compliant() |
boolean |
is28Compliant() |
boolean |
is310Compliant() |
boolean |
isClientAuthenticated()
Returns true if the client is authenticated
|
boolean |
isCommunicatable()
Returns true if we can still communicate with ISY
|
boolean |
isD2dEnabled()
Returns true if triggers are enabled
|
boolean |
isDDNSHostAvailable(java.lang.String host) |
boolean |
isDefaultCert() |
boolean |
isDeviceInDiscoveryMode()
Returns true if in discovery mode
|
boolean |
isDisclaimerAgreedTo() |
boolean |
isElk2() |
boolean |
isIrEnabled()
Returns true if IR is enabled
|
boolean |
isIsy26()
Returns true if the box is an ISY 26.
|
boolean |
isIsy99()
Returns true if the box is an ISY 99.
|
boolean |
isIsyPro()
Returns true if the box is a PRO version of the ISY.
|
boolean |
isPortalClient() |
boolean |
isRemotelyAccessed() |
protected boolean |
isResetting()
Returns true if ISY is in the process of rebooting
|
boolean |
isSecurityEnabled() |
boolean |
isSubscribed() |
boolean |
isTLSSupported() |
boolean |
isUsingSSL() |
boolean |
isViewable()
Library Internal use only
|
boolean |
loadTriggers(java.lang.StringBuffer key,
com.universaldevices.common.xml.UDXmlParser parser)
Returns all triggers
|
void |
lostSession()
Handles session loss clean up
|
boolean |
makeUserDirectory(java.lang.String path)
Makes a user directory
|
boolean |
manageModules()
Manages the modules which have to be either installed/uninstalled
|
boolean |
moveNode(java.lang.String id,
java.lang.String gid,
char flag)
|
boolean |
moveUserObject(java.lang.String oldName,
java.lang.String newName)
Renames or moves a user object including a directory
|
protected void |
offLine()
ISY no longer reachable
|
protected void |
onLine()
ISY is on line
|
static boolean |
processDescriptionURL(java.lang.String url,
UDProxyDevice dev) |
static boolean |
processDescriptionURL(java.lang.String url,
UDProxyDevice dev,
boolean show_error) |
boolean |
processSecurityRequest(java.lang.String request_type,
java.lang.String security_code)
Processes a security system request (if one is attached); the parameters
for this method are all security system specific. |
boolean |
proveSubscription()
Forces a heartbeat message to be sent back through our subscription, proving
definitively that the subscription is active.
|
boolean |
queryAll()
Queries the whole network
|
boolean |
queryAll(java.lang.String address,
boolean isGroup)
|
boolean |
reboot(java.lang.String code)
Reboots ISY;
|
boolean |
refreshNodes()
Refreshes the node/group structure
|
boolean |
removeDDNSHost(java.lang.String host) |
boolean |
removeFolder(java.lang.String id)
Permanently removes a
UDFolder from ISY |
boolean |
removeFromGroup(java.lang.String id,
java.lang.String gid)
|
boolean |
removeGroup(java.lang.String id)
Permanently removes a
UDGroup from ISY |
boolean |
removeModem()
Removes the Modem attached to ISY
|
boolean |
removeNode(java.lang.String address)
Permanently removes a
UDNode from ISY |
boolean |
removeUserDirectory(java.lang.String path,
boolean deleteContentsOnly)
Removes a user directory
|
boolean |
removeUserObject(java.lang.String path,
boolean isFolder)
Removes a user file or directory
|
boolean |
renameFolder(java.lang.String address,
java.lang.String newName)
Renames a
UDFolder in ISY |
boolean |
renameGroup(java.lang.String address,
java.lang.String newName)
Renames a
UDGroup in ISY |
boolean |
renameNetwork(java.lang.String name)
Renames the network
|
boolean |
renameNode(java.lang.String address,
java.lang.String newName)
Renames a
UDNode in ISY |
boolean |
replaceDevice(java.lang.String oldDevice,
java.lang.String newDevice,
java.lang.String newFirmware)
Replaces the oldDevice with the newDevice
|
boolean |
replaceModem()
Replaces the Modem attached to ISY
|
IUpdaterResponse |
requestProgramUpdate(java.lang.String path,
int content_len)
Prepares for a file update
|
IUpdaterResponse |
requestProgramUpdate(java.lang.String path,
int content_len,
char flag) |
IUpdaterResponse |
requestUserFileUpdate(java.lang.String path,
int content_len) |
boolean |
resetAllNotifications()
Resets any pending notifications
|
boolean |
resetErrorLog()
Completely resets ISY's error log
|
boolean |
resetLog()
Completely resets ISY's log
|
boolean |
restoreDeviceFromNode(java.lang.String id)
Restores the physical device from the logical node configured within ISY.
|
boolean |
restoreDevicesFromNodes(char flag)
Restores physical devices from the logical nodes configured within ISY.
|
boolean |
restoreLink(java.lang.String ctlNodeId,
java.lang.String rspNodeId)
Restores the link data to between the controller and responder.
|
boolean |
restoreNodesFromDevice(java.lang.String id)
Restores the nodes based on the information in the physical device.
|
boolean |
saveAndProcessSystemConfigurationFile(java.lang.String name,
java.lang.String content)
Saves the contents of an ISY system configuration file and processes it
|
boolean |
saveFloorPlan(java.lang.StringBuffer diml)
Saves the floor plan to ISY
|
boolean |
saveNodeProperties(java.lang.String address,
java.lang.StringBuffer diml)
Saves the node properties to ISY
|
boolean |
saveSystemConfigurationFile(java.lang.String name,
byte[] image) |
boolean |
saveSystemConfigurationFile(java.lang.String name,
java.lang.String content)
Saves the contents of an ISY system configuration file
|
boolean |
saveSystemConfigurationFile(java.lang.String name,
java.lang.String content,
char flag) |
boolean |
saveSystemConfigurationImage(java.lang.String name,
byte[] image,
char flag) |
boolean |
saveTrigger(java.lang.String key,
int id,
java.lang.StringBuffer pgm)
Saves a D2D trigger program in ISY
|
boolean |
sendD2DCommand(java.lang.String key,
java.lang.String cmd,
int id) |
boolean |
sendD2DCommand(java.lang.String key,
java.lang.String cmd,
int id,
java.lang.String xml) |
boolean |
sendD2DCommand(java.lang.String key,
java.lang.String cmd,
java.lang.String mask) |
boolean |
sendD2DCommandLongTimeout(java.lang.String key,
java.lang.String cmd,
java.lang.String mask) |
java.lang.Object |
sendDeviceSpecific(java.lang.String command,
java.lang.String node,
java.lang.String option,
char flag,
java.lang.StringBuffer specs)
Supports Device specific services
|
java.lang.Object |
sendDeviceSpecific(java.lang.String command,
java.lang.String node,
java.lang.String param1,
java.lang.String param2,
java.lang.String param3,
java.lang.StringBuffer specs)
Supports Device specific services
|
boolean |
sendTestEmail(java.lang.String id)
Sends a test email to check SMTP configuration
|
void |
setAutoUpdateCode(UDAutoUpdate.UDPlatform updateCode)
Sets the Update code
|
boolean |
setBatchMode(int batchMode)
Renames or moves a user object including a directory
|
boolean |
setBatteryDeviceWriteMode(int mode)
Renames or moves a user object including a directory
|
boolean |
setDebugLevel(int level)
Sets the debug level which is used in the event viewer
|
void |
setDescriptionURL(java.lang.String descriptionURL)
Sets the descriptionURL for ISY
|
protected void |
setDeviceInDiscovery(boolean b)
Sets the flag which indicates ISY is in Linking mode
|
boolean |
SetDeviceLinkingMode(char flag)
Sets the device linking mode.
|
boolean |
setDisclaimerAgreedTo() |
void |
setExternalURL(java.lang.String externalURL)
Sets ISY's external URL
|
protected void |
setFriendlyName(java.lang.String name)
Sets the ISY's friendly name
|
protected void |
setLastAlive(long lastAlive)
Sets the last time ISY was communicated with
|
protected void |
setMaxAge(int max_age)
Sets the max age for this proxy
|
boolean |
setNodeDeviceProperties(java.lang.String xml)
Sets some or all of the device properties for the given node
|
boolean |
setNodeEnabled(java.lang.String node,
boolean b)
Enables/disables a node.
|
boolean |
setNodePowerInfo(java.lang.String node,
int deviceClass,
int wattage,
int dutyCyclePeriod)
Power management functions
|
boolean |
setNTP(SystemOptions conf)
Sets NTP part of the
SystemOptions in
ISY |
protected void |
setNumNotifications(int num)
Deprecated.
|
boolean |
setParent(java.lang.String node,
int nodeType,
java.lang.String parent,
int parentType)
Sets a parent for a node
|
protected void |
setResetting(boolean isResetting)
Sets the flag which indicates that ISY is rebooting/resetting
|
void |
setReuseSocketForSubscription(boolean v) |
boolean |
setSessionKeys()
Creates the session keys
|
boolean |
setSMTPConfig(com.universaldevices.model.notifications.SMTPConfig conf)
Sets the
SMTPConfig in
ISY |
boolean |
setSystemDateTime(com.universaldevices.common.datetime.DateTime dt)
Sets ISY's system date/time/latitude/longitude
|
boolean |
setSystemOptions(SystemOptions conf)
Sets the
SystemOptions in
ISY |
boolean |
setUserCredentials(java.lang.String userid,
java.lang.String pwd)
Sets the main userid/pwd pair for ISY
|
boolean |
setVariable(int varId,
int varType,
int value,
boolean isInitValue)
Sets the debug level which is used in the event viewer
|
void |
setViewable(boolean isViewable)
Library Internal use only
|
void |
Stop()
Stops the services associated with this device
|
boolean |
submitGroupRequest(java.lang.String control,
java.lang.String action,
java.lang.String node)
Submits a group change request
|
boolean |
submitRequest(java.lang.String control,
java.lang.String action,
java.lang.String node) |
boolean |
submitRequest(java.lang.String control,
java.lang.String action,
java.lang.String actionAttrs,
java.lang.String node)
Submits a node change request
|
com.universaldevices.rest.UDRestResponse |
submitRESTRequest(java.lang.String url)
Submits a REST request and returns the results in String
|
boolean |
submitSOAPRequest(java.lang.String soapAction,
java.lang.StringBuffer body)
Submits a raw SOAP request to ISY
|
UDHTTPResponse |
submitSOAPRequest(java.lang.String soapAction,
java.lang.StringBuffer body,
short signatureType,
boolean encrypt,
boolean keep_alive) |
UDHTTPResponse |
submitSOAPRequest(java.lang.String soapAction,
java.lang.StringBuffer body,
short signatureType,
boolean encrypt,
boolean keep_alive,
boolean longTimeout)
Same as submitSOAPRequest without attributes
|
UDHTTPResponse |
submitSOAPRequest(java.lang.String soapAction,
java.lang.StringBuffer body,
java.lang.String attributes,
short signatureType,
boolean encrypt,
boolean keep_alive,
boolean longTimeout) |
UDHTTPResponse |
submitSOAPRequest(java.lang.String serviceName,
java.lang.String soapAction,
java.lang.StringBuffer body,
short signatureType,
boolean encrypt,
boolean keep_alive)
same as above but using a service name
|
UDHTTPResponse |
submitSOAPRequest(java.lang.String serviceName,
java.lang.String soapAction,
java.lang.StringBuffer body,
short signatureType,
boolean encrypt,
boolean keep_alive,
boolean longTimeout)
Same as submitSOAPRequest without attributes
|
UDHTTPResponse |
submitSOAPRequest(java.lang.String serviceName,
java.lang.String soapAction,
java.lang.StringBuffer body,
java.lang.String attributes,
short signatureType,
boolean encrypt,
boolean keep_alive,
boolean longTimeout)
Same as above with the addition of a service name
|
boolean |
submitUDMLRequest(java.lang.String control,
java.lang.String action,
java.lang.String node,
char flag)
Submits a UDML/DIML request to ISY
|
boolean |
submitUDMLRequest(java.lang.String control,
java.lang.String action,
java.lang.String actionAttrs,
java.lang.String node,
char flag) |
void |
subscribeToEvents(boolean reuseSocket)
Subscribes to ISY's events
|
boolean |
supportsErrorDriverControl() |
boolean |
synchWithNTS()
Synchronizes ISY with a Network Time Server
|
byte[] |
testNetworkResource(java.lang.String id,
char flag)
Tests a network resource
|
java.lang.String |
toString()
Simply returns the uuid of this device
|
void |
unsubscribeFromEvents()
Unsubscribes from the ISY events
|
boolean |
uploadFile(java.lang.String path,
byte[] body,
char flag,
IUpdaterClient view)
Uploads a file
|
boolean |
verifyUpdatePackage(java.io.InputStream is,
long size)
Given an inputstream, this method figures out if the update
package containing the inputstream meets the criteria for an
update package for this device
|
boolean |
writeUpdatesToDevice(java.lang.String nodeId)
Writes all pending device data changes to the device (such as new/deleted device links, on levels, etc.)
|
public static char ADD_NODE_AND_RESET
addNode(String, String, String, char)
to signify that the newly added device shall be reset and overwritten
with new values/linkspublic static char ADD_NODE_AND_CRAWL_WITH_LINKS
addNode(String, String, String, char)
to signify that the newly added device shall public static char ADD_NODE_AND_CRAWL_NO_LINKS
addNode(String, String, String, char)
to signify that the newly added device shall public static char DISCOVER_NODE_AND_RESET
cancelNodesDiscovery(char)
to signify that the newly linked device shall be reset and overwritten
with new values/linkspublic static char DISCOVER_NODE_AND_CRAWL_WITH_LINKS
cancelNodesDiscovery(char)
to signify that the newly linked device shall public static char DISCOVER_NODE_AND_CRAWL_NO_LINKS
cancelNodesDiscovery(char)
to signify that the newly linked device shall public static char DISCOVER_NODE_FAMILY_RCS_ZIGBEE
public static char DISCOVER_NODE_FAMILY_ZWAVE_INCLUDE
addNode(String, String, String, char)
to start including/adding Z-Wave devices to the ISY.public static char DISCOVER_NODE_FAMILY_ZWAVE_EXCLUDE
addNode(String, String, String, char)
to start excluding Z-Wave devices, and removing them from ISY if they exist.public static char RESTORE_NETWORK_WITH_LINKS
restoreDevicesFromNodes(char)
to signify that groups/scenes will be regenerated from the logical
representations stored in ISYpublic static char RESTORE_NETWORK_WITHOUT_LINKS
restoreDevicesFromNodes(char)
to signify that groups/scenes will not be re-generated from the logical
representations stored in ISY. This method is good for testingpublic static char RESTORE_CONF_FILES_ONLY
public java.lang.String uuid
public volatile boolean isAuthenticated
This attribute should be used by clients to correctly identify the state of the device in relationship to the client
public volatile boolean isOnline
public java.util.Hashtable<java.lang.String,UDControl> controls
Hashtable
of all the controls
All controls associated with the ISY and indexed based on the control's name
UDControl
public java.util.Hashtable<java.lang.String,UDNode> nodes
Hashtable
of all the nodes (not groups/scenes)
associated/linked to ISY.UDNode
public UPnPSecurity upnpSecurity
UPnPSecurity
object which handles all
UPnPSecurity transformationspublic short securityLevel
UPnPSecurity.NO_SECURITY
UPnPSecurity.SECURITY_LEVEL_1
- clear text authentication, with xml signaturesUPnPSecurity.SECURITY_LEVEL_2
- encrypted (bulk key) authentication, with xml signaturesUPnPSecurity.SECURITY_LEVEL_3
- RSA cryptography with xml signaturespublic UDProxyDevice(UDDeviceStateListener deviceListener)
UDControlPoint
when a new device is discovereddeviceListener
- - there's only one and that is UDControlPoint
UDControlPoint
public UDProxyDevice(java.lang.String uuid, java.lang.String descriptionURL, UDDeviceStateListener deviceListener)
Called by UDControlPoint
when a new (ISY) device is discovered
uuid
- - the uuid of the devicedescriptionURL
- - the url where the description of services may be founddeviceListener
- - there's only one and that is UDControlPoint
UDControlPoint
public boolean supportsErrorDriverControl()
public int getDriverVersion(java.lang.String driverName)
driverName
- e.g. "INSTEON"public boolean configure()
Called by UDControlPoint
Configures this device based on the configuration DIML/XML returned from
ISY
UDControlPoint
public boolean refreshNodes()
Called by UDControlPoint
Retrieves all the nodes/groups/scenes and any relationship thereof from
ISY and creates the appropriate objectes UDNode
and UDGroup
The UDNode
s are stored in the nodes attribute of this object
The UDGroup
s are stored in the groups attribute of the UDControlPoint
public int getProductId()
public java.lang.String getProductDescription()
public boolean isIsyPro()
public boolean isIsy99()
public boolean isIsy26()
public UDNode getNode(java.lang.String id)
UDNode
based on the given node address (String)id
- - the id/address of the node to getUDNode
with the given id, null otherwisepublic UDNode getPrimaryNode(java.lang.String id)
UDNode
based on the given node address
for any node defined for the device. (String)id
- - the id/address of any node defined for the device.UDNode
for the device, null otherwisepublic java.lang.String toString()
toString
in class java.lang.Object
public void Stop()
Note: this method is invoked at appropriate
times by the UDI's Network and Services Layers and, as such, should not
be invoked independently.
Stops all the services:
- Unsubscribes from ISY
- Expires session keys (security) if any
- Puts the device in off line mode
public void lostSession()
This method is called when the device is unreachable and thus cannot be stopped (using the Stop() method) Note: this method is invoked at appropriate times by the UDI's Network and Services Layers and, as such, should not be invoked independently
protected void offLine()
Called by UDControlPoint
when
the device is no longer reachable
protected void onLine()
Called by UDControlPoint
when
the device starts advertising/announcing its
existence on the network
public void setReuseSocketForSubscription(boolean v)
public void subscribeToEvents(boolean reuseSocket)
reuseSocket
- - whether or not to reuse the initiating socket
to receive events. It's always more efficient to reuse sockets.public void unsubscribeFromEvents()
Unsubscription causes the ISY to no longer to try and send notifications to this proxy
public boolean proveSubscription()
public boolean ensureSubscription()
public static boolean processDescriptionURL(java.lang.String url, UDProxyDevice dev, boolean show_error)
public static boolean processDescriptionURL(java.lang.String url, UDProxyDevice dev)
public UDHTTPResponse submitSOAPRequest(java.lang.String soapAction, java.lang.StringBuffer body, java.lang.String attributes, short signatureType, boolean encrypt, boolean keep_alive, boolean longTimeout)
soapAction
- body
- attributes
- - attributes to be injected into the service call. Note that attributes are added as issignatureType
- public UDHTTPResponse submitSOAPRequest(java.lang.String soapAction, java.lang.StringBuffer body, short signatureType, boolean encrypt, boolean keep_alive, boolean longTimeout)
soapAction
- body
- signatureType
- encrypt
- keep_alive
- longTimeout
- UDHTTPResponse
public UDHTTPResponse submitSOAPRequest(java.lang.String serviceName, java.lang.String soapAction, java.lang.StringBuffer body, java.lang.String attributes, short signatureType, boolean encrypt, boolean keep_alive, boolean longTimeout)
serviceName
- soapAction
- body
- attributes
- signatureType
- encrypt
- keep_alive
- longTimeout
- UDHTTPResponse
public UDHTTPResponse submitSOAPRequest(java.lang.String serviceName, java.lang.String soapAction, java.lang.StringBuffer body, short signatureType, boolean encrypt, boolean keep_alive, boolean longTimeout)
serviceName
- soapAction
- body
- signatureType
- encrypt
- keep_alive
- longTimeout
- UDHTTPResponse
public UDHTTPResponse submitSOAPRequest(java.lang.String soapAction, java.lang.StringBuffer body, short signatureType, boolean encrypt, boolean keep_alive)
soapAction
- body
- signatureType
- public UDHTTPResponse submitSOAPRequest(java.lang.String serviceName, java.lang.String soapAction, java.lang.StringBuffer body, short signatureType, boolean encrypt, boolean keep_alive)
serviceName
- soapAction
- body
- signatureType
- encrypt
- keep_alive
- UDHTTPResponse
public boolean submitSOAPRequest(java.lang.String soapAction, java.lang.StringBuffer body)
soapAction
- The SOAP command (eg. "addNode")body
- The body of the message (parameters in XML)public boolean submitUDMLRequest(java.lang.String control, java.lang.String action, java.lang.String node, char flag)
This method submits a UDML/DIML request to ISY to affect the behavior of one
of the UDNode
s or UDGroup
s
control
- - the name of the UDControl
to be affectedaction
- - the name of the UDAction
to be affectednode
- - the id of the UDNode
or UDGroup
to be affectedflag
- - the type of node: possible values are
Constants.NODE_IS_A_GROUP
~Constants.NODE_IS_A_GROUP (not a group)UDNode
,
UDGroup
,
UDControl
,
UDAction
public boolean submitUDMLRequest(java.lang.String control, java.lang.String action, java.lang.String actionAttrs, java.lang.String node, char flag)
public boolean submitRequest(java.lang.String control, java.lang.String action, java.lang.String actionAttrs, java.lang.String node)
public boolean submitRequest(java.lang.String control, java.lang.String action, java.lang.String node)
public boolean submitGroupRequest(java.lang.String control, java.lang.String action, java.lang.String node)
public IUpdaterResponse requestProgramUpdate(java.lang.String path, int content_len, char flag)
public boolean uploadFile(java.lang.String path, byte[] body, char flag, IUpdaterClient view)
This method uses POST
uploadFile
in interface IUpdateHandler
path
- - the file's pathbody
- - the bodyflag
- - 0x02= deleteview
- - if there's a client which listens for the update processpublic boolean deleteFile(java.lang.String path, IUpdaterClient view)
public boolean isPortalClient()
public IUpdaterResponse requestUserFileUpdate(java.lang.String path, int content_len)
public IUpdaterResponse requestProgramUpdate(java.lang.String path, int content_len)
This method prepares ISY for accepting a file/program to be written in its local file system
requestProgramUpdate
in interface IUpdateHandler
path
- - the path to which the file is going to be writtencontent_len
- - the length of the file to be writtenIUpdaterResponse
which can then be used
to actually write the file to ISYIUpdaterResponse
public boolean addNode(java.lang.String newAddress, java.lang.String newName, java.lang.String type, char flag)
UDNode
to ISYpublic boolean addNode(java.lang.String newAddress, java.lang.String newName, java.lang.String type, java.lang.String family, char flag)
UDNode
to ISYnewAddress
- - the address of the new UDNode
newName
- - the name of the new UDNode
type
- - The device typefamily
- - The product family (@link UDNode)flag
- - the type of operations to be performed on the newly created node.UDNode
public boolean removeNode(java.lang.String address)
UDNode
from ISYpublic boolean renameNode(java.lang.String address, java.lang.String newName)
UDNode
in ISYpublic boolean addGroup(java.lang.String address, java.lang.String name, char flag)
UDGroup
to ISYaddress
- - the address of the new UDGroup
name
- - the name of the new UDGroup
flag
- - the type of group to be created; at the moment, the supported
value for this flag is:
Constants.NODE_IS_A_GROUP
UDGroup
public boolean addFolder(java.lang.String address, java.lang.String name)
UDFolder
to ISYpublic boolean removeGroup(java.lang.String id)
UDGroup
from ISYpublic boolean removeFolder(java.lang.String id)
UDFolder
from ISYpublic boolean renameGroup(java.lang.String address, java.lang.String newName)
UDGroup
in ISYpublic boolean renameFolder(java.lang.String address, java.lang.String newName)
UDFolder
in ISYpublic boolean moveNode(java.lang.String id, java.lang.String gid, char flag)
id
- - the address of the UDNode
to be movedgid
- - the address of the UDGroup
being moved toflag
- - the relationship flag between the node and the group. Possible
values:
(@link Constants#NODE_IS_MASTER}: the node plays the master relationship in the group
~Constants.NODE_IS_MASTER
: the node plays a slave relationship in the groupUDNode
,
UDGroup
public boolean removeFromGroup(java.lang.String id, java.lang.String gid)
public boolean renameNetwork(java.lang.String name)
name
- - the new name for the networkpublic boolean queryAll(java.lang.String address, boolean isGroup)
public boolean queryAll()
public boolean discoverNodes(java.lang.String type)
UDNode
discovery.
In case of Insteon, this means starting a Linking session
type
- - the option type of device being linked mostly in master modepublic boolean discoverNodes(java.lang.String type, char action)
UDNode
discovery.
In case of Insteon, this means starting a Linking session
type
- - The option type of device being linked mostly in master modeaction
- - How the devices should be discovered.public boolean discoverNodes(java.lang.String type, char action, java.lang.String family)
UDNode
discovery.
In case of Insteon, this means starting a Linking session
type
- - The option type of device being linked mostly in master modeaction
- - How the devices should be discovered.family
- - Product driver family, or null for default family.public boolean cancelNodesDiscovery(char action)
UDNode
discovery.
In case of Insteon, this means stopping the Linking session
action
- - what should be followed after a device is linked.public boolean cancelNodesDiscovery(char action, java.lang.String family)
UDNode
discovery.
In case of Insteon, this means stopping the Linking session
action
- - what should be followed after a device is linked.family
- - Product driver family, or null for default family.public byte[] getSystemConfigurationFile(java.lang.String name)
name
- - the name of the system configuration filepublic java.lang.String getContentList(java.lang.String path, java.lang.String ext, boolean summaryOnly)
path
- - the content list directory (e.g. "/CONF/MAIL")ext
- - The file extension (e.g. "NTC")public boolean saveSystemConfigurationImage(java.lang.String name, byte[] image, char flag)
public boolean saveSystemConfigurationFile(java.lang.String name, java.lang.String content, char flag)
public boolean saveAndProcessSystemConfigurationFile(java.lang.String name, java.lang.String content)
saveAndProcessSystemConfigurationFile
in interface IUpdateHandler
name
- The path qualified name of the system configuration filecontent
- The contents of the filepublic boolean saveSystemConfigurationFile(java.lang.String name, byte[] image)
public boolean saveSystemConfigurationFile(java.lang.String name, java.lang.String content)
name
- The path qualified name of the system configuration filecontent
- The contents of the filepublic java.lang.String getSystemConfiguration()
It includes all the files and their paths
public java.lang.String getSystemConfiguration(java.lang.String path, java.lang.String pattern)
It includes all the files and their paths
public boolean internetAccess(char flag)
flag
- - possible values:
Constants.ENABLE_INTERNET_ACCESS_FLAG
Constants.DISABLE_INTERNET_ACCESS_FLAG
public boolean SetDeviceLinkingMode(char flag)
flag
- - the possible values are:Constants.UD_LINK_MODE_SLAVE
Constants.UD_LINK_MODE_MASTER
public SystemStatus getSystemStatus()
SystemStatus
retrieved from ISY, null if failedSystemStatus
public boolean setSystemDateTime(com.universaldevices.common.datetime.DateTime dt)
dt
- - the DateTime object according to which the ISY's system
date/time is setpublic com.universaldevices.common.datetime.DateTime getSystemDateTime()
DateTime
object holding ISY's data/time attributes; null if failedDateTime
public SystemOptions getSystemOptions()
SystemOptions
in
ISY
SystemOptions includes such things as email addresses, number pending, etc.
SystemOptions
; null if failedSystemOptions
public boolean setSystemOptions(SystemOptions conf)
SystemOptions
in
ISYgetSystemOptions()
,
SystemOptions
public com.universaldevices.model.notifications.SMTPConfig getSMTPConfig()
SMTPConfig
in
ISY
SMTPConfiguration includes such things as SMTP Server, port, etc..
SMTPConfig
; null if failedSMTPConfig
public boolean setSMTPConfig(com.universaldevices.model.notifications.SMTPConfig conf)
SMTPConfig
in
ISYgetSMTPConfig()
,
SMTPConfig
public boolean sendTestEmail(java.lang.String id)
public boolean setNTP(SystemOptions conf)
SystemOptions
in
ISYgetSystemOptions()
,
SystemOptions
public boolean resetAllNotifications()
Notifications are queued to be sent based on the configured interval
SystemOptions
public boolean getNumPendingNotifications()
Gets the number of Notifications whcih are to be sent out and
stores it in this object. To get the value, invoke getNumNotifications()
method.
SystemOptions
,
getNumNotifications()
public java.lang.String getLog()
The log file is returne in an ascii delimited tab separated format
public boolean resetLog()
This method completely resets and removes all the ISY's log entries
public java.lang.String getErrorLog()
The log file is returned in an ascii delimited tab separated format
public boolean resetErrorLog()
This method completely resets and removes all the ISY's error entries
public boolean loadTriggers(java.lang.StringBuffer key, com.universaldevices.common.xml.UDXmlParser parser)
public boolean getAllTriggerStatus(java.lang.String key, com.universaldevices.common.xml.UDXmlParser parser)
public boolean saveTrigger(java.lang.String key, int id, java.lang.StringBuffer pgm)
id
- - The id of this program, must match the pgm
- - the content of the program (public boolean sendD2DCommand(java.lang.String key, java.lang.String cmd, int id, java.lang.String xml)
public boolean sendD2DCommand(java.lang.String key, java.lang.String cmd, int id)
public boolean sendD2DCommand(java.lang.String key, java.lang.String cmd, java.lang.String mask)
public boolean sendD2DCommandLongTimeout(java.lang.String key, java.lang.String cmd, java.lang.String mask)
public boolean saveFloorPlan(java.lang.StringBuffer diml)
Note: this operation is not supported in the SDK
diml
- - the DIML/UDML representation of floorplanpublic java.lang.Object getFloorPlan()
Retrieves the DIML/UDML representation of the floor plan from ISY Note: this operation is not supported in the SDK
public boolean synchWithNTS()
public boolean getPublicKeys()
This method negotiates public keys to be used in
communicating with ISY and configures the
UPnPSecurity
object accordingly.
This method is only applicable if securityLevel
= UPnPSecurity.SECURITY_LEVEL_3
public boolean getAlgorithmsAndProtocols()
Gets the supported Algorithms and Protocols by ISY and configures the
UPnPSecurity
object accordingly
public boolean getLifetimeSequenceBase()
It also configures the
UPnPSecurity
object accordingly. This value is important as
it reduces the possiblility of replay attacks
public boolean setSessionKeys()
Session keys are used throughout
the life of the session with ISY. UPnPSecurity
object is
configured accordingly.
public boolean expireSessionKeys()
This means that no longer this proxy is holding a secure session with ISY and no notifications/publications shall be forthcoming
public boolean reboot(java.lang.String code)
This method is fully encrypted on the wire for security purposes
reboot
in interface IUpdateHandler
code
- - if a code name is given, ISY is booted to that codepublic boolean authenticate(java.lang.String userid, java.lang.String pwd)
This method is fully encrypted on the wire for security purposes
userid
- - the useridpwd
- - the passwordpublic boolean setUserCredentials(java.lang.String userid, java.lang.String pwd)
userid
- - the useridpwd
- - the passwordpublic java.lang.Object sendDeviceSpecific(java.lang.String command, java.lang.String node, java.lang.String param1, java.lang.String param2, java.lang.String param3, java.lang.StringBuffer specs)
This method is used for all device specific (such as Insteon) operations which cannot be categorized as generic ISY services
command
- - the command to performnode
- - the UDNode
affectedoption
- - the optional parameter to be passed inflag
- - the optional flags to be passed inspecs
- - any XML document to be processedObject
. It's upto the caller to decipher the meaning of the
result. null if failed or if the command does not return a resultpublic java.lang.Object sendDeviceSpecific(java.lang.String command, java.lang.String node, java.lang.String option, char flag, java.lang.StringBuffer specs)
This method is used for all device specific (such as Insteon) operations which cannot be categorized as generic ISY services
command
- - the command to performnode
- - the UDNode
affectedoption
- - the optional parameter to be passed inflag
- - the optional flags to be passed inspecs
- - any XML document to be processedObject
. It's upto the caller to decipher the meaning of the
result. null if failed or if the command does not return a resultpublic boolean clearConfiguration()
Note: This method is similar to factory reset and should be used with extreme caution
public boolean restoreDevicesFromNodes(char flag)
This method takes all the logical node/group configurations within ISY and attempt to recreate them in the physical devices. Care should be taken to ensure that the logical representations/backups are the intended starting point
flag
- - the type of restoration intendedpublic boolean restoreDeviceFromNode(java.lang.String id)
This method takes all the logical node/group configurations within ISY and attempt to recreate them in the physical devices. Care should be taken to ensure that the logical representations/backups are the intended starting point
id
- - the address of the device to be restoredpublic boolean restoreNodesFromDevice(java.lang.String id)
This method replaces all the logical node/group configurations within ISY for the specified physical device. Care should be taken because some node information may lost and any pending changes to the device will also be lost.
id
- - the address of the devicepublic boolean writeUpdatesToDevice(java.lang.String nodeId)
nodeId
- - the address of the device to be updated.public boolean replaceModem()
Modem is any device which is used for communications to physical devices linked to ISY.
In the case of Insteon, this could be a PLM.
public boolean removeModem()
Modem is any device which is used for communications to physical devices linked to ISY.
In the case of Insteon, this could be a PLM.
This is useful for cases where ISY is removed from the Network and thus all the links
from/to the modem are removed so that the devices do not report back their status to the
modem
public boolean replaceDevice(java.lang.String oldDevice, java.lang.String newDevice, java.lang.String newFirmware)
This operation removes all the settings for the newDevice and replaces them
with those of the oldDevice. This also includes setting/updating triggers and schedules.
oldDevice
- - the address of the old devicenewDevice
- - the address of the new devicenewFirmware
- - the firmware level of the new devicepublic boolean restoreLink(java.lang.String ctlNodeId, java.lang.String rspNodeId)
This operation writes the link data between the controller and responder to both devices. Normally this is done automatically, but gives the user the option to force the data to be written again.
ctlNodeId
- - the address of the controllerrspNodeId
- - the address of the responderpublic boolean getNodeDeviceProperties(java.lang.String node, UDNodeDevicePropertiesParser parser)
node
- the address of the node, if null then properties for all nodes is returnedUDNodeDeviceProperties
public boolean getNodeDeviceProperties(java.lang.String nodeAddr)
nodeAddr
- The address of the nodepublic boolean setNodeDeviceProperties(java.lang.String xml)
xml
- xml string defining the properties to setUDNodeDeviceProperties
public UDNodeProperties getNodeProperties(java.lang.String node)
node
- - the address of the nodeUDNodeProperties
UDNodeProperties
public boolean saveNodeProperties(java.lang.String address, java.lang.StringBuffer diml)
address
- - the address of the node for which the properties are saveddiml
- - the DIML/UDML representation of UDNodeProperties
UDNodeProperties
public boolean configureSecuritySystem(java.lang.String name, java.lang.StringBuffer diml)
name
- - the name/brand of the secuirty system to configurediml
- - security system specific diml representation of its configurationpublic java.lang.String getSecuritySystemConfig(java.lang.String name)
name
- - the name/brand of the security system for which the configuration is requestedpublic java.lang.String getSecuritySystemURLs(java.lang.String name)
name
- - the name/brand of the security system for which the URLs are requestedpublic boolean processSecurityRequest(java.lang.String request_type, java.lang.String security_code)
request_type
- - the type of request such as ARM, DISARM, etc.security_code
- - the security code to Arm/Disarm the systempublic java.lang.String getDebugLevel()
public boolean setDebugLevel(int level)
level
- public boolean setVariable(int varId, int varType, int value, boolean isInitValue)
varId
- - variable IDvarType
- - variable Typevalue
- - variable valueisInitValue
- - True then set the initial value, False then set the current value.public java.lang.String getVariables(int varType)
varType
- - variable typepublic java.lang.String getNodesConfig()
public java.lang.String getISYConfig()
public boolean manageModules()
public boolean installModule(java.lang.String mid)
mid
- - Module IDpublic java.lang.String getUserDirectoryListing(java.lang.String path, java.lang.String pattern)
path
- - the path within the user directory; it could be emptypattern
- - the type of files in that directory; it could be emptypublic java.lang.String getUserDirectoryListing(java.lang.String path, java.lang.String pattern, boolean recursive)
path
- - the path within the user directory; it could be emptypattern
- - the type of files in that directory; it could be emptypublic boolean makeUserDirectory(java.lang.String path)
path
- - the path within the user directorypublic boolean removeUserDirectory(java.lang.String path, boolean deleteContentsOnly)
path
- - the path within the user directorydeleteContentsOnly
- - True then delete only the files in the directory, False then delete the directory as wellpublic boolean removeUserObject(java.lang.String path, boolean isFolder)
path
- - the path within the user directoryisFolder
- - whehter or not the object is a folder or a filepublic byte[] getUserFile(java.lang.String name)
name
- - the name of the user configuration filepublic boolean addUserFile(java.lang.String path, byte[] image)
public boolean moveUserObject(java.lang.String oldName, java.lang.String newName)
oldName
- - the old namenewName
- - the new namepublic FileSystemStat getFileSystemStatus()
public byte[] testNetworkResource(java.lang.String id, char flag)
id
- - the id for the resourcepublic boolean setBatchMode(int batchMode)
batchMode
- public boolean setBatteryDeviceWriteMode(int mode)
mode
- public boolean isCommunicatable()
public boolean isClientAuthenticated()
isClientAuthenticated
in interface IUpdateHandler
public boolean isIrEnabled()
public int getNumNotifications()
SystemOptions
protected void setNumNotifications(int num)
UDControlPoint
to set the number of
pending notificationsnum
- public boolean isDeviceInDiscoveryMode()
protected void setDeviceInDiscovery(boolean b)
b
- - true if in Linking mode, false otherwisepublic java.lang.String getSCPDURL()
public java.lang.String getArchivePath()
public boolean isD2dEnabled()
protected boolean isResetting()
Called by UDControlPoint
protected void setResetting(boolean isResetting)
Called by UDControlPoint
isResetting
- - true if resetting, false otherwiseprotected long getLastAlive()
Called by UDControlPoint
protected void setLastAlive(long lastAlive)
Called by UDControlPoint
lastAlive
- - the last time ISY sent an announcementprotected int getMaxAge()
Called by UDControlPoint
protected void setMaxAge(int max_age)
Called by UDControlPoint
Sets the max age for ISY
max_age
- - the max agepublic java.lang.String getDevicetype()
Called by UDControlPoint
public java.lang.String getApplication()
public java.lang.String getAppVersion()
public java.lang.String getPlatform()
public java.lang.String getBuildTimestamp()
public java.lang.String getMake()
public java.lang.String getModel()
public java.lang.String getFriendlyName()
protected void setFriendlyName(java.lang.String name)
Called by UDControlPoint
name
- - the new friendly name for ISYpublic java.lang.String getManufacturerURL()
public java.lang.String getIcon()
public java.lang.String getServiceType()
public java.lang.String getSubscriptionID()
public void clearSubscriptionID()
Note: this method should not be invoked independent of UDI's Network and Services Layer
public java.lang.String getExternalURL()
public java.lang.String getInternalURL()
public void setExternalURL(java.lang.String externalURL)
Note: this method should not be invoked independent of UDI's Network and Services Layer
externalURL
- - the externalURL to setpublic boolean isViewable()
This method is UDI presentation layer specific and is meaningless outside this context
public void setViewable(boolean isViewable)
This method is UDI presentation layer specific and is meaningless outside this context
isViewable
- - the isViewable to setpublic java.net.URL getURLBase()
public java.net.InetSocketAddress getHostAddress()
public java.lang.String getHostName()
public void setDescriptionURL(java.lang.String descriptionURL)
descriptionURL
- public java.lang.String getDescriptionURL()
public java.lang.String getNetworkName()
Network is the top most node in the tree in UDI's Administrative Console
public UDAutoUpdate.UDPlatform getAutoUpdateCode()
UDAutoUpdate
sets
the corresponding attribute when an update is sensed.public void setAutoUpdateCode(UDAutoUpdate.UDPlatform updateCode)
UDAutoUpdate
sets the corresponding attribute in case an update
is sensed
updateCode
- - the updateCode to setpublic boolean isSecurityEnabled()
public boolean isUsingSSL()
public boolean verifyUpdatePackage(java.io.InputStream is, long size)
verifyUpdatePackage
in interface IUpdateHandler
is
- - the input streamsize
- - the size of the intput streampublic boolean isDefaultCert()
public boolean is27Compliant()
public boolean isElk2()
public boolean is28Compliant()
public boolean is310Compliant()
public int getMaxSSLStrength()
public boolean isTLSSupported()
isTLSSupported
in interface IUpdateHandler
public boolean isRemotelyAccessed()
public ProductInfo getProductInfo()
public java.lang.Boolean getIsSubscribed()
public boolean isSubscribed()
public java.lang.String getIsyStartupTime()
public LastError getLastError()
public boolean clearLastError()
public NetworkConfig getNetworkConfig()
getNetworkConfig
in interface IUpdateHandler
public DDNSHost getDDNSHost()
public boolean isDDNSHostAvailable(java.lang.String host)
public boolean addDDNSHost(java.lang.String host, java.lang.String ip)
public boolean removeDDNSHost(java.lang.String host)
public boolean setNodeEnabled(java.lang.String node, boolean b)
node
- - The address of the node to be enabledb
- - whether or not the node is enabledpublic boolean setParent(java.lang.String node, int nodeType, java.lang.String parent, int parentType)
node
- - The address of the node to have parent setnodeType
- - The type of the nodeparent
- - The address of the parentparentType
- - The type of the parentpublic boolean setNodePowerInfo(java.lang.String node, int deviceClass, int wattage, int dutyCyclePeriod)
public UDNode getRootNode()
public boolean isDisclaimerAgreedTo()
public boolean setDisclaimerAgreedTo()
public java.lang.String getFile(java.lang.StringBuffer url)
url
- - relative to basepublic com.universaldevices.rest.UDRestResponse submitRESTRequest(java.lang.String url)
url
- - relative to basepublic com.universaldevices.device.model.programs.UDPrograms getPrograms()
UDPrograms