OpenScape
V3.2, Revision 044 20100322

com.siemens.symphonia.bcom.bcommon.external
Interface DeviceEndpoint

All Superinterfaces:
ComEndpoint
All Known Subinterfaces:
DeviceEndpointInternal
All Known Implementing Classes:
DeviceEndpointImpl, DeviceEndpointInternalImpl

public interface DeviceEndpoint
extends ComEndpoint

An instance of a device to be used as communication endpoint.

It is the link between an EndpointAddress and a BComDevice object providing a directed graph representing a unique instance of a communication address. See Basic Communication Best Practice document for a detailed description of the coherences.

The DeviceEndpoint object serves furthermore the following purposes:

  1. It denotes the own communication endpoint in a communication. Therefore it can be the return value of the method getComEndpoint in a ComConnection object.
  2. It can be used as communication target.
  3. It is the root of a device view. The method getComSessions gives all communication session belonging to this device view.


Method Summary
 ComSession createComSession()
          Creates a new communication session.
 BComDevice getBComDevice()
          Get the controllable device associated with this device endpoint.
 java.util.Iterator getComSessions()
          Get all communication sessions of this device.
 EndpointAddress getEndpointAddress()
          Determine the communication address associated with this device endpoint.
 DeviceEndpointType getType()
          Get the device endpoint type.
 void resyncDevices()
          Resynchronize the communication state with the communication system for this devices.
 

Method Detail

getEndpointAddress

EndpointAddress getEndpointAddress()
Determine the communication address associated with this device endpoint.

There might be multiple DeviceEndpoint objects with the same communication address. Therefore a DeviceEndpoint object specifies uniquely a communication endpoint but an EndpointAddress doesn't necessarily do the same.
An example would be a conference service. For each pilot number, which is a communication address, there might be multiple conferences running. Therefore the EndpointAddress of the pilot number doesn't specify a certain conference uniquely but the DeviceEndpoint of a conference does.

Returns:
communication address used.

getBComDevice

BComDevice getBComDevice()
Get the controllable device associated with this device endpoint.

This allows to manage devices by its controlling object.

There might be multiple DeviceEndpoint objects associated with the same BComDevice object. An example is a key-set device which controls multiple lines. This is one controllable, physical device but multiple communication endpoints each one represented by a DeviceEndpoint object.

Returns:
controllable device object.

createComSession

ComSession createComSession()
Creates a new communication session.

The created ComSession becomes part of the view of this device. It can be used to group multiple Communication together. But it is also possible to create multiple ComSession for one device.

Note:
This method invokes a synchronous service request which implicates:

Returns:
Created ComSession.

getComSessions

java.util.Iterator getComSessions()
Get all communication sessions of this device.

Returns:
Iterator of ComSession objects.

resyncDevices

void resyncDevices()
Resynchronize the communication state with the communication system for this devices.

Allows to trigger a synchronisation between Basic Communication service and the communication system. If a difference is detected the adaption to the state of the communication system is done in a smooth way. I.e. normal event notification is used to update the state of the client.

Synchronisation takes place not only for the given instance of a device endpoint but also for all devices which belong to the same monitor in the communication system. In most cases this is equivalent to all DeviceEndpoint objects which are associated with the same EndpointAddress object.

Notes:
General:

  • Please use this method with care. It produces a high load to the system.
  • The resynchronisation might result in that this DeviceEndpoint object gets deleted. This happens if e.g. the station has been removed but the removal has been undetected until now.

This method invokes a synchronous service request which implicates:

  • A valid security token with appropriate rights needs to be part of the context.
  • The invoking thread is blocked for a short period of time.


getType

DeviceEndpointType getType()
Get the device endpoint type.

Returns:
the device endpoint type of this DeviceEndpoint.

OpenScape
V3.2, Revision 044 20100322

Copyright (c) 2014 Unify, Germany
All rights reserved.

This software is the confidential and proprietary information of Unify, Germany