Update the java doc to match the behavior

The javadoc of getProvisionedVpnProfileState only describes the
VpnProfileState will be null if if there was no profile
provisioned by the calling package. The implementation requires
the VPN profile being prepared so that the owner UID and package
name are well set up. Design is either changed to refer only the
package name information and check provisioned VPN profile from
VPN profile store, or correct the javadoc. In practice, a VPN app
that provision a VPN profile without starting it should know the
VPN status which is disconnected. The API should be useful after
starting the VPN profile.

Update the doc to match the behavior.

Bug: 280021394
Test: m
(cherry picked from https://android-review.googlesource.com/q/commit:5bca5c2f0384e36e59f8a6ea433831d99ede4e69)
Merged-In: I80322ff296661972a442d799812751d5411b665b
Change-Id: I80322ff296661972a442d799812751d5411b665b
This commit is contained in:
chiachangwang
2023-05-30 02:34:10 +00:00
committed by Cherrypicker Worker
parent 878b61b063
commit e0da29095c
3 changed files with 3 additions and 3 deletions

View File

@@ -444,7 +444,7 @@ public class VpnManager {
* Retrieve the VpnProfileState for the profile provisioned by the calling package.
*
* @return the VpnProfileState with current information, or null if there was no profile
* provisioned by the calling package.
* provisioned and started by the calling package.
*/
@Nullable
public VpnProfileState getProvisionedVpnProfileState() {

View File

@@ -406,7 +406,7 @@ public class VpnManagerService extends IVpnManager.Stub {
* Retrieve the VpnProfileState for the profile provisioned by the given package.
*
* @return the VpnProfileState with current information, or null if there was no profile
* provisioned by the given package.
* provisioned and started by the given package.
* @hide
*/
@Override

View File

@@ -5010,7 +5010,7 @@ public class Vpn {
* Retrieve the VpnProfileState for the profile provisioned by the given package.
*
* @return the VpnProfileState with current information, or null if there was no profile
* provisioned by the given package.
* provisioned and started by the given package.
*/
@Nullable
public synchronized VpnProfileState getProvisionedVpnProfileState(