com.newrelic.agent.database

Class SqlObfuscator

java.lang.Object

com.newrelic.agent.database.SqlObfuscator

public abstract class SqlObfuscator
extends java.lang.Object

The agent can be configured to report raw sql in transaction traces, report no sql at all, or report sql with string and numeric literals replaced with the ? character.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	OBFUSCATED_SETTING
static java.lang.String	OFF_SETTING
static java.lang.String	RAW_SETTING

Method Summary

Modifier and Type	Method and Description
static SqlObfuscator	getCachingSqlObfuscator(SqlObfuscator sqlObfuscator)
static SqlObfuscator	getDefaultSqlObfuscator()
boolean	isObfuscating()
abstract java.lang.String	obfuscateSql(java.lang.String sql) Obfuscates a sql statement with an unknown dialect.
abstract java.lang.String	obfuscateSql(java.lang.String sql, java.lang.String dialect) Obfuscated a sql statement with the given dialect.

Methods inherited from class java.lang.Object

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

Field Detail

OBFUSCATED_SETTING

public static final java.lang.String OBFUSCATED_SETTING

See Also:

Constant Field Values

RAW_SETTING

public static final java.lang.String RAW_SETTING

See Also:

Constant Field Values

OFF_SETTING

public static final java.lang.String OFF_SETTING

See Also:

Constant Field Values

Method Detail

obfuscateSql

public abstract java.lang.String obfuscateSql(java.lang.String sql)

Obfuscates a sql statement with an unknown dialect. The obfuscator will attempt to obfuscate using a combination of all known dialects. If that fails to obfuscate then "?" will be returned. If the dialect is known, obfuscateSql(String, String) should be used instead.

Parameters:

sql - the sql string to obfuscate

Returns:

an obfuscated version of the sql passed in

obfuscateSql

public abstract java.lang.String obfuscateSql(java.lang.String sql,
                                              java.lang.String dialect)

Obfuscated a sql statement with the given dialect. If the dialect is supported we will return a fully obfuscated version of the sql. If the dialect is not supported the obfuscator will attempt to obfuscate using a combination of all known dialects. If that still fails to obfuscate then "?" will be returned.

Parameters:

sql - the sql string to obfuscate

dialect - the dialect to obfuscate

Returns:

an obfuscated version of the sql passed in

isObfuscating

public boolean isObfuscating()

getDefaultSqlObfuscator

public static SqlObfuscator getDefaultSqlObfuscator()

getCachingSqlObfuscator

public static SqlObfuscator getCachingSqlObfuscator(SqlObfuscator sqlObfuscator)