Package com.broadleafcommerce.auth.user.endpoint

Class ImpersonationRequestToken

java.lang.Object

com.broadleafcommerce.auth.user.endpoint.ImpersonationRequestToken

All Implemented Interfaces:

Serializable

public final class ImpersonationRequestToken
extends Object
implements Serializable

The values resolved from an ImpersonationRequest after redirect and token validation.

See Also:

• com.broadleafcommerce.auth.user.web.endpoint.ImpersonationEndpoint#consumeToken(HttpServletResponse, String)
• com.broadleafcommerce.auth.user.web.endpoint.ImpersonationEndpoint#impersonate(HttpServletResponse, ImpersonationRequest, Authentication)
• Serialized Form

Constructor Summary

Constructors

Constructor	Description
ImpersonationRequestToken(String client_id, String impersonated_sub, String impersonated_client_id, String redirect_uri, String csr_user_id, Boolean impersonating_self)	Creates a new ImpersonationRequestToken instance.

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)
String	getClient_id()	The client ID of the user requesting impersonation
String	getCsr_user_id()	The user ID of the CSR that is impersonating a user.
String	getImpersonated_client_id()	The client ID of the user to be impersonated.
String	getImpersonated_sub()	The subject to be impersonated.
Boolean	getImpersonating_self()	Indicates that CSR is not impersonating as a customer but is operating as themselves.
String	getRedirect_uri()	Upon consuming the token, the URL to redirect the user to.
int	hashCode()
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Details

ImpersonationRequestToken

public ImpersonationRequestToken(String client_id,
 String impersonated_sub,
 String impersonated_client_id,
 String redirect_uri,
 String csr_user_id,
 Boolean impersonating_self)

Creates a new ImpersonationRequestToken instance.

Parameters:

client_id - The client ID of the user requesting impersonation

impersonated_sub - The subject to be impersonated. Usually the same as User.getUsername().

impersonated_client_id - The client ID of the user to be impersonated.

redirect_uri - Upon consuming the token, the URL to redirect the user to.

csr_user_id - The user ID of the CSR that is impersonating a user.

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

See Also:

• AuthorizedClient.getClientId()
• AuthorizedClient.getClientId()

Method Details

getClient_id

public String getClient_id()

The client ID of the user requesting impersonation

See Also:

• AuthorizedClient.getClientId()

getImpersonated_sub

public String getImpersonated_sub()

The subject to be impersonated. Usually the same as User.getUsername().

getImpersonated_client_id

public String getImpersonated_client_id()

The client ID of the user to be impersonated.

See Also:

• AuthorizedClient.getClientId()

getRedirect_uri

public String getRedirect_uri()

Upon consuming the token, the URL to redirect the user to.

getCsr_user_id

public String getCsr_user_id()

The user ID of the CSR that is impersonating a user.

getImpersonating_self

public Boolean getImpersonating_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