public class RestComponentHelper
extends java.lang.Object
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
CLASS_VERSION
Class version string
|
Constructor and Description |
---|
RestComponentHelper() |
Modifier and Type | Method and Description |
---|---|
static RestResult |
executeMethod(java.lang.String pComponentPath,
java.lang.String pMethodName,
java.lang.Object[] pArguments,
java.util.Map<java.lang.String,java.lang.Object> pParams,
RestSession pSession)
Executes the specified method.
|
static RestResult |
getComponent(java.lang.String pComponentPath,
java.util.Map<java.lang.String,java.lang.Object> pParams,
RestSession pSession)
Returns a representation of the given component
|
static RestResult |
getPropertyValue(java.lang.String pComponentPath,
java.lang.String pProperty,
java.util.Map<java.lang.String,java.lang.Object> pParams,
RestSession pSession)
Returns the value of the requested property or sub-property
|
static RestResult |
serviceRequest(java.lang.String pComponentPath,
java.util.Map<java.lang.String,java.lang.Object> pParams,
RestSession pSession)
Services a request (the server redirects the request to a JSP which returns JSON or XML)
|
static RestResult |
setPropertyValue(java.lang.String pComponentPath,
java.lang.String pProperty,
java.lang.Object pValue,
java.util.Map<java.lang.String,java.lang.Object> pParams,
RestSession pSession)
Sets the specified property or sub-property on the given component.
|
public static RestResult getComponent(java.lang.String pComponentPath, java.util.Map<java.lang.String,java.lang.Object> pParams, RestSession pSession) throws RestClientException
pComponentPath
- the path of the desired componentpParams
- a map of parameters to include in the request or null if no parameters are neededpSession
- the session object representing the current sessionRestClientException
- if an error occurs issuing the requestpublic static RestResult getPropertyValue(java.lang.String pComponentPath, java.lang.String pProperty, java.util.Map<java.lang.String,java.lang.Object> pParams, RestSession pSession) throws RestClientException
pComponentPath
- the path of the desired componentpProperty
- the name of the desired property or sub-property formatted as follows: "property/sub-property/sub-property"pParams
- a map of parameters to include in the request or null if no parameters are neededpSession
- the session object representing the current sessionRestClientException
- if an error occurs issuing the requestpublic static RestResult setPropertyValue(java.lang.String pComponentPath, java.lang.String pProperty, java.lang.Object pValue, java.util.Map<java.lang.String,java.lang.Object> pParams, RestSession pSession) throws RestClientException
pComponentPath
- the path of the desired componentpProperty
- the name of the property to setpValue
- the value to setpParams
- a map of parameters to include in the request or null if no parameters are neededpSession
- the session object representing the current sessionRestClientException
- if an error occurs issuing the requestpublic static RestResult executeMethod(java.lang.String pComponentPath, java.lang.String pMethodName, java.lang.Object[] pArguments, java.util.Map<java.lang.String,java.lang.Object> pParams, RestSession pSession) throws RestClientException
pComponentPath
- the path of the desired componentpMethodName
- the name of the method to callpArguments
- an array of arguments to be passed to the method or null if there are no argumentspParams
- a map of parameters to include in the request or null if no parameters are neededpSession
- the session object representing the current sessionRestClientException
- if an error occurs issuing the requestpublic static RestResult serviceRequest(java.lang.String pComponentPath, java.util.Map<java.lang.String,java.lang.Object> pParams, RestSession pSession) throws RestClientException
pComponentPath
- the path of the desired componentpParams
- a map of parameters to include in the request or null if no parameters are neededpSession
- the session object representing the current sessionRestClientException
- if an error occurs issuing the request