com.opsmatters.newrelic.api

Class NewRelicClient

java.lang.Object

com.opsmatters.newrelic.api.NewRelicClient

Direct Known Subclasses:

NewRelicApi, NewRelicInfraApi, NewRelicInsightsApi, NewRelicPartnerApi, NewRelicPluginsApi, NewRelicSyntheticsApi

public abstract class NewRelicClient
extends Object

Client used to invoke New Relic operations using the REST API.

Author:

Gerald Curley (opsmatters)

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT_PORT The default port for New Relic.
protected HttpContext	httpContext
protected HttpClientProvider	provider

Constructor Summary

Constructors

Constructor and Description
NewRelicClient() Default constructor.
NewRelicClient(String hostname, int port, HttpClientProvider provider) Constructor that takes a hostname, port and provider.

Method Summary

Modifier and Type	Method and Description
protected void	checkInitialize() Initialise the HTTP client provider and context.
HttpContext	getHttpContext() Returns the context used to make calls and deserialize payloads.
String	getUriPrefix() Returns the uri prefix for resources used by the client.
boolean	handleErrors() Returns true if errors should be handled rather than ignored.
NewRelicClient	initialize() Called after setting configuration properties.
void	setHandleErrors(boolean b) Set to true if errors should be handled rather than ignored.
void	setHostname(String hostname) Sets the name of the host to connect to.
void	setHttpClientProvider(HttpClientProvider provider) Sets the HTTP client provider.
void	setPort(int port) Sets the port of the host to connect to.

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_PORT

public static final int DEFAULT_PORT

The default port for New Relic.

See Also:

Constant Field Values

httpContext

protected HttpContext httpContext

provider

protected HttpClientProvider provider

Constructor Detail

NewRelicClient

public NewRelicClient()

Default constructor.

NewRelicClient

public NewRelicClient(String hostname,
                      int port,
                      HttpClientProvider provider)

Constructor that takes a hostname, port and provider.

Parameters:

hostname - The hostname of the server

port - The port of the server

provider - The HTTP client provider

Method Detail

initialize

public NewRelicClient initialize()

Called after setting configuration properties.

Returns:

This object

setHttpClientProvider

public void setHttpClientProvider(HttpClientProvider provider)

Sets the HTTP client provider.

Parameters:

provider - The interface for the underlying Jersey client provider

setHostname

public void setHostname(String hostname)

Sets the name of the host to connect to.

Parameters:

hostname - The name of the host

setPort

public void setPort(int port)

Sets the port of the host to connect to.

The default port is 443.

Parameters:

port - The port of the host

getHttpContext

public HttpContext getHttpContext()

Returns the context used to make calls and deserialize payloads.

Returns:

The HTTP context

setHandleErrors

public void setHandleErrors(boolean b)

Set to true if errors should be handled rather than ignored.

Parameters:

b - true if errors should be handled

handleErrors

public boolean handleErrors()

Returns true if errors should be handled rather than ignored.

Returns:

true if errors should be handled

getUriPrefix

public String getUriPrefix()

Returns the uri prefix for resources used by the client.

Defaults to an empty prefix. Where used, should always start with a "/".

Returns:

The uri prefix for the client

checkInitialize

protected void checkInitialize()

Initialise the HTTP client provider and context.