com.newrelic.api.agent

Class NewRelicApiImplementation

java.lang.Object

com.newrelic.api.agent.NewRelicApiImplementation

All Implemented Interfaces:

com.newrelic.agent.bridge.PublicApi, com.newrelic.api.agent.ErrorApi

public class NewRelicApiImplementation
extends java.lang.Object
implements com.newrelic.agent.bridge.PublicApi

The internal New Relic API implementation class.

DO NOT INVOKE THIS CLASS DIRECTLY. Use NewRelic.

Constructor Summary

Constructors

Constructor and Description
NewRelicApiImplementation()
NewRelicApiImplementation(AttributeSender customSender, AgentAttributeSender agentSender)

Method Summary

Modifier and Type	Method and Description
void	addCustomParameter(java.lang.String key, boolean value) Add a key/value pair to the current transaction.
void	addCustomParameter(java.lang.String key, java.lang.Number value) Add a key/value pair to the current transaction.
void	addCustomParameter(java.lang.String key, java.lang.String value) Add a key/value pair to the current transaction.
void	addCustomParameters(java.util.Map<java.lang.String,java.lang.Object> params) Add key/value pairs to the current transaction.
java.lang.String	getBrowserTimingFooter()
java.lang.String	getBrowserTimingFooter(java.lang.String nonce)
static java.lang.String	getBrowserTimingFooterForContentType(java.lang.String contentType) Called by JSPs.
java.lang.String	getBrowserTimingHeader()
java.lang.String	getBrowserTimingHeader(java.lang.String nonce)
static java.lang.String	getBrowserTimingHeaderForContentType(java.lang.String contentType) Called by JSPs.
void	ignoreApdex() Ignore the current transaction for calculating Apdex score.
void	ignoreTransaction() Ignore the current transaction.
static void	initialize()
void	noticeError(java.lang.String message, java.util.Map<java.lang.String,?> params, boolean expected)
void	noticeError(java.lang.Throwable throwable) Report an exception to New Relic.
void	noticeError(java.lang.Throwable throwable, java.util.Map<java.lang.String,?> params) Notice an exception and report it to New Relic.
void	noticeError(java.lang.Throwable throwable, java.util.Map<java.lang.String,?> params, boolean expected)
void	setAccountName(java.lang.String name) Set the account name to associate with the RUM JavaScript footer for the current web transaction.
void	setAppServerPort(int port)
void	setErrorGroupCallback(com.newrelic.api.agent.ErrorGroupCallback errorGroupCallback)
void	setInstanceName(java.lang.String instanceName)
void	setProductName(java.lang.String name) Set the product name to associate with the RUM JavaScript footer for the current web transaction.
void	setRequestAndResponse(com.newrelic.api.agent.Request request, com.newrelic.api.agent.Response response)
void	setServerInfo(java.lang.String dispatcherName, java.lang.String version)
void	setTransactionName(java.lang.String category, java.lang.String name) Set the name of the current transaction.
void	setUserId(java.lang.String userId) Sets the user ID for the current transaction by adding the "enduser.id" agent attribute.
void	setUserName(java.lang.String name) Set the user name to associate with the RUM JavaScript footer for the current web transaction.

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.newrelic.api.agent.ErrorApi

noticeError, noticeError, noticeError, noticeError

Constructor Detail

NewRelicApiImplementation

public NewRelicApiImplementation(AttributeSender customSender,
                                 AgentAttributeSender agentSender)

NewRelicApiImplementation

public NewRelicApiImplementation()

Method Detail

noticeError

public void noticeError(java.lang.Throwable throwable,
                        java.util.Map<java.lang.String,?> params)

Notice an exception and report it to New Relic. If this method is called within a transaction, the exception will be reported with the transaction when it finishes. If it is invoked outside of a transaction, a traced error will be created and reported to New Relic.

Specified by:

noticeError in interface com.newrelic.api.agent.ErrorApi

Parameters:

throwable -

params - Custom parameters to include in the traced error. May be null. Copied to avoid side effects.

noticeError

public void noticeError(java.lang.Throwable throwable)

Report an exception to New Relic.

Specified by:

noticeError in interface com.newrelic.api.agent.ErrorApi

Parameters:

throwable -

See Also:

noticeError(Throwable, Map)

noticeError

public void noticeError(java.lang.Throwable throwable,
                        java.util.Map<java.lang.String,?> params,
                        boolean expected)

Specified by:

noticeError in interface com.newrelic.api.agent.ErrorApi

noticeError

public void noticeError(java.lang.String message,
                        java.util.Map<java.lang.String,?> params,
                        boolean expected)

Specified by:

noticeError in interface com.newrelic.api.agent.ErrorApi

addCustomParameter

public void addCustomParameter(java.lang.String key,
                               java.lang.String value)

Add a key/value pair to the current transaction. These are reported in errors and transaction traces.

Specified by:

addCustomParameter in interface com.newrelic.agent.bridge.PublicApi

Parameters:

key -

value -

addCustomParameter

public void addCustomParameter(java.lang.String key,
                               java.lang.Number value)

Add a key/value pair to the current transaction. These are reported in errors and transaction traces.

Specified by:

addCustomParameter in interface com.newrelic.agent.bridge.PublicApi

Parameters:

key -

value -

addCustomParameter

public void addCustomParameter(java.lang.String key,
                               boolean value)

Add a key/value pair to the current transaction. These are reported in errors and transaction traces.

Specified by:

addCustomParameter in interface com.newrelic.agent.bridge.PublicApi

Parameters:

key -

value -

addCustomParameters

public void addCustomParameters(java.util.Map<java.lang.String,java.lang.Object> params)

Add key/value pairs to the current transaction. These are reported in errors and transaction traces.

Specified by:

addCustomParameters in interface com.newrelic.agent.bridge.PublicApi

Parameters:

params -

setUserId

public void setUserId(java.lang.String userId)

Sets the user ID for the current transaction by adding the "enduser.id" agent attribute. It is reported in errors and transaction traces. When high security mode is enabled, this method call will do nothing.

Specified by:

setUserId in interface com.newrelic.agent.bridge.PublicApi

Parameters:

userId - The user ID to report. If it is a null or blank String, the "enduser.id" agent attribute will not be included in the current transaction and any associated errors.

setTransactionName

public void setTransactionName(java.lang.String category,
                               java.lang.String name)

Set the name of the current transaction.

Specified by:

setTransactionName in interface com.newrelic.agent.bridge.PublicApi

Parameters:

category -

name - The name of the transaction in URI format. example: /store/order

ignoreTransaction

public void ignoreTransaction()

Ignore the current transaction.

Specified by:

ignoreTransaction in interface com.newrelic.agent.bridge.PublicApi

ignoreApdex

public void ignoreApdex()

Ignore the current transaction for calculating Apdex score.

Specified by:

ignoreApdex in interface com.newrelic.agent.bridge.PublicApi

setRequestAndResponse

public void setRequestAndResponse(com.newrelic.api.agent.Request request,
                                  com.newrelic.api.agent.Response response)

Specified by:

setRequestAndResponse in interface com.newrelic.agent.bridge.PublicApi

getBrowserTimingHeaderForContentType

public static java.lang.String getBrowserTimingHeaderForContentType(java.lang.String contentType)

Called by JSPs. Version 2.4.0 got the content type from the JSP. Post-2.4.0 versions get it from the HttpResponse. The argument is retained for backwards-compatibility with JSPs compiled with older Agents.

NOTE: This method is called by the AbstractRUMState class. It needs to remain static.

See Also:

GeneratorVisitTracerFactory

getBrowserTimingHeader

public java.lang.String getBrowserTimingHeader()

Specified by:

getBrowserTimingHeader in interface com.newrelic.agent.bridge.PublicApi

getBrowserTimingHeader

public java.lang.String getBrowserTimingHeader(java.lang.String nonce)

Specified by:

getBrowserTimingHeader in interface com.newrelic.agent.bridge.PublicApi

getBrowserTimingFooterForContentType

public static java.lang.String getBrowserTimingFooterForContentType(java.lang.String contentType)

Called by JSPs. The content type is not needed for the footer since it's checked in the header API call, and a footer cannot be written without a header. The argument is retained for backwards-compatibility with JSPs compiled with older Agents.

NOTE: This method is called by the AbstractRUMState class. It needs to remain static.

See Also:

GeneratorVisitTracerFactory

getBrowserTimingFooter

public java.lang.String getBrowserTimingFooter()

Specified by:

getBrowserTimingFooter in interface com.newrelic.agent.bridge.PublicApi

getBrowserTimingFooter

public java.lang.String getBrowserTimingFooter(java.lang.String nonce)

Specified by:

getBrowserTimingFooter in interface com.newrelic.agent.bridge.PublicApi

setUserName

public void setUserName(java.lang.String name)

Set the user name to associate with the RUM JavaScript footer for the current web transaction. If high security mode is enabled, this method call does nothing.

Specified by:

setUserName in interface com.newrelic.agent.bridge.PublicApi

setAccountName

public void setAccountName(java.lang.String name)

Set the account name to associate with the RUM JavaScript footer for the current web transaction.

Specified by:

setAccountName in interface com.newrelic.agent.bridge.PublicApi

setProductName

public void setProductName(java.lang.String name)

Set the product name to associate with the RUM JavaScript footer for the current web transaction.

Specified by:

setProductName in interface com.newrelic.agent.bridge.PublicApi

setAppServerPort

public void setAppServerPort(int port)

Specified by:

setAppServerPort in interface com.newrelic.agent.bridge.PublicApi

setServerInfo

public void setServerInfo(java.lang.String dispatcherName,
                          java.lang.String version)

Specified by:

setServerInfo in interface com.newrelic.agent.bridge.PublicApi

setInstanceName

public void setInstanceName(java.lang.String instanceName)

Specified by:

setInstanceName in interface com.newrelic.agent.bridge.PublicApi

setErrorGroupCallback

public void setErrorGroupCallback(com.newrelic.api.agent.ErrorGroupCallback errorGroupCallback)

Specified by:

setErrorGroupCallback in interface com.newrelic.api.agent.ErrorApi

initialize

public static void initialize()