CustomerServiceImpl

java.lang.Object
- io.sphere.internal.CustomerServiceImpl

All Implemented Interfaces:: CustomerService

public class CustomerServiceImpl
extends java.lang.Object
implements CustomerService

Field Summary

Fields
Modifier and Type	Field and Description
`protected ProjectEndpoints`	`endpoints`
`protected org.codehaus.jackson.type.TypeReference<QueryResult<T>>`	`queryResultTypeReference`
`protected RequestFactory`	`requestFactory`
`protected org.codehaus.jackson.type.TypeReference<T>`	`typeReference`

Constructor Summary

Constructors
Constructor and Description

CustomerServiceImpl(RequestFactory requestFactory, ProjectEndpoints endpoints)

Constructors
Constructor and Description
`CustomerServiceImpl(RequestFactory requestFactory, ProjectEndpoints endpoints)`

Method Summary

Methods
Modifier and Type	Method and Description
`QueryRequest<Customer>`	`all()` Deprecated.
`FetchRequest<Customer>`	`byId(java.lang.String id)` Finds a customer by id.
`FetchRequest<Customer>`	`byToken(java.lang.String token)` Finds a customer by a token value.
`CommandRequest<Customer>`	`changePassword(VersionedId customerId, java.lang.String currentPassword, java.lang.String newPassword)` Sets a new password for a customer.
`CommandRequest<Customer>`	`confirmEmail(VersionedId customerId, java.lang.String token)` Sets `Customer.isEmailVerified` to true.
`protected CommandRequest<T>`	`createCommandRequest(java.lang.String url, Command command)`
`CommandRequest<CustomerToken>`	`createEmailVerificationToken(VersionedId customerId, int ttlMinutes)` Creates a token used to verify customer's email.
`CommandRequest<CustomerToken>`	`createPasswordResetToken(java.lang.String email)` Creates a password reset token for the customer with the given email.
`CommandRequest<CustomerToken>`	`createPasswordResetToken(java.lang.String email, int ttlMinutes)`
`QueryRequest<Customer>`	`query()` Queries customers.
`protected QueryRequest<T>`	`queryImpl(java.lang.String url)`
`CommandRequest<Customer>`	`resetPassword(VersionedId customerId, java.lang.String token, java.lang.String newPassword)` Sets a new password for a customer.
`CommandRequest<SignInResult>`	`signIn(java.lang.String email, java.lang.String password)` Signs in a customer.
`CommandRequest<SignInResult>`	`signIn(java.lang.String email, java.lang.String password, java.lang.String cartId)` Signs in a customer and associates an existing anonymous cart to the customer.
`CommandRequest<SignInResult>`	`signUp(SignUpBuilder builder)` Creates a new customer.
`CommandRequest<SignInResult>`	`signUp(java.lang.String email, java.lang.String password, CustomerName name)` Creates a new customer.
`CommandRequest<SignInResult>`	`signUp(java.lang.String email, java.lang.String password, CustomerName name, java.lang.String cartId)` Creates a new customer and associates an existing anonymous cart to the customer.
`CommandRequest<Customer>`	`update(VersionedId customerId, CustomerUpdate customerUpdate)` Updates a customer.

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

- Field Detail
  - endpoints
```
protected ProjectEndpoints endpoints
```
  - requestFactory
```
protected RequestFactory requestFactory
```
  - typeReference
```
protected org.codehaus.jackson.type.TypeReference<T> typeReference
```
  - queryResultTypeReference
```
protected org.codehaus.jackson.type.TypeReference<QueryResult<T>> queryResultTypeReference
```
- Constructor Detail
  - CustomerServiceImpl
```
public CustomerServiceImpl(RequestFactory requestFactory,
                   ProjectEndpoints endpoints)
```
- Method Detail
  - byId
```
public FetchRequest<Customer> byId(java.lang.String id)
```
    Description copied from interface: CustomerService
    
    Finds a customer by id.
    
    Specified by:
    
    byId in interface CustomerService
  - byToken
```
public FetchRequest<Customer> byToken(java.lang.String token)
```
    Description copied from interface: CustomerService
    
    Finds a customer by a token value. If the customer is not found, it means the token is invalid or expired.
    
    Specified by:
    
    byToken in interface CustomerService
  - all
```
@Deprecated
public QueryRequest<Customer> all()
```
    Deprecated.
    
    Description copied from interface: CustomerService
    
    Queries all customers.
    
    Specified by:
    
    all in interface CustomerService
  - query
```
public QueryRequest<Customer> query()
```
    Description copied from interface: CustomerService
    
    Queries customers.
    
    Specified by:
    
    query in interface CustomerService
  - signUp
```
public CommandRequest<SignInResult> signUp(java.lang.String email,
                                  java.lang.String password,
                                  CustomerName name)
```
    Description copied from interface: CustomerService
    
    Creates a new customer.
    Specified by:
    
    signUp in interface CustomerService
    
    Returns:
    A command request which can fail with the following exceptions:
    
    EmailAlreadyInUseException if the email is already taken.
  - signUp
```
public CommandRequest<SignInResult> signUp(java.lang.String email,
                                  java.lang.String password,
                                  CustomerName name,
                                  java.lang.String cartId)
```
    Description copied from interface: CustomerService
    
    Creates a new customer and associates an existing anonymous cart to the customer.
    If the customer already had a cart, the given anonymous cart is merged with customer's cart. If no cart existed for the customer, the anonymous cart becomes customer's cart.
    Specified by:
    
    signUp in interface CustomerService
    
    cartId - The id of the anonymous cart that should be merged / associated to the customer. Can't be empty.
    
    Returns:
    A command request which can fail with the following exceptions:
    
    EmailAlreadyInUseException if the email is already taken.
  - signUp
```
public CommandRequest<SignInResult> signUp(SignUpBuilder builder)
```
    Description copied from interface: CustomerService
    
    Creates a new customer.
    If the customer already had a cart, the given anonymous cart is merged with customer's cart. If no cart existed for the customer, the anonymous cart becomes customer's cart.
    Specified by:
    
    signUp in interface CustomerService
    
    Returns:
    A command request which can fail with the following exceptions:
    
    EmailAlreadyInUseException if the email is already taken.
  - signIn
```
public CommandRequest<SignInResult> signIn(java.lang.String email,
                                  java.lang.String password)
```
    Description copied from interface: CustomerService
    
    Signs in a customer.
    Specified by:
    
    signIn in interface CustomerService
    
    Returns:
    A command request which can fail with the following exceptions:
    
    InvalidCredentialsException if no customer with given credentials exists.
  - signIn
```
public CommandRequest<SignInResult> signIn(java.lang.String email,
                                  java.lang.String password,
                                  java.lang.String cartId)
```
    Description copied from interface: CustomerService
    
    Signs in a customer and associates an existing anonymous cart to the customer.
    If the customer already had a cart, the given anonymous cart is merged with customer's cart. If no cart existed for the customer, the anonymous cart becomes customer's cart.
    Specified by:
    
    signIn in interface CustomerService
    
    cartId - The id of the anonymous cart that should be merged / associated to the customer. Can't be empty.
    
    Returns:
    A command request which can fail with the following exceptions:
    
    InvalidCredentialsException if no customer with given credentials exists.
  - changePassword
```
public CommandRequest<Customer> changePassword(VersionedId customerId,
                                      java.lang.String currentPassword,
                                      java.lang.String newPassword)
```
    Description copied from interface: CustomerService
    
    Sets a new password for a customer.
    Specified by:
    
    changePassword in interface CustomerService
    
    Returns:
    A command request which can fail with the following exceptions:
    
    InvalidPasswordException if the current password is invalid.
  - update
```
public CommandRequest<Customer> update(VersionedId customerId,
                              CustomerUpdate customerUpdate)
```
    Description copied from interface: CustomerService
    
    Updates a customer.
    
    Specified by:
    
    update in interface CustomerService
  - createPasswordResetToken
```
public CommandRequest<CustomerToken> createPasswordResetToken(java.lang.String email)
```
    Description copied from interface: CustomerService
    Creates a password reset token for the customer with the given email. The validity of the token is 10 minutes.
    The typical workflow is the following:
    1. Customer enters his or her email in a password reset form and submits.
    2. Create a password reset token using this method.
    3. Send an email containing a link with the token to the customer.
    4. The link points to a form where the customer can enter a new password. The form should load the customer using CustomerService.byToken(java.lang.String) and remember customer's id and version in hidden form fields. If the customer can't be found, the token has expired or is invalid.
    5. When the customer submits the form with the new password, call CustomerService.resetPassword(io.sphere.client.model.VersionedId, java.lang.String, java.lang.String), passing in the customer id and version, the new password and the token (the token is extracted from the URL).
    Specified by:
    
    createPasswordResetToken in interface CustomerService
    
    Parameters:
    email - Email address for which the token should be created.
  - createPasswordResetToken
```
public CommandRequest<CustomerToken> createPasswordResetToken(java.lang.String email,
                                                     int ttlMinutes)
```
    Specified by:
    
    createPasswordResetToken in interface CustomerService
    
    Parameters:
    email - Email address for which the token should be created.
    ttlMinutes - A hint for the backend how long the token should be valid. The actual timeout could be shorter.
    See Also:
    CustomerService.createPasswordResetToken(java.lang.String)
  - resetPassword
```
public CommandRequest<Customer> resetPassword(VersionedId customerId,
                                     java.lang.String token,
                                     java.lang.String newPassword)
```
    Description copied from interface: CustomerService
    
    Sets a new password for a customer. Requires a token that was previously generated using the CustomerService.createPasswordResetToken(String) method.
    
    Specified by:
    
    resetPassword in interface CustomerService
  - createEmailVerificationToken
```
public CommandRequest<CustomerToken> createEmailVerificationToken(VersionedId customerId,
                                                         int ttlMinutes)
```
    Description copied from interface: CustomerService
    Creates a token used to verify customer's email.
    Typically, verification emails are sent as part of the signup process but the decision is when and whether to verify customer emails is up to you.
    The typical workflow is the following:
    1. Create an email verification token using this method.
    2. Send an email containing a link with the token to the customer.
    3. The link points to a page where the customer has to log in (if not already logged in). If the customer is successfully logged in, you can call CustomerService.confirmEmail(io.sphere.client.model.VersionedId, java.lang.String), passing in current customer's id, version and the token, extracted from the URL.
    See also CustomerService.
    Specified by:
    
    createEmailVerificationToken in interface CustomerService
    
    ttlMinutes - Validity of the token in minutes. The maximum allowed value is 43200 (30 days).
  - confirmEmail
```
public CommandRequest<Customer> confirmEmail(VersionedId customerId,
                                    java.lang.String token)
```
    Description copied from interface: CustomerService
    
    Sets Customer.isEmailVerified to true. Requires a token that was previously generated using the CustomerService.createEmailVerificationToken(io.sphere.client.model.VersionedId, int) method.
    
    Specified by:
    
    confirmEmail in interface CustomerService
  - createCommandRequest
```
protected CommandRequest<T> createCommandRequest(java.lang.String url,
                                     Command command)
```
  - queryImpl
```
protected QueryRequest<T> queryImpl(java.lang.String url)
```

Class CustomerServiceImpl

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

endpoints

requestFactory

typeReference

queryResultTypeReference

Constructor Detail

CustomerServiceImpl

Method Detail

byId

byToken

all

query

signUp

signUp

signUp

signIn

signIn

changePassword

update

createPasswordResetToken

createPasswordResetToken

resetPassword

createEmailVerificationToken

confirmEmail

createCommandRequest

queryImpl