com.opsmatters.newrelic.api

Class NewRelicPartnerApi

java.lang.Object

com.opsmatters.newrelic.api.NewRelicClient

com.opsmatters.newrelic.api.NewRelicPartnerApi

public class NewRelicPartnerApi
extends NewRelicClient

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

Author:

Gerald Curley (opsmatters)

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	NewRelicPartnerApi.Builder Builder to make NewRelicPartnerApi construction easier.

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT_HOST The default hostname for New Relic Partner API.

Fields inherited from class com.opsmatters.newrelic.api.NewRelicClient

DEFAULT_PORT, httpContext, provider

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
PartnerAccountService	accounts() Returns the operations related to Partner accounts.
static NewRelicPartnerApi.Builder	builder() Returns a builder for the NewRelicPartnerApi.
String	getUriPrefix() Returns the uri prefix for resources used by the client.
void	setHostname(String hostname) Sets the name of the host to connect to.
PartnerSubscriptionService	subscriptions() Returns the operations related to Partner subscriptions.
PartnerUserService	users() Returns the operations related to Partner users.

Methods inherited from class com.opsmatters.newrelic.api.NewRelicClient

checkInitialize, getHttpContext, handleErrors, initialize, setHandleErrors, setHttpClientProvider, setPort

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_HOST

public static final String DEFAULT_HOST

The default hostname for New Relic Partner API.

See Also:

Constant Field Values

Constructor Detail

NewRelicPartnerApi

public NewRelicPartnerApi()

Default constructor.

NewRelicPartnerApi

public NewRelicPartnerApi(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

setHostname

public void setHostname(String hostname)

Sets the name of the host to connect to.

The default hostname is "rpm.newrelic.com".

Overrides:

setHostname in class NewRelicClient

Parameters:

hostname - The name of the host

getUriPrefix

public String getUriPrefix()

Returns the uri prefix for resources used by the client.

Defaults to "/api" for Partner API.

Overrides:

getUriPrefix in class NewRelicClient

Returns:

The uri prefix for the client

accounts

public PartnerAccountService accounts()

Returns the operations related to Partner accounts.

Returns:

The Partner account service

users

public PartnerUserService users()

Returns the operations related to Partner users.

Returns:

The Partner user service

subscriptions

public PartnerSubscriptionService subscriptions()

Returns the operations related to Partner subscriptions.

Returns:

The Partner subscription service

builder

public static NewRelicPartnerApi.Builder builder()

Returns a builder for the NewRelicPartnerApi.

Returns:

The builder instance.