com.android.apksig

Class ApkVerifier.Builder

java.lang.Object

com.android.apksig.ApkVerifier.Builder

Enclosing class:

ApkVerifier

public static class ApkVerifier.Builder
extends Object

Builder of ApkVerifier instances.

The resulting verifier by default checks whether the APK will verify on all platform versions supported by the APK, as specified by android:minSdkVersion attributes in the APK's AndroidManifest.xml. The range of platform versions can be customized using setMinCheckedPlatformVersion(int) and setMaxCheckedPlatformVersion(int).

Constructor Summary

Constructors

Constructor and Description
Builder(DataSource apk) Constructs a new Builder for verifying the provided APK.
Builder(File apk) Constructs a new Builder for verifying the provided APK file.

Method Summary

Modifier and Type	Method and Description
ApkVerifier	build() Returns an ApkVerifier initialized according to the configuration of this builder.
ApkVerifier.Builder	setMaxCheckedPlatformVersion(int maxSdkVersion) Sets the newest Android platform version for which the APK is verified.
ApkVerifier.Builder	setMinCheckedPlatformVersion(int minSdkVersion) Sets the oldest Android platform version for which the APK is verified.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Builder

public Builder(File apk)

Constructs a new Builder for verifying the provided APK file.

Builder

public Builder(DataSource apk)

Constructs a new Builder for verifying the provided APK.

Method Detail

setMinCheckedPlatformVersion

public ApkVerifier.Builder setMinCheckedPlatformVersion(int minSdkVersion)

Sets the oldest Android platform version for which the APK is verified. APK verification will confirm that the APK is expected to install successfully on all known Android platforms starting from the platform version with the provided API Level. The upper end of the platform versions range can be modified via setMaxCheckedPlatformVersion(int).

This method is useful for overriding the default behavior which checks that the APK will verify on all platform versions supported by the APK, as specified by android:minSdkVersion attributes in the APK's AndroidManifest.xml. For example, the default behavior refuses to handle APKs with codenames as values of android:minSdkVersion (e.g., "N").

Parameters:

minSdkVersion - API Level of the oldest platform for which to verify the APK

See Also:

setMinCheckedPlatformVersion(int)

setMaxCheckedPlatformVersion

public ApkVerifier.Builder setMaxCheckedPlatformVersion(int maxSdkVersion)

Sets the newest Android platform version for which the APK is verified. APK verification will confirm that the APK is expected to install successfully on all platform versions supported by the APK up until and including the provided version. The lower end of the platform versions range can be modified via setMinCheckedPlatformVersion(int).

Parameters:

maxSdkVersion - API Level of the newest platform for which to verify the APK

See Also:

setMinCheckedPlatformVersion(int)

build

public ApkVerifier build()

Returns an ApkVerifier initialized according to the configuration of this builder.