uk.co.visalia.brightpearl.apiclient.account

Class Datacenter

java.lang.Object

uk.co.visalia.brightpearl.apiclient.account.Datacenter

All Implemented Interfaces:

Serializable

public final class Datacenter
extends Object
implements Serializable

Represents the datacenter on which an account is hosted. Static instances are included representing the known datacenters, and a customer datacenter can be created if required. To find the datacenter for an account, see the link below.

See Also:

http://www.brightpearl.com/developer/latest/concept/uri-syntax.html, Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static Datacenter	EU1 Datacenter EU1 (GMT, CET).
static Datacenter	EU2 Datacenter EU2 (for accounts where admin domain is https://secure2.thisispearl.com).
static Datacenter	USE Datacenter USE (EST, CST).
static Datacenter	USW Datacenter USW (PST, MST).

Constructor Summary

Constructors

Constructor and Description
Datacenter(String name, String host) Create a custom datacenter.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(Object o)
static Datacenter	forName(String name) Looks up a known datacenter by name, similar to looking up an enum by name.
String	getHost() Returns the datacenter host, including its scheme.
String	getName() Returns the name of the datacenter.
int	hashCode()
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

EU1

public static final Datacenter EU1

Datacenter EU1 (GMT, CET).

EU2

public static final Datacenter EU2

Datacenter EU2 (for accounts where admin domain is https://secure2.thisispearl.com).

USE

public static final Datacenter USE

Datacenter USE (EST, CST).

USW

public static final Datacenter USW

Datacenter USW (PST, MST).

Constructor Detail

Datacenter

public Datacenter(String name,
          String host)

Create a custom datacenter.

Parameters:

name - User friendly name of the datacenter. This is used for logging only; any non-null value is valid.

host - Scheme and host name of the datacenter, e.g. https://ws-usw.brightpearl.com. Trailing slashes should be omitted.

Method Detail

getName

public String getName()

Returns the name of the datacenter. This is an internal name only, useful for logging.

Returns:

the name of the datacenter.

getHost

public String getHost()

Returns the datacenter host, including its scheme.

Returns:

the datacenter host.

forName

public static Datacenter forName(String name)

Looks up a known datacenter by name, similar to looking up an enum by name. If a custom datacenter is being used this method cannot be used; no static references to custom instances are kept.

Parameters:

name - A datacenter name, corresponding to one of the static instances.

Returns:

The datacenter matching the supplied name, or null if the name is invalid.

toString

public String toString()

Overrides:

toString in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object