Configuration Platform SDK 7.6 API Reference

Package com.genesyslab.platform.configuration.protocol.confserver.events

This package includes the Event messages that contain information about the status of your requests.

See:
          Description

Class Summary
EventAuthenticated  
EventError  
EventHistoryLogSent  
EventLocaleRead  
EventNotificationRegistered  
EventNotificationUnregistered  
EventObjectCreated  
EventObjectDeleted  
EventObjectPermissionsRead  
EventObjectsRead Returns information about objects in the Genesys Configuration Layer.
EventObjectsSent Indicates that Configuration Server has finished sending data in response to a RequestReadObjects message.
EventObjectUpdated  
EventOperationalModeChanged  
EventPasswordChanged  
EventPermissionsChanged  
EventPermissionsNotificationRegistered  
EventPermissionsNotificationUnregistered  
EventPermissionsRead  
EventPermissionsUpdated  
 

Package com.genesyslab.platform.configuration.protocol.confserver.events Description

This package includes the Event messages that contain information about the status of your requests.

For example, if you use RequestReadObjects to ask for information about objects in the Configuration Layer, you will receive one or more EventObjectsRead messages and an EventObjectsSent message. You can use the getConfObjects() method to retrieve an XML Document containing the information you asked for, as shown here:


Message response = confServerProtocol.request(requestReadObjects);
switch(response.messageId())
{
        case EventObjectsRead.ID:
        // Object information has arrived, keep going...
		case EventError.ID:
        // There has been an error, go somewhere else...
        ...
}

EventObjectsRead eventObjectsRead = (EventObjectsRead) theMessage;
Document resultDocument =
	(Document) eventObjectsRead.getConfObject();
Genesys recommends that you use the Message Broker Application Block to process the events returned from Configuration Server. For information about how to do this, refer to the article on Event Handling at the beginning of this API Reference and to the Message Broker Application Block Guide.

For general information on the structure and usage of the Platform SDKs, please refer to the same article.

For an introduction to the use of the Configuration Platform SDK, please refer to the article Using the Configuration Platform SDK that appears at the beginning of this guide.


Configuration Platform SDK 7.6 API Reference

Send comments on this topic.
Copyright © 2006–2008 Genesys Telecommunication Laboratories, Inc. All rights reserved.