com.entrust.toolkit.util

Class HttpManagerServletEngine

java.lang.Object

com.entrust.toolkit.util.HttpManagerServletEngine

public class HttpManagerServletEngine
extends java.lang.Object

The HttpManagerServletEngine class contains the core features for proxying client requests to an Entrust PKI, allowing users to be initialized through an http tunnel.

To use this class:

1. Create your Servlet class and create an instance of HttpManagerServletEngine
2. The doGet() and doPost() methods of your HttpManagerServlet should call the corresponding doGet() and doPost() methods of your HttpManagerServletEngine instance.

Since:

7.2 SP2 Patch

Field Summary

Fields

Modifier and Type	Field and Description
static long	DEFAULT_MAXIMUM_LIFETIME

Constructor Summary

Constructors

Constructor and Description
HttpManagerServletEngine(jakarta.servlet.Servlet servlet, java.lang.String managerIP, int managerPort, long maximumLifetime) Constructor for manager tunneling engine.
HttpManagerServletEngine(jakarta.servlet.Servlet servlet, User user, long maximumLifetime) Constructor for manager tunneling engine.

Method Summary

Modifier and Type	Method and Description
void	doGet(jakarta.servlet.http.HttpServletRequest req, jakarta.servlet.http.HttpServletResponse res) Handles the doGet() method in the servlet.
void	doPost(jakarta.servlet.http.HttpServletRequest req, jakarta.servlet.http.HttpServletResponse res) Handles the doPost() method in the servlet.
java.lang.String	getManagerIP()
long	getMaximumLifetime()
int	getPort()
boolean	isDebug()
void	setDebug(boolean m_debug)
void	setManagerIP(java.lang.String m_managerip)
void	setMaximumLifetime(long lifetime)
void	setPort(int m_port)

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_MAXIMUM_LIFETIME

public static final long DEFAULT_MAXIMUM_LIFETIME

See Also:

Constant Field Values

Constructor Detail

HttpManagerServletEngine

public HttpManagerServletEngine(jakarta.servlet.Servlet servlet,
                                java.lang.String managerIP,
                                int managerPort,
                                long maximumLifetime)
                         throws jakarta.servlet.UnavailableException

Constructor for manager tunneling engine.

Parameters:

servlet - servlet using this engine

managerIP - manager IP or server name

managerPort - manager port

maximumLifetime - (milliseconds)

Throws:

jakarta.servlet.UnavailableException

HttpManagerServletEngine

public HttpManagerServletEngine(jakarta.servlet.Servlet servlet,
                                User user,
                                long maximumLifetime)
                         throws jakarta.servlet.UnavailableException

Constructor for manager tunneling engine.

Parameters:

servlet - servlet using this engine instance

user - a logged in Java Toolkit User

maximumLifetime - (milliseconds)

Throws:

jakarta.servlet.UnavailableException

Method Detail

isDebug

public boolean isDebug()

setDebug

public void setDebug(boolean m_debug)

getMaximumLifetime

public long getMaximumLifetime()

setMaximumLifetime

public void setMaximumLifetime(long lifetime)

getPort

public int getPort()

setPort

public void setPort(int m_port)

getManagerIP

public java.lang.String getManagerIP()

setManagerIP

public void setManagerIP(java.lang.String m_managerip)

doPost

public void doPost(jakarta.servlet.http.HttpServletRequest req,
                   jakarta.servlet.http.HttpServletResponse res)
            throws jakarta.servlet.ServletException,
                   java.io.IOException

Handles the doPost() method in the servlet.

The doPost() method receives a message from the client, passes it to the Registration Authority server, and receives a response. The response is saved until the client requests it by sending a GET request.

Parameters:

req -

res -

Throws:

jakarta.servlet.ServletException

java.io.IOException

See Also:

doGet(HttpServletRequest req, HttpServletResponse res)

doGet

public void doGet(jakarta.servlet.http.HttpServletRequest req,
                  jakarta.servlet.http.HttpServletResponse res)
           throws jakarta.servlet.ServletException,
                  java.io.IOException

Handles the doGet() method in the servlet.

The doGet() method responds to HTML GET requests from clients. A client sends a GET to the servlet in two situations:

• A client uses GET to request that a response from the the Registration Authority be returned to it. The doGet() method identifies the client by its cookie (session id) and returns the appropriate response.
• A client sends a GET to notify that the session is complete and the servlet should close the connection to the PKI that was opened earlier on behalf of that client.

Parameters:

req -

res -

Throws:

jakarta.servlet.ServletException

java.io.IOException