com.elasticpath.xpf.connectivity.context

Class XPFHttpTagSetContext

java.lang.Object

com.elasticpath.xpf.connectivity.entity.XPFEntity

com.elasticpath.xpf.connectivity.context.XPFHttpTagSetContext

public class XPFHttpTagSetContext
extends XPFEntity

HTTP tag set Extension Point context.

Constructor Summary

Constructors

Constructor and Description
XPFHttpTagSetContext(@NonNull javax.servlet.http.HttpServletRequest httpRequest, XPFStore store, @NonNull Map<String,String> userTraitValues)

Method Summary

Modifier and Type	Method and Description
protected boolean	canEqual(Object other)
boolean	equals(Object o)
@NonNull javax.servlet.http.HttpServletRequest	getHttpRequest() The HTTP request.
Map<String,String>	getKeyValuePairsHeader(String... headers) Get the key/value pairs for a particular HttpServletRequest header.
Collection<String>	getMultipleValuesHeader(String... headers) Get multiple values header from HttpServletRequest.
XPFStore	getStore() The store.
String	getUserIdFromRequest() Get User Id from HttpServletRequest.
Collection<String>	getUserRolesFromRequest() Get the User Roles from the HttpServletRequest.
Collection<String>	getUserScopesFromRequest() Get User Scopes from the HttpServletRequest.
Collection<String>	getUserTraitsFromRequest() Get the User Traits from the HttpServletRequest.
@NonNull Map<String,String>	getUserTraitValues() The user trait values.
int	hashCode()
String	toString()

Methods inherited from class com.elasticpath.xpf.connectivity.entity.XPFEntity

getCustomData

Methods inherited from class java.lang.Object

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

Constructor Detail

XPFHttpTagSetContext

public XPFHttpTagSetContext(@NonNull
                            @NonNull javax.servlet.http.HttpServletRequest httpRequest,
                            XPFStore store,
                            @NonNull
                            @NonNull Map<String,String> userTraitValues)

Method Detail

getUserIdFromRequest

public String getUserIdFromRequest()

Get User Id from HttpServletRequest.

Returns:

the user id

getUserScopesFromRequest

public Collection<String> getUserScopesFromRequest()

Get User Scopes from the HttpServletRequest.

Returns:

the user scopes

getUserRolesFromRequest

public Collection<String> getUserRolesFromRequest()

Get the User Roles from the HttpServletRequest.

Returns:

the user roles

getUserTraitsFromRequest

public Collection<String> getUserTraitsFromRequest()

Get the User Traits from the HttpServletRequest.

Returns:

the user traits

getMultipleValuesHeader

public Collection<String> getMultipleValuesHeader(String... headers)

Get multiple values header from HttpServletRequest. Values can be comma-separated or specified as separate headers with the same key.

Parameters:

headers - the headers

Returns:

the header values

getKeyValuePairsHeader

public Map<String,String> getKeyValuePairsHeader(String... headers)

Get the key/value pairs for a particular HttpServletRequest header. Values should be of the form "key1=value1,key2=value2".

Parameters:

headers - the headers

Returns:

the key value pairs

getHttpRequest

@NonNull
public @NonNull javax.servlet.http.HttpServletRequest getHttpRequest()

The HTTP request.

getStore

public XPFStore getStore()

The store.

getUserTraitValues

@NonNull
public @NonNull Map<String,String> getUserTraitValues()

The user trait values.

equals

public boolean equals(Object o)

Overrides:

equals in class XPFEntity

canEqual

protected boolean canEqual(Object other)

Overrides:

canEqual in class XPFEntity

hashCode

public int hashCode()

Overrides:

hashCode in class XPFEntity

toString

public String toString()

Overrides:

toString in class XPFEntity