Package api.equinix.javasdk

Class EquinixClient

java.lang.Object

api.equinix.javasdk.EquinixClient

All Implemented Interfaces:

Service, Closeable, AutoCloseable

Direct Known Subclasses:

CustomerPortal, Fabric, IBXSmartView, InternetAccess, Messaging, NetworkEdge, Projects

public class EquinixClient
extends Object
implements Service, Closeable

The base class for all Equinix SDK domain entry points.

This class provides common functionality shared by all domain clients including OAuth2 authentication, HTTP client management, and resource lifecycle. Domain-specific entry points (Fabric, NetworkEdge, CustomerPortal, etc.) extend this class and add their own resource accessors.

Authentication is handled automatically on the first API call using OAuth2 client credentials. The client can also be explicitly authenticated using authenticate(). Implements Closeable to properly release HTTP connections when the client is no longer needed.

Usage

 // Domain clients extend EquinixClient
 Fabric fabric = new Fabric(credentials);

 // Optional: explicitly authenticate before making calls
 fabric.authenticate();

 // Use try-with-resources for proper cleanup
 try (Fabric fabric = new Fabric(credentials)) {
     PaginatedList<Port> ports = fabric.ports().list();
 }
 

Version:

$Id: $Id

Author:

ianjones

See Also:

• Fabric
• NetworkEdge
• CustomerPortal
• IBXSmartView
• InternetAccess
• Projects
• Messaging

Field Summary

Fields

Modifier and Type	Field	Description
protected final EquinixClient	equinixClient

Constructor Summary

Constructors

Constructor	Description
EquinixClient(EquinixCredentials equinixCredentials)	Creates a new Equinix client using the provided credentials.
EquinixClient(EquinixCredentials equinixCredentials, boolean isSandBoxed)	Creates a new Equinix client with optional sandbox mode.

Method Summary

Modifier and Type	Method	Description
void	authenticate()	Explicitly performs OAuth2 authentication using the configured client credentials.
void	close()
protected Core	core()	Returns the internal core client for authentication and platform-level operations.

Methods inherited from class java.lang.Object

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

Field Details

equinixClient

protected final EquinixClient equinixClient

Constructor Details

EquinixClient

public EquinixClient(EquinixCredentials equinixCredentials)

Creates a new Equinix client using the provided credentials. Authentication occurs automatically on the first API call.

Parameters:

equinixCredentials - the OAuth2 credentials for authenticating with Equinix APIs

EquinixClient

public EquinixClient(EquinixCredentials equinixCredentials,
 boolean isSandBoxed)

Creates a new Equinix client with optional sandbox mode.

Parameters:

equinixCredentials - the OAuth2 credentials for authenticating with Equinix APIs

isSandBoxed - true to use the sandbox environment for testing; false for production

Method Details

authenticate

public void authenticate()
                  throws EquinixClientException

Explicitly performs OAuth2 authentication using the configured client credentials. Stores the resulting access token for subsequent API calls. This is optional — authentication occurs automatically on the first API call if not called explicitly.

Throws:

EquinixClientException - if authentication fails due to invalid credentials or network errors

core

protected Core core()

Returns the internal core client for authentication and platform-level operations. This is used internally by domain clients and is not typically called directly.

Returns:

the Core client for core platform operations

close

public void close()
           throws IOException

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Throws:

IOException