Package de.hybris.platform.assistedservicefacades.impl

Class DefaultAssistedServiceFacade

java.lang.Object

de.hybris.platform.assistedservicefacades.impl.DefaultAssistedServiceFacade

All Implemented Interfaces:

AssistedServiceFacade

public class DefaultAssistedServiceFacade
extends java.lang.Object
implements AssistedServiceFacade

Default implementation of the AssistedServiceFacade interface.

Field Summary

Fields

Modifier and Type	Field	Description
protected static java.lang.String	AGENT_TIMER_KEY
protected static java.lang.String	ASM_AGENT_STORE
static java.lang.String	ASM_CUSTOMER_PROFILE_REFERENCES
protected static java.lang.String	ASM_ERROR_MESSAGE_ARGS_KEY
protected static java.lang.String	ASM_ERROR_MESSAGE_KEY
protected static java.lang.String	CREATE_DISABLED_KEY
protected static int	DEFAULT_SESSION_TIMER
protected static java.lang.String	EMULATE_BY_ORDER_KEY
static java.lang.String	ERROR_NO_CUSTOMER_OR_CART_ID_PROVIDED
protected static java.lang.String	SESSION_CART_KEY

Constructor Summary

Constructors

Constructor	Description
DefaultAssistedServiceFacade()

Method Summary

Modifier and Type	Method	Description
protected UserModel	attachCartToSession(java.lang.String cartId, UserModel customer)
protected void	attachLatestSessionCart(UserModel customer)
void	bindCustomerToCart(java.lang.String customerId, java.lang.String cartId)	Binds customer with provided id to cart if it's anonymous cart.
protected void	cleanAsmSession()
CustomerData	createCustomer(java.lang.String customerId, java.lang.String customerName)	Creates a new customer by it email and name.
protected void	createSessionEvent(UserModel agent, UserModel customer, EventType type)	Creates session event for provided customer and agent.
protected void	detachSessionCart()	Detaches current cart from session and attaches newly created empty one.
void	emulateAfterLogin()	Personify customer based on customer stored on login step and current session cart.
void	emulateCustomer(java.lang.String customerId, java.lang.String cartId)	Adds a customer and/or cart to the current session.
void	emulateCustomer(java.lang.String customerId, java.lang.String cartId, java.lang.String orderId)	Adds provided customer, cart or an order to the current session.
AssistedServiceSession	getAsmSession()	Returns ASM session object with all information about current asm session.
protected java.lang.String	getAssistedServiceAgentStore(UserModel agent)
protected AssistedServiceService	getAssistedServiceService()
java.util.Map<java.lang.String,java.lang.Object>	getAssistedServiceSessionAttributes()	Returns assisted service attributes map for page model.
int	getAssistedServiceSessionTimeout()	Returns timeout for assisted service agent session in seconds.
int	getAssistedServiceSessionTimerValue()	Returns timer value (in seconds) for assisted service agent session, that displays inside widget.
protected Converter<CartModel,CartData>	getCartConverter()
java.util.Collection<CartData>	getCartListForCustomer(CustomerModel customer)	Returns collection of a customer's carts
protected CartService	getCartService()
protected CommerceCommonI18NService	getCommerceCommonI18NService()
CustomerData	getCustomerByOrder(java.lang.String orderId)	Get the order's customer using orderFacade.getOrderDetailsForCode
protected Converter<UserModel,CustomerData>	getCustomerConverter()
java.util.List<CustomerData>	getCustomers(java.lang.String searchTerm, PageableData pageableData)	Get list of customers which username or email starts with provided value.
protected EventService	getEventService()
protected ModelService	getModelService()
protected PasswordEncoderService	getPasswordEncoderService()
protected SessionService	getSessionService()
java.util.List<CustomerData>	getSuggestedCustomerList(java.lang.String username)	Validate session and get list of customers which username or email starts with provided value.
protected UserService	getUserService()
protected boolean	isAssistedServiceAgent(UserModel asmAgent)	Verify that provided user participate in a parent AS agent group.
boolean	isAssistedServiceAgentLoggedIn()	Checks if there is ASM information in the current session or no, this will be used by Session Restriction mainly
boolean	isAssistedServiceModeLaunched()	Whether or not Assisted Service module is launched.
protected boolean	isBruteForce(UserModel asmAgent)
protected java.lang.Boolean	isCustomerAccountActive(UserModel customer)
void	launchAssistedServiceMode()	Starts the Assisted Service Mode.
protected void	loginAssistedServiceAgent(UserModel agent)
void	loginAssistedServiceAgent(java.lang.String username, java.lang.String password)	Logs in Assisted Service agent using provided credentials.
protected void	loginAssistedServiceAgent(java.lang.String username, java.lang.String password, boolean isTokenBasedLogin)
void	loginAssistedServiceAgentSAML(java.lang.String username, java.lang.String password)	Logs in Assisted Service agent using provided SAML credentials.
void	logoutAssistedServiceAgent()	Logs out Assisted Service agent by removing session attribute.
protected void	quitAsmSession()
void	quitAssistedServiceMode()	Ends the Assisted Service Mode.
protected void	resetBruteForceCounter(UserModel asmAgent)
protected void	sanityCheckForAgent(UserModel agent)
void	setAssistedServiceService(AssistedServiceService assistedServiceService)
void	setCartConverter(Converter<CartModel,CartData> cartConverter)
void	setCartService(CartService cartService)
void	setCommerceCommonI18NService(CommerceCommonI18NService commerceCommonI18NService)
void	setCustomerConverter(Converter<UserModel,CustomerData> customerConverter)
void	setEventService(EventService eventService)
void	setModelService(ModelService modelService)
void	setPasswordEncoderService(PasswordEncoderService passwordEncoderService)
void	setSessionService(SessionService sessionService)
void	setUserService(UserService userService)
void	stopEmulateCustomer()	Remove customer and/or cart from the current session.
protected void	validateSession()	Checks current session for ASM requirements
protected void	verifyAssistedServiceAgent(UserModel asmAgent)	Verify that provided user participate in a parent AS agent group.
protected void	verifyAssistedServiceMode()	Checks current session for ASM mode launched.
protected void	verifyFormLoginAbility()	Verify whether AS agent can be logged in via https login form.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

ASM_CUSTOMER_PROFILE_REFERENCES

public static final java.lang.String ASM_CUSTOMER_PROFILE_REFERENCES

See Also:

Constant Field Values

ERROR_NO_CUSTOMER_OR_CART_ID_PROVIDED

public static final java.lang.String ERROR_NO_CUSTOMER_OR_CART_ID_PROVIDED

See Also:

Constant Field Values

DEFAULT_SESSION_TIMER

protected static final int DEFAULT_SESSION_TIMER

See Also:

Constant Field Values

SESSION_CART_KEY

protected static final java.lang.String SESSION_CART_KEY

See Also:

Constant Field Values

AGENT_TIMER_KEY

protected static final java.lang.String AGENT_TIMER_KEY

See Also:

Constant Field Values

CREATE_DISABLED_KEY

protected static final java.lang.String CREATE_DISABLED_KEY

See Also:

Constant Field Values

EMULATE_BY_ORDER_KEY

protected static final java.lang.String EMULATE_BY_ORDER_KEY

See Also:

Constant Field Values

ASM_ERROR_MESSAGE_KEY

protected static final java.lang.String ASM_ERROR_MESSAGE_KEY

See Also:

Constant Field Values

ASM_ERROR_MESSAGE_ARGS_KEY

protected static final java.lang.String ASM_ERROR_MESSAGE_ARGS_KEY

See Also:

Constant Field Values

ASM_AGENT_STORE

protected static final java.lang.String ASM_AGENT_STORE

See Also:

Constant Field Values

Constructor Detail

DefaultAssistedServiceFacade

public DefaultAssistedServiceFacade()

Method Detail

getAssistedServiceSessionAttributes

public java.util.Map<java.lang.String,java.lang.Object> getAssistedServiceSessionAttributes()

Description copied from interface: AssistedServiceFacade

Returns assisted service attributes map for page model.

Specified by:

getAssistedServiceSessionAttributes in interface AssistedServiceFacade

Returns:

String->Object map for page model.

isAssistedServiceModeLaunched

public boolean isAssistedServiceModeLaunched()

Description copied from interface: AssistedServiceFacade

Whether or not Assisted Service module is launched.

Specified by:

isAssistedServiceModeLaunched in interface AssistedServiceFacade

Returns:

true when assisted service mode has been launched

emulateCustomer

public void emulateCustomer(java.lang.String customerId,
                            java.lang.String cartId,
                            java.lang.String orderId)
                     throws AssistedServiceException

Description copied from interface: AssistedServiceFacade

Adds provided customer, cart or an order to the current session.

Specified by:

emulateCustomer in interface AssistedServiceFacade

Parameters:

customerId - id to identify the customer by (usually email address)

cartId - the id of the customer cart to pick up

orderId - the id of the customer order to pick up

Throws:

AssistedServiceException - In case of: 1) both customerId and cartId parameters blank 2) bad credentials, 3) AS agent isn't logged in yet 4) AS agent trying to emulate himself

isCustomerAccountActive

protected java.lang.Boolean isCustomerAccountActive(UserModel customer)

attachCartToSession

protected UserModel attachCartToSession(java.lang.String cartId,
                                        UserModel customer)
                                 throws AssistedServiceWrongCartIdException

Throws:

AssistedServiceWrongCartIdException

emulateCustomer

public void emulateCustomer(java.lang.String customerId,
                            java.lang.String cartId)
                     throws AssistedServiceException

Description copied from interface: AssistedServiceFacade

Adds a customer and/or cart to the current session.

Specified by:

emulateCustomer in interface AssistedServiceFacade

Parameters:

customerId - id to identify the customer by (usually email address)

cartId - the id of the customer cart to pick up

Throws:

AssistedServiceException - In case of: 1) blank parameters 2) bad credentials, 3) AS agent isn't logged in yet 4) AS agent trying to emulate himself

stopEmulateCustomer

public void stopEmulateCustomer()

Description copied from interface: AssistedServiceFacade

Remove customer and/or cart from the current session.

Specified by:

stopEmulateCustomer in interface AssistedServiceFacade

detachSessionCart

protected void detachSessionCart()

Detaches current cart from session and attaches newly created empty one.

attachLatestSessionCart

protected void attachLatestSessionCart(UserModel customer)

launchAssistedServiceMode

public void launchAssistedServiceMode()

Description copied from interface: AssistedServiceFacade

Starts the Assisted Service Mode.

Specified by:

launchAssistedServiceMode in interface AssistedServiceFacade

quitAssistedServiceMode

public void quitAssistedServiceMode()

Description copied from interface: AssistedServiceFacade

Ends the Assisted Service Mode.

Specified by:

quitAssistedServiceMode in interface AssistedServiceFacade

loginAssistedServiceAgent

public void loginAssistedServiceAgent(java.lang.String username,
                                      java.lang.String password)
                               throws AssistedServiceException

Description copied from interface: AssistedServiceFacade

Logs in Assisted Service agent using provided credentials.

Specified by:

loginAssistedServiceAgent in interface AssistedServiceFacade

Parameters:

username - uid

password - password

Throws:

AssistedServiceException - In case of bad credentials

loginAssistedServiceAgentSAML

public void loginAssistedServiceAgentSAML(java.lang.String username,
                                          java.lang.String password)
                                   throws AssistedServiceException

Description copied from interface: AssistedServiceFacade

Logs in Assisted Service agent using provided SAML credentials.

Specified by:

loginAssistedServiceAgentSAML in interface AssistedServiceFacade

Parameters:

username - uid

password - password

Throws:

AssistedServiceException - In case of bad credentials

loginAssistedServiceAgent

protected void loginAssistedServiceAgent(java.lang.String username,
                                         java.lang.String password,
                                         boolean isTokenBasedLogin)
                                  throws AssistedServiceException

Throws:

AssistedServiceException

sanityCheckForAgent

protected void sanityCheckForAgent(UserModel agent)
                            throws AssistedServiceException

Throws:

AssistedServiceException

loginAssistedServiceAgent

protected void loginAssistedServiceAgent(UserModel agent)
                                  throws AssistedServiceException

Throws:

AssistedServiceException

logoutAssistedServiceAgent

public void logoutAssistedServiceAgent()
                                throws AssistedServiceException

Description copied from interface: AssistedServiceFacade

Logs out Assisted Service agent by removing session attribute.

Specified by:

logoutAssistedServiceAgent in interface AssistedServiceFacade

Throws:

AssistedServiceException - In case there is no AS agent session

getAssistedServiceSessionTimeout

public int getAssistedServiceSessionTimeout()

Description copied from interface: AssistedServiceFacade

Returns timeout for assisted service agent session in seconds.

Specified by:

getAssistedServiceSessionTimeout in interface AssistedServiceFacade

Returns:

session in seconds

getAssistedServiceSessionTimerValue

public int getAssistedServiceSessionTimerValue()

Description copied from interface: AssistedServiceFacade

Returns timer value (in seconds) for assisted service agent session, that displays inside widget.

Specified by:

getAssistedServiceSessionTimerValue in interface AssistedServiceFacade

Returns:

value in seconds

getCustomerByOrder

public CustomerData getCustomerByOrder(java.lang.String orderId)

Description copied from interface: AssistedServiceFacade

Get the order's customer using orderFacade.getOrderDetailsForCode

Specified by:

getCustomerByOrder in interface AssistedServiceFacade

Parameters:

orderId - the id of the customer order to get customer

Returns:

customerData

getSuggestedCustomerList

public java.util.List<CustomerData> getSuggestedCustomerList(java.lang.String username)
                                                      throws AssistedServiceException

Description copied from interface: AssistedServiceFacade

Validate session and get list of customers which username or email starts with provided value.

Specified by:

getSuggestedCustomerList in interface AssistedServiceFacade

Parameters:

username - uid or customer's name

Returns:

suggested customers

Throws:

AssistedServiceException - In case Assisted Service Agent is not logged in or Assisted Service mode inactive

getCustomers

public java.util.List<CustomerData> getCustomers(java.lang.String searchTerm,
                                                 PageableData pageableData)

Description copied from interface: AssistedServiceFacade

Get list of customers which username or email starts with provided value.

Specified by:

getCustomers in interface AssistedServiceFacade

Parameters:

searchTerm - part of uid or customer's name

pageableData - the pageable data

Returns:

list of customers

emulateAfterLogin

public void emulateAfterLogin()
                       throws AssistedServiceException

Description copied from interface: AssistedServiceFacade

Personify customer based on customer stored on login step and current session cart.

Specified by:

emulateAfterLogin in interface AssistedServiceFacade

Throws:

AssistedServiceException - In case of: 1) AS agent isn't logged in yet 2) AS agent trying to emulate himself

bindCustomerToCart

public void bindCustomerToCart(java.lang.String customerId,
                               java.lang.String cartId)
                        throws AssistedServiceException

Description copied from interface: AssistedServiceFacade

Binds customer with provided id to cart if it's anonymous cart.

Specified by:

bindCustomerToCart in interface AssistedServiceFacade

Parameters:

customerId - email of to be newly created customer that is used as uid

cartId - the id of the customer cart to pick up

Throws:

AssistedServiceException - In cas of missing cart with given cardId

createSessionEvent

protected void createSessionEvent(UserModel agent,
                                  UserModel customer,
                                  EventType type)

Creates session event for provided customer and agent.

Parameters:

agent -

customer -

type -

validateSession

protected void validateSession()
                        throws AssistedServiceException

Checks current session for ASM requirements

Throws:

AssistedServiceException - in case ASM not launched or AS agent isn't logged in

verifyAssistedServiceMode

protected void verifyAssistedServiceMode()
                                  throws AssistedServiceException

Checks current session for ASM mode launched.

Throws:

AssistedServiceException - in case it's not

verifyFormLoginAbility

protected void verifyFormLoginAbility()
                               throws AssistedServiceException

Verify whether AS agent can be logged in via https login form.

Throws:

AssistedServiceException - in case it can't

verifyAssistedServiceAgent

protected void verifyAssistedServiceAgent(UserModel asmAgent)
                                   throws AssistedServiceException

Verify that provided user participate in a parent AS agent group.

Parameters:

asmAgent -

Throws:

AssistedServiceException - in case he's not

isAssistedServiceAgent

protected boolean isAssistedServiceAgent(UserModel asmAgent)

Verify that provided user participate in a parent AS agent group.

Parameters:

asmAgent -

Returns:

true when he is

isAssistedServiceAgentLoggedIn

public boolean isAssistedServiceAgentLoggedIn()

Description copied from interface: AssistedServiceFacade

Checks if there is ASM information in the current session or no, this will be used by Session Restriction mainly

Specified by:

isAssistedServiceAgentLoggedIn in interface AssistedServiceFacade

Returns:

boolean value to indicates if there are a valid assisted service info in the session or no.

createCustomer

public CustomerData createCustomer(java.lang.String customerId,
                                   java.lang.String customerName)
                            throws AssistedServiceException

Description copied from interface: AssistedServiceFacade

Creates a new customer by it email and name.

Specified by:

createCustomer in interface AssistedServiceFacade

Parameters:

customerId - email of to be newly created customer that is used as uid

customerName - name of to be newly created customer (firstname and surname separated by space symbol)

Returns:

CustomerModel

Throws:

AssistedServiceException - In case of: 1) trying to create already existing customer with given customerId 2) disabled customer creation

getAsmSession

public AssistedServiceSession getAsmSession()

Description copied from interface: AssistedServiceFacade

Returns ASM session object with all information about current asm session.

Specified by:

getAsmSession in interface AssistedServiceFacade

Returns:

asm session object

cleanAsmSession

protected void cleanAsmSession()

quitAsmSession

protected void quitAsmSession()

isBruteForce

protected boolean isBruteForce(UserModel asmAgent)

resetBruteForceCounter

protected void resetBruteForceCounter(UserModel asmAgent)

getAssistedServiceAgentStore

protected java.lang.String getAssistedServiceAgentStore(UserModel agent)

getCartListForCustomer

public java.util.Collection<CartData> getCartListForCustomer(CustomerModel customer)

Description copied from interface: AssistedServiceFacade

Returns collection of a customer's carts

Specified by:

getCartListForCustomer in interface AssistedServiceFacade

Parameters:

customer - customer model whose carts to be returned

Returns:

collection of the customer's cart models

getAssistedServiceService

protected AssistedServiceService getAssistedServiceService()

setAssistedServiceService

public void setAssistedServiceService(AssistedServiceService assistedServiceService)

getCartService

protected CartService getCartService()

setCartService

public void setCartService(CartService cartService)

getSessionService

protected SessionService getSessionService()

setSessionService

public void setSessionService(SessionService sessionService)

getCommerceCommonI18NService

protected CommerceCommonI18NService getCommerceCommonI18NService()

setCommerceCommonI18NService

public void setCommerceCommonI18NService(CommerceCommonI18NService commerceCommonI18NService)

getUserService

protected UserService getUserService()

setUserService

public void setUserService(UserService userService)

getPasswordEncoderService

protected PasswordEncoderService getPasswordEncoderService()

setPasswordEncoderService

public void setPasswordEncoderService(PasswordEncoderService passwordEncoderService)

getModelService

protected ModelService getModelService()

Returns:

the modelService

setModelService

public void setModelService(ModelService modelService)

Parameters:

modelService - the modelService to set

getEventService

protected EventService getEventService()

setEventService

public void setEventService(EventService eventService)

getCartConverter

protected Converter<CartModel,CartData> getCartConverter()

setCartConverter

public void setCartConverter(Converter<CartModel,CartData> cartConverter)

getCustomerConverter

protected Converter<UserModel,CustomerData> getCustomerConverter()

setCustomerConverter

public void setCustomerConverter(Converter<UserModel,CustomerData> customerConverter)