CurrentCustomer

java.lang.Object
- sphere.CurrentCustomer

```
@ThreadSafe
public class CurrentCustomer
extends java.lang.Object
```
Project customer service that automatically accesses the customer associated to the current HTTP session.
After calling Sphere.logout, any existing CurrentCustomer instance is not valid any more and will throw IllegalStateException.
Therefore, don't keep instances of this class around, but always use Sphere.currentCustomer to get an up-to-date instance or null, if noone is logged in.

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`changePassword(java.lang.String currentPassword, java.lang.String newPassword)` Changes customer's password.
`play.libs.F.Promise<SphereResult<Customer>>`	`changePasswordAsync(java.lang.String currentPassword, java.lang.String newPassword)` Changes customer's password asynchronously.
`QueryRequest<Comment>`	`comments()` Queries all comments that the current customer created.
`Customer`	`confirmEmail(java.lang.String token)` Sets `Customer.isEmailVerified` to true.
`play.libs.F.Promise<SphereResult<Customer>>`	`confirmEmailAsync(java.lang.String token)` Sets `Customer.isEmailVerified` to true asynchronously.
`Comment`	`createComment(java.lang.String productId, java.lang.String authorName, java.lang.String title, java.lang.String text)` Creates a comment.
`play.libs.F.Promise<SphereResult<Comment>>`	`createCommentAsync(java.lang.String productId, java.lang.String authorName, java.lang.String title, java.lang.String text)` Creates a comment asynchronously.
`CustomerToken`	`createEmailVerificationToken(int ttlMinutes)` Creates a token to verify customer's email.
`play.libs.F.Promise<SphereResult<CustomerToken>>`	`createEmailVerificationTokenAsync(int ttlMinutes)` Creates a token to verify customer's email asynchronously.
`static CurrentCustomer`	`createFromSession(CustomerService customerService, OrderService orderService, CommentService commentService, ReviewService reviewService)` If a customer is logged in, returns a `CurrentCustomer` instance.
`Review`	`createReview(java.lang.String productId, java.lang.String authorName, java.lang.String title, java.lang.String text, java.lang.Double score)` Creates a review.
`play.libs.F.Promise<SphereResult<Review>>`	`createReviewAsync(java.lang.String productId, java.lang.String authorName, java.lang.String title, java.lang.String text, java.lang.Double score)` Creates a review asynchronously.
`Customer`	`fetch()` Fetches the currently authenticated `Customer`.
`play.libs.F.Promise<Customer>`	`fetchAsync()` Fetches the currently authenticated `Customer` asynchronously.
`QueryRequest<Order>`	`orders()` Queries all orders of given customer.
`QueryRequest<Review>`	`reviews()` Queries all reviews of the current.
`QueryRequest<Review>`	`reviewsForProduct(java.lang.String productId)` Queries all reviews of the current customer for a specific product.
`Customer`	`update(CustomerUpdate update)` Updates the currently authenticated customer.
`play.libs.F.Promise<SphereResult<Customer>>`	`updateAsync(CustomerUpdate update)` Updates the currently authenticated customer asynchronously.

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

Method Detail

createFromSession

public static CurrentCustomer createFromSession(CustomerService customerService,
                                OrderService orderService,
                                CommentService commentService,
                                ReviewService reviewService)

If a customer is logged in, returns a CurrentCustomer instance. If no customer is logged in, returns null.

fetch
```
public Customer fetch()
```
Fetches the currently authenticated Customer.

Returns:
Customer or null if no customer is authenticated.

fetchAsync
```
public play.libs.F.Promise<Customer> fetchAsync()
```
Fetches the currently authenticated Customer asynchronously.

Returns:
Customer or null if no customer is authenticated.

changePassword

public void changePassword(java.lang.String currentPassword,
                  java.lang.String newPassword)

Changes customer's password.

Throws:: InvalidPasswordException - if the current password is invalid.

changePasswordAsync

public play.libs.F.Promise<SphereResult<Customer>> changePasswordAsync(java.lang.String currentPassword,
                                                              java.lang.String newPassword)

Changes customer's password asynchronously.

Returns:

A result which can fail with the following exceptions:

InvalidPasswordException if the current password is invalid.

update

public Customer update(CustomerUpdate update)

Updates the currently authenticated customer.

updateAsync

public play.libs.F.Promise<SphereResult<Customer>> updateAsync(CustomerUpdate update)

Updates the currently authenticated customer asynchronously.

createEmailVerificationToken

public CustomerToken createEmailVerificationToken(int ttlMinutes)

Creates a token to verify customer's email.

createEmailVerificationTokenAsync
```
public play.libs.F.Promise<SphereResult<CustomerToken>> createEmailVerificationTokenAsync(int ttlMinutes)
```
Creates a token to verify customer's email asynchronously.

Parameters:
ttlMinutes - Validity of the token in minutes.

confirmEmail
```
public Customer confirmEmail(java.lang.String token)
```
Sets Customer.isEmailVerified to true. Requires a token that was previously generated using the createEmailVerificationToken(int) method.

confirmEmailAsync
```
public play.libs.F.Promise<SphereResult<Customer>> confirmEmailAsync(java.lang.String token)
```
Sets Customer.isEmailVerified to true asynchronously. Requires a token that was previously generated using the createEmailVerificationToken(int) method.

orders
```
public QueryRequest<Order> orders()
```
Queries all orders of given customer.

reviews
```
public QueryRequest<Review> reviews()
```
Queries all reviews of the current.

reviewsForProduct
```
public QueryRequest<Review> reviewsForProduct(java.lang.String productId)
```
Queries all reviews of the current customer for a specific product.

createReview

public Review createReview(java.lang.String productId,
                  java.lang.String authorName,
                  java.lang.String title,
                  java.lang.String text,
                  java.lang.Double score)

Creates a review. At least one of the three optional parameters (title, text, score) must be set.

createReviewAsync

public play.libs.F.Promise<SphereResult<Review>> createReviewAsync(java.lang.String productId,
                                                          java.lang.String authorName,
                                                          java.lang.String title,
                                                          java.lang.String text,
                                                          java.lang.Double score)

Creates a review asynchronously. At least one of the three optional parameters (title, text, score) must be set.

comments
```
public QueryRequest<Comment> comments()
```
Queries all comments that the current customer created.

createComment

public Comment createComment(java.lang.String productId,
                    java.lang.String authorName,
                    java.lang.String title,
                    java.lang.String text)

Creates a comment. At least one of the two optional parameters (title, text) must be set.

createCommentAsync

public play.libs.F.Promise<SphereResult<Comment>> createCommentAsync(java.lang.String productId,
                                                            java.lang.String authorName,
                                                            java.lang.String title,
                                                            java.lang.String text)

Creates a comment asynchronously. At least one of the two optional parameters (title, text) must be set.

Class CurrentCustomer

Method Summary

Methods inherited from class java.lang.Object

Method Detail

createFromSession

fetch

fetchAsync

changePassword

changePasswordAsync

update

updateAsync

createEmailVerificationToken

createEmailVerificationTokenAsync

confirmEmail

confirmEmailAsync

orders

reviews

reviewsForProduct

createReview

createReviewAsync

comments

createComment

createCommentAsync