com.entrust.toolkit.util

Class HttpDirectoryServlet

java.lang.Object

javax.servlet.GenericServlet

javax.servlet.http.HttpServlet

com.entrust.toolkit.util.HttpDirectoryServlet

All Implemented Interfaces:

java.io.Serializable, javax.servlet.Servlet, javax.servlet.ServletConfig

public class HttpDirectoryServlet
extends javax.servlet.http.HttpServlet

The HttpDirectoryServlet class is a servlet that acts as a proxy for client requests to an LDAP Directory over HTTP.

To use this class:

1. Create a class called DirectoryServlet (or any other name you choose) using the following code

        import com.entrust.toolkit.util.HttpDirectoryServlet;
        public class DirectoryServlet extends com.entrust.toolkit.util.HttpDirectoryServlet {
        }
     

2. Put DirectoryServlet into your Web server's servlet folder. The specific location depends on the Web server you are using.

The HttpDirectoryServlet class receives the IP address and port number of your Directory as parameters called directoryIP and directoryPort. Configure this servlet using these parameters. Specific configuration details depend on the Web server you are using. For example, the servletrunner program that is part of Sun's J2SDK, uses a servlet.properties file to pass configuration parameters to each servlet. A sample servlet.properties file for DirectoryServlet contains the following information:

     # Directory servlet
     servlet.mainDirectory.code=DirectoryServlet
     servlet.mainDirectory.initArgs=\
           directoryIP=47.97.235.29,\
           directoryPort=389,\
           debug=false
  

If you want to use this example, edit it to reflect the name and URL you choose for your servlet.

If you have several Directories, you can re-use the HttpDirectoryServlet class. Wrap it in a second DirectoryServlet class as above, but give it a different name. For example:

     # Directory servlet
     servlet.backupDirectory.code=DirectoryServletTwo
     servlet.backupDirectory.initArgs=\
           directoryIP=47.97.235.30,\
           directoryPort=389,\
           debug=false
 

Using the names in this example, the HttpDirectoryClient communicates with each HttpDirectoryServlet as follows:

     LdapDirectory mainDir = new HttpDirectoryClient("http://wothdmontg.entrust.com:80/servlet/mainDirectory",   0);
     LdapDirectory backup  = new HttpDirectoryClient("http://wothdmontg.entrust.com:80/servlet/backupDirectory", 0);
 

In this example, the Web server is using port 80 on wothdmontg.entrust.com. The servlets are located in the server's servlet folder.

See Also:

HttpDirectoryClient, Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected HttpDirectoryServletEngine	httpDirectoryServletEngine
protected boolean	m_debug

Constructor Summary

Constructors

Constructor and Description
HttpDirectoryServlet()

Method Summary

Methods

Modifier and Type	Method and Description
void	config(javax.servlet.ServletConfig config) Provides the ServletConfig data to the servlet superclass without the requirement of calling super.init in the subclass.
void	doGet(javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse res) Call the doGet() method in HttpDirectoryServletEngine class.
java.lang.String	getServletInfo() Returns a short description of this servlet
void	init(javax.servlet.ServletConfig config) Overrides the init method in the servlet superclass.

Methods inherited from class javax.servlet.http.HttpServlet

doDelete, doOptions, doPost, doPut, doTrace, getLastModified, service, service

Methods inherited from class javax.servlet.GenericServlet

destroy, getInitParameter, getInitParameterNames, getServletConfig, getServletContext, init, log, log

Methods inherited from class java.lang.Object

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

Field Detail

m_debug

protected boolean m_debug

httpDirectoryServletEngine

protected HttpDirectoryServletEngine httpDirectoryServletEngine

Constructor Detail

HttpDirectoryServlet

public HttpDirectoryServlet()

Method Detail

init

public void init(javax.servlet.ServletConfig config)
          throws javax.servlet.ServletException

Overrides the init method in the servlet superclass.

This method attempts to establish a connection to the Directory at the IP address and port number specified in the servlet's configuration parameters (servlet.properties file) and throws an exception if it cannot establish a connection.

Specified by:

init in interface javax.servlet.Servlet

Overrides:

init in class javax.servlet.GenericServlet

Parameters:

config - the servlet configuration parameters

Throws:

javax.servlet.ServletException

config

public void config(javax.servlet.ServletConfig config)
            throws javax.servlet.ServletException

Provides the ServletConfig data to the servlet superclass without the requirement of calling super.init in the subclass.

This is used in place of super.init when overriding the init function.

Parameters:

config - the servlet configuration parameters

Throws:

javax.servlet.ServletException

getServletInfo

public java.lang.String getServletInfo()

Returns a short description of this servlet

Specified by:

getServletInfo in interface javax.servlet.Servlet

Overrides:

getServletInfo in class javax.servlet.GenericServlet

doGet

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

Call the doGet() method in HttpDirectoryServletEngine class.

Overrides:

doGet in class javax.servlet.http.HttpServlet

Parameters:

req -

res -

Throws:

javax.servlet.ServletException

java.io.IOException

See Also:

HttpDirectoryServletEngine