com.newrelic.api.agent

Class NewRelicApiImplementation

java.lang.Object

com.newrelic.api.agent.NewRelicApiImplementation

All Implemented Interfaces:

com.newrelic.agent.bridge.PublicApi

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 sender)

Method Summary

Modifier and Type	Method and Description
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()
static java.lang.String	getBrowserTimingFooterForContentType(java.lang.String contentType) Called by JSPs.
java.lang.String	getBrowserTimingHeader()
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) Report an error to New Relic.
void	noticeError(java.lang.String message, boolean expected)
void	noticeError(java.lang.String message, java.util.Map<java.lang.String,? extends java.lang.Object> params) Notice an error and report it to New Relic.
void	noticeError(java.lang.String message, java.util.Map<java.lang.String,? extends java.lang.Object> params, boolean expected)
void	noticeError(java.lang.Throwable throwable) Report an exception to New Relic.
void	noticeError(java.lang.Throwable throwable, boolean expected)
void	noticeError(java.lang.Throwable throwable, java.util.Map<java.lang.String,? extends java.lang.Object> params) Notice an exception and report it to New Relic.
void	noticeError(java.lang.Throwable throwable, java.util.Map<java.lang.String,? extends java.lang.Object> 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	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	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

Constructor Detail

NewRelicApiImplementation

public NewRelicApiImplementation(AttributeSender sender)

NewRelicApiImplementation

public NewRelicApiImplementation()

Method Detail

noticeError

public void noticeError(java.lang.Throwable throwable,
                        java.util.Map<java.lang.String,? extends java.lang.Object> 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.agent.bridge.PublicApi

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.agent.bridge.PublicApi

Parameters:

throwable -

See Also:

noticeError(Throwable, Map)

noticeError

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

Notice an error and report it to New Relic. If this method is called within a transaction, the error message 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.agent.bridge.PublicApi

Parameters:

message - the error message

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

noticeError

public void noticeError(java.lang.String message)

Report an error to New Relic.

Specified by:

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

Parameters:

message - the error message

See Also:

noticeError(String, Map)

noticeError

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

Specified by:

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

noticeError

public void noticeError(java.lang.Throwable throwable,
                        boolean expected)

Specified by:

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

noticeError

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

Specified by:

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

noticeError

public void noticeError(java.lang.String message,
                        boolean expected)

Specified by:

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

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 - @

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 -

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

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

setUserName

public void setUserName(java.lang.String name)

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

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

initialize

public static void initialize()