com.entrust.toolkit.util

Class HttpDirectoryServletEngine

java.lang.Object

com.entrust.toolkit.util.HttpDirectoryServletEngine

public class HttpDirectoryServletEngine
extends java.lang.Object

The HttpDirectorySevletEngine consists of the core functionality of the HttpDirectoryServlet used for proxying client requests to the Directory. It has been created so the existing HttpDirectoryServlet can be better customized for application server environments.

To use this class:

1. Create your Servlet class and create an instance of HttpDirectoryServletEngine
2. The doGet() method of your servlet should call the corresponding doGet() method of your HttpDirectoryServletEngine instance.

Since:

7.2 SP2 Patch

Constructor Summary

Constructors

Constructor and Description
HttpDirectoryServletEngine(jakarta.servlet.Servlet servlet, LdapDirectory directory) Constructor for directory tunneling engine.
HttpDirectoryServletEngine(jakarta.servlet.Servlet servlet, java.lang.String directoryIP, java.lang.String directoryPort) Constructor for directory tunneling engine.
HttpDirectoryServletEngine(jakarta.servlet.Servlet servlet, User user) Constructor for directory 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.
static java.lang.String	getStackTraceAsString(java.lang.Exception e)

Methods inherited from class java.lang.Object

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

Constructor Detail

HttpDirectoryServletEngine

public HttpDirectoryServletEngine(jakarta.servlet.Servlet servlet,
                                  java.lang.String directoryIP,
                                  java.lang.String directoryPort)
                           throws jakarta.servlet.UnavailableException

Constructor for directory tunneling engine.

Parameters:

servlet - servlet using this engine instance

directoryIP - directory server name or IP address

directoryPort - directory server port

Throws:

jakarta.servlet.UnavailableException

HttpDirectoryServletEngine

public HttpDirectoryServletEngine(jakarta.servlet.Servlet servlet,
                                  User user)
                           throws jakarta.servlet.UnavailableException

Constructor for directory tunneling engine.

Parameters:

servlet - servlet using this engine instance

user - a logged in Java Toolkit User with a valid connection from one of the setConnection(} methods

Throws:

jakarta.servlet.UnavailableException

HttpDirectoryServletEngine

public HttpDirectoryServletEngine(jakarta.servlet.Servlet servlet,
                                  LdapDirectory directory)
                           throws jakarta.servlet.UnavailableException

Constructor for directory tunneling engine.

Parameters:

servlet - servlet using this engine instance

directory - the connection to the directory. The object provided must implement LdapDirectory and must have a copy constructor.

Throws:

jakarta.servlet.UnavailableException

Method Detail

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.

In this sample implementation of the servlet, HttpDirectoryServletEngine receives the Directory attribute and the Directory entry as a URL-encoded search expression in the URI of the HTML GET request (see HttpDirectoryClient). The doGet() method decodes the URL, retrieves the requested attribute from the Directory, and returns it in the response to the HTML GET. A separate directory connection is used for each servlet instance.

Parameters:

req -

res -

Throws:

jakarta.servlet.ServletException

java.io.IOException

java.io.FileNotFoundException

java.io.IOException

javax.naming.NamingException

getStackTraceAsString

public static java.lang.String getStackTraceAsString(java.lang.Exception e)