ConfigurationFactory

public class ConfigurationFactory
extends Object implements IConfigurationFactory

java.lang.Object
   ↳ com.android.tradefed.config.ConfigurationFactory

Es una fábrica para crear IConfiguration.

Resumen

Clases anidadas

class ConfigurationFactory.ConfigLoader

Es la implementación de IConfigDefLoader que hace un seguimiento de las configuraciones incluidas desde una configuración raíz y arroja una excepción en las inclusiones circulares. 

class ConfigurationFactory.ExceptionLoader

 

Constructores protegidos

ConfigurationFactory()

Métodos públicos

void clearMapConfig()

En algunos casos particulares, debemos borrar el mapa.

IConfiguration createConfigurationFromArgs(String[] arrayArgs, List<String> unconsumedArgs, IKeyStoreClient keyStoreClient)

Crea el objeto IConfiguration a partir de argumentos de línea de comandos con un almacén de claves.

IConfiguration createConfigurationFromArgs(String[] arrayArgs, List<String> unconsumedArgs)

Crea el IConfiguration a partir de argumentos de línea de comandos.

IConfiguration createConfigurationFromArgs(String[] arrayArgs)

Es un método de conveniencia que llama a createConfigurationFromArgs(String[],List) con un segundo argumento null.

IGlobalConfiguration createGlobalConfigurationFromArgs(String[] arrayArgs, List<String> remainingArgs)

Crea un IGlobalConfiguration a partir de argumentos de línea de comandos.

IConfiguration createPartialConfigurationFromArgs(String[] arrayArgs, IKeyStoreClient keyStoreClient, Set<String> allowedObjects, TradefedDelegator delegator)

Crea una configuración que solo contenga un conjunto de objetos seleccionados.

void dumpConfig(String configName, PrintStream out)

Volca el contenido de la configuración en el PrintStream determinado

List<String> getConfigList(String subPath, boolean loadFromEnv)

Es una variación de getConfigList() en la que se puede especificar si también queremos cargar la configuración del entorno.

List<String> getConfigList()

Devuelve la lista de nombres de todos los parámetros de configuración que se encuentran en los archivos JAR de la ruta de acceso a la clase.

static IConfigurationFactory getInstance()

Obtén la instancia singleton de IConfigurationFactory.

void loadAllConfigs(boolean discardExceptions)

Carga todas las configuraciones que se encuentran en los directorios de casos de prueba y classpath.

void loadAndPrintAllConfigs()

Método de utilidad que verifica que todas las configuraciones se puedan cargar y analizar, y que se hayan establecido todos los valores de las opciones.

void printHelp(PrintStream out)

Imprime el resultado de ayuda para esta fábrica.

void printHelpForConfig(String[] args, boolean importantOnly, PrintStream out)

Imprime el resultado de ayuda para el IConfiguration especificado en los argumentos de la línea de comandos.

Si "args" hace referencia a una configuración conocida, se creará un objeto IConfiguration a partir de XML y se generará ayuda para ese IConfiguration.

Métodos protegidos

InputStream getBundledConfigStream(String name)
String getConfigPrefix()

Devuelve el prefijo de ruta de los archivos XML de configuración en la ruta de clase.

Se expone para que las pruebas de unidades puedan simular.

BufferedInputStream getConfigStream(String name)

Carga un InputStream para el nombre de configuración determinado

ConfigurationDef getConfigurationDef(String name, boolean isGlobal, Map<String, String> templateMap)

Recupera el ConfigurationDef para el nombre determinado.

Map<ConfigurationFactory.ConfigId, ConfigurationDef> getMapConfig()

Se expone para pruebas.

boolean isDirectConfiguration(String configName)
String[] reorderArgs(String[] args)

Reordena los argumentos para que todos los argumentos de template:map se muevan al principio.

IRemoteFileResolver.ResolvedFile resolveRemoteFile(URI configURI, URI destDir)

Constructores protegidos

ConfigurationFactory

protected ConfigurationFactory ()

Métodos públicos

clearMapConfig

public void clearMapConfig ()

En algunos casos particulares, debemos borrar el mapa.

createConfigurationFromArgs

public IConfiguration createConfigurationFromArgs (String[] arrayArgs, 
                List<String> unconsumedArgs, 
                IKeyStoreClient keyStoreClient)

Crea el objeto IConfiguration a partir de argumentos de línea de comandos con un almacén de claves.

El formato esperado es "CONFIG [opciones]", donde CONFIG es el nombre de la configuración integrada o una ruta de acceso a un archivo XML de configuración.

Parámetros
arrayArgs String: Los argumentos de la línea de comandos
unconsumedArgs List: Es una lista que se completará con los argumentos que no consumieron los objetos asociados con la configuración especificada. Si es null, la implementación arrojará ConfigurationException si quedan argumentos sin procesar.
keyStoreClient IKeyStoreClient: Un IKeyStoreClient que se usa para obtener información sensible en los argumentos.
Muestra
IConfiguration IConfiguration cargado. Los campos del objeto delegado Option se propagaron con valores en args.
Arroja
ConfigurationException

createConfigurationFromArgs

public IConfiguration createConfigurationFromArgs (String[] arrayArgs, 
                List<String> unconsumedArgs)

Crea el IConfiguration a partir de argumentos de línea de comandos.

El formato esperado es "CONFIG [opciones]", donde CONFIG es el nombre de la configuración integrada o una ruta de acceso a un archivo XML de configuración.

Parámetros
arrayArgs String: Los argumentos de la línea de comandos
unconsumedArgs List: Es una lista que se completará con los argumentos que no consumieron los objetos asociados con la configuración especificada. Si es null, la implementación arrojará ConfigurationException si quedan argumentos sin procesar.
Muestra
IConfiguration IConfiguration cargado. Los campos del objeto delegado Option se propagaron con valores en args.
Arroja
ConfigurationException

createConfigurationFromArgs

public IConfiguration createConfigurationFromArgs (String[] arrayArgs)

Es un método de conveniencia que llama a createConfigurationFromArgs(String[],List) con un segundo argumento null. Por lo tanto, arrojará ConfigurationException si quedan argumentos sin consumir.

Parámetros
arrayArgs String

Muestra
IConfiguration

Arroja
ConfigurationException

createGlobalConfigurationFromArgs

public IGlobalConfiguration createGlobalConfigurationFromArgs (String[] arrayArgs, 
                List<String> remainingArgs)

Crea un IGlobalConfiguration a partir de argumentos de línea de comandos.

El formato esperado es "CONFIG [opciones]", donde CONFIG es el nombre de la configuración integrada o una ruta de acceso a un archivo XML de configuración.

Parámetros
arrayArgs String: Los argumentos de la línea de comandos
remainingArgs List: Es una lista que se completará con los argumentos que no se procesaron como argumentos globales.
Muestra
IGlobalConfiguration IGlobalConfiguration cargado. Los campos del objeto delegado Option se propagaron con valores en args.
Arroja
ConfigurationException

createPartialConfigurationFromArgs

public IConfiguration createPartialConfigurationFromArgs (String[] arrayArgs, 
                IKeyStoreClient keyStoreClient, 
                Set<String> allowedObjects, 
                TradefedDelegator delegator)

Crea una configuración que solo contenga un conjunto de objetos seleccionados.

Parámetros
arrayArgs String: Los argumentos de la línea de comandos
keyStoreClient IKeyStoreClient: Es un IKeyStoreClient que se usa para obtener información sensible en los argumentos.
allowedObjects Set: Es el conjunto de objetos permitidos que se pueden crear.
delegator TradefedDelegator

Muestra
IConfiguration Es el objeto IConfiguration cargado.
Arroja
ConfigurationException

dumpConfig

public void dumpConfig (String configName, 
                PrintStream out)

Volca el contenido de la configuración en el PrintStream determinado

Parámetros
configName String: Es el nombre de la configuración.
out PrintStream: El PrintStream en el que se volcará el resultado

getConfigList

public List<String> getConfigList (String subPath, 
                boolean loadFromEnv)

Es una variación de getConfigList() en la que se puede especificar si también queremos cargar la configuración del entorno.

Parámetros
subPath String: Es el nombre de los subdirectorios en los que se buscará la configuración. Si es nulo, tendrá el mismo comportamiento que getConfigList().
loadFromEnv boolean: Es verdadero si debemos cargar la configuración en la variable de entorno.
Muestra
List<String>

getConfigList

public List<String> getConfigList ()

Devuelve la lista de nombres de todos los parámetros de configuración que se encuentran en los archivos JAR de la ruta de acceso a la clase. No intenta cargar ninguna de las configuraciones, por lo que es posible que haya configuraciones que no funcionen en esta lista.

Muestra
List<String>

getInstance

public static IConfigurationFactory getInstance ()

Obtén la instancia singleton de IConfigurationFactory.

Muestra
IConfigurationFactory

loadAllConfigs

public void loadAllConfigs (boolean discardExceptions)

Carga todas las configuraciones que se encuentran en los directorios de casos de prueba y classpath.

Parámetros
discardExceptions boolean: Es verdadero si se debe ignorar cualquier ConfigurationException.
Arroja
com.android.tradefed.config.ConfigurationException
ConfigurationException

loadAndPrintAllConfigs

public void loadAndPrintAllConfigs ()

Método de utilidad que verifica que todas las configuraciones se puedan cargar y analizar, y que se hayan establecido todos los valores de las opciones. Solo se expone para que el proyecto dependiente pueda validar sus configuraciones. No se debe exponer en la consola.

Arroja
ConfigurationException Si no se pudieron cargar uno o más parámetros de configuración

printHelp

public void printHelp (PrintStream out)

Imprime el resultado de ayuda para esta fábrica.

Imprime información de ayuda genérica y enumera todas las configuraciones disponibles.

Parámetros
out PrintStream: El PrintStream en el que se volcará el resultado

printHelpForConfig

public void printHelpForConfig (String[] args, 
                boolean importantOnly, 
                PrintStream out)

Imprime el resultado de ayuda para el IConfiguration especificado en los argumentos de la línea de comandos.

Si "args" hace referencia a una configuración conocida, se creará un objeto IConfiguration a partir de XML y se generará ayuda para ese IConfiguration. Ten en cuenta que se ignorarán todos los demás valores de "args" (es decir, el texto de ayuda describirá los valores actuales de Options cargados desde XML y no reflejará los valores de las opciones establecidos por los argumentos de la línea de comandos).

Si "args" no hace referencia a un IConfiguration conocido, se mostrará la ayuda genérica de printHelp(PrintStream).

Parámetros
args String: Los argumentos de la línea de comandos
importantOnly boolean: Si es true, imprime una lista de ayuda abreviada que solo incluya los detalles importantes.
out PrintStream: El PrintStream en el que se volcará el resultado

Métodos protegidos

getBundledConfigStream

protected InputStream getBundledConfigStream (String name)

Parámetros
name String

Muestra
InputStream

getConfigPrefix

protected String getConfigPrefix ()

Devuelve el prefijo de ruta de los archivos XML de configuración en la ruta de clase.

Se expone para que las pruebas de unidades puedan simular.

Muestra
String Ruta de acceso String con una barra final

getConfigStream

protected BufferedInputStream getConfigStream (String name)

Carga un InputStream para el nombre de configuración determinado

Parámetros
name String: Es el nombre de la configuración que se cargará.
Muestra
BufferedInputStream Un BufferedInputStream para leer el contenido de la configuración
Arroja
ConfigurationException Si no se pudo encontrar la configuración

getConfigurationDef

protected ConfigurationDef getConfigurationDef (String name, 
                boolean isGlobal, 
                Map<String, String> templateMap)

Recupera el ConfigurationDef para el nombre determinado.

Parámetros
name String: Es el nombre de una configuración integrada para cargar o una ruta de acceso de archivo al archivo de configuración para cargar.
isGlobal boolean

templateMap Map

Muestra
ConfigurationDef ConfigurationDef
Arroja
ConfigurationException Si se produjo un error al cargar la configuración

getMapConfig

protected Map<ConfigurationFactory.ConfigId, ConfigurationDef> getMapConfig ()

Se expone para pruebas. Devuelve una copia del mapa.

Muestra
Map<ConfigurationFactory.ConfigId, ConfigurationDef>

isDirectConfiguration

protected boolean isDirectConfiguration (String configName)

Parámetros
configName String

Muestra
boolean

reorderArgs

protected String[] reorderArgs (String[] args)

Reordena los argumentos para que todos los argumentos de template:map se muevan al principio.

Parámetros
args String

Muestra
String[]

resolveRemoteFile

protected IRemoteFileResolver.ResolvedFile resolveRemoteFile (URI configURI, 
                URI destDir)

Parámetros
configURI URI

destDir URI

Muestra
IRemoteFileResolver.ResolvedFile

Arroja
BuildRetrievalError