com.perimeterx.api

Class PerimeterX

java.lang.Object

com.perimeterx.api.PerimeterX

public class PerimeterX
extends Object

Facade object for - configuring, validating and blocking requests

Created by shikloshi on 03/07/2016.

Constructor Summary

Constructors

Constructor and Description
PerimeterX(PXConfiguration configuration)
PerimeterX(PXConfiguration configuration, HostnameProvider hostnameProvider)
PerimeterX(PXConfiguration configuration, IPProvider ipProvider)
PerimeterX(PXConfiguration configuration, IPProvider ipProvider, HostnameProvider hostnameProvider)

Method Summary

Modifier and Type	Method and Description
PXContext	pxVerify(javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponseWrapper responseWrapper) Verify http request using cookie or PX server call
void	setActivityHandler(ActivityHandler activityHandler) Set activity handler
void	setCustomParametersProvider(CustomParametersProvider customParametersProvider)
void	setHostnameProvider(HostnameProvider hostnameProvider) Set Hostname Provider
void	setIpProvider(IPProvider ipProvider) Set IP Provider
void	setVerificationHandler(VerificationHandler verificationHandler) Set Set Verification Handler

Methods inherited from class java.lang.Object

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

Constructor Detail

PerimeterX

public PerimeterX(PXConfiguration configuration)
           throws PXException

Throws:

PXException

PerimeterX

public PerimeterX(PXConfiguration configuration,
                  IPProvider ipProvider,
                  HostnameProvider hostnameProvider)
           throws PXException

Throws:

PXException

PerimeterX

public PerimeterX(PXConfiguration configuration,
                  IPProvider ipProvider)
           throws PXException

Throws:

PXException

PerimeterX

public PerimeterX(PXConfiguration configuration,
                  HostnameProvider hostnameProvider)
           throws PXException

Throws:

PXException

Method Detail

pxVerify

public PXContext pxVerify(javax.servlet.http.HttpServletRequest req,
                          javax.servlet.http.HttpServletResponseWrapper responseWrapper)
                   throws PXException

Verify http request using cookie or PX server call

Parameters:

req - - current http call examined by PX

responseWrapper - - response wrapper on which we will set the response according to PX verification.

Returns:

PXContext, or null if module is disabled

Throws:

PXException - - PXException

setActivityHandler

public void setActivityHandler(ActivityHandler activityHandler)

Set activity handler

Parameters:

activityHandler - - new activity handler to use

setIpProvider

public void setIpProvider(IPProvider ipProvider)

Set IP Provider

Parameters:

ipProvider - - IP provider that is used to extract ip from request

setHostnameProvider

public void setHostnameProvider(HostnameProvider hostnameProvider)

Set Hostname Provider

Parameters:

hostnameProvider - - Used to extract hostname from request

setVerificationHandler

public void setVerificationHandler(VerificationHandler verificationHandler)

Set Set Verification Handler

Parameters:

verificationHandler - - sets the verification handler for user customization

setCustomParametersProvider

public void setCustomParametersProvider(CustomParametersProvider customParametersProvider)