io.bitrise.trace.plugin.modifier

Class ManifestHelper

java.lang.Object

io.bitrise.trace.plugin.modifier.ManifestHelper

public class ManifestHelper
extends java.lang.Object

Responsible for modifying the AndroidManifest.xml.

Constructor Summary

Constructors

Constructor and Description
ManifestHelper(org.w3c.dom.Document androidManifest, org.gradle.api.logging.Logger logger) Constructor for class.
ManifestHelper(java.lang.String androidManifestPath, org.gradle.api.logging.Logger logger) Constructor for class.

Method Summary

Modifier and Type	Method and Description
void	addElement(org.w3c.dom.Element parent, org.w3c.dom.Element child) Adds an Element to the xml file.
void	applyManifestChanges() Commits the changes to the AndroidManifest.xml on androidManifestPath and reopens it.
void	commitManifestChanges() Commits the changes to the AndroidManifest.xml on androidManifestPath.
void	commitManifestChanges(org.w3c.dom.Document newAndroidManifest) Commits the changes to the AndroidManifest.xml on androidManifestPath.
org.w3c.dom.Attr	createAttribute(java.lang.String name, java.lang.String value) Creates an Attr to the xml file.
org.w3c.dom.Element	createElement(java.lang.String name) Creates an Element to the xml file.
org.w3c.dom.Element	createMetricSenderServiceElement() Creates an Element to the xml file, with the required values for the MetricSender Service.
org.w3c.dom.Element	createTraceSenderServiceElement() Creates an Element to the xml file, with the required values for the TraceSender Service.
org.w3c.dom.Document	getAndroidManifest() Gets the androidManifest.
java.lang.String	getAndroidManifestPath() Gets the path of the AndroidManifest document.
org.w3c.dom.Element	getApplicationElement() Gets the application Element from the androidManifest.
java.lang.String	getApplicationName() Gets the Application name attribute to the given value.
java.lang.String	getPackageName() Gets the package name from the android manifest file.
java.util.List<java.lang.String>	getPermissions() Gets the list of permissions from the AndroidManifest.xml file.
boolean	isApplicationNamePresent() Checks if the application name attribute is presented in the androidManifest or not.
void	setDefaultApplicationName() Adds an Application name attribute with the given value.

Methods inherited from class java.lang.Object

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

Constructor Detail

ManifestHelper

public ManifestHelper(@NonNull
                      org.w3c.dom.Document androidManifest,
                      @NonNull
                      org.gradle.api.logging.Logger logger)

Constructor for class. Creates a ManifestHelper to easily parse and modify the given AndroidManifest.xml.

Parameters:

androidManifest - the AndroidManifest parsed as a Document to work with.

logger - for providing the logging functions.

ManifestHelper

public ManifestHelper(@NonNull
                      java.lang.String androidManifestPath,
                      @NonNull
                      org.gradle.api.logging.Logger logger)
               throws java.io.IOException,
                      org.xml.sax.SAXException,
                      javax.xml.parsers.ParserConfigurationException

Constructor for class. Creates the ManifestHelper and automatically searches for the AndroidManifest.xml to work with.

Parameters:

androidManifestPath - the androidManifestPath of the AndroidManifest.xml.

logger - for providing the logging functions.

Throws:

java.io.IOException - if any IO errors occur.

org.xml.sax.SAXException - if any parse errors occur.

javax.xml.parsers.ParserConfigurationException - if a DocumentBuilder cannot be created which satisfies the configuration requested.

Method Detail

isApplicationNamePresent

public boolean isApplicationNamePresent()

Checks if the application name attribute is presented in the androidManifest or not.

Returns:

true if the application name attribute is present, false otherwise.

getPackageName

@NonNull
public java.lang.String getPackageName()

Gets the package name from the android manifest file.

Returns:

the package name, or null when not found.

getApplicationElement

@Nullable
public org.w3c.dom.Element getApplicationElement()

Gets the application Element from the androidManifest.

Returns:

the application Element.

addElement

public void addElement(@NonNull
                       org.w3c.dom.Element parent,
                       @NonNull
                       org.w3c.dom.Element child)

Adds an Element to the xml file.

Parameters:

parent - the parent Element of the Element to add.

child - the child Element to add.

createElement

@NonNull
public org.w3c.dom.Element createElement(@NonNull
                                                  java.lang.String name)

Creates an Element to the xml file.

Parameters:

name - the name of the Element which will be created.

Returns:

the created Element.

createAttribute

@NonNull
public org.w3c.dom.Attr createAttribute(@NonNull
                                                 java.lang.String name,
                                                 @NonNull
                                                 java.lang.String value)

Creates an Attr to the xml file.

Parameters:

name - the name of the Attr which will be created.

value - the value of the given Attr which will be created.

Returns:

the created Attr.

setDefaultApplicationName

public void setDefaultApplicationName()

Adds an Application name attribute with the given value. If not present, the attribute is added.

getApplicationName

@NonNull
public java.lang.String getApplicationName()

Gets the Application name attribute to the given value.

Returns:

the value of the name attribute or empty String if not the attribute is not presented.

createMetricSenderServiceElement

@NonNull
public org.w3c.dom.Element createMetricSenderServiceElement()

Creates an Element to the xml file, with the required values for the MetricSender Service.

Returns:

the created Element.

createTraceSenderServiceElement

@NonNull
public org.w3c.dom.Element createTraceSenderServiceElement()

Creates an Element to the xml file, with the required values for the TraceSender Service.

Returns:

the created Element.

getPermissions

@NonNull
public java.util.List<java.lang.String> getPermissions()

Gets the list of permissions from the AndroidManifest.xml file.

Returns:

the list of permissions.

applyManifestChanges

public void applyManifestChanges()
                          throws javax.xml.transform.TransformerException,
                                 java.io.IOException,
                                 org.xml.sax.SAXException,
                                 javax.xml.parsers.ParserConfigurationException

Commits the changes to the AndroidManifest.xml on androidManifestPath and reopens it.

Throws:

javax.xml.transform.TransformerException - if an unrecoverable error occurs during the course of the transformation.

java.io.IOException - if the path is null.

org.xml.sax.SAXException - if any parse errors occur.

javax.xml.parsers.ParserConfigurationException - if a DocumentBuilder cannot be created which satisfies the configuration requested.

commitManifestChanges

public void commitManifestChanges()
                           throws javax.xml.transform.TransformerException,
                                  java.io.IOException

Commits the changes to the AndroidManifest.xml on androidManifestPath.

Throws:

javax.xml.transform.TransformerException - if an unrecoverable error occurs during the course of the transformation.

java.io.IOException - if the path is null.

commitManifestChanges

public void commitManifestChanges(@NonNull
                                  org.w3c.dom.Document newAndroidManifest)
                           throws javax.xml.transform.TransformerException,
                                  java.io.IOException

Commits the changes to the AndroidManifest.xml on androidManifestPath.

Parameters:

newAndroidManifest - the new document.

Throws:

javax.xml.transform.TransformerException - if an unrecoverable error occurs during the course of the transformation.

java.io.IOException - if the path is null.

getAndroidManifest

@NonNull
public org.w3c.dom.Document getAndroidManifest()

Gets the androidManifest.

Returns:

the AndroidManifest.xml.

getAndroidManifestPath

@Nullable
public java.lang.String getAndroidManifestPath()

Gets the path of the AndroidManifest document.

Returns:

the path, or null when ManifestHelper(Document, Logger) constructor was used.