com.oakgrovesystems.reactor.requests
Class SetACL

java.lang.Object
  |
  +--com.oakgrovesystems.reactor.requests.ReactorRequest
        |
        +--com.oakgrovesystems.reactor.requests.SetACL
All Implemented Interfaces:
java.io.Serializable

public class SetACL
extends ReactorRequest

A request to replace an ACL on a Process Mediation Object. The parameters must include an ID or Labelpath of the object, as well as an ACL to set.

See Also:
Serialized Form

Field Summary
static java.lang.String ACL_PARM_NAME
          This stores the actual ACL to replace.
static java.lang.String ID_PARM_NAME
          These parameters are mutually exclusive.
static java.lang.String LABEL_PATH_PARM_NAME
           
static java.lang.String REQUEST_TYPE
          The request type of SetACL requests.
static java.lang.String TYPE_PARM_NAME
          This stores the Class type to set.
 
Fields inherited from class com.oakgrovesystems.reactor.requests.ReactorRequest
operandOutputter, policyOutputter, processOutputter, statusOutputter
 
Constructor Summary
SetACL()
          Creates a SetACL request without specifying the authentication token to use to make the request.
SetACL(java.lang.String authToken)
          Creates a SetACL request that will use the specified authentication token
 
Method Summary
 com.oakgrovesystems.reactor.processMediation.ACL getNewACL()
          Returns the new ACL to set.
 com.oakgrovesystems.reactor.ReactorObjectId getObjectId()
          Returns the id of the object to set the ACL on.
 com.oakgrovesystems.reactor.LabelPath getObjectLabelPath()
          Returns the label path of the object to set ACL on.
 java.lang.Class getType()
          Returns the type of the object to set the ACL on.
 java.util.List paramsToXML()
          Converts the object-based parameters to XML.
protected  void parseParameters(org.jdom.Element params, com.oakgrovesystems.reactor.LabelPathToIdMapper mapper)
          Configures the parameters from the XML representation
protected  com.oakgrovesystems.reactor.ReactorResponse parseReturnValues(org.jdom.Element returnValues)
           
 void setNewACL(com.oakgrovesystems.reactor.processMediation.ACL newACL)
          Specifies the new ACL to set.
 void setObjectId(com.oakgrovesystems.reactor.ReactorObjectId id)
          Specifies the id of the object to set the ACL on.
 void setObjectLabelPath(com.oakgrovesystems.reactor.LabelPath lp)
          Specifies the label path of the object to set ACL on.
 void setType(java.lang.Class type)
          Specifies the type of the object to set the ACL on.
 
Methods inherited from class com.oakgrovesystems.reactor.requests.ReactorRequest
configureFromXML, configureFromXML, createResponseXML, createResponseXML, createReturnValuesElem, createRtnValXML, getAuthToken, getLabelPath, getObjectId, getParameter, getParameter, getParameterNames, getRequestType, makeAuthTokenXML, makeObjectElement, makeOperandElement, makePolicyElement, makeProcessElement, makeReferenceElement, makeStatusElement, parseResponse, send, sendAsXML, sendViaHttp, setAuthToken, setParameter, setRequestType, toString, toXML
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

ID_PARM_NAME

public static final java.lang.String ID_PARM_NAME
These parameters are mutually exclusive. A caller can reference a desired object by ID or label path.

See Also:
Constant Field Values

LABEL_PATH_PARM_NAME

public static final java.lang.String LABEL_PATH_PARM_NAME
See Also:
Constant Field Values

TYPE_PARM_NAME

public static final java.lang.String TYPE_PARM_NAME
This stores the Class type to set. Speeds searching.

See Also:
Constant Field Values

ACL_PARM_NAME

public static final java.lang.String ACL_PARM_NAME
This stores the actual ACL to replace.

See Also:
Constant Field Values

REQUEST_TYPE

public static final java.lang.String REQUEST_TYPE
The request type of SetACL requests. Used as a parameter to setRequestType() in the instance initializer.

See Also:
Constant Field Values
Constructor Detail

SetACL

public SetACL()
Creates a SetACL request without specifying the authentication token to use to make the request. setAuthToken() must be called before the request can be sent successfully.


SetACL

public SetACL(java.lang.String authToken)
Creates a SetACL request that will use the specified authentication token

Parameters:
authToken - the authentication token to use to make the request
Method Detail

setObjectId

public void setObjectId(com.oakgrovesystems.reactor.ReactorObjectId id)
Specifies the id of the object to set the ACL on. Calling this method with a non-null parameter has the side effect of calling setLabelPath with a null parameter.

Parameters:
id - the id of the object to set ACL on

getObjectId

public com.oakgrovesystems.reactor.ReactorObjectId getObjectId()
Returns the id of the object to set the ACL on.

Returns:
the id of the object to set ACL on

setType

public void setType(java.lang.Class type)
Specifies the type of the object to set the ACL on.


getType

public java.lang.Class getType()
Returns the type of the object to set the ACL on.

Returns:
the type of the object to set ACL on

setObjectLabelPath

public void setObjectLabelPath(com.oakgrovesystems.reactor.LabelPath lp)
Specifies the label path of the object to set ACL on. Calling this method with a non-null parameter has the side effect of calling setId with a null parameter.

Parameters:
lp - the label path of the object to set ACL on

getObjectLabelPath

public com.oakgrovesystems.reactor.LabelPath getObjectLabelPath()
Returns the label path of the object to set ACL on.

Returns:
the label path of the object to set ACL on

getNewACL

public com.oakgrovesystems.reactor.processMediation.ACL getNewACL()
Returns the new ACL to set.

Returns:
the new ACL to set

setNewACL

public void setNewACL(com.oakgrovesystems.reactor.processMediation.ACL newACL)
Specifies the new ACL to set.

Parameters:
newACL - the new ACL to set

paramsToXML

public java.util.List paramsToXML()
                           throws FailedRequestException
Converts the object-based parameters to XML.

Specified by:
paramsToXML in class ReactorRequest
Returns:
a list of XML elements
FailedRequestException

parseParameters

protected void parseParameters(org.jdom.Element params,
                               com.oakgrovesystems.reactor.LabelPathToIdMapper mapper)
                        throws FailedRequestException
Description copied from class: ReactorRequest
Configures the parameters from the XML representation

Specified by:
parseParameters in class ReactorRequest
Parameters:
params - the 'parameters' Element of the request
Throws:
FailedRequestException - if the parameters can't be configured from the XML.

parseReturnValues

protected com.oakgrovesystems.reactor.ReactorResponse parseReturnValues(org.jdom.Element returnValues)
                                                                 throws FailedRequestException
Specified by:
parseReturnValues in class ReactorRequest
FailedRequestException


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