Sphere

java.lang.Object
- sphere.Sphere

```
@ThreadSafe
public class Sphere
extends java.lang.Object
```
Client for accessing all Sphere APIs.
To obtain a thread-safe singleton instance of this class that can be used from all controllers in your application, use the static method getInstance.

Method Summary

Methods
Modifier and Type	Method and Description
`CategoryTree`	`categories()` All categories in the project, represented as an in-memory tree.
`SphereClient`	`client()` Provides access to the low-level Sphere Java client, may you need it to perform tasks that are not common in a typical online shop scenario.
`CommentService`	`comments()` Sphere HTTP API for working with product comments.
`CurrentCart`	`currentCart()` Returns a Cart API object for the current request.
`CurrentCustomer`	`currentCustomer()` Customer object for the current session.
`CustomerService`	`customers()` Sphere HTTP API for working with customers in a given project.
`CustomObjectService`	`customObjects()` Sphere HTTP API for storing arbitrary JSON data.
`static Sphere`	`getInstance()` Returns a thread-safe client for accessing the Sphere APIs.
`InventoryService`	`inventory()` Sphere HTTP API for working with product inventory.
`boolean`	`isLoggedIn()` Returns true if a customer is currently logged in, false otherwise.
`boolean`	`login(java.lang.String email, java.lang.String password)` Authenticates a customer and stores customer id in the session.
`play.libs.F.Promise<SphereResult<SignInResult>>`	`loginAsync(java.lang.String email, java.lang.String password)` Authenticates an existing customer asynchronously and store customer id in the session when finished.
`void`	`logout()` Removes the customer and cart information from the session.
`OrderService`	`orders()` Sphere HTTP API for working with orders.
`ProductService`	`products()` Sphere HTTP API for working with products.
`ReviewService`	`reviews()` Sphere HTTP API for working with product reviews.
`ShippingMethodService`	`shippingMethods()` Sphere HTTP API for working with shipping methods.
`SignInResult`	`signup(SignUpBuilder signUpBuilder)`
`SignInResult`	`signup(java.lang.String email, java.lang.String password, CustomerName customerName)` Creates and authenticates a new customer (you don't have to to call `login` explicitly).
`play.libs.F.Promise<SphereResult<SignInResult>>`	`signupAsync(SignUpBuilder signUpBuilder)`
`play.libs.F.Promise<SphereResult<SignInResult>>`	`signupAsync(java.lang.String email, java.lang.String password, CustomerName customerName)` Creates and authenticates a new customer asynchronously (you don't have to to call `login` explicitly).

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

- Method Detail
  - products
```
public ProductService products()
```
    Sphere HTTP API for working with products.
  - categories
```
public CategoryTree categories()
```
    All categories in the project, represented as an in-memory tree. The category tree is initialized just once on startup.
  - orders
```
public OrderService orders()
```
    Sphere HTTP API for working with orders.
  - customers
```
public CustomerService customers()
```
    Sphere HTTP API for working with customers in a given project. Use currentCustomer() for working with the currently logged in customer.
  - reviews
```
public ReviewService reviews()
```
    Sphere HTTP API for working with product reviews.
  - comments
```
public CommentService comments()
```
    Sphere HTTP API for working with product comments.
  - inventory
```
public InventoryService inventory()
```
    Sphere HTTP API for working with product inventory.
  - shippingMethods
```
public ShippingMethodService shippingMethods()
```
    Sphere HTTP API for working with shipping methods.
  - customObjects
```
public CustomObjectService customObjects()
```
    Sphere HTTP API for storing arbitrary JSON data.
  - client
```
public SphereClient client()
```
    Provides access to the low-level Sphere Java client, may you need it to perform tasks that are not common in a typical online shop scenario.
    Using the shop client, you can access all Sphere HTTP API endpoints, so you can for example create shopping carts freely, fetch orders for any customer, etc.
  - currentCart
```
@Nonnull
public CurrentCart currentCart()
```
    Returns a Cart API object for the current request. This object is automatically associated to the current HTTP session, meaning the cart is preserved for a user.
    
    Returns:
    A cart API object. This method never returns null.
  - getInstance
```
public static Sphere getInstance()
```
    Returns a thread-safe client for accessing the Sphere APIs. The returned instance is designed to be shared by all controllers in your application.
  - isLoggedIn
```
public boolean isLoggedIn()
```
    Returns true if a customer is currently logged in, false otherwise. This is equivalent to currentCustomer() != null but more readable.
  - currentCustomer
```
public CurrentCustomer currentCustomer()
```
    Customer object for the current session.
    
    Returns:
    The current customer if a customer is logged in, null otherwise.
  - login
```
public boolean login(java.lang.String email,
            java.lang.String password)
```
    Authenticates a customer and stores customer id in the session. If login was successful, currentCustomer() will always return a CurrentCustomer instance, until logout() is called.
    
    Returns:
    True if the customer was successfully authenticated, false otherwise.
  - loginAsync
```
public play.libs.F.Promise<SphereResult<SignInResult>> loginAsync(java.lang.String email,
                                                         java.lang.String password)
```
    Authenticates an existing customer asynchronously and store customer id in the session when finished.
  - signup
```
public SignInResult signup(java.lang.String email,
                  java.lang.String password,
                  CustomerName customerName)
```
    Creates and authenticates a new customer (you don't have to to call login explicitly).
    
    Throws:
    
    EmailAlreadyInUseException - if the email is already taken.
  - signup
```
public SignInResult signup(SignUpBuilder signUpBuilder)
```
  - signupAsync
```
public play.libs.F.Promise<SphereResult<SignInResult>> signupAsync(java.lang.String email,
                                                          java.lang.String password,
                                                          CustomerName customerName)
```
    Creates and authenticates a new customer asynchronously (you don't have to to call login explicitly).
    Returns:
    A result which can fail with the following exceptions:
    EmailAlreadyInUseException if the email is already taken.
  - signupAsync
```
public play.libs.F.Promise<SphereResult<SignInResult>> signupAsync(SignUpBuilder signUpBuilder)
```
  - logout
```
public void logout()
```
    Removes the customer and cart information from the session.
    After calling logout, currentCustomer() will return null. Make sure you don't keep old CurrentCustomer instances around as they become invalid after logout.

Class Sphere

Method Summary

Methods inherited from class java.lang.Object

Method Detail

products

categories

orders

customers

reviews

comments

inventory

shippingMethods

customObjects

client

currentCart

getInstance

isLoggedIn

currentCustomer

login

loginAsync

signup

signup

signupAsync

signupAsync

logout