Android/frameworks_base
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Merge "Update Java doc for ResumeOnReboot"

Browse Source
This commit is contained in:
Tianjie Xu
2021-02-05 18:36:48 +00:00
committed by Gerrit Code Review
parent de2340c0e9 d5567fea8e
commit 90772648cd
1 changed files with 9 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

14
core/java/android/service/resumeonreboot/ResumeOnRebootService.java
View File

@@ -87,7 +87,9 @@ public abstract class ResumeOnRebootService extends Service {
* Implementation for wrapping the opaque blob used for resume-on-reboot prior to * Implementation for wrapping the opaque blob used for resume-on-reboot prior to
* reboot. The service should not assume any structure of the blob to be wrapped. The * reboot. The service should not assume any structure of the blob to be wrapped. The
* implementation should wrap the opaque blob in a reasonable time or throw {@link IOException} * implementation should wrap the opaque blob in a reasonable time or throw {@link IOException}
* if it's unable to complete the action. * if it's unable to complete the action due to retry-able errors (e.g network errors)
* and {@link IllegalArgumentException} if {@code wrapBlob} fails due to fatal errors
* (e.g corrupted blob).
* *
* @param blob The opaque blob with size on the order of 100 bytes. * @param blob The opaque blob with size on the order of 100 bytes.
* @param lifeTimeInMillis The life time of the blob. This must be strictly enforced by the * @param lifeTimeInMillis The life time of the blob. This must be strictly enforced by the
@@ -95,7 +97,8 @@ public abstract class ResumeOnRebootService extends Service {
* this function after expiration should * this function after expiration should
* fail. * fail.
* @return Wrapped blob to be persisted across reboot with size on the order of 100 bytes. * @return Wrapped blob to be persisted across reboot with size on the order of 100 bytes.
* @throws IOException if the implementation is unable to wrap the blob successfully. * @throws IOException if the implementation is unable to wrap the blob successfully due to
* retry-able errors.
*/ */
@NonNull @NonNull
public abstract byte[] onWrap(@NonNull byte[] blob, @DurationMillisLong long lifeTimeInMillis) public abstract byte[] onWrap(@NonNull byte[] blob, @DurationMillisLong long lifeTimeInMillis)
@@ -106,12 +109,13 @@ public abstract class ResumeOnRebootService extends Service {
* operation would happen after reboot during direct boot mode (i.e before device is unlocked * operation would happen after reboot during direct boot mode (i.e before device is unlocked
* for the first time). The implementation should unwrap the wrapped blob in a reasonable time * for the first time). The implementation should unwrap the wrapped blob in a reasonable time
* and returns the result or throw {@link IOException} if it's unable to complete the action * and returns the result or throw {@link IOException} if it's unable to complete the action
* and {@link IllegalArgumentException} if {@code unwrapBlob} fails because the wrappedBlob is * due to retry-able errors (e.g network error) and {@link IllegalArgumentException}
* stale. * if {@code unwrapBlob} fails due to fatal errors (e.g stale or corrupted blob).
* *
* @param wrappedBlob The wrapped blob with size on the order of 100 bytes. * @param wrappedBlob The wrapped blob with size on the order of 100 bytes.
* @return Unwrapped blob used for resume-on-reboot with the size on the order of 100 bytes. * @return Unwrapped blob used for resume-on-reboot with the size on the order of 100 bytes.
* @throws IOException if the implementation is unable to unwrap the wrapped blob successfully. * @throws IOException if the implementation is unable to unwrap the wrapped blob successfully
* due to retry-able errors.
*/ */
@NonNull @NonNull
public abstract byte[] onUnwrap(@NonNull byte[] wrappedBlob) throws IOException; public abstract byte[] onUnwrap(@NonNull byte[] wrappedBlob) throws IOException;