com.newrelic.agent.attributes

Class AttributeValidator

java.lang.Object

com.newrelic.agent.attributes.AttributeValidator

Direct Known Subclasses:

CustomEventAttributeValidator, LlmEventAttributeValidator, LogAttributeValidator

public class AttributeValidator
extends java.lang.Object

Constructor Summary

Constructors

Constructor and Description
AttributeValidator(java.lang.String attributeType)

Method Summary

Modifier and Type	Method and Description
protected void	logTruncatedValue(java.lang.String key, java.lang.String value, java.lang.String truncatedVal, java.lang.String methodCalled, int maxAttributeSize)
protected void	setTransactional(boolean isTransactional) Allow attribute sending when outside a transaction, such as error events or custom events.
static java.lang.String	truncateString(java.lang.String s, int maxBytes) This function truncates a Unicode String so that it can be encoded in maxBytes.
protected java.lang.String	truncateValue(java.lang.String key, java.lang.String value, java.lang.String methodCalled)
<T> T	verifyParameterAndReturnValue(java.lang.String key, T value, java.lang.String methodCalled) Verifies the input key and value.
protected java.util.Map<java.lang.String,java.lang.Object>	verifyParametersAndReturnValues(java.util.Map<java.lang.String,java.lang.Object> params, java.lang.String methodCalled) Verifies a map of key/value pairs and returns a new map containing the verified parameters.

Methods inherited from class java.lang.Object

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

Constructor Detail

AttributeValidator

public AttributeValidator(java.lang.String attributeType)

Method Detail

setTransactional

protected void setTransactional(boolean isTransactional)

Allow attribute sending when outside a transaction, such as error events or custom events.

Parameters:

isTransactional - new value of transactional setting.

verifyParameterAndReturnValue

public <T> T verifyParameterAndReturnValue(java.lang.String key,
                                           T value,
                                           java.lang.String methodCalled)

Verifies the input key and value. Null is returned if the key/value is invalid, else the value is returned. Parameters added by the noticeError or transaction-less Span APIs will be reported regardless if they're in a transaction or not. In cases where parameters are longer than the maxUserParameterSize the returned value will be truncated.

verifyParametersAndReturnValues

protected java.util.Map<java.lang.String,java.lang.Object> verifyParametersAndReturnValues(java.util.Map<java.lang.String,java.lang.Object> params,
                                                                                           java.lang.String methodCalled)

Verifies a map of key/value pairs and returns a new map containing the verified parameters. An empty map is returned if there are no valid keys/values pairs or if addCustomParameters(Map) is invoked outside of a New Relic transaction, with the exception being that parameters added by the noticeError or transaction-less Span APIs will be reported regardless if they're in a transaction or not. In cases where parameters are longer than the maxUserParameterSize the returned value will be truncated.

truncateValue

protected java.lang.String truncateValue(java.lang.String key,
                                         java.lang.String value,
                                         java.lang.String methodCalled)

logTruncatedValue

protected void logTruncatedValue(java.lang.String key,
                                 java.lang.String value,
                                 java.lang.String truncatedVal,
                                 java.lang.String methodCalled,
                                 int maxAttributeSize)

truncateString

public static java.lang.String truncateString(java.lang.String s,
                                              int maxBytes)

This function truncates a Unicode String so that it can be encoded in maxBytes. It uses the UTF-8 encoding to determine where the String has to be truncated.

Parameters:

s - String to be truncated

maxBytes - Maximum number of bytes in UTF-8 charset encoding

Returns:

truncated input string