com.oakgrovesystems.reactor.client
Class AbstractReactorProxy

java.lang.Object
  |
  +--com.oakgrovesystems.reactor.client.AbstractReactorProxy
All Implemented Interfaces:
ReactorProxy
Direct Known Subclasses:
EJBReactorProxy, TestReactorProxy, XMLReactorProxy

public abstract class AbstractReactorProxy
extends java.lang.Object
implements ReactorProxy

AbstractReactorProxy is a convenience class that programmers can use to make requests to Reactor server. Users can use either EJBReactorProxy or XMLReactorProxy.


Field Summary
protected  java.lang.String authToken
          Authentication token that this proxy uses as credential to talk to the server
 
Constructor Summary
AbstractReactorProxy()
           
 
Method Summary
 void addStatusToProcess(com.oakgrovesystems.reactor.LabelPath processLabelPath, com.oakgrovesystems.reactor.LabelPath statusLabelPath)
          Sends add status request to the server.
 void addStatusToProcess(com.oakgrovesystems.reactor.processMediation.Process process, com.oakgrovesystems.reactor.processMediation.Status status)
          Sends add status request to the server.
 void addStatusToProcess(com.oakgrovesystems.reactor.ReactorObjectId processId, com.oakgrovesystems.reactor.ReactorObjectId statusId)
          Sends add status request to the server.
 com.oakgrovesystems.reactor.ReactorObjectId cloneInstance(com.oakgrovesystems.reactor.LabelPath labelPath)
          Sends a clone request to the server.
 com.oakgrovesystems.reactor.ReactorObjectId cloneInstance(com.oakgrovesystems.reactor.LabelPath labelPath, java.lang.String cloneLabel)
          Sends a clone request to the server.
 com.oakgrovesystems.reactor.ReactorObjectId cloneInstance(com.oakgrovesystems.reactor.processMediation.Process process)
          Sends a clone request to the server.
 com.oakgrovesystems.reactor.ReactorObjectId cloneInstance(com.oakgrovesystems.reactor.processMediation.Process process, java.lang.String cloneLabel)
          Sends a clone request to the server.
 com.oakgrovesystems.reactor.ReactorObjectId cloneInstance(com.oakgrovesystems.reactor.ReactorObjectId id)
          Sends a clone request to the server.
 com.oakgrovesystems.reactor.ReactorObjectId cloneInstance(com.oakgrovesystems.reactor.ReactorObjectId id, java.lang.String cloneLabel)
          Sends a clone request to the server.
 void createObjects(java.util.Set set)
          Sends create request to the server.
 void createObjects(java.util.Set set, com.oakgrovesystems.reactor.ReactorObjects objects)
          Sends create request to the server The objects to be created must only be process mediation objects.
 void delete(com.oakgrovesystems.reactor.LabelPath labelPath, java.lang.Class type)
          Sends a delete request to the server.
 void delete(com.oakgrovesystems.reactor.LabelPath labelPath, java.lang.Class type, com.oakgrovesystems.reactor.ReactorObjects objects)
          Sends a delete request to the server.
 void delete(com.oakgrovesystems.reactor.ReactorObjectId id, java.lang.Class type)
          Sends a delete request to the server.
 void delete(com.oakgrovesystems.reactor.ReactorObjectId id, java.lang.Class type, com.oakgrovesystems.reactor.ReactorObjects objects)
          Sends a delete request to the server.
 com.oakgrovesystems.reactor.processMediation.ProcessMediationObject get(com.oakgrovesystems.reactor.LabelPath labelPath)
          Sends get request to the server.
 com.oakgrovesystems.reactor.processMediation.ProcessMediationObject get(com.oakgrovesystems.reactor.LabelPath labelPath, com.oakgrovesystems.reactor.ReactorObjects objects)
          Sends get request to the server.
 com.oakgrovesystems.reactor.processMediation.ProcessMediationObject get(com.oakgrovesystems.reactor.ReactorObjectId id)
          Sends get request to the server.
 com.oakgrovesystems.reactor.processMediation.ProcessMediationObject get(com.oakgrovesystems.reactor.ReactorObjectId id, com.oakgrovesystems.reactor.ReactorObjects objects)
          Sends get request to the server.
 java.lang.String getAuthToken()
          Gets the authentication token that this proxy is using to talk to server
 com.oakgrovesystems.reactor.ReactorResponse handleRequest(com.oakgrovesystems.reactor.requests.ReactorRequest request)
          Sends request to the server.
 void lock(com.oakgrovesystems.reactor.LabelPath path, com.oakgrovesystems.reactor.processMediation.ACE ace)
           
 void lock(com.oakgrovesystems.reactor.LabelPath path, com.oakgrovesystems.reactor.processMediation.ACE ace, java.lang.String eligibleRole, java.lang.String standbyRole, com.oakgrovesystems.reactor.LabelPath status)
           
 void lock(com.oakgrovesystems.reactor.LabelPath path, com.oakgrovesystems.reactor.processMediation.ACE ace, java.lang.String eligibleRole, java.lang.String standbyRole, com.oakgrovesystems.reactor.ReactorObjectId status)
           
 void lock(com.oakgrovesystems.reactor.ReactorObjectId id, com.oakgrovesystems.reactor.processMediation.ACE ace)
           
 void lock(com.oakgrovesystems.reactor.ReactorObjectId id, com.oakgrovesystems.reactor.processMediation.ACE ace, java.lang.String eligibleRole, java.lang.String standbyRole)
           
 void lock(com.oakgrovesystems.reactor.ReactorObjectId id, com.oakgrovesystems.reactor.processMediation.ACE ace, java.lang.String eligibleRole, java.lang.String standbyRole, com.oakgrovesystems.reactor.LabelPath status)
           
 void lock(com.oakgrovesystems.reactor.ReactorObjectId id, com.oakgrovesystems.reactor.processMediation.ACE ace, java.lang.String eligibleRole, java.lang.String standbyRole, com.oakgrovesystems.reactor.ReactorObjectId status)
           
protected  void lock(com.oakgrovesystems.reactor.ReactorObjectId objectId, com.oakgrovesystems.reactor.LabelPath objectPath, com.oakgrovesystems.reactor.processMediation.ACE ace, java.lang.String eligibleRole, java.lang.String standbyRole, com.oakgrovesystems.reactor.ReactorObjectId statusId, com.oakgrovesystems.reactor.LabelPath statusPath)
           
 java.lang.String login(java.lang.String username, java.lang.String password)
          Sends login request to the server.
 void logout()
          Sends logout request to the server.
 com.oakgrovesystems.reactor.ReactorObjects query(com.oakgrovesystems.reactor.client.QueryCriteria criteria, com.oakgrovesystems.reactor.ReactorObjects objects)
          Sends a query request to the server.
 void removeStatusFromProcess(com.oakgrovesystems.reactor.LabelPath processLabelPath, com.oakgrovesystems.reactor.LabelPath statusLabelPath)
          Sends remove status request to the server.
 void removeStatusFromProcess(com.oakgrovesystems.reactor.processMediation.Process process, com.oakgrovesystems.reactor.processMediation.Status status)
          Sends remove status request to the server.
 void removeStatusFromProcess(com.oakgrovesystems.reactor.ReactorObjectId processId, com.oakgrovesystems.reactor.ReactorObjectId statusId)
          Sends remove status request to the server.
protected abstract  com.oakgrovesystems.reactor.ReactorResponse sendRequest(com.oakgrovesystems.reactor.requests.ReactorRequest request)
          Sends request to the server.
 void setACLOnObject(com.oakgrovesystems.reactor.LabelPath objectLabelPath, com.oakgrovesystems.reactor.processMediation.ACL newACL, java.lang.Class type)
          Sets a new ACL on an object by labelpath.
 void setACLOnObject(com.oakgrovesystems.reactor.ReactorObjectId objectId, com.oakgrovesystems.reactor.processMediation.ACL newACL, java.lang.Class type)
          Sets a new ACL on an object by ID.
 void setAuthToken(java.lang.String authToken)
          Sets the authentication token that proxy will use to talk to server
 void setObjects(java.util.Set set)
          Sends the set request to the server.
 void setObjects(java.util.Set set, com.oakgrovesystems.reactor.ReactorObjects objects)
          Sends the set request to the server.
 void startProcess(com.oakgrovesystems.reactor.LabelPath labelPath)
          Sends a start request to the server.
 void startProcess(com.oakgrovesystems.reactor.processMediation.Process process)
          Sends a start request to the server.
 void startProcess(com.oakgrovesystems.reactor.ReactorObjectId id)
          Sends a start request to the server.
 void stopProcess(com.oakgrovesystems.reactor.LabelPath labelPath)
          Sends a stop request to the server.
 void stopProcess(com.oakgrovesystems.reactor.processMediation.Process process)
          Sends a stop request to the server.
 void stopProcess(com.oakgrovesystems.reactor.ReactorObjectId id)
          Sends a stop request to the server.
 void unlock(com.oakgrovesystems.reactor.LabelPath path, com.oakgrovesystems.reactor.processMediation.ACE ace)
           
 void unlock(com.oakgrovesystems.reactor.LabelPath path, com.oakgrovesystems.reactor.processMediation.ACE ace, java.lang.String eligibleRole, java.lang.String standbyRole, com.oakgrovesystems.reactor.LabelPath status)
           
 void unlock(com.oakgrovesystems.reactor.LabelPath path, com.oakgrovesystems.reactor.processMediation.ACE ace, java.lang.String eligibleRole, java.lang.String standbyRole, com.oakgrovesystems.reactor.ReactorObjectId status)
           
 void unlock(com.oakgrovesystems.reactor.ReactorObjectId id, com.oakgrovesystems.reactor.processMediation.ACE ace)
           
 void unlock(com.oakgrovesystems.reactor.ReactorObjectId id, com.oakgrovesystems.reactor.processMediation.ACE ace, java.lang.String eligibleRole, java.lang.String standbyRole)
           
 void unlock(com.oakgrovesystems.reactor.ReactorObjectId id, com.oakgrovesystems.reactor.processMediation.ACE ace, java.lang.String eligibleRole, java.lang.String standbyRole, com.oakgrovesystems.reactor.LabelPath status)
           
 void unlock(com.oakgrovesystems.reactor.ReactorObjectId id, com.oakgrovesystems.reactor.processMediation.ACE ace, java.lang.String eligibleRole, java.lang.String standbyRole, com.oakgrovesystems.reactor.ReactorObjectId status)
           
protected  void unlock(com.oakgrovesystems.reactor.ReactorObjectId objectId, com.oakgrovesystems.reactor.LabelPath objectPath, com.oakgrovesystems.reactor.processMediation.ACE ace, java.lang.String eligibleRole, java.lang.String standbyRole, com.oakgrovesystems.reactor.ReactorObjectId statusId, com.oakgrovesystems.reactor.LabelPath statusPath)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

authToken

protected java.lang.String authToken
Authentication token that this proxy uses as credential to talk to the server

Constructor Detail

AbstractReactorProxy

public AbstractReactorProxy()
Method Detail

setAuthToken

public void setAuthToken(java.lang.String authToken)
Sets the authentication token that proxy will use to talk to server

Specified by:
setAuthToken in interface ReactorProxy
Parameters:
authToken - the authentication token

getAuthToken

public java.lang.String getAuthToken()
Gets the authentication token that this proxy is using to talk to server

Specified by:
getAuthToken in interface ReactorProxy
Returns:
the authentication token

handleRequest

public com.oakgrovesystems.reactor.ReactorResponse handleRequest(com.oakgrovesystems.reactor.requests.ReactorRequest request)
                                                          throws ReactorProxyException
Sends request to the server. This is a generic method that users can use to make requests to the server. Users can create requests using classes from com.oakgrovesystems.reactor.requests package and use this method to to send it to server.

Specified by:
handleRequest in interface ReactorProxy
Parameters:
request - the request that has to be made to the server
Returns:
response the response from the server
Throws:
ReactorProxyException - if error occurs while talking to the server.

login

public java.lang.String login(java.lang.String username,
                              java.lang.String password)
                       throws ReactorProxyException
Sends login request to the server. The client should login before making other requests. The authentication token returned will be used in the subsequent requests that client makes

Specified by:
login in interface ReactorProxy
Parameters:
username - the username credential of the user
password - the password credential of the user
Returns:
the authentication token that this proxy will use for making requests to the server
Throws:
ReactorProxyException - if username or password is null or login request fails or an error occurs while talking to the server.

logout

public void logout()
            throws ReactorProxyException
Sends logout request to the server.

Specified by:
logout in interface ReactorProxy
Throws:
ReactorProxyException - if logout request fails or an error occurs while talking to the server.

createObjects

public void createObjects(java.util.Set set)
                   throws ReactorProxyException
Sends create request to the server. The objects to be created must only be process mediation objects.

Specified by:
createObjects in interface ReactorProxy
Parameters:
set - The set of process mediation objects to be created.
Throws:
ReactorProxyException - if arguement set is null or create request fails or an error occurs while talking to the server.

createObjects

public void createObjects(java.util.Set set,
                          com.oakgrovesystems.reactor.ReactorObjects objects)
                   throws ReactorProxyException
Sends create request to the server The objects to be created must only be process mediation objects. If create request is successful then the objects to be created will be added to convenience collection object ReactorObjects

Specified by:
createObjects in interface ReactorProxy
Parameters:
set - The set of new process mediation objects to be created.
objects - The convenience collection object to which created objects will be added. Can be null.
Throws:
ReactorProxyException - if argument set is null or create request fails or an error occurs while talking to the server.

setObjects

public void setObjects(java.util.Set set)
                throws ReactorProxyException
Sends the set request to the server. The objects to be set must only be process mediation objects. If the process mediation object to be set already exists then it will be updated else a new object will be created.

Specified by:
setObjects in interface ReactorProxy
Parameters:
set - The set of process mediation objects to be updated.
Throws:
ReactorProxyException - If argument set is null or set request fails or an error occurs while talking to the server.

setObjects

public void setObjects(java.util.Set set,
                       com.oakgrovesystems.reactor.ReactorObjects objects)
                throws ReactorProxyException
Sends the set request to the server. The objects to be set must only be process mediation objects. If the process mediation object to be set already exists then it will be updated else a new object will be created. If set request is successful then the objects to be set will be added to convenience collection object ReactorObjects

Specified by:
setObjects in interface ReactorProxy
Parameters:
set - The set of process mediation objects to be updated.
objects - The convenience collection object to which updated objects will be added. Can be null.
Throws:
ReactorProxyException - If argument set is null or set request fails or an error occurs while talking to the server.

delete

public void delete(com.oakgrovesystems.reactor.ReactorObjectId id,
                   java.lang.Class type)
            throws ReactorProxyException
Sends a delete request to the server. This request deletes the process mediation object and all its associated objects

Specified by:
delete in interface ReactorProxy
Parameters:
id - The id of the process mediation object to be deleted.
type - The class of the object to be deleted. Either Process, Operand, Status or Policy classes from com.oakgrovesystems.reactor.processMediation package.
Throws:
ReactorProxyException - If arguments id or type are null or delete request fails or an error occurs while talking to the server.

delete

public void delete(com.oakgrovesystems.reactor.ReactorObjectId id,
                   java.lang.Class type,
                   com.oakgrovesystems.reactor.ReactorObjects objects)
            throws ReactorProxyException
Sends a delete request to the server. This request deletes the process mediation object and all its associated objects. It will also remove the object from convenience collection object ReactorObjects

Specified by:
delete in interface ReactorProxy
Parameters:
id - The id of the process mediation object to be deleted.
type - The class of the object to be deleted. Either Process, Operand, Status or Policy classes from com.oakgrovesystems.reactor.processMediation package.
Throws:
ReactorProxyException - If argument id or type are null or delete request fails or an error occurs while talking to the server.

delete

public void delete(com.oakgrovesystems.reactor.LabelPath labelPath,
                   java.lang.Class type)
            throws ReactorProxyException
Sends a delete request to the server. This request deletes the process mediation object and all its associated objects. The labelPath must resolve to only ONE process mediation object.

Specified by:
delete in interface ReactorProxy
Parameters:
labelPath - The label path of the process mediation object to be deleted. The label path must resolve to only ONE processMediation object.
type - The class of the object to be deleted. Either Process, Operand, Status or Policy classes from com.oakgrovesystems.reactor.processMediation package.
Throws:
ReactorProxyException - If argument labelPath or type is null or delete request fails or an error occurs while talking to the server.

delete

public void delete(com.oakgrovesystems.reactor.LabelPath labelPath,
                   java.lang.Class type,
                   com.oakgrovesystems.reactor.ReactorObjects objects)
            throws ReactorProxyException
Sends a delete request to the server. This request deletes the process mediation object and all its associated objects. The labelPath must resolve to only ONE process mediation object. It will also remove the object from convenience collection object ReactorObjects

Specified by:
delete in interface ReactorProxy
Parameters:
labelPath - The label path of the process mediation object to be deleted. The label path must resolve to only ONE processMediation object.
type - The class of the object to be deleted. Either Process, Operand, Status or Policy classes from com.oakgrovesystems.reactor.processMediation package.
Throws:
ReactorProxyException - If argument labelPath or type is null or delete request fails or an error occurs while talking to the server.

cloneInstance

public com.oakgrovesystems.reactor.ReactorObjectId cloneInstance(com.oakgrovesystems.reactor.ReactorObjectId id)
                                                          throws ReactorProxyException
Sends a clone request to the server. This request will create an instance of the process definition.

Specified by:
cloneInstance in interface ReactorProxy
Parameters:
id - The id of the process to be cloned.
Returns:
The id of cloned instance of the process.
Throws:
ReactorProxyException - If argument id is null or clone request fails or an error occurs while talking to the server.

cloneInstance

public com.oakgrovesystems.reactor.ReactorObjectId cloneInstance(com.oakgrovesystems.reactor.LabelPath labelPath)
                                                          throws ReactorProxyException
Sends a clone request to the server. This request will create an instance of the process definition. The label path must resolve to only ONE process definition.

Specified by:
cloneInstance in interface ReactorProxy
Parameters:
labelPath - The label path of the process to be cloned. The label path must resolve to only ONE process definition.
Returns:
The id of cloned instance of the process.
Throws:
ReactorProxyException - If argument labelPath is null or clone request fails or an error occurs while talking to the server.

cloneInstance

public com.oakgrovesystems.reactor.ReactorObjectId cloneInstance(com.oakgrovesystems.reactor.processMediation.Process process)
                                                          throws ReactorProxyException
Sends a clone request to the server. This request will create an instance of the process definition.

Specified by:
cloneInstance in interface ReactorProxy
Parameters:
process - The process to be cloned.
Returns:
The id of cloned instance of the process.
Throws:
ReactorProxyException - If argument process is null or clone request fails or an error occurs while talking to the server.

cloneInstance

public com.oakgrovesystems.reactor.ReactorObjectId cloneInstance(com.oakgrovesystems.reactor.ReactorObjectId id,
                                                                 java.lang.String cloneLabel)
                                                          throws ReactorProxyException
Sends a clone request to the server. This request will create an instance of the process definition and assigns it a new label.

Specified by:
cloneInstance in interface ReactorProxy
Parameters:
id - The id of the process to be cloned.
cloneLabel - The new label to be assigned to the process instance.
Returns:
The id of cloned instance of the process.
Throws:
ReactorProxyException - If argument id is null or clone request fails or an error occurs while talking to the server.

cloneInstance

public com.oakgrovesystems.reactor.ReactorObjectId cloneInstance(com.oakgrovesystems.reactor.LabelPath labelPath,
                                                                 java.lang.String cloneLabel)
                                                          throws ReactorProxyException
Sends a clone request to the server. This request will create an instance of the process definition and assigns it a new label. The label path must resolve to only ONE process definition.

Specified by:
cloneInstance in interface ReactorProxy
Parameters:
labelPath - The label path of the process to be cloned. The label path must resolve to only ONE process definition.
cloneLabel - The new label to be assigned to the process instance.
Returns:
The id of cloned instance of the process.
Throws:
ReactorProxyException - If arguement labelPath is null or clone request fails or an error occurs while talking to the server.

cloneInstance

public com.oakgrovesystems.reactor.ReactorObjectId cloneInstance(com.oakgrovesystems.reactor.processMediation.Process process,
                                                                 java.lang.String cloneLabel)
                                                          throws ReactorProxyException
Sends a clone request to the server. This request will create an instance of the process definition and assigns it a new label.

Specified by:
cloneInstance in interface ReactorProxy
Parameters:
process - The process to be cloned.
cloneLabel - The new label to be assigned to the process instance.
Returns:
The id of cloned instance of the process.
Throws:
ReactorProxyException - If argument process is null or clone request fails or an error occurs while talking to the server.

startProcess

public void startProcess(com.oakgrovesystems.reactor.ReactorObjectId id)
                  throws ReactorProxyException
Sends a start request to the server. Only process instances can be started. So process definition must be cloned before it can be started.

Specified by:
startProcess in interface ReactorProxy
Parameters:
id - The id of the process instance to be started.
Throws:
ReactorProxyException - If argument id is null or start request fails or an error occurs while talking to the server.

startProcess

public void startProcess(com.oakgrovesystems.reactor.LabelPath labelPath)
                  throws ReactorProxyException
Sends a start request to the server. Only process instances can be started. So process definition must be cloned before it can be started. The label path must resolve to only ONE process instance.

Specified by:
startProcess in interface ReactorProxy
Parameters:
labelPath - The label path of the process instance to be started. The label path must resolve to only ONE process instance.
Throws:
ReactorProxyException - If argument labelPath is null or start request fails or an error occurs while talking to the server.

startProcess

public void startProcess(com.oakgrovesystems.reactor.processMediation.Process process)
                  throws ReactorProxyException
Sends a start request to the server. Only process instances can be started. So process definition must be cloned before it can be started.

Specified by:
startProcess in interface ReactorProxy
Parameters:
process - The process instance to be started.
Throws:
ReactorProxyException - If argument process is null or start request fails or an error occurs while talking to the server.

stopProcess

public void stopProcess(com.oakgrovesystems.reactor.ReactorObjectId id)
                 throws ReactorProxyException
Sends a stop request to the server. Only started processes can be stopped.

Specified by:
stopProcess in interface ReactorProxy
Parameters:
id - The id of the started process instance to be stopped.
Throws:
ReactorProxyException - If argument id is null or stop request fails or an error occurs while talking to the server.

stopProcess

public void stopProcess(com.oakgrovesystems.reactor.LabelPath labelPath)
                 throws ReactorProxyException
Sends a stop request to the server. Only started processes can be stopped. The label path must resolve to only ONE started process instance.

Specified by:
stopProcess in interface ReactorProxy
Parameters:
labelPath - The label path of the started process instance to be stopped. The label path must resolve to only ONE started process instance.
Throws:
ReactorProxyException - If argument id is null or stop request fails or an error occurs while talking to the server.

stopProcess

public void stopProcess(com.oakgrovesystems.reactor.processMediation.Process process)
                 throws ReactorProxyException
Sends a stop request to the server. Only started processes can be stopped.

Specified by:
stopProcess in interface ReactorProxy
Parameters:
process - The started process instance to be stopped.
Throws:
ReactorProxyException - If argument process is null or stop request fails or an error occurs while talking to the server.

setACLOnObject

public void setACLOnObject(com.oakgrovesystems.reactor.ReactorObjectId objectId,
                           com.oakgrovesystems.reactor.processMediation.ACL newACL,
                           java.lang.Class type)
                    throws ReactorProxyException
Sets a new ACL on an object by ID.

Specified by:
setACLOnObject in interface ReactorProxy
Parameters:
objectId - The id of the object on which the new ACL will be set.
type - The class type the objectId refers to.
Throws:
ReactorProxyException - If any argument is null, the request fails, or if other errors occur while talking to the server.

setACLOnObject

public void setACLOnObject(com.oakgrovesystems.reactor.LabelPath objectLabelPath,
                           com.oakgrovesystems.reactor.processMediation.ACL newACL,
                           java.lang.Class type)
                    throws ReactorProxyException
Sets a new ACL on an object by labelpath.

Specified by:
setACLOnObject in interface ReactorProxy
Parameters:
type - The class type the labelPath refers to.
Throws:
ReactorProxyException - If any argument is null, the request fails, or if other errors occur while talking to the server.

addStatusToProcess

public void addStatusToProcess(com.oakgrovesystems.reactor.ReactorObjectId processId,
                               com.oakgrovesystems.reactor.ReactorObjectId statusId)
                        throws ReactorProxyException
Sends add status request to the server. A status can be added only to a process instance.

Specified by:
addStatusToProcess in interface ReactorProxy
Parameters:
processId - The id of the process to which the status will be added.
statusId - The id of the status that will be added to the process.
Throws:
ReactorProxyException - If argument processId or statusId is null or add status request fails or an error occurs while talking to the server.

addStatusToProcess

public void addStatusToProcess(com.oakgrovesystems.reactor.LabelPath processLabelPath,
                               com.oakgrovesystems.reactor.LabelPath statusLabelPath)
                        throws ReactorProxyException
Sends add status request to the server. A status can be added only to a process instance. The label path of the process must resolve to ony ONE process instance and the label path of the staus must resolve to only ONE status.

Specified by:
addStatusToProcess in interface ReactorProxy
Parameters:
processLabelPath - The label path of the process to which the status will be added. The label path must resolve to only ONE process instance.
statusLabelPath - The label path of the status that will be added to the process. The label path must resolve to ony one status.
Throws:
ReactorProxyException - If argument processLabelPath or statusLabelPath is null or add status request fails or an error occurs while talking to the server.

addStatusToProcess

public void addStatusToProcess(com.oakgrovesystems.reactor.processMediation.Process process,
                               com.oakgrovesystems.reactor.processMediation.Status status)
                        throws ReactorProxyException
Sends add status request to the server. A status can be added only to a process instance.

Specified by:
addStatusToProcess in interface ReactorProxy
Parameters:
process - The process to which the status will be added.
status - The status that will be added to the process.
Throws:
ReactorProxyException - If argument process or status is null or add status request fails or an error occurs while talking to the server.

removeStatusFromProcess

public void removeStatusFromProcess(com.oakgrovesystems.reactor.ReactorObjectId processId,
                                    com.oakgrovesystems.reactor.ReactorObjectId statusId)
                             throws ReactorProxyException
Sends remove status request to the server. A status can be added only be removed from a process instance.

Specified by:
removeStatusFromProcess in interface ReactorProxy
Parameters:
processId - The id of the process from which the status will be removed.
statusId - The id of the status that will be removed from the process.
Throws:
ReactorProxyException - If argument processId or argument statusId is null or remove status request fails or an error occurs while talking to the server.

removeStatusFromProcess

public void removeStatusFromProcess(com.oakgrovesystems.reactor.LabelPath processLabelPath,
                                    com.oakgrovesystems.reactor.LabelPath statusLabelPath)
                             throws ReactorProxyException
Sends remove status request to the server. A status can be added only be removed from a process instance. The label path of the process must resolve to ony ONE process instance and the label path of the staus must resolve to only ONE status.

Specified by:
removeStatusFromProcess in interface ReactorProxy
Parameters:
processLabelPath - The label path of the process from which the status will be removed. The label path must resolve to only ONE process instance.
statusLabelPath - The label path of the status that will be removed from the process. The label path must resolve to ony one status.
Throws:
ReactorProxyException - If argument processLabelPath or statusLabelPath is null or remove status request fails or an error occurs while talking to the server.

removeStatusFromProcess

public void removeStatusFromProcess(com.oakgrovesystems.reactor.processMediation.Process process,
                                    com.oakgrovesystems.reactor.processMediation.Status status)
                             throws ReactorProxyException
Sends remove status request to the server. A status can be added only be removed from a process instance.

Specified by:
removeStatusFromProcess in interface ReactorProxy
Parameters:
process - The process from which the status will be removed .
status - The status that will be removed from the process.
Throws:
ReactorProxyException - If argument process or status is null or remove status request fails or an error occurs while talking to the server.

get

public com.oakgrovesystems.reactor.processMediation.ProcessMediationObject get(com.oakgrovesystems.reactor.ReactorObjectId id)
                                                                        throws ReactorProxyException
Sends get request to the server. The process mediation object to get must exist on the server.

Specified by:
get in interface ReactorProxy
Parameters:
id - The id of the process mediation object to get.
Returns:
The process mediation object.
Throws:
ReactorProxyException - If argument id is null or get request fails or error occurs while talking to the server.

get

public com.oakgrovesystems.reactor.processMediation.ProcessMediationObject get(com.oakgrovesystems.reactor.ReactorObjectId id,
                                                                               com.oakgrovesystems.reactor.ReactorObjects objects)
                                                                        throws ReactorProxyException
Sends get request to the server. The process mediation object to get must exist on the server. The process mediation object will be added to the convenience collection ReactorObjects

Specified by:
get in interface ReactorProxy
Parameters:
id - The id of the process mediation object to get.
objects - The convenience collection object to which the process mediation object will be added. Can be null.
Returns:
The process mediation object.
Throws:
ReactorProxyException - If argument id is null or get request fails or an error occurs while talking to the server.

get

public com.oakgrovesystems.reactor.processMediation.ProcessMediationObject get(com.oakgrovesystems.reactor.LabelPath labelPath)
                                                                        throws ReactorProxyException
Sends get request to the server. The process mediation object to get must exist on the server. The label path must resove to only ONE process mediation object.

Specified by:
get in interface ReactorProxy
Parameters:
labelPath - The labelPath of the process mediation object to get. The label path must resolve to only one process mediation object.
Returns:
The process mediation object.
Throws:
ReactorProxyException - If argument labelPath is null or get request fails or an error occurs while talking to the server.

get

public com.oakgrovesystems.reactor.processMediation.ProcessMediationObject get(com.oakgrovesystems.reactor.LabelPath labelPath,
                                                                               com.oakgrovesystems.reactor.ReactorObjects objects)
                                                                        throws ReactorProxyException
Sends get request to the server. The process mediation object to get must exist on the server. The label path must resove to only ONE process mediation object. The process mediation object will be added to the convenience collection ReactorObjects

Specified by:
get in interface ReactorProxy
Parameters:
labelPath - The labelPath of the process mediation object to get. The label path must resolve to only one process mediation object.
objects - The convenience collection object to which the process mediation object will be added. Can be null
Returns:
The process mediation object.
Throws:
ReactorProxyException - If argument labelPath is null or get request fails or an error occurs while talking to the server.

query

public com.oakgrovesystems.reactor.ReactorObjects query(com.oakgrovesystems.reactor.client.QueryCriteria criteria,
                                                        com.oakgrovesystems.reactor.ReactorObjects objects)
                                                 throws ReactorProxyException
Sends a query request to the server. Various combination of criteria can be specified using QueryCriteria object. If ReactorObjects is provided as an argument then process mediation objects meeting the criteria will be added to it or else a new instance of ReactorObjects will be created and returned.

Specified by:
query in interface ReactorProxy
Parameters:
criteria - The criteria of the query.
objects - If specified then process mediation objects will be added to it.
Returns:
The convenience collection object containing the process mediation objects
Throws:
ReactorProxyException - If argument criteria is null or query request fails or an error occurs while talking to the server.

lock

public void lock(com.oakgrovesystems.reactor.ReactorObjectId id,
                 com.oakgrovesystems.reactor.processMediation.ACE ace)
          throws ReactorProxyException
Specified by:
lock in interface ReactorProxy
ReactorProxyException

lock

public void lock(com.oakgrovesystems.reactor.ReactorObjectId id,
                 com.oakgrovesystems.reactor.processMediation.ACE ace,
                 java.lang.String eligibleRole,
                 java.lang.String standbyRole)
          throws ReactorProxyException
Specified by:
lock in interface ReactorProxy
ReactorProxyException

lock

public void lock(com.oakgrovesystems.reactor.ReactorObjectId id,
                 com.oakgrovesystems.reactor.processMediation.ACE ace,
                 java.lang.String eligibleRole,
                 java.lang.String standbyRole,
                 com.oakgrovesystems.reactor.ReactorObjectId status)
          throws ReactorProxyException
Specified by:
lock in interface ReactorProxy
ReactorProxyException

lock

public void lock(com.oakgrovesystems.reactor.ReactorObjectId id,
                 com.oakgrovesystems.reactor.processMediation.ACE ace,
                 java.lang.String eligibleRole,
                 java.lang.String standbyRole,
                 com.oakgrovesystems.reactor.LabelPath status)
          throws ReactorProxyException
Specified by:
lock in interface ReactorProxy
ReactorProxyException

lock

public void lock(com.oakgrovesystems.reactor.LabelPath path,
                 com.oakgrovesystems.reactor.processMediation.ACE ace)
          throws ReactorProxyException
Specified by:
lock in interface ReactorProxy
ReactorProxyException

lock

public void lock(com.oakgrovesystems.reactor.LabelPath path,
                 com.oakgrovesystems.reactor.processMediation.ACE ace,
                 java.lang.String eligibleRole,
                 java.lang.String standbyRole,
                 com.oakgrovesystems.reactor.ReactorObjectId status)
          throws ReactorProxyException
Specified by:
lock in interface ReactorProxy
ReactorProxyException

lock

public void lock(com.oakgrovesystems.reactor.LabelPath path,
                 com.oakgrovesystems.reactor.processMediation.ACE ace,
                 java.lang.String eligibleRole,
                 java.lang.String standbyRole,
                 com.oakgrovesystems.reactor.LabelPath status)
          throws ReactorProxyException
Specified by:
lock in interface ReactorProxy
ReactorProxyException

unlock

public void unlock(com.oakgrovesystems.reactor.ReactorObjectId id,
                   com.oakgrovesystems.reactor.processMediation.ACE ace)
            throws ReactorProxyException
Specified by:
unlock in interface ReactorProxy
ReactorProxyException

unlock

public void unlock(com.oakgrovesystems.reactor.ReactorObjectId id,
                   com.oakgrovesystems.reactor.processMediation.ACE ace,
                   java.lang.String eligibleRole,
                   java.lang.String standbyRole)
            throws ReactorProxyException
Specified by:
unlock in interface ReactorProxy
ReactorProxyException

unlock

public void unlock(com.oakgrovesystems.reactor.ReactorObjectId id,
                   com.oakgrovesystems.reactor.processMediation.ACE ace,
                   java.lang.String eligibleRole,
                   java.lang.String standbyRole,
                   com.oakgrovesystems.reactor.ReactorObjectId status)
            throws ReactorProxyException
Specified by:
unlock in interface ReactorProxy
ReactorProxyException

unlock

public void unlock(com.oakgrovesystems.reactor.ReactorObjectId id,
                   com.oakgrovesystems.reactor.processMediation.ACE ace,
                   java.lang.String eligibleRole,
                   java.lang.String standbyRole,
                   com.oakgrovesystems.reactor.LabelPath status)
            throws ReactorProxyException
Specified by:
unlock in interface ReactorProxy
ReactorProxyException

unlock

public void unlock(com.oakgrovesystems.reactor.LabelPath path,
                   com.oakgrovesystems.reactor.processMediation.ACE ace)
            throws ReactorProxyException
Specified by:
unlock in interface ReactorProxy
ReactorProxyException

unlock

public void unlock(com.oakgrovesystems.reactor.LabelPath path,
                   com.oakgrovesystems.reactor.processMediation.ACE ace,
                   java.lang.String eligibleRole,
                   java.lang.String standbyRole,
                   com.oakgrovesystems.reactor.ReactorObjectId status)
            throws ReactorProxyException
Specified by:
unlock in interface ReactorProxy
ReactorProxyException

unlock

public void unlock(com.oakgrovesystems.reactor.LabelPath path,
                   com.oakgrovesystems.reactor.processMediation.ACE ace,
                   java.lang.String eligibleRole,
                   java.lang.String standbyRole,
                   com.oakgrovesystems.reactor.LabelPath status)
            throws ReactorProxyException
Specified by:
unlock in interface ReactorProxy
ReactorProxyException

lock

protected void lock(com.oakgrovesystems.reactor.ReactorObjectId objectId,
                    com.oakgrovesystems.reactor.LabelPath objectPath,
                    com.oakgrovesystems.reactor.processMediation.ACE ace,
                    java.lang.String eligibleRole,
                    java.lang.String standbyRole,
                    com.oakgrovesystems.reactor.ReactorObjectId statusId,
                    com.oakgrovesystems.reactor.LabelPath statusPath)
             throws ReactorProxyException
ReactorProxyException

unlock

protected void unlock(com.oakgrovesystems.reactor.ReactorObjectId objectId,
                      com.oakgrovesystems.reactor.LabelPath objectPath,
                      com.oakgrovesystems.reactor.processMediation.ACE ace,
                      java.lang.String eligibleRole,
                      java.lang.String standbyRole,
                      com.oakgrovesystems.reactor.ReactorObjectId statusId,
                      com.oakgrovesystems.reactor.LabelPath statusPath)
               throws ReactorProxyException
ReactorProxyException

sendRequest

protected abstract com.oakgrovesystems.reactor.ReactorResponse sendRequest(com.oakgrovesystems.reactor.requests.ReactorRequest request)
                                                                    throws ReactorProxyException
Sends request to the server.

ReactorProxyException


Copyright (c) 1999-2004 Oak Grove Systems. All Rights Reserved.