com.idimiddleware.objectq

Class GenericManager

java.lang.Object

com.idimiddleware.objectq.Manager

com.idimiddleware.objectq.GenericManager

public class GenericManager
extends Manager

The GenericManager is a fully functioning manager which provides access to the ObjectQ methods of get, set create, delete and action. It currently provides no validity checking. The GenericManager also processes event report request messages. It can be used as the base class for application specific managers. If it is used in this manner, only the specializations need to be added by the application specific manager, not the basic functionality.
The processing of the get, set, create, delete and action are the same. The following describes how the generic manager processes each request:

• If the state is not IDLE, return error, else execute the reset method which clears the list of messages and the list of audit objects.
• Create request using the appropriate Manager create request function.
• Call the submitRequest function to send the request, do synchronous processing if a synchronous request or register the message with the Dispatcher if an asynchronous request. Details on the processing in the submitRequest function are below.

submitRequest Function

The submitRequest function performs the following functions:

• Send the request, either to the conversational handle, if the conversational mode flag is true, or to the service, setting the reply-to handle if set in the ManagerResource.
• If mode (set in the ManagerResource) is NON_CONFIRMED, no response is expected and the processing is complete. If mode is NONE or CONFIRMED, a response is expected and is handled as described below.
• If a synchronous request, use Manager receiveSynchResponse to get the response. Then use the appropriate processGetResponse, etc. to process the response. This function is described below. This processing is repeated until all envelopes have been received.
• If an asynchronous request, register the message with the Dispatcher. The responseHandler function will call the appropriate response processing function (processGetResponse, processSetResponse, etc.) when a response is received.

Response Processing

Responses are handled by the appropriate response processing function: processGetResponse, processSetResponse, processCreateResponse, processDeleteResponse or processActionResponse. These are virtual functions with full implementations. A subclassed application specific manager can provide its own response processing for any request type. These response processing functions are called either from the submitRequest function, in the synchronous case, or the responseHandler function in the asynchronous case. Each of these response handling functions call the processResponse function which performs the following tasks:

• Unpack the envelope. The unpacked messages are added to the Manager’s message list.
• Get the list of Audit data from the Envelope and add it to the list of audit data.
• If it is not the last envelope, and the partial notify flag is set to true, execute the notifyPartial function on the requester object.
• If it is the last envelope and it is not a synchronous message, execute the notifyComplete function on the requester object and unregister the message with the Dispatcher.

GenericManager States

The GenericManager maintains 3 states, as defined as follows:

• IDLE - not processing a request; available for a new request.
• ACTIVE - started some request processing; used by a function that can be executed multiple times to create a request which contains multiple request messages in a single envelope.
• WAITING - sent a request and waiting for a response; cannot execute any new requests in this state.

Event Notification

When an event report request message is received, the eventHandler function will call the processEventRepReq function. This function calls the processEvent function which provides the following functionality:

• Unpack the envelope. The unpacked messages are added to the Manager’s message list.
• Get the list of Audit data from the Envelope and add it to the list of audit data.
• Execute the notifyEvent function on the requester object.

The processEventRepReq function is a virtual function with full implementation. A subclassed application specific manager can provide its own version if needed.

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.List<Audit>	auditData
protected Handle	conversationHandle
protected boolean	conversationMode
protected ObjectQ.ManagerStatus	requestStatus
protected java.util.List<Audit>	sendAuditData
protected ObjectQ.ManagerState	state

Fields inherited from class com.idimiddleware.objectq.Manager

auditResource, envelope, invokeId, managerResource, maxMessages, maxMessageSize, messages, modeType, partialNotify, replyQueue, requester, resource, scopeType, service, synchMessage, synchType, timeout, useReplyToQueue, vendor

Constructor Summary

Constructors

Constructor and Description
GenericManager(ManagerResource managerResource, Requester requester, java.lang.String service) Create manager for specified service using provided ManagerResource.
GenericManager(ManagerResource managerResource, java.lang.String service) Create manager for specified service using provided ManagerResource.
GenericManager(Requester requester, java.lang.String service) Create manager for specified service using default ManagerResource.
GenericManager(java.lang.String service) Create manager for specified service, using default ManagerResource.

Method Summary

Modifier and Type	Method and Description
void	action(java.lang.String className, int action, java.util.List<Attribute> attrIdList, java.util.List<Attribute> attrList, EventFilter eventFilter, Attribute instanceId)
void	action(java.lang.String className, int action, java.util.List<Attribute> attrIdList, java.util.List<Attribute> attrList, EventFilter eventFilter, Attribute instanceId, short tree, boolean more)
void	action(java.lang.String className, int action, java.util.List<Attribute> attrIdList, java.util.List<Attribute> attrList, EventFilter eventFilter, InstanceFilter instanceFilter)
void	action(java.lang.String className, int action, java.util.List<Attribute> attrIdList, java.util.List<Attribute> attrList, EventFilter eventFilter, InstanceFilter instanceFilter, short tree, boolean more) Request to perform an action on one or more objects.
void	create(java.lang.String className, java.util.List<Attribute> attrList, Attribute instanceId)
void	create(java.lang.String className, java.util.List<Attribute> attrList, Attribute instanceId, short tree, boolean more) Request to create an object.
void	delete(java.lang.String className, Attribute instanceId)
void	delete(java.lang.String className, Attribute instanceId, short tree, boolean more) Request to delete an object.
void	delete(java.lang.String className, InstanceFilter instanceFilter)
void	delete(java.lang.String className, InstanceFilter instanceFilter, short tree, boolean more)
protected void	eventHandler(Envelope envelope)
void	get(java.lang.String className, java.util.List<Attribute> attrList, Attribute instanceId)
void	get(java.lang.String className, java.util.List<Attribute> attrList, Attribute instanceId, short tree, boolean more)
void	get(java.lang.String className, java.util.List<Attribute> attrList, InstanceFilter instanceFilter)
void	get(java.lang.String className, java.util.List<Attribute> attrList, InstanceFilter instanceFilter, short tree, boolean more) Request to get data.
java.util.List<Message>	getMessages()
ObjectQ.ManagerStatus	getRequestStatus()
protected void	processActionResponse(Envelope envelope)
protected void	processCreateResponse(Envelope envelope)
protected void	processDeleteResponse(Envelope envelope)
protected void	processEventMessage(Envelope envelope)
protected void	processEventReportRequest(Envelope envelope)
protected void	processGetResponse(Envelope envelope)
protected void	processResponse(Envelope envelope)
protected void	processSetResponse(Envelope envelope)
void	reset()
protected void	responseHandler(Envelope envelope)
void	set(java.lang.String className, java.util.List<Attribute> attrList, Attribute instanceId)
void	set(java.lang.String className, java.util.List<Attribute> attrList, Attribute instanceId, short tree, boolean more)
void	set(java.lang.String className, java.util.List<Attribute> attrList, InstanceFilter instanceFilter)
void	set(java.lang.String className, java.util.List<Attribute> attrList, InstanceFilter instanceFilter, short tree, boolean more) Request to set data.
protected void	submitRequest(ObjectQ.MessageType msgType)
protected void	timeoutHandler()
java.lang.String	toString()

Methods inherited from class com.idimiddleware.objectq.Manager

action, clearMessages, createActionRequest, createActionRequest, createCreateRequest, createCreateRequest, createDeleteRequest, createDeleteRequest, createGetRequest, createGetRequest, createSetRequest, createSetRequest, delete, get, processAsynchResponse, processSynchResponse, processSynchResponse, processSynchResponse, receiveSynchResponse, receiveSynchResponse, sendRequest, sendRequest, sendRequest, sendRequest, set, subscribe, subscribe, unpackEnvelope, unsubscribe

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

auditData

protected java.util.List<Audit> auditData

conversationHandle

protected Handle conversationHandle

conversationMode

protected boolean conversationMode

requestStatus

protected ObjectQ.ManagerStatus requestStatus

sendAuditData

protected java.util.List<Audit> sendAuditData

state

protected ObjectQ.ManagerState state

Constructor Detail

GenericManager

public GenericManager(ManagerResource managerResource,
                      Requester requester,
                      java.lang.String service)
               throws NoTransportException

Create manager for specified service using provided ManagerResource.

Parameters:

managerResource - The ManagerResource.

requester - The requester object whose callback functions will be invoked.

service - The service to which requests will be sent.

Throws:

NoTransportException - There is no transport associated with this service.

GenericManager

public GenericManager(ManagerResource managerResource,
                      java.lang.String service)
               throws NoTransportException

Create manager for specified service using provided ManagerResource. No callback functionality will be provided since no requester object address has been given.

Parameters:

managerResource - The ManagerResource.

service - The service to which requests will be sent.

Throws:

NoTransportException - There is no transport associated with this service.

GenericManager

public GenericManager(Requester requester,
                      java.lang.String service)
               throws NoTransportException

Create manager for specified service using default ManagerResource.

Parameters:

requester - The requester object whose callback functions will be invoked.

service - The service to which requests will be sent.

Throws:

NoTransportException - There is no transport associated with this service.

GenericManager

public GenericManager(java.lang.String service)
               throws NoTransportException

Create manager for specified service, using default ManagerResource. All requests will be done synchronously since there is no object specified for callback functions.

Parameters:

service - The service to which requests will be sent.

Throws:

NoTransportException - There is no transport associated with this service.

Method Detail

action

public void action(java.lang.String className,
                   int action,
                   java.util.List<Attribute> attrIdList,
                   java.util.List<Attribute> attrList,
                   EventFilter eventFilter,
                   Attribute instanceId)
            throws EnvelopeOverflowException,
                   NoTransportException,
                   VendorTransportException

Throws:

EnvelopeOverflowException

NoTransportException

VendorTransportException

See Also:

action(String, int, List, List, EventFilter, InstanceFilter, short, boolean)

action

public void action(java.lang.String className,
                   int action,
                   java.util.List<Attribute> attrIdList,
                   java.util.List<Attribute> attrList,
                   EventFilter eventFilter,
                   Attribute instanceId,
                   short tree,
                   boolean more)
            throws EnvelopeOverflowException,
                   NoTransportException,
                   VendorTransportException

Throws:

EnvelopeOverflowException

NoTransportException

VendorTransportException

See Also:

action(String, int, List, List, EventFilter, InstanceFilter, short, boolean)

action

public void action(java.lang.String className,
                   int action,
                   java.util.List<Attribute> attrIdList,
                   java.util.List<Attribute> attrList,
                   EventFilter eventFilter,
                   InstanceFilter instanceFilter)
            throws EnvelopeOverflowException,
                   NoTransportException,
                   VendorTransportException

Throws:

EnvelopeOverflowException

NoTransportException

VendorTransportException

See Also:

action(String, int, List, List, EventFilter, InstanceFilter, short, boolean)

action

public void action(java.lang.String className,
                   int action,
                   java.util.List<Attribute> attrIdList,
                   java.util.List<Attribute> attrList,
                   EventFilter eventFilter,
                   InstanceFilter instanceFilter,
                   short tree,
                   boolean more)
            throws EnvelopeOverflowException,
                   NoTransportException,
                   VendorTransportException

Request to perform an action on one or more objects. The list of attribute ids specifies which of the optional output attributes to send in the response message. The list of attributes is the input attributes. The instance id specifies which instance of the class to perform the action on. The instance filter specifies which instances of the class(es) to perform the action on. If the tree = 0, this request is a class action and only applied to a class, otherwise this request is a service level action and applied to the containment tree specified, rooted at the specified class. The event filter is only used in subscription requests and specifies on which events the subscriber wishes to be sent event notification. Since multiple requests can be packaged in one request envelope, the more parameter is used to indicate whether or not any additional requests will be added to the envelope. A more parameter value of true is used when additional messages are to be part of the same request envelope. A more parameter value of False indicates that there will be no additional requests in the envelope. If the more parameter is False, after the request message is added to the envelope, the envelope will be sent. If tree and more are omitted, they are assumed to be 0 and false respectively.

Parameters:

className - The class name.

action - The action to be performed.

attrIdList - See above.

attrList - See above.

eventFilter - See above.

instanceFilter - See above.

tree - See above.

more - See above.

Throws:

EnvelopeOverflowException - The created envelope would exceed the maximum size.

NoTransportException - No transport could be found for the requested service.

VendorTransportException - A transport error occurred.

create

public void create(java.lang.String className,
                   java.util.List<Attribute> attrList,
                   Attribute instanceId)
            throws EnvelopeOverflowException,
                   NoTransportException,
                   VendorTransportException

Overrides:

create in class Manager

Throws:

EnvelopeOverflowException

NoTransportException

VendorTransportException

See Also:

create(String, List, Attribute, short, boolean)

create

public void create(java.lang.String className,
                   java.util.List<Attribute> attrList,
                   Attribute instanceId,
                   short tree,
                   boolean more)
            throws EnvelopeOverflowException,
                   NoTransportException,
                   VendorTransportException

Request to create an object. The list of attributes specifies which attributes to set on the new object. The instance id specifies which instance of the class to create. If the tree = 0, this request is applied only to a class, otherwise this request is applied to the containment tree specified, rooted at the specified class. Since multiple requests can be packaged in one request envelope, the more parameter is used to indicate whether or not any additional requests will be added to the envelope. A more parameter value of true is used when additional messages are to be part of the same request envelope. A more parameter value of False indicates that there will be no additional requests in the envelope. If the more parameter is False, after the request message is added to the envelope, the envelope will be sent. If tree and more are omitted, they are assumed to be 0 and false respectively.

Parameters:

className - The class name.

attrList - See above.

instanceId - See above.

tree - See above.

more - See above.

Throws:

EnvelopeOverflowException - The created envelope would exceed the maximum size.

NoTransportException - No transport could be found for the requested service.

VendorTransportException - A transport error occurred.

delete

public void delete(java.lang.String className,
                   Attribute instanceId)
            throws EnvelopeOverflowException,
                   NoTransportException,
                   VendorTransportException

Throws:

EnvelopeOverflowException

NoTransportException

VendorTransportException

See Also:

delete(String, Attribute, short, boolean)

delete

public void delete(java.lang.String className,
                   Attribute instanceId,
                   short tree,
                   boolean more)
            throws EnvelopeOverflowException,
                   NoTransportException,
                   VendorTransportException

Request to delete an object. The instance id specifies which instance of the class to delete. The instance filter specifies which instances of the class(es) to set the data on. If the tree = 0, this request is applied only to a class, otherwise this request is applied to the containment tree specified, rooted at the specified class. Since multiple requests can be packaged in one request envelope, the more parameter is used to indicate whether or not any additional requests will be added to the envelope. A more parameter value of true is used when additional messages are to be part of the same request envelope. A more parameter value of False indicates that there will be no additional requests in the envelope. If the more parameter is false, after the request message is added to the envelope, the envelope will be sent. If tree and more are omitted, they are assumed to be 0 and false respectively.

Parameters:

className - The class name.

instanceId - See above.

tree - See above.

more - See above.

Throws:

EnvelopeOverflowException - The created envelope would exceed the maximum size.

NoTransportException - No transport could be found for the requested service.

VendorTransportException - A transport error occurred.

delete

public void delete(java.lang.String className,
                   InstanceFilter instanceFilter)
            throws EnvelopeOverflowException,
                   NoTransportException,
                   VendorTransportException

Throws:

EnvelopeOverflowException

NoTransportException

VendorTransportException

See Also:

delete(String, Attribute, short, boolean)

delete

public void delete(java.lang.String className,
                   InstanceFilter instanceFilter,
                   short tree,
                   boolean more)
            throws EnvelopeOverflowException,
                   NoTransportException,
                   VendorTransportException

Throws:

EnvelopeOverflowException

NoTransportException

VendorTransportException

See Also:

delete(String, Attribute, short, boolean)

eventHandler

protected void eventHandler(Envelope envelope)

Specified by:

eventHandler in class Manager

get

public void get(java.lang.String className,
                java.util.List<Attribute> attrList,
                Attribute instanceId)
         throws EnvelopeOverflowException,
                NoTransportException,
                VendorTransportException

Throws:

EnvelopeOverflowException

NoTransportException

VendorTransportException

See Also:

get(String, List, InstanceFilter, short, boolean)

get

public void get(java.lang.String className,
                java.util.List<Attribute> attrList,
                Attribute instanceId,
                short tree,
                boolean more)
         throws EnvelopeOverflowException,
                NoTransportException,
                VendorTransportException

Throws:

EnvelopeOverflowException

NoTransportException

VendorTransportException

See Also:

get(String, List, InstanceFilter, short, boolean)

get

public void get(java.lang.String className,
                java.util.List<Attribute> attrList,
                InstanceFilter instanceFilter)
         throws EnvelopeOverflowException,
                NoTransportException,
                VendorTransportException

Throws:

EnvelopeOverflowException

NoTransportException

VendorTransportException

See Also:

get(String, List, InstanceFilter, short, boolean)

get

public void get(java.lang.String className,
                java.util.List<Attribute> attrList,
                InstanceFilter instanceFilter,
                short tree,
                boolean more)
         throws EnvelopeOverflowException,
                NoTransportException,
                VendorTransportException

Request to get data. The list of attributes specifies which attributes to retrieve. The instance id specifies which instance of the class to get the data on. The instance filter specifies which instances of the class(es) to get the data on. If the tree = 0, this request is applied only to a class, otherwise this request is applied to the containment tree specified, rooted at the specified class. Since multiple requests can be packaged in one request envelope, the more parameter is used to indicate whether or not any additional requests will be added to the envelope. A more parameter value of true is used when additional messages are to be part of the same request envelope. A more parameter value of False indicates that there will be no additional requests in the envelope. If the more parameter is False, after the request message is added to the envelope, the envelope will be sent. If tree and more are omitted, they are assumed to be 0 and false respectively.

Parameters:

className - The class name.

attrList - See above.

instanceFilter - See above.

tree - See above.

more - See above.

Throws:

EnvelopeOverflowException - The created envelope would exceed the maximum size.

NoTransportException - No transport could be found for the requested service.

VendorTransportException - A transport error occurred.

getMessages

public java.util.List<Message> getMessages()

getRequestStatus

public ObjectQ.ManagerStatus getRequestStatus()

Returns:

the requestStatus

processActionResponse

protected void processActionResponse(Envelope envelope)

processCreateResponse

protected void processCreateResponse(Envelope envelope)

processDeleteResponse

protected void processDeleteResponse(Envelope envelope)

processEventMessage

protected void processEventMessage(Envelope envelope)

processEventReportRequest

protected void processEventReportRequest(Envelope envelope)

processGetResponse

protected void processGetResponse(Envelope envelope)

processResponse

protected void processResponse(Envelope envelope)

processSetResponse

protected void processSetResponse(Envelope envelope)

reset

public void reset()

responseHandler

protected void responseHandler(Envelope envelope)

Specified by:

responseHandler in class Manager

set

public void set(java.lang.String className,
                java.util.List<Attribute> attrList,
                Attribute instanceId)
         throws EnvelopeOverflowException,
                NoTransportException,
                VendorTransportException

Throws:

EnvelopeOverflowException

NoTransportException

VendorTransportException

See Also:

set(String, List, InstanceFilter, short, boolean)

set

public void set(java.lang.String className,
                java.util.List<Attribute> attrList,
                Attribute instanceId,
                short tree,
                boolean more)
         throws EnvelopeOverflowException,
                NoTransportException,
                VendorTransportException

Throws:

EnvelopeOverflowException

NoTransportException

VendorTransportException

See Also:

set(String, List, InstanceFilter, short, boolean)

set

public void set(java.lang.String className,
                java.util.List<Attribute> attrList,
                InstanceFilter instanceFilter)
         throws EnvelopeOverflowException,
                NoTransportException,
                VendorTransportException

Throws:

EnvelopeOverflowException

NoTransportException

VendorTransportException

See Also:

set(String, List, InstanceFilter, short, boolean)

set

public void set(java.lang.String className,
                java.util.List<Attribute> attrList,
                InstanceFilter instanceFilter,
                short tree,
                boolean more)
         throws EnvelopeOverflowException,
                NoTransportException,
                VendorTransportException

Request to set data. The list of attributes specifies which attributes to retrieve. The instance id specifies which instance of the class to set the data on. The instance filter specifies which instances of the class(es) to set the data on. If the tree = 0, this request is applied only to a class, otherwise this request is applied to the containment tree specified, rooted at the specified class. Since multiple requests can be packaged in one request envelope, the more parameter is used to indicate whether or not any additional requests will be added to the envelope. A more parameter value of true is used when additional messages are to be part of the same request envelope. A more parameter value of False indicates that there will be no additional requests in the envelope. If the more parameter is False, after the request message is added to the envelope, the envelope will be sent. If tree and more are omitted, they are assumed to be 0 and false respectively.

Parameters:

className - The class name.

attrList - See above.

instanceFilter - See above.

tree - See above.

more - See above.

Throws:

EnvelopeOverflowException - The created envelope would exceed the maximum size.

NoTransportException - No transport could be found for the requested service.

VendorTransportException - A transport error occurred.

submitRequest

protected void submitRequest(ObjectQ.MessageType msgType)
                      throws NoTransportException,
                             VendorTransportException

Throws:

NoTransportException

VendorTransportException

timeoutHandler

protected void timeoutHandler()

Specified by:

timeoutHandler in class Manager

toString

public java.lang.String toString()

Overrides:

toString in class Manager