|
OpenScape V3.2, Revision 044 20100322 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface BComUser
Representation of a user.
For each user who is configured to be able doing communication (i.e. a valid ONS device is configured by administration)
there is one and only one BComUser
object which represents this user. Other users (e.g. administrators)
are not known to Basic Communication and therefore no related BComUser
objects exists.
The BComUser
object serves two purposes:
getComEndpoint
in a ComConnection
object.
getComSessions
gives all
communication session belonging to this user view.
Method Summary | |
---|---|
void |
addConnectionListener(ConnectionListener listener)
Add a listener for connection oriented events. |
void |
addDeviceListener(DeviceListener listener)
Add a listener for device events. |
void |
addRoutingListener(RoutingListener listener)
Add a listener for Rules & Routing events. |
ComSession |
createComSession()
Creates a new communication session. |
java.util.Iterator |
getComSessions()
Get all communication sessions of this user. |
BComDevice |
getONSDevice()
Get the ONS (One Number Service) device object of this user. |
EndpointAddress |
getONSNumber()
Get the ONS (One Number Service) communication address of this user. |
java.lang.String |
getUserId()
Get Symphonia user identification. |
void |
removeConnectionListener(ConnectionListener listener)
Remove a listener for connection oriented events. |
void |
removeDeviceListener(DeviceListener listener)
Remove a listener for device events. |
void |
removeRoutingListener(RoutingListener listener)
Remove a listener for Rules & Routing events. |
void |
resyncDevices()
Resynchronize the communication state with the communication system for all devices of this user. |
Method Detail |
---|
java.lang.String getUserId()
This identification is the identification stored in Domain Management DB for a user and can therefore be used in the whole system (and accross different services) for uniquely identifying a user.
String
containing the unique identification of this user.EndpointAddress getONSNumber()
Each user must be assigned a public communication address which everybody has to use for reaching this user. This assignement is done by the administrator and can't be changed by the user.
BComDevice getONSDevice()
Each user must be assigned a public communication address which everybody has to use for reaching this user. This assignement is done by the administrator and can't be changed by the user.
ComSession createComSession()
The created ComSession
becomes part of the
view of this user. It can be used to group multiple
Communication
together. But it is also
possible to create multiple ComSession
for
one user.
Note:
This method invokes a synchronous service request which implicates:
ComSession.
java.util.Iterator getComSessions()
ComSession
objects.void addConnectionListener(ConnectionListener listener)
Registers an implementation of the interface
ConnectionListener
. It is supposed
to provide call-back methods for delivering state change events. Such events are sent for all communications
the user is involved in. The implementation has to be provided by the client.
It is allowed to use one instance of a
ConnectionListener
for multiple registrations at different users.
If you need to register multiple users at one time please use the method
addConnectionListenerForUser
. It is much more efficient for multiple users.
listener
- Implementation of call-back methods.void removeConnectionListener(ConnectionListener listener)
It is silently ignored if the listener hasn't been registered by using
addConnectionListener
. I.e. no exception is thrown and no action takes place.
listener
- The listener to remove.void addRoutingListener(RoutingListener listener)
This method is for routing services only and therefore not documented. Furthermore it is protected by a special role in the authorisation statement and can't be invoked by a normal service or user.
listener
- Implementation of call-back methods.void removeRoutingListener(RoutingListener listener)
listener
- The RoutingListener to remove.void addDeviceListener(DeviceListener listener)
Registers an implementation of the interface
DeviceListener
. It is supposed
to provide call-back methods for delivering device related events. Such events are sent for all device
assigned to the user. The implementation has to be provided by the client.
It is allowed to use one instance of a
DeviceListener
for multiple registrations at different users.
If you need to register multiple users at one time please use the method
addDeviceListenerForUser
. It is much more efficient for multiple users.
listener
- Implementation of call-back methods.void removeDeviceListener(DeviceListener listener)
It is silently ignored if the listener hasn't been registered by using
addDeviceListener
. I.e. no exception is thrown and no action takes place.
listener
- The listener to remove.void resyncDevices()
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.
Notes:Please use this method with care. It produces a high load to the system.
This method invokes a synchronous service request which implicates:
|
OpenScape V3.2, Revision 044 20100322 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
This software is the confidential and proprietary information of Siemens Enterprise Communications, Germany