public class OcProvisioning {
/**
- * Method to Intialize Provisioning Manager.This will load the provisioning
+ * Method to Initialize Provisioning Manager.This will load the provisioning
* Manager's persistent database.
*
* @param dbPath dbPath file path of the sqlite3 db.
- * @throws OcException
+ *
+ * @throws OcException Indicate initialization failure.
+ * Use OcException.GetErrorCode() for more details.
*/
public static native void provisionInit(String dbPath) throws OcException;
*
* @param timeout Timeout in sec.Time to listen for responses before
* returining the Array.
+ *
* @return Array of OcSecureResource class objects.
- * @throws OcException
+ *
+ * @throws OcException Indicate discovery failure.
+ * Use OcException.GetErrorCode() for more details.
*/
public static List<OcSecureResource> discoverUnownedDevices(int timeout) throws OcException {
return Arrays.asList(OcProvisioning.discoverUnownedDevices1(timeout));
*
* @param timeout Timeout in sec.Time to listen for responses before
* returining the Array.
+ *
* @return Array of OcSecureResource class objects.
- * @throws OcException
+ *
+ * @throws OcException Indicate discovery failure.
+ * Use OcException.GetErrorCode() for more details.
*/
public static List<OcSecureResource> discoverOwnedDevices(int timeout) throws OcException {
return Arrays.asList(OcProvisioning.discoverOwnedDevices1(timeout));
* transfer Type
*
* @param type OxmType ownership transfer type.
- * @throws OcException
+ * @param pinCallbackListener Pin callback Listener.
+ *
+ * @throws OcException Indicate failure registering ownership transfer.
+ * Use OcException.GetErrorCode() for more details.
*/
public static void SetownershipTransferCBdata(OxmType type,
PinCallbackListener pinCallbackListener) throws OcException
* Server API to set Callback for Displaying stack generated PIN.
*
* @param displayPinListener Pin callback Listener to be registered.
- * @throws OcException
+ *
+ * @throws OcException Indicate failure setting the pin listener callback.
+ * Use OcException.GetErrorCode() for more details.
*/
public static native void setDisplayPinListener(DisplayPinListener displayPinListener)
throws OcException;
/**
* API to Set callback for displaying verifNum in verified Just-Works.
*
- *@param DisplayNumListener callback Listener to be registered for
- displaying VerifyNUm.
- *@throws OcException
+ * @param displayNumListener callback Listener to be registered for
+ * displaying VerifyNUm.
+ *
+ * @throws OcException Indicate failure setting the DisplayNumListener.
+ * Use OcException.GetErrorCode() for more details.
*/
public static native void setDisplayNumListener(
DisplayNumListener displayNumListener) throws OcException;
/**
* API to unregister DisplayNumListener Listener
*
- *@return 0 on success, 1 on failure
- *@throws OcException
+ *@return 0 on success, 1 on failure
+ *
+ *@throws OcException Indicate failure to unregister the DisplayNumListener Listener.
+ * Use OcException.GetErrorCode() for more details.
*/
public static native int unsetDisplayNumListener() throws OcException;
* API to Set callback for getting user confirmation in verified
* Just-Works
*
- *@param ConfirmNumListener callback Listener to be registered for getting user confirmation.
- *@throws OcException
+ *@param confirmNumListener callback Listener to be registered for getting user confirmation.
+ *
+ *@throws OcException Indicate failure setting the confirmation number Just-Works listener.
+ * Use OcException.GetErrorCode() for more details.
*/
public static native void setConfirmNumListener(ConfirmNumListener
confirmNumListener) throws OcException;
* API to unregister ConfirmMutualVerifyNum Listener
*
*@return 0 on success, 1 on failure
- *@throws OcException
+ *
+ *@throws OcException Indicate failure unregistering the ConfirmMutualVerifyNum Listener
+ * Use OcException.GetErrorCode() for more details.
*/
public static native int unsetConfirmNumListener() throws OcException;
* API to set options for Mutual Verified Just-works
* Default is for both screen PIN display and get user confirmation.
*
+ * @param optionMask Verification Method Options
+ *
+ * @return 0 on success
+ *
+ * @throws OcException Indicate failure to set the Mutual Verified Just-works options.
+ * Use OcException.GetErrorCode() for more details.
*/
public static int setMVJustWorksOptions(EnumSet<MVJustWorksOptionMask> optionMask) throws OcException {
* @param timeout timeout in sec for the API to return.
* @return Array of OcSecureResource class objects.
* be provisioned.
- * @throws OcException
+ * @throws OcException Indicate failure to get array of devices.
+ * Use OcException.GetErrorCode() for more details.
+ *
*/
public static List<OcSecureResource> getDeviceStatusList(int timeout) throws OcException {
return Arrays.asList(OcProvisioning.getDeviceStatusList1(timeout));
private static native OcSecureResource[] getDeviceStatusList1(int timeout) throws OcException;
/**
- * Method to save the Trust certificate chain to SVR.
+ * Method to save the Trust certificate chain to SVR.
+ *
+ * @param trustCertChain Trust certificate chain to be saved in Cred of SVR.
+ * @param encodingType Encoding type of trust certificate chain to be saved in Cred of SVR
+ *
+ * @return CredId of saved trust certificate chain in Cred of SVR.
*
- * @param trustCertChain
- * @param encodingType
- * @throws OcException
+ * @throws OcException Indicate failure to save the trust certificate chain.
+ * Use OcException.GetErrorCode() for more details.
*/
public static int saveTrustCertChain(byte[] trustCertChain, EncodingType encodingType) throws OcException {
return saveTrustCertChain1(trustCertChain,encodingType.getValue());