SphereClient

java.lang.Object
- io.sphere.client.shop.SphereClient

```
@Immutable
public final class SphereClient
extends java.lang.Object
```
The main access point to Sphere HTTP APIs. It is essentially just a configured set of services.

Constructor Summary

Constructors
Constructor and Description
SphereClient(SphereClientConfig config, com.ning.http.client.AsyncHttpClient httpClient, ClientCredentials clientCredentials, ProductService productService, CategoryTree categoryTree, CartService cartService, OrderService orderService, CustomerService customerService, CommentService commentService, ReviewService reviewService, InventoryService inventoryService, ShippingMethodService shippingMethodService, TaxCategoryService taxCategoryService, CustomObjectService customObjectService, ChannelService channelService) Creates an instance of SphereClient.

Method Summary

Methods
Modifier and Type	Method and Description
`CartService`	`carts()` Provides access to shop's shopping carts.
`CategoryTree`	`categories()` Provides access to shop's categories.
`ChannelService`	`channels()` Provides access to supply channels.
`CommentService`	`comments()` Provides access to shop's comments.
`static SphereClient`	`create(SphereClientConfig config)` Creates an instance of SphereClient.
`CustomerService`	`customers()` Provides access to shop's customers.
`CustomObjectService`	`customObjects()` Provides access to custom objects.
`SphereClientConfig`	`getConfig()` Configuration of the client.
`TaxCategoryService`	`getTaxCategoryService()` Provides access to shop's tax categories.
`InventoryService`	`inventory()` Provides access to shop's product inventory.
`OrderService`	`orders()` Provides access to shop's orders.
`ProductService`	`products()` Provides access to shop's products.
`ReviewService`	`reviews()` Provides access to shop's reviews.
`ShippingMethodService`	`shippingMethods()` Provides access to shop's shipping methods.
`void`	`shutdown()` Closes HTTP connections and shuts down internal thread pools.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SphereClient

public SphereClient(SphereClientConfig config,
            com.ning.http.client.AsyncHttpClient httpClient,
            ClientCredentials clientCredentials,
            ProductService productService,
            CategoryTree categoryTree,
            CartService cartService,
            OrderService orderService,
            CustomerService customerService,
            CommentService commentService,
            ReviewService reviewService,
            InventoryService inventoryService,
            ShippingMethodService shippingMethodService,
            TaxCategoryService taxCategoryService,
            CustomObjectService customObjectService,
            ChannelService channelService)

Creates an instance of SphereClient. All dependencies are configurable. This allows for supplying alternate implementations, for example stubs for testing.

Method Detail
- create
```
public static SphereClient create(SphereClientConfig config)
```
  Creates an instance of SphereClient.
- shutdown
```
public void shutdown()
```
  Closes HTTP connections and shuts down internal thread pools.
  You should call this method right before your application exits, otherwise background threads created by the SphereClient might prevent the process from terminating.
- getConfig
```
public SphereClientConfig getConfig()
```
  Configuration of the client.
- products
```
public ProductService products()
```
  Provides access to shop's products.
- categories
```
public CategoryTree categories()
```
  Provides access to shop's categories.
- carts
```
public CartService carts()
```
  Provides access to shop's shopping carts.
- orders
```
public OrderService orders()
```
  Provides access to shop's orders.
- customers
```
public CustomerService customers()
```
  Provides access to shop's customers.
- comments
```
public CommentService comments()
```
  Provides access to shop's comments.
- reviews
```
public ReviewService reviews()
```
  Provides access to shop's reviews.
- inventory
```
public InventoryService inventory()
```
  Provides access to shop's product inventory.
- shippingMethods
```
public ShippingMethodService shippingMethods()
```
  Provides access to shop's shipping methods.
- getTaxCategoryService
```
public TaxCategoryService getTaxCategoryService()
```
  Provides access to shop's tax categories.
- customObjects
```
public CustomObjectService customObjects()
```
  Provides access to custom objects.
- channels
```
public ChannelService channels()
```
  Provides access to supply channels.

Class SphereClient

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

SphereClient

Method Detail

create

shutdown

getConfig

products

categories

carts

orders

customers

comments

reviews

inventory

shippingMethods

getTaxCategoryService

customObjects

channels