Package org.openjdk.jmc.agent.impl

Class DefaultTransformRegistry

java.lang.Object

org.openjdk.jmc.agent.impl.DefaultTransformRegistry

All Implemented Interfaces:

TransformRegistry

public class DefaultTransformRegistry
extends Object
implements TransformRegistry

Field Summary

Fields

Modifier and Type	Field	Description
private String	currentConfiguration
private static final Logger	logger
private static final Schema	PROBE_SCHEMA
private static final String	PROBE_SCHEMA_XSD
private boolean	revertInstrumentation
private final HashMap<String,List<TransformDescriptor>>	transformData
private static final String	XML_ATTRIBUTE_NAME_ID
private static final String	XML_ELEMENT_CONFIGURATION
private static final String	XML_ELEMENT_FIELD_NAME
private static final String	XML_ELEMENT_METHOD_NAME
private static final String	XML_ELEMENT_NAME_EVENT
private static final String	XML_ELEMENT_PARAMETER_NAME
private static final String	XML_ELEMENT_RETURN_VALUE_NAME

Constructor Summary

Constructors

Constructor	Description
DefaultTransformRegistry()

Method Summary

Modifier and Type	Method	Description
private void	add(TransformDescriptor td)
private static void	addDefaults(HashMap<String,String> globalDefaults)
private void	clearAllOtherTransformData(Set<String> classesToKeep)
Set<String>	clearAllTransformData()	Clears all classes and their corresponding transforms in the registry.
private static void	disableExternalEntityProcessing(XMLInputFactory inputFactory)
static TransformRegistry	empty()
static TransformRegistry	from(InputStream in)
Set<String>	getClassNames()	Returns the names of all classes stored in the registry.
String	getCurrentConfiguration()	Returns the currently instrumented configuration.
List<TransformDescriptor>	getTransformData(String className)	Returns the unmodifiable list of TransformDescriptors for the named class.
private static String	getXmlAsString(InputStream in)
boolean	hasPendingTransforms(String className)	The named class has transforms that have not been executed yet.
private boolean	isPendingTransforms(List<TransformDescriptor> transforms)
boolean	isRevertIntrumentation()	Determines if classes should be reverted to their pre instrumentation versions.
Set<String>	modify(String xmlDescription)	Modifies class information in the registry according to the xml description.
private static Field	parseField(XMLStreamReader streamReader)
private static Method	parseMethod(XMLStreamReader streamReader, List<Parameter> parameters, ReturnValue[] returnValue)
private static Parameter	parseParameter(int index, XMLStreamReader streamReader)
private static ReturnValue	parseReturnValue(XMLStreamReader streamReader)
private static TransformDescriptor	parseTransformData(XMLStreamReader streamReader, HashMap<String,String> globalDefaults)
private static void	readGlobalConfig(XMLStreamReader streamReader, HashMap<String,String> globalDefaults)
void	setCurrentConfiguration(String configuration)	Set the current configuration that will be instrumented
void	setRevertInstrumentation(boolean shouldRevert)	Signify classes are or are not being reverted to their pre instrumentation versions.
String	toString()
private static void	transfer(HashMap<String,String> globalDefaults, Map<String,String> values)
private static boolean	validate(DefaultTransformRegistry registry, TransformDescriptor td)
static void	validateProbeDefinition(InputStream in)
static void	validateProbeDefinition(String configuration)

Methods inherited from class java.lang.Object

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

Field Details

XML_ATTRIBUTE_NAME_ID

private static final String XML_ATTRIBUTE_NAME_ID

See Also:

• Constant Field Values

XML_ELEMENT_NAME_EVENT

private static final String XML_ELEMENT_NAME_EVENT

See Also:

• Constant Field Values

XML_ELEMENT_METHOD_NAME

private static final String XML_ELEMENT_METHOD_NAME

See Also:

• Constant Field Values

XML_ELEMENT_FIELD_NAME

private static final String XML_ELEMENT_FIELD_NAME

See Also:

• Constant Field Values

XML_ELEMENT_PARAMETER_NAME

private static final String XML_ELEMENT_PARAMETER_NAME

See Also:

• Constant Field Values

XML_ELEMENT_RETURN_VALUE_NAME

private static final String XML_ELEMENT_RETURN_VALUE_NAME

See Also:

• Constant Field Values

XML_ELEMENT_CONFIGURATION

private static final String XML_ELEMENT_CONFIGURATION

See Also:

• Constant Field Values

logger

private static final Logger logger

transformData

private final HashMap<String,List<TransformDescriptor>> transformData

revertInstrumentation

private volatile boolean revertInstrumentation

currentConfiguration

private String currentConfiguration

PROBE_SCHEMA_XSD

private static final String PROBE_SCHEMA_XSD

See Also:

• Constant Field Values

PROBE_SCHEMA

private static final Schema PROBE_SCHEMA

Constructor Details

DefaultTransformRegistry

public DefaultTransformRegistry()

Method Details

hasPendingTransforms

public boolean hasPendingTransforms(String className)

Description copied from interface: TransformRegistry

The named class has transforms that have not been executed yet.

Specified by:

hasPendingTransforms in interface TransformRegistry

Parameters:

className - the name of the class to be transformed.

Returns:

true if the class has transforms scheduled. false if not.

empty

public static TransformRegistry empty()

validateProbeDefinition

public static void validateProbeDefinition(InputStream in)
                                    throws XMLValidationException

Throws:

XMLValidationException

validateProbeDefinition

public static void validateProbeDefinition(String configuration)
                                    throws XMLValidationException

Throws:

XMLValidationException

from

public static TransformRegistry from(InputStream in)
                              throws XMLStreamException,
XMLValidationException

Throws:

XMLStreamException

XMLValidationException

add

private void add(TransformDescriptor td)

validate

private static boolean validate(DefaultTransformRegistry registry,
 TransformDescriptor td)

parseTransformData

private static TransformDescriptor parseTransformData(XMLStreamReader streamReader,
 HashMap<String,String> globalDefaults)
                                               throws XMLStreamException

Throws:

XMLStreamException

transfer

private static void transfer(HashMap<String,String> globalDefaults,
 Map<String,String> values)

readGlobalConfig

private static void readGlobalConfig(XMLStreamReader streamReader,
 HashMap<String,String> globalDefaults)

addDefaults

private static void addDefaults(HashMap<String,String> globalDefaults)

parseParameter

private static Parameter parseParameter(int index,
 XMLStreamReader streamReader)
                                 throws XMLStreamException

Throws:

XMLStreamException

parseField

private static Field parseField(XMLStreamReader streamReader)
                         throws XMLStreamException

Throws:

XMLStreamException

parseReturnValue

private static ReturnValue parseReturnValue(XMLStreamReader streamReader)
                                     throws XMLStreamException

Throws:

XMLStreamException

parseMethod

private static Method parseMethod(XMLStreamReader streamReader,
 List<Parameter> parameters,
 ReturnValue[] returnValue)
                           throws XMLStreamException

Throws:

XMLStreamException

getTransformData

public List<TransformDescriptor> getTransformData(String className)

Description copied from interface: TransformRegistry

Returns the unmodifiable list of TransformDescriptors for the named class.

Specified by:

getTransformData in interface TransformRegistry

Parameters:

className - the class for which to retrieve the transformation metadata.

Returns:

the list of transformation metadata for the named class; may be empty but never null.

isPendingTransforms

private boolean isPendingTransforms(List<TransformDescriptor> transforms)

toString

public String toString()

Overrides:

toString in class Object

modify

public Set<String> modify(String xmlDescription)
                   throws XMLValidationException

Description copied from interface: TransformRegistry

Modifies class information in the registry according to the xml description.

Specified by:

modify in interface TransformRegistry

Parameters:

xmlDescription - an XML snippet describing the wanted modifications.

Returns:

a set of class names associated with modified TransformDescriptors.

Throws:

XMLValidationException - if the supplied XML fails to validate.

clearAllOtherTransformData

private void clearAllOtherTransformData(Set<String> classesToKeep)

clearAllTransformData

public Set<String> clearAllTransformData()

Description copied from interface: TransformRegistry

Clears all classes and their corresponding transforms in the registry.

Specified by:

clearAllTransformData in interface TransformRegistry

Returns:

the set of class names that were cleared.

getXmlAsString

private static String getXmlAsString(InputStream in)

getClassNames

public Set<String> getClassNames()

Description copied from interface: TransformRegistry

Returns the names of all classes stored in the registry.

Specified by:

getClassNames in interface TransformRegistry

Returns:

the unmodifiable set of class names.

getCurrentConfiguration

public String getCurrentConfiguration()

Description copied from interface: TransformRegistry

Returns the currently instrumented configuration.

Specified by:

getCurrentConfiguration in interface TransformRegistry

Returns:

an XML snippet of the configuration.

setCurrentConfiguration

public void setCurrentConfiguration(String configuration)

Description copied from interface: TransformRegistry

Set the current configuration that will be instrumented

Specified by:

setCurrentConfiguration in interface TransformRegistry

Parameters:

configuration - an XML snippet describing the current configuration

setRevertInstrumentation

public void setRevertInstrumentation(boolean shouldRevert)

Description copied from interface: TransformRegistry

Signify classes are or are not being reverted to their pre instrumentation versions.

Specified by:

setRevertInstrumentation in interface TransformRegistry

Parameters:

shouldRevert - true if class instrumentation should be reverted, false otherwise.

isRevertIntrumentation

public boolean isRevertIntrumentation()

Description copied from interface: TransformRegistry

Determines if classes should be reverted to their pre instrumentation versions.

Specified by:

isRevertIntrumentation in interface TransformRegistry

Returns:

true, if classes should be reverted and false otherwise.

disableExternalEntityProcessing

private static void disableExternalEntityProcessing(XMLInputFactory inputFactory)