Class ProxyHandler

  • Direct Known Subclasses:
    ProxyHandlerImpl

    public abstract class ProxyHandler
    extends Object
    Abstract class allowing a backend appserver instance to retrieve information about the original client request that was intercepted by an SSL terminating proxy server (e.g., load balancer).

    An implementation of this abstract class inspects a given request for the custom request headers through which the proxy server communicates the information about the original client request to the appserver instance, and makes this information available to the appserver.

    This allows the appserver to work with any number of 3rd party SSL offloader implementations configured on the front-end web server, for which a corresponding ProxyHandler implementation has been configured on the backend appserver.

    • Constructor Summary

      Constructors 
      Constructor Description
      ProxyHandler()  
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      String getRemoteAddress​(jakarta.servlet.http.HttpServletRequest request)
      Gets the Internet Protocol (IP) address of the original client request that was intercepted by the proxy server.
      X509Certificate[] getSSLClientCertificateChain​(jakarta.servlet.http.HttpServletRequest request)
      Gets the SSL client certificate chain with which the client had authenticated itself to the SSL offloader, and which the SSL offloader has added as a custom request header on the given request.
      int getSSLKeysize​(jakarta.servlet.http.HttpServletRequest request)
      Returns the SSL keysize with which the original client request that was intercepted by the SSL offloader has been protected, and which the SSL offloader has added as a custom request header on the given request.
    • Constructor Detail

      • ProxyHandler

        public ProxyHandler()
    • Method Detail

      • getSSLClientCertificateChain

        public X509Certificate[] getSSLClientCertificateChain​(jakarta.servlet.http.HttpServletRequest request)
                                                       throws CertificateException
        Gets the SSL client certificate chain with which the client had authenticated itself to the SSL offloader, and which the SSL offloader has added as a custom request header on the given request.
        Parameters:
        request - The request from which to retrieve the SSL client certificate chain
        Returns:
        Array of java.security.cert.X509Certificate instances representing the SSL client certificate chain, or null if this information is not available from the given request
        Throws:
        CertificateException - if the certificate chain retrieved from the request header cannot be parsed
      • getSSLKeysize

        public int getSSLKeysize​(jakarta.servlet.http.HttpServletRequest request)
        Returns the SSL keysize with which the original client request that was intercepted by the SSL offloader has been protected, and which the SSL offloader has added as a custom request header on the given request.
        Parameters:
        request - The request from which to retrieve the SSL key size
        Returns:
        SSL keysize, or -1 if this information is not available from the given request
      • getRemoteAddress

        public String getRemoteAddress​(jakarta.servlet.http.HttpServletRequest request)
        Gets the Internet Protocol (IP) address of the original client request that was intercepted by the proxy server.
        Parameters:
        request - The request from which to retrieve the IP address of the original client request
        Returns:
        IP address of the original client request, or null if this information is not available from the given request