import org.oic.simulator.OperationInProgressException;
import org.oic.simulator.SimulatorException;
import org.oic.simulator.SimulatorResourceModel;
+import org.oic.simulator.SimulatorResult;
/**
* SimulatorRemoteResource represents a Resource running in the remote Simulator
}
/**
- * Method to get the URI for this resource.
- *
+ * API to get the URI for this resource.
+ *
* @return Resource URI
*/
public String getUri() {
}
/**
- * Method to get the observe capability of this resource.
- *
+ * API to get the observe policy of this resource.
+ *
* @return True if the resource is observable, otherwise false.
*/
public boolean getIsObservable() {
}
/**
- * Method to get the connectivity type for this resource.
- *
+ * API to get the connectivity type for this resource.
+ *
* @return Connectivity type.
*/
public SimulatorConnectivityType getConnectivityType() {
}
/**
- * Method to get the list of resource types.
- *
+ * API to get the list of resource types.
+ *
* @return List of resource types.
*/
public LinkedList<String> getResourceTypes() {
}
/**
- * Method to get the list of resource interfaces.
- *
+ * API to get the list of resource interfaces.
+ *
* @return List of resource interfaces.
*/
public LinkedList<String> getResourceInterfaces() {
}
/**
- * Method to get a string representation of the host address of the remote
- * resource.
- *
+ * API to get host address and port information of the resource.
+ *
* @return Host address.
*/
public String getHost() {
}
/**
- * Method to get a unique Id for the resource.
- *
+ * API to get a unique Id of the resource .
+ *
* @return Unique ID.
*/
public String getId() {
}
/**
- * Method to set observation on the remote resource.
- *
+ * API to start observing the resource.
+ *
* @param observeType
* Allows the client to specify how it wants to observe.
* @param queryParamsMap
* The handler method which will be invoked with a map of
* attribute names and values whenever there is a change in
* resource model of the remote resource.
- *
+ *
* @throws InvalidArgsException
* This exception will be thrown if any parameter has invalid
* values.
* @throws SimulatorException
* This exception will be thrown for other errors.
*/
- public native void observe(SimulatorObserveType observeType,
+ public native void startObserve(SimulatorObserveType observeType,
Map<String, String> queryParamsMap,
IObserveListener onObserveListener) throws InvalidArgsException,
SimulatorException;
/**
- * Method to cancel the observation on the resource.
- *
+ * API to stop observing the resource.
+ *
* @throws InvalidArgsException
* This exception will be thrown if the native remote resource
* object is unavailable.
* @throws SimulatorException
* This exception will be thrown for other errors.
*/
- public native void cancelObserve() throws InvalidArgsException,
+ public native void stopObserve() throws InvalidArgsException,
SimulatorException;
/**
- * Method to get the attributes of a resource.
- *
+ * API to send GET request to the resource. Response will be notified
+ * asynchronously via callback set for {@link IGetListener}.
+ *
* @param queryParamsMap
* Map which can have the query parameter name and value.
* @param onGetListener
* Event handler which will be invoked with the response for GET
* request with a map of attribute name and values.
- *
+ *
* @throws InvalidArgsException
* This exception will be thrown if any parameter has invalid
* values.
public void get(Map<String, String> queryParamsMap,
IGetListener onGetListener) throws InvalidArgsException,
NoSupportException, SimulatorException {
- this.get(null, queryParamsMap, onGetListener);
+ if (null == onGetListener)
+ throw new InvalidArgsException(
+ SimulatorResult.SIMULATOR_INVALID_PARAM.ordinal(),
+ "Parameter passed in invalid");
+ this.nativeGet(null, queryParamsMap, onGetListener);
}
/**
- * Method to get the attributes of a resource.
- *
+ * API to send GET request to the resource. Response will be notified
+ * asynchronously via callback set for {@link IGetListener}.
+ *
* @param resourceInterface
* Interface type of the resource to operate on.
* @param queryParamsMap
* @param onGetListener
* Event handler which will be invoked with the response for GET
* request with a map of attribute name and values.
- *
+ *
* @throws InvalidArgsException
* This exception will be thrown if any parameter has invalid
* values.
* @throws SimulatorException
* This exception will be thrown for other errors.
*/
- public native void get(String resourceInterface,
+ public void get(String resourceInterface,
+ Map<String, String> queryParamsMap, IGetListener onGetListener)
+ throws InvalidArgsException, NoSupportException, SimulatorException {
+ if (null == resourceInterface || resourceInterface.isEmpty() || null == onGetListener)
+ throw new InvalidArgsException(
+ SimulatorResult.SIMULATOR_INVALID_PARAM.ordinal(),
+ "Parameter passed in invalid");
+ this.nativeGet(resourceInterface, queryParamsMap, onGetListener);
+ }
+
+ private native void nativeGet(String resourceInterface,
Map<String, String> queryParamsMap, IGetListener onGetListener)
throws InvalidArgsException, NoSupportException, SimulatorException;
/**
- * Method to set the representation of a resource (via PUT)
- *
+ * API to send PUT request to the resource. Response will be notified
+ * asynchronously via callback set for {@link IPutListener}.
+ *
* @param representation
* {@link SimulatorResourceModel} holding the representation of
* the resource.
* @param onPutListener
* Event handler which will be invoked with the response for PUT
* request with a map of attribute name and values.
- *
+ *
* @throws InvalidArgsException
* This exception will be thrown if any parameter has invalid
* value.
public void put(SimulatorResourceModel representation,
Map<String, String> queryParamsMap, IPutListener onPutListener)
throws InvalidArgsException, NoSupportException, SimulatorException {
- this.put(null, representation, queryParamsMap, onPutListener);
+ if (null == representation || null == onPutListener)
+ throw new InvalidArgsException(
+ SimulatorResult.SIMULATOR_INVALID_PARAM.ordinal(),
+ "Parameter passed in invalid");
+ this.nativePut(null, representation, queryParamsMap, onPutListener);
}
/**
- * Method to set the representation of a resource (via PUT).
- *
+ * API to send PUT request to the resource. Response will be notified
+ * asynchronously via callback set for {@link IPutListener}.
+ *
* @param resourceInterface
* Interface type of the resource to operate on.
* @param representation
* @param onPutListener
* Event handler which will be invoked with the response for PUT
* request with a map of attribute name and values.
- *
+ *
* @throws InvalidArgsException
* This exception will be thrown if any parameter has invalid
* value.
* @throws SimulatorException
* This exception will be thrown for other errors.
*/
- private native void put(String resourceInterface,
+ public void put(String resourceInterface,
+ SimulatorResourceModel representation,
+ Map<String, String> queryParamsMap, IPutListener onPutListener)
+ throws InvalidArgsException, NoSupportException, SimulatorException {
+ if (null == resourceInterface || resourceInterface.isEmpty() ||
+ null == representation || null == onPutListener)
+ throw new InvalidArgsException(
+ SimulatorResult.SIMULATOR_INVALID_PARAM.ordinal(),
+ "Parameter passed in invalid");
+ this.nativePut(resourceInterface, representation, queryParamsMap, onPutListener);
+ }
+
+ private native void nativePut(String resourceInterface,
SimulatorResourceModel representation,
Map<String, String> queryParamsMap, IPutListener onPutListener)
throws InvalidArgsException, NoSupportException, SimulatorException;
/**
- * Method to POST on a resource.
- *
+ * API to send POST request to the resource. Response will be notified
+ * asynchronously via callback set for {@link IPostListener}.
+ *
* @param representation
* {@link SimulatorResourceModel} holding the representation of
* the resource
* @param onPostListener
* Event handler which will be invoked with the response for POST
* request with a map of attribute name and values.
- *
+ *
* @throws InvalidArgsException
* This exception will be thrown if any parameter has invalid
* value.
public void post(SimulatorResourceModel representation,
Map<String, String> queryParamsMap, IPostListener onPostListener)
throws InvalidArgsException, NoSupportException, SimulatorException {
- this.post(null, representation, queryParamsMap, onPostListener);
+ if (null == representation || null == onPostListener)
+ throw new InvalidArgsException(
+ SimulatorResult.SIMULATOR_INVALID_PARAM.ordinal(),
+ "Parameter passed in invalid");
+ this.nativePost(null, representation, queryParamsMap, onPostListener);
}
/**
- * Method to POST on a resource.
- *
+ * API to send POST request to the resource. Response will be notified
+ * asynchronously via callback set for {@link IPostListener}.
+ *
* @param resourceInterface
* Interface type of the resource to operate on.
* @param representation
* @param onPostListener
* Event handler which will be invoked with the response for POST
* request with a map of attribute name and values.
- *
+ *
* @throws InvalidArgsException
* This exception will be thrown if any parameter has invalid
* value.
* @throws SimulatorException
* This exception will be thrown for other errors.
*/
- public native void post(String resourceInterface,
+ public void post(String resourceInterface,
+ SimulatorResourceModel representation,
+ Map<String, String> queryParamsMap, IPostListener onPostListener)
+ throws InvalidArgsException, NoSupportException, SimulatorException {
+ if (null == resourceInterface || resourceInterface.isEmpty() ||
+ null == representation || null == onPostListener)
+ throw new InvalidArgsException(
+ SimulatorResult.SIMULATOR_INVALID_PARAM.ordinal(),
+ "Parameter passed in invalid");
+ this.nativePost(resourceInterface, representation, queryParamsMap, onPostListener);
+ }
+
+ private native void nativePost(String resourceInterface,
SimulatorResourceModel representation,
Map<String, String> queryParamsMap, IPostListener onPostListener)
throws InvalidArgsException, NoSupportException, SimulatorException;
/**
- * Method to set the RAML file path from application
- *
- * @param ramlPath
- * RAML configuration file path
- *
+ * API to provide remote resource configure information,
+ * which is required for using automation feature.
+ *
+ * @param path
+ * Path to RAML file.
+ *
* @throws InvalidArgsException
* Thrown if the RAML configuration file path is invalid.
* @throws SimulatorException
* Thrown for other errors.
*/
- public native void configureRAMLPath(String ramlPath)
+ public native void setConfigInfo(String path)
throws InvalidArgsException, SimulatorException;
/**
- * Method to start verification of a resource using automation.
- *
+ * API to send multiple requests for the resource, based on
+ * the configure file provided from {@link setConfigInfo}.
+ * This verifies response received as well.
+ *
* @param requestType
* Request type to verify.
* @param onVerifyListener
* This event handler will be invoked with the current status of
* the automation.
- *
+ *
* @return Automation ID.
- *
+ *
* @throws InvalidArgsException
* This exception will be thrown if any parameter has invalid
* value.
return startVerification(requestType.ordinal(), onVerifyListener);
}
- private native int startVerification(int requestType,
- IVerificationListener onVerifyListener)
- throws InvalidArgsException, NoSupportException,
- OperationInProgressException, SimulatorException;
-
/**
- * Method to stop verification of a resource previously started.
- *
+ * API to stop sending requests which has been started using {@link setConfigInfo}.
+ *
* @param id
* Automation ID.
- *
+ *
* @throws InvalidArgsException
* Thrown if the automation ID is invalid.
* @throws NoSupportException
public native void stopVerification(int id) throws InvalidArgsException,
NoSupportException, SimulatorException;
+ private native int startVerification(int requestType,
+ IVerificationListener onVerifyListener)
+ throws InvalidArgsException, NoSupportException,
+ OperationInProgressException, SimulatorException;
+
@Override
protected void finalize() throws Throwable {
- super.finalize();
-
- dispose();
+ try {
+ dispose();
+ } catch(Throwable t){
+ throw t;
+ } finally{
+ super.finalize();
+ }
}
private native void dispose();
projects / contrib / iotivity.git / blobdiff