Configuration

java.lang.Object
- de.uni_hildesheim.sse.monitoring.runtime.configuration.Configuration

```
public class Configuration
extends java.lang.Object
```
Stores and maintains the configuration of the measurement process. Configuration settings are described in more detail in the manual. Configuration settings which may be changed during runtime are marked. Others are intended to be modified only internally or not at all during runtime (no setters).

Since:

1.00

Version:

1.21

Author:

Holger Eichelberger

Field Summary

Fields
Modifier and Type	Field and Description
`private ResourceType[]`	`accountableResources` Stores the accountable resources (currently all).
`private boolean`	`accountExcluded` Stores whether excluded parts should be accounted in a global monitoring group or whether they should be ignored and only be accounted for the entire program.
`private boolean`	`allClassMembers` Returns whether all class members shall be considered for instrumentation by default or whether SPASS-meter shall apply configuration-based filters such as "plain time" that may need explicit specification of the monitoring phase (as arbitrary classes are then not considered for analysis anymore).
`private AnnotationSearchType`	`annotationSearchType` Stores the annotation search type.
`private ResourceType[]`	`anywayResources` Stores the resources to be collected anyway.
`private java.lang.String`	`baseDir` Stores the base directory.
`private java.lang.String`	`bootJar` Stores the name of the bootpath jar file.
`private static java.lang.String`	`cmdArgs` May carry the initial arguments for initializing an instance of this class.
`private boolean`	`configurationDetection` Stores if automated configuration detection is enabled.
`private java.io.PrintStream`	`debugLog` Stores the debug log file (lazy initialization).
`static java.lang.String`	`DEFAULT_INSTRUMENTER` Defines the class name of the default instrumenter.
`private ResourceType[]`	`defaultGroupResources` Stores the default resources for monitoring groups(currently all).
`private java.lang.String`	`excludeClasses` Returns whether specific classes shall be excluded.
`private GroupAccountingType`	`groupAccountingType` Stores the group accounting type.
`static Configuration`	`INSTANCE` Stores the instance of this file, i.e. a singleton.
`private InstanceIdentifierKind`	`instanceIdentifierKind` Stores the instance identifier kind.
`private java.util.Set<java.lang.String>`	`instrumented` Stores the names of instrumented classes (preliminary solution).
`private XMLConfiguration`	`instrumenterConfig` Stores the instrumenter configuration taken from XML.
`private java.lang.String`	`instrumenterFactory` Stores the class name of the instrumenter factory.
`private boolean`	`instrumentInstrumenter` Stores if the instrumenter itself should be instrumented (legacy).
`private boolean`	`instrumentJavaLib` Stores whether the java library should be instrumented.
`private static java.lang.String`	`JVM_PROPERTY_CONFIGURATION_ARGS` Defines a key for storing the configuration arguments as JVM property.
`private ConfigurationListener`	`listener` Stores the attached configuration listener.
`private boolean`	`localEventProcessing` If `true`, performs asynchronous event processing all the time, if `false` use local asynchronous calls as long as no network-based recorder strategy is running.
`static java.util.logging.Logger`	`LOG` Defines the logger.
`private MainDefaultType`	`mainDefault` Stores the default instrumentation behavior at the first main method.
`private MemoryAccountingType`	`memoryAccountingType` Stores the memory accounting type.
`private boolean`	`multiConsiderContained` Stores whether accountable resources of the multi monitoring group is authoritative or weather the contained groups should be considered.
`private boolean`	`multiDistributeValues` Stores whether values in multi groups should be distributed evenly to the contained values or whether the entire value should be added to each group.
`private java.lang.String`	`outFileName` The output file.
`private int`	`outInterval` Stores the interval (in 500ms units) used for incrementally printing aggregated events.
`private boolean`	`printStatistics` Print statistic output at the end.
`private boolean`	`pruneAnnotations` Stores whether unused annotations should be removed from the resulting code.
`private HashMap<java.lang.String,java.lang.String>`	`pseudoId` Stores recorderId/pseudoId mappings for multiple recorder ids.
`private boolean`	`recordOverhead` Stores if overhead recording is enabled.
`private boolean`	`registerThreads` Stores whether threads being ready for running should be explicitly registered with the native implementation (e.g. needed when the Java implementation does not provide thread-based time monitoring through JMX).
`private boolean`	`retransformJavaLib` Stores whether the java library classes should be retransformed and instrumented.
`private ScopeType`	`scopeType` Stores the scope type, i.e. whether and how group annotations determine the instrumentation.
`private boolean`	`staticInstrumentation` Stores whether the current execution performs static instrumentation.
`private ResourceType[]`	`sumResources` Stores the SUM resources (currently all).
`private TcpConnectionInfo`	`tcp` Stores the hostname for tcp recording.
`private HashMap<java.lang.String,java.lang.String>`	`unrecognizedParams` Stores unrecognized parameters to be passed to plugins.
`private boolean`	`variantContributions` Stores if variant contributions should be collected.

Constructor Summary

Constructors
Modifier Constructor and Description

private Configuration()
Prevents this class from being instantiated from outside.

Constructors
Modifier	Constructor and Description
`private`	`Configuration()` Prevents this class from being instantiated from outside.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`accountExcluded()` Returns whether excluded parts should be accounted in a global monitoring group or whether they should be ignored and only be accounted for the entire program.
`boolean`	`accountForGlobalResource(boolean sum, ResourceType resource)` Returns whether we shall account for a global SUM/System resource.
`boolean`	`allClassMembers()` Returns whether all class members should be analyzed for instrumentation by default or whether SPASS-meter shall apply filter strategies such as "plain time".
`void`	`attachListener(ConfigurationListener listener)` Allows to set once a configuration listener (internal use only).
`void`	`close()` Closes the configuration (end of recording).
`private void`	`closeDebugLog()` Closes the debug log.
`boolean`	`configurationDetection()` Returns whether automatic configuration detection should be performed.
`void`	`debugLog(java.lang.String text)` Provides the opportunity to log to a debug file (if specified in configuration).
`private void`	`ensureDefaultResources()` Ensures that the `defaultGroupResources` is a subset of `accountableResources`.
`ResourceType[]`	`getAccountableResources()` Returns the resources which are accountable at all.
`AnnotationSearchType`	`getAnnotationSearchType()` Returns how annotations in super classes and interfacecs should be taken into account.
`ResourceType[]`	`getAnywayResources()` Returns the resources to be accounted anyway.
`java.lang.String`	`getBaseDir()` Returns the base directory.
`java.lang.String`	`getBootJar()` Returns the name of the bootpath jar file .
`ResourceType[]`	`getDefaultGroupResources()` Returns the default resources for monitoring groups.
`java.lang.String[]`	`getExcludeClasses()` Returns class name prefixes to be excluded (given in / rather than . notation).
`GroupAccountingType`	`getGroupAccountingType()` Returns the group accounting type [startup only].
`InstanceIdentifierKind`	`getInstanceIdentifierKind()` Returns the default instance identifier kind.
`java.lang.String`	`getInstrumenterFactory()` Returns the instrumenter factory class name.
`MainDefaultType`	`getMainDefault()` Returns the default instrumentation behavior for the first main method considered by the instrumenter.
`MemoryAccountingType`	`getMemoryAccountingType()` Returns the memory accounting type [startup only].
`MonitoringGroupConfiguration`	`getMonitoringGroupConfiguration(java.lang.String recId)` Returns the monitoring group configuration assigned to `recId`.
`java.io.File`	`getOutFile()` Returns the output file.
`java.lang.String`	`getOutFileName()` Returns the name of the output file.
`int`	`getOutInterval()` Returns the interval used for incrementally printing aggregated events.
`java.lang.String`	`getPseudoMapping(java.lang.String recId)` Returns the ids mapped to the given pseudo id.
`java.lang.String`	`getRecId(java.lang.String[] id)` Returns the first id if there is only one in the array or the (previously generated) pseudo id.
`RecordingType`	`getRecordingType()` Returns whether local event processing shall be done or whether local synchronous calls shall be used instead.
`ScopeType`	`getScopeType()` Returns the scope type, i.e. the influence of the monitoring group on the actual instrumentation.
`ResourceType[]`	`getSumResources()` Returns the resources to be accounted for the SUM (system under monitoring).
`java.lang.String`	`getTCPHostname()` Returns the hostname.
`int`	`getTCPPort()` Returns the port.
`java.lang.String`	`getUnrecognizedParam(java.lang.String key)` Returns an (unmodifiable) map of unrecognized params detected during parsing the agent options.
`XMLConfiguration`	`getXMLConfig()` Returns the XML configuration.
`void`	`instrumented(java.lang.String name)` Marks a class as instrumented.
`boolean`	`instrumentInstrumenter()` Returns if the instrumenter should be instrumented (legacy).
`boolean`	`instrumentJavaLib()` Returns whether the java library should be instrumented.
`boolean`	`isInstrumented(java.lang.String name)` Returns whether a class was instrumented.
`boolean`	`isStaticInstrumentation()` Returns whether the current execution performs a static instrumentation.
`boolean`	`measureVariantContributions()` Returns whether individual contributions of variants to configurations should be measured.
`boolean`	`multiGroupsConsiderContained()` Returns whether accountable resources of the multi monitoring group is authoritative or weather the contained groups should be considered.
`boolean`	`multiGroupsDistributeValues()` Returns whether values in multi groups should be distributed evenly to the contained values or whether the entire value should be added to each group.
`boolean`	`printStatistics()` Returns whether statistics shall be printed at the end of monitoring.
`boolean`	`programUseFromJvm()` Returns whether the memory used by the program should be inferred from JVM information or by accounting this information individually (memory intensive).
`boolean`	`pruneAnnotations()` Returns whether java library classes should be retransformed and instrumented at program start (additional overhead).
`void`	`read(java.io.DataInputStream in)` Reads this instance from the given input stream.
`void`	`readFromAgentArguments(java.lang.String args)` Reads the configuration parameters from an agent command line.
`boolean`	`recordOverhead()` Returns if measurement overhead should be collected.
`boolean`	`registerThreads()` Returns whether threads being ready for running should be explicitly registered with the native implementation (e.g. needed when the Java implementation does not provide thread-based time monitoring through JMX).
`boolean`	`retransformJavaLib()` Returns whether java library classes should be retransformed and instrumented at program start (additional overhead).
`void`	`setBaseDir(java.lang.String baseDir)` Changes the (optional) base directory (to be prepended to file location specifications).
`void`	`setBootJar(java.lang.String bootJar)` Changes the name of the bootpath jar file.
`void`	`setDebugLog(java.lang.String debugLog)` Changes the debug log file.
`void`	`setLogLevel(java.lang.String level)` Changes the logging level.
`void`	`setOutFileName(java.lang.String outFile)` Changes the name of the output file.
`void`	`setOutInterval(int outInterval)` Changes the interval used for incrementally printing aggregated events.
`void`	`setStaticInstrumentation(boolean staticInstrumentation)` Changes whether the current execution performs a static instrumentation.
`void`	`setTCPData(java.lang.String hostname, int port)` Changes TPC settings.
`void`	`setXMLConfig(java.lang.String xmlConfig)` Parses the specified XML configuration.
`void`	`write(java.io.DataOutputStream out)` Writes this instance to the given output stream.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - DEFAULT_INSTRUMENTER
```
public static final java.lang.String DEFAULT_INSTRUMENTER
```
    Defines the class name of the default instrumenter.
    
    See Also:
    
    Constant Field Values
  - LOG
```
public static final java.util.logging.Logger LOG
```
    Defines the logger.
  - INSTANCE
```
public static final Configuration INSTANCE
```
    Stores the instance of this file, i.e. a singleton.
  - JVM_PROPERTY_CONFIGURATION_ARGS
```
private static final java.lang.String JVM_PROPERTY_CONFIGURATION_ARGS
```
    Defines a key for storing the configuration arguments as JVM property. This is required to transport an initialization across different class loader contexts, e.g. in OSGi environments.
    
    See Also:
    
    Constant Field Values
  - cmdArgs
```
private static java.lang.String cmdArgs
```
    May carry the initial arguments for initializing an instance of this class. Intended to be set during pre-instrumentation. Do not rename this attribute as it may be set by instrumentation.
  - outFileName
```
private java.lang.String outFileName
```
    The output file. May be null for console output. Default value is null.
  - outInterval
```
private int outInterval
```
    Stores the interval (in 500ms units) used for incrementally printing aggregated events.
    This value must be > 0, otherwise this function will be disabled.
    
    Since:
    
    1.00
  - printStatistics
```
private boolean printStatistics
```
    Print statistic output at the end.
  - baseDir
```
private java.lang.String baseDir
```
    Stores the base directory.
  - instrumentInstrumenter
```
private boolean instrumentInstrumenter
```
    Stores if the instrumenter itself should be instrumented (legacy).
  - recordOverhead
```
private boolean recordOverhead
```
    Stores if overhead recording is enabled. Default value is false.
  - configurationDetection
```
private boolean configurationDetection
```
    Stores if automated configuration detection is enabled.
  - variantContributions
```
private boolean variantContributions
```
    Stores if variant contributions should be collected.
  - instrumenterFactory
```
private java.lang.String instrumenterFactory
```
    Stores the class name of the instrumenter factory.
  - unrecognizedParams
```
private HashMap<java.lang.String,java.lang.String> unrecognizedParams
```
    Stores unrecognized parameters to be passed to plugins.
  - tcp
```
private TcpConnectionInfo tcp
```
    Stores the hostname for tcp recording.
  - localEventProcessing
```
private boolean localEventProcessing
```
    If true, performs asynchronous event processing all the time, if false use local asynchronous calls as long as no network-based recorder strategy is running.
  - bootJar
```
private java.lang.String bootJar
```
    Stores the name of the bootpath jar file.
    
    Since:
    
    1.00
  - debugLog
```
private java.io.PrintStream debugLog
```
    Stores the debug log file (lazy initialization).
  - instrumenterConfig
```
private XMLConfiguration instrumenterConfig
```
    Stores the instrumenter configuration taken from XML.
  - instrumentJavaLib
```
private boolean instrumentJavaLib
```
    Stores whether the java library should be instrumented.
  - retransformJavaLib
```
private boolean retransformJavaLib
```
    Stores whether the java library classes should be retransformed and instrumented.
  - pruneAnnotations
```
private boolean pruneAnnotations
```
    Stores whether unused annotations should be removed from the resulting code.
  - scopeType
```
private ScopeType scopeType
```
    Stores the scope type, i.e. whether and how group annotations determine the instrumentation. The default value ScopeType.SUM due to legacy reasons.
  - staticInstrumentation
```
private boolean staticInstrumentation
```
    Stores whether the current execution performs static instrumentation. This attribute is internal to the framework and should not be accessible to user settings. Needs to be modified by a static instrumentation facility.
  - memoryAccountingType
```
private MemoryAccountingType memoryAccountingType
```
    Stores the memory accounting type.
  - groupAccountingType
```
private GroupAccountingType groupAccountingType
```
    Stores the group accounting type.
  - instanceIdentifierKind
```
private InstanceIdentifierKind instanceIdentifierKind
```
    Stores the instance identifier kind.
  - annotationSearchType
```
private AnnotationSearchType annotationSearchType
```
    Stores the annotation search type.
  - accountableResources
```
private ResourceType[] accountableResources
```
    Stores the accountable resources (currently all).
  - defaultGroupResources
```
private ResourceType[] defaultGroupResources
```
    Stores the default resources for monitoring groups(currently all).
  - sumResources
```
private ResourceType[] sumResources
```
    Stores the SUM resources (currently all).
  - anywayResources
```
private ResourceType[] anywayResources
```
    Stores the resources to be collected anyway.
  - multiDistributeValues
```
private boolean multiDistributeValues
```
    Stores whether values in multi groups should be distributed evenly to the contained values or whether the entire value should be added to each group.
    
    Since:
    
    1.00
  - multiConsiderContained
```
private boolean multiConsiderContained
```
    Stores whether accountable resources of the multi monitoring group is authoritative or weather the contained groups should be considered.
    
    Since:
    
    1.00
  - mainDefault
```
private MainDefaultType mainDefault
```
    Stores the default instrumentation behavior at the first main method.
  - registerThreads
```
private boolean registerThreads
```
    Stores whether threads being ready for running should be explicitly registered with the native implementation (e.g. needed when the Java implementation does not provide thread-based time monitoring through JMX).
    
    Since:
    
    1.00
  - listener
```
private ConfigurationListener listener
```
    Stores the attached configuration listener.
  - instrumented
```
private java.util.Set<java.lang.String> instrumented
```
    Stores the names of instrumented classes (preliminary solution).
  - pseudoId
```
private HashMap<java.lang.String,java.lang.String> pseudoId
```
    Stores recorderId/pseudoId mappings for multiple recorder ids.
  - accountExcluded
```
private boolean accountExcluded
```
    Stores whether excluded parts should be accounted in a global monitoring group or whether they should be ignored and only be accounted for the entire program.
    
    Since:
    
    1.00
  - allClassMembers
```
private boolean allClassMembers
```
    Returns whether all class members shall be considered for instrumentation by default or whether SPASS-meter shall apply configuration-based filters such as "plain time" that may need explicit specification of the monitoring phase (as arbitrary classes are then not considered for analysis anymore).
    
    Since:
    
    1.13
  - excludeClasses
```
private java.lang.String excludeClasses
```
    Returns whether specific classes shall be excluded.
- Constructor Detail
  - Configuration
```
private Configuration()
```
    Prevents this class from being instantiated from outside.
    
    Since:
    
    1.00
- Method Detail
  - write
```
public void write(java.io.DataOutputStream out)
           throws java.io.IOException
```
    Writes this instance to the given output stream.
    
    Parameters:
    
    out - the output stream
    
    Throws:
    
    java.io.IOException - in case of any I/O error or problem
    
    Since:
    
    1.00
  - read
```
public void read(java.io.DataInputStream in)
          throws java.io.IOException
```
    Reads this instance from the given input stream.
    
    Parameters:
    
    in - the input stream
    
    Throws:
    
    java.io.IOException - in case of any I/O error or problem
    
    Since:
    
    1.00
  - attachListener
```
public void attachListener(ConfigurationListener listener)
```
    Allows to set once a configuration listener (internal use only).
    
    Parameters:
    
    listener - the configuration listener
    
    Since:
    
    1.00
  - instrumentInstrumenter
```
public boolean instrumentInstrumenter()
```
    Returns if the instrumenter should be instrumented (legacy).
    
    Returns:
    
    true if enabled, false else
    
    Since:
    
    1.00
  - getMemoryAccountingType
```
public MemoryAccountingType getMemoryAccountingType()
```
    Returns the memory accounting type [startup only].
    
    Returns:
    
    the memory accounting type
    
    Since:
    
    1.00
  - getGroupAccountingType
```
public GroupAccountingType getGroupAccountingType()
```
    Returns the group accounting type [startup only].
    
    Returns:
    
    the group accounting type
    
    Since:
    
    1.00
  - getInstanceIdentifierKind
```
public InstanceIdentifierKind getInstanceIdentifierKind()
```
    Returns the default instance identifier kind.
    
    Returns:
    
    the default instance identifier kind
    
    Since:
    
    1.20
  - setLogLevel
```
public void setLogLevel(java.lang.String level)
```
    Changes the logging level.
    
    Parameters:
    
    level - the new logging level
    
    Since:
    
    1.00
    
    See Also:
    
    Level
  - setBaseDir
```
public void setBaseDir(java.lang.String baseDir)
```
    Changes the (optional) base directory (to be prepended to file location specifications).
    
    Parameters:
    
    baseDir - the base directory, may be null if unused
    
    Since:
    
    1.00
  - getBaseDir
```
public java.lang.String getBaseDir()
```
    Returns the base directory.
    
    Returns:
    
    the base directory, may be null if unspecified
    
    Since:
    
    1.00
  - setOutFileName
```
public void setOutFileName(java.lang.String outFile)
```
    Changes the name of the output file.
    
    Parameters:
    
    outFile - the name of the output file
    
    Since:
    
    1.00
  - getOutFileName
```
public java.lang.String getOutFileName()
```
    Returns the name of the output file.
    
    Returns:
    
    the name of the output file
    
    Since:
    
    1.00
  - setBootJar
```
public void setBootJar(java.lang.String bootJar)
```
    Changes the name of the bootpath jar file.
    
    Parameters:
    
    bootJar - the name of the bootpath jar file
    
    Since:
    
    1.00
  - setDebugLog
```
public void setDebugLog(java.lang.String debugLog)
```
    Changes the debug log file.
    
    Parameters:
    
    debugLog - the new debug log file
    
    Since:
    
    1.00
  - closeDebugLog
```
private void closeDebugLog()
```
    Closes the debug log.
    
    Since:
    
    1.00
  - close
```
public void close()
```
    Closes the configuration (end of recording).
    
    Since:
    
    1.00
  - setXMLConfig
```
public void setXMLConfig(java.lang.String xmlConfig)
```
    Parses the specified XML configuration.
    
    Parameters:
    
    xmlConfig - the XML configuration file
    
    Since:
    
    1.00
  - getXMLConfig
```
public XMLConfiguration getXMLConfig()
```
    Returns the XML configuration.
    
    Returns:
    
    the XML configuration
    
    Since:
    
    1.00
  - getBootJar
```
public java.lang.String getBootJar()
```
    Returns the name of the bootpath jar file .
    
    Returns:
    
    the name of the bootpath jar file
    
    Since:
    
    1.00
  - getOutFile
```
public java.io.File getOutFile()
```
    Returns the output file.
    
    Returns:
    
    the output file (by considering baseDir
    
    Since:
    
    1.00
  - printStatistics
```
public boolean printStatistics()
```
    Returns whether statistics shall be printed at the end of monitoring.
    
    Returns:
    
    true if statistics shall be printed, false else
    
    Since:
    
    1.00
  - getOutInterval
```
public int getOutInterval()
```
    Returns the interval used for incrementally printing aggregated events. If less than 500 the value is interpreted as 500ms units, if greater or equal 500 the value is interpreted as absolute time interval in milliseconds.
    
    Returns:
    
    the output interval, disabled if negative
    
    Since:
    
    1.00
  - setOutInterval
```
public void setOutInterval(int outInterval)
```
    Changes the interval used for incrementally printing aggregated events. If less than 500 the value is interpreted as 500ms units, if greater or equal 500 the value is interpreted as absolute time interval in milliseconds.
    
    Parameters:
    
    outInterval - the output interval, disables event printing if negative
    
    Since:
    
    1.00
  - getAccountableResources
```
public ResourceType[] getAccountableResources()
```
    Returns the resources which are accountable at all.
    
    Returns:
    
    the accountable resources (empty if all)
  - getDefaultGroupResources
```
public ResourceType[] getDefaultGroupResources()
```
    Returns the default resources for monitoring groups.
    
    Returns:
    
    the accountable resources by default (empty if all), a subset of getAccountableResources()
  - getSumResources
```
public ResourceType[] getSumResources()
```
    Returns the resources to be accounted for the SUM (system under monitoring).
    
    Returns:
    
    the accountable resources for the SUM (empty if all), a subset of getAccountableResources()
  - getAnywayResources
```
public ResourceType[] getAnywayResources()
```
    Returns the resources to be accounted anyway.
    
    Returns:
    
    the accountable resources, a subset of getAccountableResources() and ResourceType.SET_ANYWAY.
    
    Since:
    
    1.00
  - accountForGlobalResource
```
public boolean accountForGlobalResource(boolean sum,
                                        ResourceType resource)
```
    Returns whether we shall account for a global SUM/System resource.
    
    Parameters:
    
    sum - true for an answer for SUM-level, false for system level
    
    resource - the resource to query for
    
    Returns:
    
    true for accounting, false else
    
    Since:
    
    1.21
  - instrumentJavaLib
```
public boolean instrumentJavaLib()
```
    Returns whether the java library should be instrumented.
    
    Returns:
    
    true if the java library should be instrumented, false else
    
    Since:
    
    1.00
  - retransformJavaLib
```
public boolean retransformJavaLib()
```
    Returns whether java library classes should be retransformed and instrumented at program start (additional overhead).
    
    Returns:
    
    true if the java library should be retransformed, false else
    
    Since:
    
    1.00
  - pruneAnnotations
```
public boolean pruneAnnotations()
```
    Returns whether java library classes should be retransformed and instrumented at program start (additional overhead).
    
    Returns:
    
    true if unused annotations should be removed from the resulting code, false else
    
    Since:
    
    1.00
  - isStaticInstrumentation
```
public boolean isStaticInstrumentation()
```
    Returns whether the current execution performs a static instrumentation. This setting is internal to the framework and should not be modified by user settings.
    
    Returns:
    
    true if currently a static instrumentation is performed, false else
    
    Since:
    
    1.00
  - setStaticInstrumentation
```
public void setStaticInstrumentation(boolean staticInstrumentation)
```
    Changes whether the current execution performs a static instrumentation. This setting is internal to the framework and should not be modified by user settings.
    
    Parameters:
    
    staticInstrumentation - true if currently a static instrumentation is performed, false else
    
    Since:
    
    1.00
  - recordOverhead
```
public boolean recordOverhead()
```
    Returns if measurement overhead should be collected.
    
    Returns:
    
    true if measurement overhead should be collected, false else
    
    Since:
    
    1.00
  - configurationDetection
```
public boolean configurationDetection()
```
    Returns whether automatic configuration detection should be performed.
    
    Returns:
    
    true if configuration detection should be performed, false else
    
    Since:
    
    1.00
  - measureVariantContributions
```
public boolean measureVariantContributions()
```
    Returns whether individual contributions of variants to configurations should be measured.
    
    Returns:
    
    true if configuration detection should be performed, false else
    
    Since:
    
    1.00
  - setTCPData
```
public void setTCPData(java.lang.String hostname,
                       int port)
```
    Changes TPC settings.
    
    Parameters:
    
    hostname - the hostname of the TCP recording server
    
    port - the port number of the TCP recording server
    
    Since:
    
    1.00
  - getTCPHostname
```
public java.lang.String getTCPHostname()
```
    Returns the hostname.
    
    Returns:
    
    The hostname (empty for unknown)
  - getTCPPort
```
public int getTCPPort()
```
    Returns the port.
    
    Returns:
    
    The port (negative for unknown)
  - readFromAgentArguments
```
public void readFromAgentArguments(java.lang.String args)
```
    Reads the configuration parameters from an agent command line.
    
    Parameters:
    
    args - the agent command line
    
    Since:
    
    1.00
  - ensureDefaultResources
```
private void ensureDefaultResources()
```
    Ensures that the defaultGroupResources is a subset of accountableResources. Adjusts memoryAccountingType and defaultGroupResources, sumResources as well as anywayResources accordingly.
    
    Since:
    
    1.00
  - getScopeType
```
public ScopeType getScopeType()
```
    Returns the scope type, i.e. the influence of the monitoring group on the actual instrumentation.
    
    Returns:
    
    the scope type
    
    Since:
    
    1.00
  - getUnrecognizedParam
```
public java.lang.String getUnrecognizedParam(java.lang.String key)
```
    Returns an (unmodifiable) map of unrecognized params detected during parsing the agent options.
    
    Parameters:
    
    key - the configuration parameter name
    
    Returns:
    
    the unrecognized parameter or null
    
    Since:
    
    1.00
  - debugLog
```
public final void debugLog(java.lang.String text)
```
    Provides the opportunity to log to a debug file (if specified in configuration).
    
    Parameters:
    
    text - the text to log
    
    Since:
    
    1.00
  - getMonitoringGroupConfiguration
```
public MonitoringGroupConfiguration getMonitoringGroupConfiguration(java.lang.String recId)
```
    Returns the monitoring group configuration assigned to recId.
    
    Parameters:
    
    recId - the recording id to consider
    
    Returns:
    
    the assigned configuration or null if none is known
    
    Since:
    
    1.00
  - instrumented
```
public void instrumented(java.lang.String name)
```
    Marks a class as instrumented.
    
    Parameters:
    
    name - the name of the class
    
    Since:
    
    1.00
  - isInstrumented
```
public boolean isInstrumented(java.lang.String name)
```
    Returns whether a class was instrumented.
    
    Parameters:
    
    name - the name of the class
    
    Returns:
    
    true if it was instrumented, false else
    
    Since:
    
    1.00
  - programUseFromJvm
```
public boolean programUseFromJvm()
```
    Returns whether the memory used by the program should be inferred from JVM information or by accounting this information individually (memory intensive). [startup-time property]
    
    Returns:
    
    true the information should be inferred from the JVM, false individual accounting should be performed
    
    Since:
    
    1.00
  - getAnnotationSearchType
```
public AnnotationSearchType getAnnotationSearchType()
```
    Returns how annotations in super classes and interfacecs should be taken into account.
    
    Returns:
    
    the mode how to consider annotations
    
    Since:
    
    1.00
  - getRecId
```
public java.lang.String getRecId(java.lang.String[] id)
```
    Returns the first id if there is only one in the array or the (previously generated) pseudo id.
    
    Parameters:
    
    id - the ids to return the unique id for
    
    Returns:
    
    the first id if there is only one, the unique otherwise
    
    Since:
    
    1.00
  - getPseudoMapping
```
public java.lang.String getPseudoMapping(java.lang.String recId)
```
    Returns the ids mapped to the given pseudo id. This method is not efficiently implemented and should only be used for debugging or logging purpose.
    
    Parameters:
    
    recId - a pseudo recording id
    
    Returns:
    
    the assigned value
    
    Since:
    
    1.00
  - multiGroupsDistributeValues
```
public boolean multiGroupsDistributeValues()
```
    Returns whether values in multi groups should be distributed evenly to the contained values or whether the entire value should be added to each group.
    
    Returns:
    
    true if values should be distributed, false if not
    
    Since:
    
    1.00
  - multiGroupsConsiderContained
```
public boolean multiGroupsConsiderContained()
```
    Returns whether accountable resources of the multi monitoring group is authoritative or weather the contained groups should be considered.
    
    Returns:
    
    true if the contained groups values should be considered, false if the multi group is authoritative
    
    Since:
    
    1.00
  - getMainDefault
```
public MainDefaultType getMainDefault()
```
    Returns the default instrumentation behavior for the first main method considered by the instrumenter.
    
    Returns:
    
    the behavior specification
    
    Since:
    
    1.00
  - registerThreads
```
public boolean registerThreads()
```
    Returns whether threads being ready for running should be explicitly registered with the native implementation (e.g. needed when the Java implementation does not provide thread-based time monitoring through JMX).
    
    Returns:
    
    true if threads need to be registered explicitly, false else
    
    Since:
    
    1.00
  - accountExcluded
```
public boolean accountExcluded()
```
    Returns whether excluded parts should be accounted in a global monitoring group or whether they should be ignored and only be accounted for the entire program.
    
    Returns:
    
    true if they should be accounted in an own monitoring group, false if only for the entire program
    
    Since:
    
    1.00
  - getExcludeClasses
```
public java.lang.String[] getExcludeClasses()
```
    Returns class name prefixes to be excluded (given in / rather than . notation).
    
    Returns:
    
    class name prefixes to be excluded parsed into individual entries, may be null if none shall be excluded
    
    Since:
    
    1.11
  - getInstrumenterFactory
```
public java.lang.String getInstrumenterFactory()
```
    Returns the instrumenter factory class name.
    
    Returns:
    
    the instrumenter factory class name
    
    Since:
    
    1.00
  - getRecordingType
```
public RecordingType getRecordingType()
```
    Returns whether local event processing shall be done or whether local synchronous calls shall be used instead.
    
    Returns:
    
    true in case of local asynchronous event processing, false else
    
    Since:
    
    1.00
  - allClassMembers
```
public boolean allClassMembers()
```
    Returns whether all class members should be analyzed for instrumentation by default or whether SPASS-meter shall apply filter strategies such as "plain time".
    
    Returns:
    
    true if all class members shall be analyzed by default, false if filters shall be applied
    
    Since:
    
    1.13

Class Configuration

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

DEFAULT_INSTRUMENTER

LOG

INSTANCE

JVM_PROPERTY_CONFIGURATION_ARGS

cmdArgs

outFileName

outInterval

printStatistics

baseDir

instrumentInstrumenter

recordOverhead

configurationDetection

variantContributions

instrumenterFactory

unrecognizedParams

tcp

localEventProcessing

bootJar

debugLog

instrumenterConfig

instrumentJavaLib

retransformJavaLib

pruneAnnotations

scopeType

staticInstrumentation

memoryAccountingType

groupAccountingType

instanceIdentifierKind

annotationSearchType

accountableResources

defaultGroupResources

sumResources

anywayResources

multiDistributeValues

multiConsiderContained

mainDefault

registerThreads

listener

instrumented

pseudoId

accountExcluded

allClassMembers

excludeClasses

Constructor Detail

Configuration

Method Detail

write

read

attachListener

instrumentInstrumenter

getMemoryAccountingType

getGroupAccountingType

getInstanceIdentifierKind

setLogLevel

setBaseDir

getBaseDir

setOutFileName

getOutFileName

setBootJar

setDebugLog

closeDebugLog

close

setXMLConfig

getXMLConfig

getBootJar

getOutFile

printStatistics

getOutInterval

setOutInterval

getAccountableResources

getDefaultGroupResources

getSumResources

getAnywayResources

accountForGlobalResource