com.perimeterx.models.PXContext Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of perimeterx-sdk Show documentation
PerimeterX Java SDK
There is a newer version: 6.13.0
package com.perimeterx.models;

import com.perimeterx.api.ip.IPProvider;
import com.perimeterx.api.ip.RemoteAddressIPProvider;
import com.perimeterx.internals.cookie.RiskCookie;
import com.perimeterx.models.risk.BlockReason;
import com.perimeterx.models.risk.S2SCallReason;
import com.perimeterx.utils.Constants;
import org.apache.commons.lang3.StringUtils;

import javax.servlet.http.HttpServletRequest;
import java.util.Enumeration;
import java.util.HashMap;
import java.util.Map;

/**
 * PXContext - Populate relevant data from HttpRequest
 * 
 * Created by shikloshi on 03/07/2016.
 */
public class PXContext {

    private String pxCookie;
    private String pxCaptcha;
    private String ip;
    private String vid;
    private String uuid;
    private Map headers;
    private String hostname;
    private String uri;
    private String userAgent;
    private String fullUrl;
    private S2SCallReason s2sCallReason;
    private BlockReason blockReason;
    private String httpMethod;
    private String httpVersion;
    private int score;
    private RiskCookie riskCookie;
    private final HttpServletRequest request;

    public PXContext(final HttpServletRequest request) {
        initContext(request);
        this.ip = new RemoteAddressIPProvider().getRequestIP(request);
        this.request = request;
    }

    public PXContext(final HttpServletRequest request, final IPProvider ipProvider) {
        initContext(request);
        this.ip = ipProvider.getRequestIP(request);
        this.request = request;
    }

    private void initContext(final HttpServletRequest request) {
        this.headers = new HashMap<>();
        final Enumeration headerNames = request.getHeaderNames();
        while (headerNames.hasMoreElements()) {
            final String name = (String) headerNames.nextElement();
            final String value = request.getHeader(name);
            this.headers.put(name, value);
        }

        final String cookie = request.getHeader("cookie");
        this.pxCookie = extractCookieByKey(cookie, Constants.COOKIE_KEY);
        final String pxCaptchaCookie = extractCookieByKey(cookie, Constants.COOKIE_CAPTCHA_KEY);
        if (pxCaptchaCookie != null) {
            final String[] s = pxCaptchaCookie.split(":", 2);
            if (s.length == 2) {
                this.pxCaptcha = s[0];
                this.vid = s[1];
            }
        }

        this.userAgent = request.getHeader("user-agent");
        this.uri = request.getRequestURI();
        this.fullUrl = request.getRequestURL().toString();
        this.hostname = request.getServerName();
        this.s2sCallReason = S2SCallReason.NONE;
        this.httpMethod = request.getMethod();
        String protocolDetails[] = request.getProtocol().split("/");
        if (protocolDetails.length > 1) {
            this.httpVersion = protocolDetails[1];
        } else {
            this.httpMethod = StringUtils.EMPTY;
        }
    }

    // Prefer to utilize this // throw exception for no cookie found
    private String extractCookieByKey(String cookie, String key) {
        String cookieValue = null;
        if (cookie != null) {
            String[] cookies = cookie.split(";\\s?");
            for (String c : cookies) {
                String[] splicedCookie = c.split("=", 2);
                if (key.equals(splicedCookie[0])) {
                    cookieValue = splicedCookie[1];
                    break;
                }
            }
        }
        return cookieValue;
    }

    public String getPxCookie() {
        return pxCookie;
    }

    public String getPxCaptcha() {
        return pxCaptcha;
    }

    public String getIp() {
        return ip;
    }

    public String getVid() {
        return vid;
    }

    public Map getHeaders() {
        return headers;
    }

    public String getHostname() {
        return hostname;
    }

    public String getUri() {
        return uri;
    }

    public String getUserAgent() {
        return userAgent;
    }

    public String getFullUrl() {
        return fullUrl;
    }

    public S2SCallReason getS2sCallReason() {
        return s2sCallReason;
    }

    public void setS2sCallReason(S2SCallReason callReason) {
        this.s2sCallReason = callReason;
    }

    public BlockReason getBlockReason() {
        return blockReason;
    }

    public void setBlockReason(BlockReason blockReason) {
        this.blockReason = blockReason;
    }

    public String getUuid() {
        return uuid;
    }

    public String getHttpMethod() {
        return httpMethod;
    }

    public String getHttpVersion() {
        return httpVersion;
    }

    public void setScore(int score) {
        this.score = score;
    }

    public void setVid(String vid) {
        this.vid = vid;
    }

    public void setUuid(String uuid) {
        this.uuid = uuid;
    }

    public int getScore() {
        return this.score;
    }

    public void setRiskCookie(RiskCookie riskCookie) {
        this.riskCookie = riskCookie;
    }

    public RiskCookie getRiskCookie() {
        return riskCookie;
    }

    public HttpServletRequest getRequest() {
        return request;
    }
}