com.newrelic.agent

Class InboundHeaderState

java.lang.Object

com.newrelic.agent.InboundHeaderState

public class InboundHeaderState
extends java.lang.Object

Instances of this immutable class represent the NewRelic-specific inbound headers for this transaction. This class is thread safe.

Constructor Summary

Constructors

Constructor and Description
InboundHeaderState(Transaction tx, com.newrelic.api.agent.InboundHeaders inboundHeaders) Create this inbound header state object.

Method Summary

Modifier and Type	Method and Description
boolean	forceTrace()
java.lang.String	getClientCrossProcessId()
java.lang.String	getInboundTripId()
java.lang.String	getReferrerGuid()
java.lang.Integer	getReferringPathHash()
long	getRequestContentLength() It's not always possible for clients to determine the number of bytes sent, so reply with the number of bytes received.
java.lang.String	getSyntheticsJobId()
java.lang.String	getSyntheticsMonitorId()
java.lang.String	getSyntheticsResourceId()
int	getSyntheticsVersion() Get the version.
java.lang.String	getUnparsedSyntheticsHeader() Get the encoded, unparsed synthetics header from the inbound request.
boolean	isTrustedCatRequest() Return true if this is a trusted cross-process request.
boolean	isTrustedSyntheticsRequest() Return true if this is a trusted request from New Relic Synthetics.

Methods inherited from class java.lang.Object

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

Constructor Detail

InboundHeaderState

public InboundHeaderState(Transaction tx,
                          com.newrelic.api.agent.InboundHeaders inboundHeaders)

Create this inbound header state object.

Implementation note: the interface Request extends InboundHeaders. If the calling class has a Request object, the Request should be passed directly; code in this class may test the type of the inboundHeaders argument and provide more sophisticated processing if the InboundHeaders are in fact a Request.

We go to extra pain to code this in a way that allows all the state in this class to be final.

Parameters:

tx - our owning Transaction. May not be null.

inboundHeaders - the deobfuscated inbound headers. This value may be null.

Method Detail

getUnparsedSyntheticsHeader

public java.lang.String getUnparsedSyntheticsHeader()

Get the encoded, unparsed synthetics header from the inbound request.

This method is public because the inbound synthetic header is copied directly to outbound CAT requests. There's no need to parse and regenerate the header in these cases.

Returns:

the synthetics header from the inbound request or null if there is no such header. Also returns null if synthetics is globally disabled.

getSyntheticsVersion

public int getSyntheticsVersion()

Get the version. Callers should generally use isSupportedSyntheticsVersion() rather than calling here and then performing their own checks on supported versions. External caller must check validity of the version or customer privacy may be compromised. Currently, the only callers outside this class are non-shipping tests.

Returns:

the Synthetics version from the request headers, or HeadersUtil.SYNTHETICS_VERSION_NONE.

isTrustedSyntheticsRequest

public boolean isTrustedSyntheticsRequest()

Return true if this is a trusted request from New Relic Synthetics. The request is trusted if the calling ID can be decoded to a non-null value and the version in the header is supported.

Implementation note: None of the callers ever care what the actual value of the Synthetics account ID is, and hence this boolean accessor instead of a standard getter. The same underlying "trust logic" is used for both CAT and Synthetics.

Returns:

true if this is a trusted request from New Relic Synthetics.

getSyntheticsResourceId

public java.lang.String getSyntheticsResourceId()

getSyntheticsJobId

public java.lang.String getSyntheticsJobId()

getSyntheticsMonitorId

public java.lang.String getSyntheticsMonitorId()

isTrustedCatRequest

public boolean isTrustedCatRequest()

Return true if this is a trusted cross-process request.

Implementation note: the request is trusted if the calling ID can be decoded to a non-null value. Most callers don't care what the actual value of the ID is, and hence this boolean accessor in addition to a String getter. The same underlying "trust logic" is used for both CAT and Synthetics.

Returns:

true if this is a trusted cross-process request.

getClientCrossProcessId

public java.lang.String getClientCrossProcessId()

getReferrerGuid

public java.lang.String getReferrerGuid()

forceTrace

public boolean forceTrace()

getReferringPathHash

public java.lang.Integer getReferringPathHash()

getInboundTripId

public java.lang.String getInboundTripId()

getRequestContentLength

public long getRequestContentLength()

It's not always possible for clients to determine the number of bytes sent, so reply with the number of bytes received.

Returns:

the value of the Content-Length request header, or -1 if none