Package com.pnfsoftware.jeb.core.units.code.android

Class ApkManifestHelper

java.lang.Object

com.pnfsoftware.jeb.core.units.code.android.XmlResourceHelper

com.pnfsoftware.jeb.core.units.code.android.ApkXmlResourceHelper

com.pnfsoftware.jeb.core.units.code.android.ApkManifestHelper

public class ApkManifestHelper
extends ApkXmlResourceHelper

This helper class facilitates access to the data contained in an Android APK Manifest. In particular, the readAttributeXxx methods allow easy retrieval of attribute values by tag names, throughout the entire document.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ApkManifestHelper.ActivityDescription	Short description of an APK activity end-point.
static enum	ApkManifestHelper.AndroidSystemType	Types of Android systems.
static class	ApkManifestHelper.ApplicationDescription	Description of the APK's application.
static class	ApkManifestHelper.EndPointDescription	Short description of APK end-point.
static enum	ApkManifestHelper.EndPointType	Types of APK end-points.
static class	ApkManifestHelper.IntentFilterDescription	Short description of an intent filter.
static class	ApkManifestHelper.IntentFilterDescriptions	A collection of intent filters.
static class	ApkManifestHelper.ProviderDescription	Short description of an APK provider end-point.
static class	ApkManifestHelper.ReceiverDescription	Short description of an APK received end-point.
static class	ApkManifestHelper.ServiceDescription	Short description of an APK service end-point.

Field Summary

Fields inherited from class com.pnfsoftware.jeb.core.units.code.android.ApkXmlResourceHelper

attrPrefix

Fields inherited from class com.pnfsoftware.jeb.core.units.code.android.XmlResourceHelper

doc, rootElt

Constructor Summary

Constructors

Constructor	Description
ApkManifestHelper(IApkUnit apk)	This convenience constructor can be used to create a helper from an APK unit.
ApkManifestHelper(IXmlUnit xml)	Create a manifest helper around the provided manifest unit.
ApkManifestHelper(Document doc)	Create a manifest helper around the provided low-level XML document object.

Method Summary

Modifier and Type	Method	Description
static boolean	canParse(IApkUnit apk)
List<String>	getActivities()
List<ApkManifestHelper.ActivityDescription>	getActivityDescriptions()
ApkManifestHelper.ApplicationDescription	getApplicationDescription()
String	getApplicationName()
List<ApkManifestHelper.EndPointDescription>	getEndPointDescriptions()
ApkManifestHelper.AndroidSystemType	getIntendedSystemType()
String	getMainActivity()
String	getPackageName()
List<String>	getPermissions()
List<ApkManifestHelper.ProviderDescription>	getProviderDescriptions()
List<String>	getProviders()
List<ApkManifestHelper.ReceiverDescription>	getReceiverDescriptions()
List<String>	getReceivers()
int[]	getSdkVersion()	Retrieve the minimal and target Android version numbers to run the app.
List<ApkManifestHelper.ServiceDescription>	getServiceDescriptions()
List<String>	getServices()
Element	getXmlManifestElement()	This low-level method offers access to the org.w3c.dom.Element holding the Manifest root.
boolean	hasApplication()
boolean	isDebuggable()
protected void	prepare(Document doc)	This implementation checks that the input XML resource is an actual Android Manifest.

Methods inherited from class com.pnfsoftware.jeb.core.units.code.android.ApkXmlResourceHelper

buildAttributeName

Methods inherited from class com.pnfsoftware.jeb.core.units.code.android.XmlResourceHelper

convertEltlist, convertNodelist, getAttr, getRootElement, getSimpleName, hasAttributeValue, isFullyQualifiedName, isSimpleName, readAttribute, readAttributes, readMultiAttributes

Methods inherited from class java.lang.Object

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

Constructor Details

ApkManifestHelper

public ApkManifestHelper(IApkUnit apk)

This convenience constructor can be used to create a helper from an APK unit. A Manifest XML unit must exist under the APK unit.

Parameters:

apk -

ApkManifestHelper

public ApkManifestHelper(IXmlUnit xml)

Create a manifest helper around the provided manifest unit.

Parameters:

xml -

ApkManifestHelper

public ApkManifestHelper(Document doc)

Create a manifest helper around the provided low-level XML document object.

Parameters:

doc -

Method Details

canParse

public static boolean canParse(IApkUnit apk)

prepare

protected void prepare(Document doc)

This implementation checks that the input XML resource is an actual Android Manifest.

Overrides:

prepare in class ApkXmlResourceHelper

getXmlManifestElement

public Element getXmlManifestElement()

This low-level method offers access to the org.w3c.dom.Element holding the Manifest root. Use this method to retrieve any tag or attribute stored in the manifest.

Returns:

getPackageName

public String getPackageName()

getPermissions

public List<String> getPermissions()

hasApplication

public boolean hasApplication()

getApplicationName

public String getApplicationName()

isDebuggable

public boolean isDebuggable()

getApplicationDescription

public ApkManifestHelper.ApplicationDescription getApplicationDescription()

Returns:

null if the manifest does not have an Application element

getIntendedSystemType

public ApkManifestHelper.AndroidSystemType getIntendedSystemType()

getActivities

public List<String> getActivities()

getServices

public List<String> getServices()

getReceivers

public List<String> getReceivers()

getProviders

public List<String> getProviders()

getMainActivity

public String getMainActivity()

getEndPointDescriptions

public List<ApkManifestHelper.EndPointDescription> getEndPointDescriptions()

getActivityDescriptions

public List<ApkManifestHelper.ActivityDescription> getActivityDescriptions()

getServiceDescriptions

public List<ApkManifestHelper.ServiceDescription> getServiceDescriptions()

getReceiverDescriptions

public List<ApkManifestHelper.ReceiverDescription> getReceiverDescriptions()

getProviderDescriptions

public List<ApkManifestHelper.ProviderDescription> getProviderDescriptions()

getSdkVersion

public int[] getSdkVersion()

Retrieve the minimal and target Android version numbers to run the app.

Returns:

a tuple (minSdkVersion, targetSdkVersion)