com.perimeterx.models

Class PXContext

java.lang.Object

com.perimeterx.models.PXContext

public class PXContext
extends Object

PXContext - Populate relevant data from HttpRequest

Created by shikloshi on 03/07/2016.

Constructor Summary

Constructors

Constructor and Description
PXContext(javax.servlet.http.HttpServletRequest request, IPProvider ipProvider, HostnameProvider hostnameProvider, PXConfiguration pxConfiguration)

Method Summary

Modifier and Type	Method and Description
String	getAppId()
BlockAction	getBlockAction()
String	getBlockActionData()
BlockReason	getBlockReason()
String	getCollectorURL()
String	getCookieHmac()
String	getCookieOrigin()
String	getCookieVersion()
CustomParameters	getCustomParameters()
String	getDecodedOriginalToken()
String	getFullUrl()
Map<String,String>	getHeaders()
String	getHostname()
String	getHttpMethod()
String	getHttpVersion()
String	getIp()
String	getOriginalToken()
Map<String,String>	getOriginalTokenCookies()
String	getOriginalTokenError()
String	getOriginalUuid()
PassReason	getPassReason()
String	getPxCaptcha()
PXConfiguration	getPxConfiguration()
String	getPxCookie()
String	getPxCookieOrig()
Map<String,String>	getPxCookies()
String	getPxOriginalTokenCookie()
javax.servlet.http.HttpServletRequest	getRequest()
String	getRiskCookie()
long	getRiskRtt()
int	getRiskScore()
S2SCallReason	getS2sCallReason()
String	getUri()
String	getUserAgent()
String	getUuid()
String	getVid()
boolean	isFirstPartyRequest() Check if PerimeterX treated the request as first partyta,
boolean	isHandledResponse() Check if PerimeterX already handled the response thus the request should not be passed to the application In case true, you can check if isRequestLowScore() or isFirstPartyRequest() for more information if the response was handled by first party or score was lower than the configured threshold
boolean	isMadeS2SApiCall()
boolean	isMobileToken()
boolean	isRequestLowScore() Check if request is verified or not, this method should not be used as a condition if to pass the request to the application, instead use isHandledResponse() for the reason that its not handling a case where we already responded if this is a first party request The isRequestLowScore() only indicates if the request was verified and should called only if more details about the request is needed (like knowing the reason why shouldn't be passed)
boolean	isSensitiveRoute()
boolean	isVerified() Deprecated. - Use isHandledResponse()
void	setBlockAction(String blockAction)
void	setBlockActionData(String blockActionData)
void	setBlockReason(BlockReason blockReason)
void	setCookieHmac(String cookieHmac)
void	setCustomParameters(CustomParameters customParameters)
void	setDecodedOriginalToken(String decodedOriginalToken)
void	setDeserializeFromOriginalToken(boolean deserializeFromOriginalToken)
void	setFirstPartyRequest(boolean firstPartyRequest)
void	setMadeS2SApiCall(boolean flag)
void	setOriginalTokenError(String originalTokenError)
void	setOriginalUuid(String originalUuid)
void	setPassReason(PassReason passReason)
void	setPxCookieOrig(String pxCookieOrig)
void	setRiskCookie(AbstractPXCookie riskCookie)
void	setRiskRtt(long riskRtt)
void	setRiskScore(int riskScore)
void	setS2sCallReason(S2SCallReason callReason)
void	setUuid(String uuid)
void	setVerified(boolean verified)
void	setVid(String vid)
boolean	shouldDeserializeFromOriginalToken()

Methods inherited from class java.lang.Object

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

Constructor Detail

PXContext

public PXContext(javax.servlet.http.HttpServletRequest request,
                 IPProvider ipProvider,
                 HostnameProvider hostnameProvider,
                 PXConfiguration pxConfiguration)

Method Detail

getPxOriginalTokenCookie

public String getPxOriginalTokenCookie()

getPxCookie

public String getPxCookie()

getCookieVersion

public String getCookieVersion()

getPxCookies

public Map<String,String> getPxCookies()

getPxCaptcha

public String getPxCaptcha()

getIp

public String getIp()

getVid

public String getVid()

getHeaders

public Map<String,String> getHeaders()

getHostname

public String getHostname()

getUri

public String getUri()

getUserAgent

public String getUserAgent()

getFullUrl

public String getFullUrl()

getS2sCallReason

public S2SCallReason getS2sCallReason()

setS2sCallReason

public void setS2sCallReason(S2SCallReason callReason)

getBlockReason

public BlockReason getBlockReason()

setBlockReason

public void setBlockReason(BlockReason blockReason)

getUuid

public String getUuid()

getHttpMethod

public String getHttpMethod()

getHttpVersion

public String getHttpVersion()

setRiskScore

public void setRiskScore(int riskScore)

setVid

public void setVid(String vid)

setUuid

public void setUuid(String uuid)

getRiskScore

public int getRiskScore()

setRiskCookie

public void setRiskCookie(AbstractPXCookie riskCookie)

getRiskCookie

public String getRiskCookie()

getRequest

public javax.servlet.http.HttpServletRequest getRequest()

getAppId

public String getAppId()

getPxCookieOrig

public String getPxCookieOrig()

getPassReason

public PassReason getPassReason()

setPassReason

public void setPassReason(PassReason passReason)

setPxCookieOrig

public void setPxCookieOrig(String pxCookieOrig)

setBlockAction

public void setBlockAction(String blockAction)

getBlockAction

public BlockAction getBlockAction()

setCookieHmac

public void setCookieHmac(String cookieHmac)

getCookieHmac

public String getCookieHmac()

isSensitiveRoute

public boolean isSensitiveRoute()

getRiskRtt

public long getRiskRtt()

setRiskRtt

public void setRiskRtt(long riskRtt)

isVerified

@Deprecated
public boolean isVerified()

Deprecated. - Use isHandledResponse()

Check if request is verified or not

Returns:

true if request is valid, false otherwise

isRequestLowScore

public boolean isRequestLowScore()

Check if request is verified or not, this method should not be used as a condition if to pass the request to the application, instead use isHandledResponse() for the reason that its not handling a case where we already responded if this is a first party request The isRequestLowScore() only indicates if the request was verified and should called only if more details about the request is needed (like knowing the reason why shouldn't be passed)

Returns:

true if request is valid, false otherwise

isHandledResponse

public boolean isHandledResponse()

Check if PerimeterX already handled the response thus the request should not be passed to the application In case true, you can check if isRequestLowScore() or isFirstPartyRequest() for more information if the response was handled by first party or score was lower than the configured threshold

Returns:

true if response was handled

setVerified

public void setVerified(boolean verified)

setMadeS2SApiCall

public void setMadeS2SApiCall(boolean flag)

isMadeS2SApiCall

public boolean isMadeS2SApiCall()

getBlockActionData

public String getBlockActionData()

setBlockActionData

public void setBlockActionData(String blockActionData)

getCookieOrigin

public String getCookieOrigin()

isMobileToken

public boolean isMobileToken()

getCollectorURL

public String getCollectorURL()

getCustomParameters

public CustomParameters getCustomParameters()

setCustomParameters

public void setCustomParameters(CustomParameters customParameters)

isFirstPartyRequest

public boolean isFirstPartyRequest()

Check if PerimeterX treated the request as first partyta,

Returns:

true if response was hadled by PerimeterX module

setFirstPartyRequest

public void setFirstPartyRequest(boolean firstPartyRequest)

getPxConfiguration

public PXConfiguration getPxConfiguration()

setOriginalTokenError

public void setOriginalTokenError(String originalTokenError)

setDeserializeFromOriginalToken

public void setDeserializeFromOriginalToken(boolean deserializeFromOriginalToken)

shouldDeserializeFromOriginalToken

public boolean shouldDeserializeFromOriginalToken()

setDecodedOriginalToken

public void setDecodedOriginalToken(String decodedOriginalToken)

setOriginalUuid

public void setOriginalUuid(String originalUuid)

getOriginalTokenCookies

public Map<String,String> getOriginalTokenCookies()

getOriginalUuid

public String getOriginalUuid()

getOriginalTokenError

public String getOriginalTokenError()

getDecodedOriginalToken

public String getDecodedOriginalToken()

getOriginalToken

public String getOriginalToken()