SecurityContext.java

package org.bubblecloud.ilves.security;

import org.apache.commons.lang.StringUtils;
import org.bubblecloud.ilves.model.User;
import org.bubblecloud.ilves.util.PropertiesUtil;

import javax.persistence.EntityManager;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpSession;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.List;
import java.util.Map;

/**
 * Processing context to be passed to processing layer. Processing context
 * is used for access control and audit logging.
 */
public class SecurityContext {

    /** The object map. */
    private final Map<Object, Object> objectMap = new HashMap<Object, Object>();
    /** The entity manager. */
    private final EntityManager entityManager;
    /** The audit entity manager. */
    private final EntityManager auditEntityManager;
    /** The server name from HTTP request. */
    protected final String serverName;
    /** The local component IP address. */
    protected final String localIpAddress;
    /** The local component port. */
    protected final Integer componentPort;
    /** The local component type. */
    protected String componentType;
    /** The remote host. */
    protected String remoteHost;
    /** The remote peer IP address. */
    protected String remoteIpAddress;
    /** The remote peer port. */
    protected Integer remotePort;
    /** The user ID. */
    protected String userId;
    /** The user name. */
    protected String userName;
    /** The user roles. */
    protected final List<String> roles;
    /** The web session ID if exists. */
    protected final HttpSession session;

    /**
     * Constructor for defining parameters for processing context.
     *
     * @param entityManager the entity manager
     * @param auditEntityManager the audit entity manager
     * @param serverName the server name
     * @param localIpAddress the local IP address
     * @param componentPort the local component port
     * @param componentType the local component type
     * @param remoteHost the remote host
     * @param remoteIpAddress the remote peer IP address
     * @param remotePort the remote peer port
     * @param userId the user ID
     * @param userName the user name
     * @param roles the user roles
     */
    public SecurityContext(final EntityManager entityManager,
                           final EntityManager auditEntityManager,
                           final String serverName,
                           final String localIpAddress,
                           final Integer componentPort,
                           final String componentType,
                           final String remoteHost,
                           final String remoteIpAddress,
                           final Integer remotePort,
                           final String userId,
                           final String userName,
                           final List<String> roles) {
        this.entityManager = entityManager;
        this.auditEntityManager = auditEntityManager;
        this.serverName = serverName;
        this.localIpAddress = localIpAddress;
        this.componentPort = componentPort;
        this.componentType = componentType;
        this.remoteHost = remoteHost;
        this.remoteIpAddress = remoteIpAddress;
        this.remotePort = remotePort;
        this.userId = userId;
        this.userName = userName;
        this.roles = roles;
        this.session = null;
    }

    /**
     * Authenticated HTTP servlet request.
     *
     * @param entityManager the entity manager
     * @param auditEntityManager the audit entity manager
     * @param request the request
     * @param user the user
     * @param roles the user roles
     */
    public SecurityContext(final EntityManager entityManager,
                           final EntityManager auditEntityManager,
                           final HttpServletRequest request,
                           final User user,
                           final List<String> roles) {
        this.entityManager = entityManager;
        this.auditEntityManager = auditEntityManager;
        this.componentPort = Integer.parseInt(PropertiesUtil.getProperty("site", "http-port"));
        this.componentType = PropertiesUtil.getProperty("site", "site-type");
        this.serverName = request.getServerName();
        this.localIpAddress = request.getLocalAddr();
        setRemoteDetails(request);
        this.userId = user != null ? user.getUserId() : null;
        this.userName = user != null ? user.getEmailAddress() : null;
        this.roles = roles;
        this.session = request.getSession();
    }

    /**
     * Anonymous or system to system HTTP request.
     *
     * @param entityManager the entity manager
     * @param auditEntityManager the audit entity manager
     * @param request the HTTP servlet request
     */
    public SecurityContext(final EntityManager entityManager,
                           final EntityManager auditEntityManager,
                           final HttpServletRequest request) {
        this.entityManager = entityManager;
        this.auditEntityManager = auditEntityManager;
        if (Integer.parseInt(PropertiesUtil.getProperty("site", "https-port")) == 0) {
            this.componentPort = Integer.parseInt(PropertiesUtil.getProperty("site", "http-port"));
        } else {
            this.componentPort = Integer.parseInt(PropertiesUtil.getProperty("site", "https-port"));
        }
        this.componentType = PropertiesUtil.getProperty("site", "site-type");
        this.serverName = request.getServerName();
        this.localIpAddress = request.getLocalAddr();
        setRemoteDetails(request);
        this.userId = null;
        this.userName = null;
        this.roles = new ArrayList<String>();
        this.session = request.getSession();
    }


    public void setRemoteDetails(final HttpServletRequest request) {
        remoteHost = request.getRemoteHost();

        if (!StringUtils.isEmpty(request.getHeader("X-Forwarded-For"))) {
            remoteIpAddress = request.getHeader("X-Forwarded-For");
        } else {
            remoteIpAddress = request.getRemoteAddr();
        }

        if (!StringUtils.isEmpty(request.getHeader("X-Forwarded-Port"))
                && ! request.getHeader("X-Forwarded-Port").startsWith("(")) {
            remotePort = Integer.parseInt(request.getHeader("X-Forwarded-Port"));
        } else {
            remotePort = request.getRemotePort();
        }
    }


    /**
     * Gets extension object.
     *
     * @param <T> The type of the object.
     * @param objectKey the object key
     * @return the service class singleton instance.
     */
    @SuppressWarnings({ "unchecked" })
    public <T> T getObject(final Object objectKey) {
        return (T) objectMap.get(objectKey);
    }

    /**
     * Puts extension object.
     *
     * @param <T> The type of the object.
     * @param objectKey the object key
     * @param object the object
     */
    public <T> void putObject(final Object objectKey, final T object) {
        objectMap.put(objectKey, object);
    }

    public EntityManager getEntityManager() {
        return entityManager;
    }

    public EntityManager getAuditEntityManager() {
        return auditEntityManager;
    }

    public String getLocalIpAddress() {
        return localIpAddress;
    }

    public Integer getComponentPort() {
        return componentPort;
    }

    public String getComponentType() {
        return componentType;
    }

    public String getRemoteIpAddress() {
        return remoteIpAddress;
    }

    public Integer getRemotePort() {
        return remotePort;
    }

    public String getUserId() {
        return userId;
    }

    public String getUserName() {
        return userName;
    }

    public String getServerName() {
        return serverName;
    }

    public String getRemoteHost() {
        return remoteHost;
    }

    public List<String> getRoles() {
        return roles;
    }

    public HttpSession getSession() {
        return session;
    }
}