cisco.uc.cuae.legacy
Class BaseCiscoDeviceListServer
java.lang.Object
cisco.uc.cuae.legacy.BaseCiscoDeviceListServer
- All Implemented Interfaces:
- CiscoDeviceList, CiscoDeviceListServer, CuaeCommon, CuaeCommonServer, etch.bindings.java.support.ObjSession
public class BaseCiscoDeviceListServer
- extends java.lang.Object
- implements CiscoDeviceListServer, etch.bindings.java.support.ObjSession
Base implementation of CiscoDeviceListServer, with default method implementations
which throw UnsupportedOperationException. Extend this class to provide
implementations of messages from the client.
- See Also:
ImplCiscoDeviceListServer
| Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
BaseCiscoDeviceListServer
public BaseCiscoDeviceListServer()
_sessionQuery
public java.lang.Object _sessionQuery(java.lang.Object query)
throws java.lang.Exception
- Specified by:
_sessionQuery in interface etch.bindings.java.support.ObjSession
- Throws:
java.lang.Exception
_sessionControl
public void _sessionControl(java.lang.Object control,
java.lang.Object value)
throws java.lang.Exception
- Specified by:
_sessionControl in interface etch.bindings.java.support.ObjSession
- Throws:
java.lang.Exception
_sessionNotify
public void _sessionNotify(java.lang.Object event)
throws java.lang.Exception
- Specified by:
_sessionNotify in interface etch.bindings.java.support.ObjSession
- Throws:
java.lang.Exception
exclude
public CiscoDeviceList.ExcludeResult exclude(java.lang.String sessionId,
CiscoDeviceList.ExcludeOptions options)
- Description copied from interface:
CiscoDeviceListServer
- The Exclude action is used to query (by exclusion) the device information
cache located on the Cisco Unified Application Server, in order to retrieve
information on one or more devices.
Only Registered and FoundAndUnregistered devices can be returned for Cisco
Unified Communications Manager 5.x and 6.x, so for best-case compatibility,
you should assume this behavior in your application.
The DeviceListX provider polls every 2 hours (configurable). This means
that the local Cisco Unified Application Environment device cache can be
out of date with current phone information. If testing and developing with
a phone that has just come online, manually invoke a refresh of the
database by navigating to mceadmin > Providers > Cisco DeviceListX Provider
> Invoke Extension to re-synchronous the cache.
Exclude performs a search by searching the entire database for all devices
that do not match the specified device attributes and returns the results
in a null () variable. A common practice is to pass this variable into a
CustomCode block for parsing the data within it.
Every action parameter specified in this action is used to further refine
the actual query on the underlying Cisco Unified Application Server
database using AND logic.
The resulting DataTable is an object comprised of rows and columns, with
the number of resulting rows corresponding to the number of devices matched
by the query. The name of the colums correspond to device attributes
retrieved from the device cache database. The following list is the name of
the columns comprising each row in the DataTable, which one would use when
using C# to parse out the results from the table:
Name - The name of the device, such as SEPXXXXXXXXXXXX. This should not
ever be null.
IP - The IP address of the device. This will be "" if undefined.
Description - The description of the device. This will be "" if
undefined.
SearchSpace - The Calling Search Space of the device. This will be "" if
undefined.
Pool - The Device Pool of the device. This will be "Unknown" if
undefined.
Status - The Status of the device. This will be "0" if undefined.
TYPE - The type of the device. This will be "1" if undefined.
UserName - The username associated with the device. This will be "" if
undefined.
PhysicalAddress - The physical (MAC) address of the device. This will be
"" if undefined.
Extn - The extension of the device. This will be "" if undefined.
ExtnInetAddress - The Extension InetAddress of the device. This will be
"" if undefined.
CCMIP - The IP address of the publisher node of the cluster that the
device is registered to. This should not ever be null.
- Specified by:
exclude in interface CiscoDeviceListServer
- Parameters:
sessionId - The session Id for this method calloptions - An object holding all the optional parameters
query
public CiscoDeviceList.QueryResult query(java.lang.String sessionId,
CiscoDeviceList.QueryOptions options)
- Description copied from interface:
CiscoDeviceListServer
- The Query action is used for querying the device information cache located
on the Cisco Unified Application Server, in order to retrieve information
on one or more devices.
Only Registered and FoundAndUnregistered devices can be returned for Cisco
Unified Communications Manager 5.x and 6.x, so for best-case compatibility,
you should assume this behavior in your application.
Even though devices are uniquely keyed by DeviceName within a single Cisco
Unified Communications Manager cluster, it is possible that multiple
devices can be returned for a given device name. This scenario occurs when
the Cisco Unified Application Server is polling multiple clusters and the
device is configured in two or more of those clusters. You can use the
Status parameter to only search for devices that are currently registered
or/and specify the publisher IP address in the CallManagerIP action
parameter to help isolate the query.
The DeviceListX provider polls every 2 hours (configurable). This means
that the local Cisco Unified Application Environment device cache can be
out of date with current phone information. If testing and developing with
a phone that has just come online, manually invoke a refresh of the
database by navigating to mceadmin > Providers > Cisco DeviceListX Provider
> Invoke Extension to re-synchronous the cache.
Query performs a search with the specified device attributes and returns
the results in a null () variable. A common practice is to pass this
variable into a CustomCode block for parsing the data within it.
Every action parameter specified in this action is used to further refine
the actual query on the underlying Cisco Unified Application Server
database using AND logic.
The resulting DataTable is an object comprised of rows and columns, with
the number of resulting rows corresponding to the number of devices matched
by the query. The name of the colums correspond to device attributes
retrieved from the device cache database. The following list is the name of
the columns comprising each row in the DataTable, which one would use when
using C# to parse out the results from the table:
Name - The name of the device, such as SEPXXXXXXXXXXXX. This should not
ever be null.
IP - The IP address of the device. This will be "" if undefined.
Description - The description of the device. This will be "" if
undefined.
SearchSpace - The Calling Search Space of the device. This will be "" if
undefined.
Pool - The Device Pool of the device. This will be "Unknown" if
undefined.
Status - The Status of the device. This will be "0" if undefined.
UserName - The username associated with the device. This will be "" if
undefined.
PhysicalAddress - The physical (MAC) address of the device. This will be
"" if undefined.
Extn - The extension of the device. This will be "" if undefined.
ExtnInetAddress - The Extension InetAddress of the device. This will be
"" if undefined.
TYPE - The type of the device. This will be "1" if undefined.
CCMIP - The IP address of the publisher node of the cluster that the
device is registered to. This should not ever be null.
The following code shows how one would retrieve the IP address of a
DataTable returned by a successful query with a device name specified of a
valid phone in a CustomCode block:
Retrieving the IP address of a Found Device
- Specified by:
query in interface CiscoDeviceListServer
- Parameters:
sessionId - The session Id for this method calloptions - An object holding all the optional parameters
Copyright © 2010. All Rights Reserved.