io.sphere.sdk.customers.commands

Class CustomerSignInCommand

java.lang.Object

io.sphere.sdk.models.Base

io.sphere.sdk.commands.CommandImpl<CustomerSignInResult>

io.sphere.sdk.customers.commands.CustomerSignInCommand

All Implemented Interfaces:

SphereRequest<CustomerSignInResult>, Command<CustomerSignInResult>

public final class CustomerSignInCommand
extends CommandImpl<CustomerSignInResult>

Retrieves the authenticated customer (a customer that matches the given email/password pair). Before signing in, a customer might have created an anonymous cart. After signing in, the content of the anonymous cart should be in the customer's cart. If the customer did not have a cart associated to him, then the anonymous cart becomes the customer's cart. If a customer already had a cart associated to him, then the content of the anonymous cart will be copied to the customer's cart. If a line item in the anonymous cart matches an existing line item in the customer's cart (same product ID and variant ID), then the maximum quantity of both line items is used as the new quantity. If the customer forgot the password reset it with CustomerCreatePasswordTokenCommand.

Example for a simple sign in without any carts involved:

withCustomer(client(), customer -> {
    final CustomerSignInResult result = client().executeBlocking(CustomerSignInCommand.of(customer.getEmail(), PASSWORD));
    assertThat(result.getCustomer()).isEqualTo(customer);
});
See the test code.

Example for a signin where the customer has a cart and signs in with an anonymous cart

withCustomerCustomerCartAndAnonymousCart(client(), customer -> customersCart -> anonymousCart -> {
    assertThat(customersCart.getCustomerId())
            .as("customersCart belongs to customer")
            .isEqualTo(customer.getId());
    assertThat(anonymousCart.getCustomerId()).as("anonymous cart has no customer").isNull();
    assertThat(customersCart.getLineItems().get(0).getProductId())
            .as("both carts have the same product variant")
            .isEqualTo(anonymousCart.getLineItems().get(0).getProductId());
    assertThat(customersCart.getLineItems().get(0).getQuantity())
            .describedAs("both carts have the same variant in different quantities")
            .isNotEqualTo(anonymousCart.getLineItems().get(0).getQuantity());
    assertThat(customersCart.getLineItems().get(0).getQuantity()).isEqualTo(3);
    assertThat(anonymousCart.getLineItems().get(0).getQuantity()).isEqualTo(7);
    final long maxOfBothQuantities = Math.max(customersCart.getLineItems().get(0).getQuantity(),
            anonymousCart.getLineItems().get(0).getQuantity());
    assertThat(maxOfBothQuantities).isEqualTo(7);

    final CustomerSignInResult result = client().executeBlocking(CustomerSignInCommand
            .of(customer.getEmail(), PASSWORD, anonymousCart.getId()));

    final Cart mergeResultCart = result.getCart();
    final LineItem mergeResultLineItem = mergeResultCart.getLineItems().get(0);
    assertThat(mergeResultLineItem.getQuantity()).isEqualTo(maxOfBothQuantities).isEqualTo(7);
    assertThat(mergeResultLineItem.getProductId())
            .describedAs("same product variant as before")
            .isEqualTo(customersCart.getLineItems().get(0).getProductId());
    assertThat(mergeResultCart.getId()).isEqualTo(customersCart.getId());
    assertThat(mergeResultCart.getId()).isEqualTo(customersCart.getId());
    assertThat(mergeResultCart.getCartState()).isEqualTo(CartState.ACTIVE);
    final Cart abandonedCart = client().executeBlocking(CartByIdGet.of(anonymousCart.getId()));
    assertThat(abandonedCart.getCartState()).isEqualTo(CartState.MERGED);
});
See the test code.

Example for invalid credentials:

withCustomer(client(), customer -> {
    assertThatThrownBy(() -> client().executeBlocking(CustomerSignInCommand.of("notpresent@null.europe-west1.gcp.commercetools.com", PASSWORD)))
            .isInstanceOf(ErrorResponseException.class)
            .matches(e -> ((ErrorResponseException) e).hasErrorCode(CustomerInvalidCredentials.CODE));
});
See the test code.

See Also:

Customer, CustomerCreatePasswordTokenCommand

Method Summary

Modifier and Type	Method and Description
ResourceIdentifier<Cart>	getAnonymousCart()
String	getAnonymousCartId() Deprecated. use getAnonymousCart() instead
AnonymousCartSignInMode	getAnonymousCartSignInMode()
String	getAnonymousId()
String	getEmail()
String	getPassword()
HttpRequestIntent	httpRequestIntent() Provides an http request intent, this does not include the execution of it.
protected com.fasterxml.jackson.databind.JavaType	jacksonJavaType()
static CustomerSignInCommand	of(String email, String password)
static CustomerSignInCommand	of(String email, String password, ResourceIdentifier<Cart> anonymousCart)
static CustomerSignInCommand	of(String email, String password, String anonymousCartId) Deprecated. use of(String, String, ResourceIdentifier) instead
CustomerSignInCommand	withAnonymousCart(ResourceIdentifier<Cart> anonymousCart)
CustomerSignInCommand	withAnonymousCartSignInMode(AnonymousCartSignInMode anonymousCartSignInMode)
CustomerSignInCommand	withAnonymousId(String anonymousId)
CustomerSignInCommand	withUpdateProductData(Boolean updateProductData)

Methods inherited from class io.sphere.sdk.commands.CommandImpl

deserialize

Methods inherited from class io.sphere.sdk.models.Base

equals, hashCode, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface io.sphere.sdk.client.SphereRequest

canDeserialize

Method Detail

of

public static CustomerSignInCommand of(String email,
                                       String password)

of

@Deprecated
public static CustomerSignInCommand of(String email,
                                                   String password,
                                                   @Nullable
                                                   String anonymousCartId)

Deprecated. use of(String, String, ResourceIdentifier) instead

of

public static CustomerSignInCommand of(String email,
                                       String password,
                                       @Nullable
                                       ResourceIdentifier<Cart> anonymousCart)

withAnonymousId

public CustomerSignInCommand withAnonymousId(@Nullable
                                             String anonymousId)

withAnonymousCart

public CustomerSignInCommand withAnonymousCart(@Nullable
                                               ResourceIdentifier<Cart> anonymousCart)

withAnonymousCartSignInMode

public CustomerSignInCommand withAnonymousCartSignInMode(@Nullable
                                                         AnonymousCartSignInMode anonymousCartSignInMode)

withUpdateProductData

public CustomerSignInCommand withUpdateProductData(@Nullable
                                                   Boolean updateProductData)

jacksonJavaType

protected com.fasterxml.jackson.databind.JavaType jacksonJavaType()

Specified by:

jacksonJavaType in class CommandImpl<CustomerSignInResult>

httpRequestIntent

public HttpRequestIntent httpRequestIntent()

Description copied from interface: SphereRequest

Provides an http request intent, this does not include the execution of it.

Returns:

http request intent

getEmail

public String getEmail()

getPassword

public String getPassword()

getAnonymousCartId

@Deprecated
 @Nullable
public String getAnonymousCartId()

Deprecated. use getAnonymousCart() instead

getAnonymousCart

@Nullable
public ResourceIdentifier<Cart> getAnonymousCart()

getAnonymousId

@Nullable
public String getAnonymousId()

getAnonymousCartSignInMode

@Nullable
public AnonymousCartSignInMode getAnonymousCartSignInMode()