Configuration Platform SDK 7.6 API Reference

Uses of Class
com.genesyslab.platform.commons.protocol.Message

Packages that use Message
com.genesyslab.platform.commons.protocol Contains classes that support the Protocol objects used by applications developed with the Platform SDKs. 
com.genesyslab.platform.configuration.protocol.confserver.events This package includes the Event messages that contain information about the status of your requests. 
com.genesyslab.platform.configuration.protocol.confserver.requests.connectivity   
com.genesyslab.platform.configuration.protocol.confserver.requests.locale   
com.genesyslab.platform.configuration.protocol.confserver.requests.objects This package contains the Request Object classes that your applications can use to work with objects in the Genesys Configuration Layer.

To use these classes, you will need to supply information about the objects you want to work with. 
com.genesyslab.platform.configuration.protocol.confserver.requests.security The classes in this package allow you to authenticate a user, change his or her password, and work with his or her permissions. 
 

Uses of Message in com.genesyslab.platform.commons.protocol
 

Methods in com.genesyslab.platform.commons.protocol that return Message
 Message MessageParser.parse(byte[] bytes, int pos, int len)
          This method will try to extract IMessage object from the given byte array, beginning from specified position.
 Message MessageParser.parse(byte[] bytes)
          This method will try to extract IMessage object from the given byte array.
 Message QueueMessageReceiver.receive()
           
 Message QueueMessageReceiver.receive(long timeout)
           
 Message MessageReceiver.receive()
          Receive message from the channel.
 Message MessageReceiver.receive(long timeout)
          Receive message from the channel.
 Message RequestFuture.get()
          Waits if necessary for the request to complete, and then retrieves its result.
 Message RequestFuture.get(long timeout)
          Waits if necessary for at most the given time for the request to complete, and then retrieves its result, if available.
 Message RequestFuture.getResponse()
          Waits if necessary for the request to complete, and then retrieves its result.
 Message RequestFuture.getResponse(long timeout)
          Waits if necessary for at most the given time for the request to complete, and then retrieves its result, if available.
 Message RequestFuture.getRequest()
           
 Message AbstractProtocolFactory.createMessage(int id)
           
 Message RegistrationException.getResponseMessage()
           
 Message ClientChannel.request(Message message)
          This synchronous method sends the specified request to the server, and waits for a response from the server for the length of the timeout property.

Here is a sample of how to use the request() method.

 Message ClientChannel.request(Message message, long timeout)
          This synchronous method sends the specified request to the server and waits for a response from the server for the length of the specified timeout value.
 Message ClientChannel.endRequest(RequestFuture future)
          Try to finnish request started with ClientChannel.beginRequest(Message)
 Message ClientChannel.endRequest(RequestFuture future, long timeout)
          Try to finnish request started with ClientChannel.beginRequest(Message)
 Message DuplexChannel.receive()
          This synchronous method blocks until it receives a message from the server.
 Message DuplexChannel.receive(long timeout)
          This synchronous method blocks until it receives a message from the server or until it reaches the length of the designated timeout.
 Message MessageCorrelator.waitResponse(MessageCorrelator.MessageEntry entry, long timeout)
           
 Message MessageCorrelator.MessageEntry.getRequestMessage()
           
 Message MessageCorrelator.MessageEntry.getResponseMessage()
           
 Message MessageCorrelator.MessageEntry.getResponseMessage(long timeout)
           
 Message RequestChannel.request(Message message)
          Send the message and waitResponse for response.
 Message RequestChannel.request(Message message, long timeout)
          Send the message and waitResponse for response or while specified timeout is elapsed.
 Message RequestChannel.endRequest(RequestFuture future)
          Try to finnish request started with RequestChannel.beginRequest(Message)
 Message RequestChannel.endRequest(RequestFuture future, long timeout)
          Try to finnish request started with RequestChannel.beginRequest(Message)
 Message RequestContext.getRequestMessage()
           
 Message ServerChannel.receive()
           
 Message ServerChannel.receive(long timeout)
           
 Message XmlMessageSerializer.deserialize(javax.xml.transform.Source doc)
          Deserialize (restore) the message from an xml document
 Message ProtocolFactory.createMessage(int id)
          Creates Message by id.
 Message ProtocolFactory.createMessage(int id, java.lang.String name)
          Creates Message by id.
 Message Message.cloneMessage()
           
 

Methods in com.genesyslab.platform.commons.protocol with parameters of type Message
 void MessageReceiverSupport.processMessage(Message message)
           
 void QueueMessageReceiver.processMessage(Message message)
           
 java.lang.Object AbstractReferenceBuilder.retreiveReference(Message message)
           
 void AbstractReferenceBuilder.updateReference(Message message, java.lang.Object reference)
           
 java.lang.Object AbstractReferenceBuilder.updateReference(Message message)
           
 Message ClientChannel.request(Message message)
          This synchronous method sends the specified request to the server, and waits for a response from the server for the length of the timeout property.

Here is a sample of how to use the request() method.

 Message ClientChannel.request(Message message, long timeout)
          This synchronous method sends the specified request to the server and waits for a response from the server for the length of the specified timeout value.
 RequestFuture ClientChannel.beginRequest(Message message)
          Start request and exit.
 void DuplexChannel.send(Message message)
           
 java.lang.Object IntReferenceBuilder.retreiveReference(Message message)
           
 MessageCorrelator.MessageEntry MessageCorrelator.registerMessage(Message message)
           
 MessageCorrelator.MessageEntry MessageCorrelator.correlate(Message message)
           
 void OutputChannel.send(Message message)
          Send message to remote party.
 java.lang.Object ReferenceBuilder.retreiveReference(Message message)
          Look for reference in the message.
 void ReferenceBuilder.updateReference(Message message, java.lang.Object reference)
          Update message reference with the one supplied.
 java.lang.Object ReferenceBuilder.updateReference(Message message)
          Update message's reference with created one.
 Message RequestChannel.request(Message message)
          Send the message and waitResponse for response.
 Message RequestChannel.request(Message message, long timeout)
          Send the message and waitResponse for response or while specified timeout is elapsed.
 RequestFuture RequestChannel.beginRequest(Message message)
          Start request and exit.
 void RequestContext.respond(Message message)
          Send the message (responce) using channel that received the request.
 void RequestContext.transmit(Message message)
          Send the message to all channels EXCEPT the channel that received the request.
 void ServerChannel.send(Message message)
           
 void ServerChannel.sendToChannelsExcept(Message message, OutputChannel except)
          Send message to all channels except the one.
 void XmlMessageSerializer.serialize(Message message, javax.xml.transform.Result result)
          Serialize protocol message to XML document.
 

Constructors in com.genesyslab.platform.commons.protocol with parameters of type Message
RegistrationException(java.lang.String message, Message cause)
           
 

Uses of Message in com.genesyslab.platform.configuration.protocol.confserver.events
 

Subclasses of Message in com.genesyslab.platform.configuration.protocol.confserver.events
 class EventAuthenticated
           
 class EventError
           
 class EventHistoryLogSent
           
 class EventLocaleRead
           
 class EventNotificationRegistered
           
 class EventNotificationUnregistered
           
 class EventObjectCreated
           
 class EventObjectDeleted
           
 class EventObjectPermissionsRead
           
 class EventObjectsRead
          Returns information about objects in the Genesys Configuration Layer.
 class EventObjectsSent
          Indicates that Configuration Server has finished sending data in response to a RequestReadObjects message.
 class EventObjectUpdated
           
 class EventOperationalModeChanged
           
 class EventPasswordChanged
           
 class EventPermissionsChanged
           
 class EventPermissionsNotificationRegistered
           
 class EventPermissionsNotificationUnregistered
           
 class EventPermissionsRead
           
 class EventPermissionsUpdated
           
 

Uses of Message in com.genesyslab.platform.configuration.protocol.confserver.requests.connectivity
 

Subclasses of Message in com.genesyslab.platform.configuration.protocol.confserver.requests.connectivity
 class RequestHistoryLog
           
 

Uses of Message in com.genesyslab.platform.configuration.protocol.confserver.requests.locale
 

Subclasses of Message in com.genesyslab.platform.configuration.protocol.confserver.requests.locale
 class RequestReadLocale
          Retrieves the information from data resource repository corresponding to the requested LocaleID identifier (0 - default locale).
 

Uses of Message in com.genesyslab.platform.configuration.protocol.confserver.requests.objects
 

Subclasses of Message in com.genesyslab.platform.configuration.protocol.confserver.requests.objects
 class RequestCreateObject
          Adds a new object with property values specified by ObjectType and ConfObject.
 class RequestDeleteObject
          A request to delete an object from the Genesys Configuration Layer.
 class RequestReadObjects
          A request to obtain information about objects in the Genesys Configuration Layer.
 class RequestRegisterNotification
          Registers application to receive notifications on the objects specified in the Subscription list.
 class RequestUnregisterNotification
          Unregisters application from receiving notifications on the objects specified in the Subscription list.
 class RequestUpdateObject
          Sets new property values specified by ConfObject (delta object) for the object specified by ObjectType and delta_object.
 

Uses of Message in com.genesyslab.platform.configuration.protocol.confserver.requests.security
 

Subclasses of Message in com.genesyslab.platform.configuration.protocol.confserver.requests.security
 class RequestAuthenticate
          Authenticates user’s credentials, but does not register it on Configuration Server.
 class RequestChangePassword
          Changes password for specified user.
 class RequestReadObjectPermissions
           
 class RequestReadPermissions
           
 class RequestRegisterPermissionsNotification
           
 class RequestUnregisterPermissionsNotification
           
 class RequestUpdatePermissions
           
 


Configuration Platform SDK 7.6 API Reference

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