Package com.broadleafcommerce.auth.user.endpoint

Class ImpersonationRequest

java.lang.Object

com.broadleafcommerce.auth.user.endpoint.ImpersonationRequest

All Implemented Interfaces:

Serializable

public final class ImpersonationRequest
extends Object
implements Serializable

The initial impersonation request. This is used by sales reps to shop as guests, impersonate customers, or access a storefront as themselves to perform important sales functions such as managing requested quotes.

Author:

Nick Crum (ncrum)

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
ImpersonationRequest(String client_id, String impersonated_sub, String impersonated_client_id, String redirect_uri, Boolean impersonate_self)

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)
String	getClient_id()	Id of the AuthorizedClient initiating this request.
Boolean	getImpersonate_self()	Indicates that CSR is not impersonating as a customer but is operating as themselves.
String	getImpersonated_client_id()	The id of the AuthorizedClient that the user-to-be-impersonated belongs to.
String	getImpersonated_sub()	The username of the user to impersonate if any.
String	getRedirect_uri()	Uri to redirect to upon successful request.
int	hashCode()
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Details

ImpersonationRequest

public ImpersonationRequest(String client_id,
 String impersonated_sub,
 String impersonated_client_id,
 String redirect_uri,
 Boolean impersonate_self)

Method Details

getClient_id

public String getClient_id()

Id of the AuthorizedClient initiating this request.

getImpersonated_sub

public String getImpersonated_sub()

The username of the user to impersonate if any.

getImpersonated_client_id

public String getImpersonated_client_id()

The id of the AuthorizedClient that the user-to-be-impersonated belongs to.

getRedirect_uri

public String getRedirect_uri()

Uri to redirect to upon successful request.

getImpersonate_self

public Boolean getImpersonate_self()

Indicates that CSR is not impersonating as a customer but is operating as themselves. This is typically used for things like quote management.

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object