com.entrust.toolkit.util

Class HttpDirectoryClient

java.lang.Object

com.entrust.toolkit.util.HttpDirectoryClient

All Implemented Interfaces:

LdapDirectory

public class HttpDirectoryClient
extends java.lang.Object
implements LdapDirectory

The HttpDirectoryClient class works with the HttpDirectoryServlet class to send requests to an LDAP Directory through an HTTP tunnel.

This class implements the LdapDirectory interface, so you can use the HttpDirectoryClient class wherever you would normally use LdapDirectory to communicate with the Directory. The following code fragments show first how to use the LdapDirectory class to connect to the Directory, and then how to use an HTTP tunnel to the Directory.

Using LdapDirectory:

     LdapDirectory dir = new JNDIDirectory("47.97.235.29", 309);
 

Using HttpDirectoryClient:

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

In this example, the Web server is on the wothdmontg.entrust.com computer and the DirectoryServlet class resides in the server's servlet folder. The Web server is configured so that the URL refers to the DirectoryServlet servlet. The IP address and port number of the Directory are specified in the servlet's parameters. Refer to the Javadoc reference for HttpDirectoryServlet.

See Also:

HttpDirectoryServlet

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.Vector<java.lang.String>	m_httpHeaders
protected int	m_port
protected java.lang.String	m_proxyIP
protected int	m_proxyPort
protected java.net.URL	m_url

Constructor Summary

Constructors

Constructor and Description
HttpDirectoryClient(HttpDirectoryClient httpDirectoryClient) Copy constructor.
HttpDirectoryClient(java.lang.String urlString, int port) Create an HttpDirectoryClient.
HttpDirectoryClient(java.lang.String urlString, int port, boolean checkConnectivity) Create an HttpDirectoryClient.

Method Summary

Modifier and Type	Method and Description
void	addHttpHeader(java.lang.String name, java.lang.String value) Adds additional HTTP header information.
byte[][]	getAttr(java.lang.String dn, java.lang.String attributeToFind) Implements the getAttr method of the LdapDirectory interface.
X509CRL[]	getCRLs(java.lang.String distributionPoint, boolean wantARL) Implements the getCRLs() method of the LdapDirectory interface.
boolean	isAvailable() Determines whether the remote servlet is available.
void	setClientCredentials(java.security.cert.X509Certificate verificationCertificate, java.security.cert.X509Certificate caCertificate, java.security.PrivateKey signingKey) This method does nothing.
void	setWebProxy(java.lang.String ipAddress, int port) Sets the Web proxy.

Methods inherited from class java.lang.Object

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

Field Detail

m_url

protected java.net.URL m_url

m_port

protected int m_port

m_proxyIP

protected java.lang.String m_proxyIP

m_proxyPort

protected int m_proxyPort

m_httpHeaders

protected java.util.Vector<java.lang.String> m_httpHeaders

Constructor Detail

HttpDirectoryClient

public HttpDirectoryClient(java.lang.String urlString,
                           int port)
                    throws java.net.MalformedURLException,
                           java.net.UnknownHostException,
                           java.io.IOException

Create an HttpDirectoryClient.

Parameters:

urlString - the URL of the server hosting the servlet that will process the Directory search requests.

port - the port number to connect to on the server. This is ignored if urlString specifies the port.

Throws:

java.net.MalformedURLException - if urlString is not a valid URL.

java.net.UnknownHostException - if the host specified in urlString cannot be contacted.

java.io.IOException - if there is an IO problem after connecting to the host.

HttpDirectoryClient

public HttpDirectoryClient(java.lang.String urlString,
                           int port,
                           boolean checkConnectivity)
                    throws java.net.MalformedURLException,
                           java.net.UnknownHostException,
                           java.io.IOException

Create an HttpDirectoryClient.

Parameters:

urlString - the URL of the server hosting the servlet that will process the Directory search requests.

port - the port number to connect to on the server. This is ignored if urlString specifies the port.

checkConnectivity - whether or not the ability to connect to the server should be tested in the constructor.

Throws:

java.net.MalformedURLException - if urlString is not a valid URL.

java.net.UnknownHostException - if the host specified in urlString cannot be contacted.

java.io.IOException - if there is an IO problem after connecting to the host.

HttpDirectoryClient

public HttpDirectoryClient(HttpDirectoryClient httpDirectoryClient)

Copy constructor. Creates a new HttpDirectoryClient object using existing parameters.

Parameters:

httpDirectoryClient - a com.entrust.toolkit.util.HttpDirectoryClient object.

Method Detail

isAvailable

public boolean isAvailable()

Determines whether the remote servlet is available.

If this method returns true, it is not a guarantee that the servlet can communicate with the Directory.

Specified by:

isAvailable in interface LdapDirectory

Returns:

Returns true if the remote servlet is available.

getAttr

public byte[][] getAttr(java.lang.String dn,
                        java.lang.String attributeToFind)
                 throws javax.naming.NamingException

Implements the getAttr method of the LdapDirectory interface.

This method sends an HTML GET request to the proxy servlet, requesting a Directory search. The search specifies a particular attribute at a particular Directory entry, which is specified by a distinguished name (DN). The getAttr method reads the servlet's response and returns the attribute as an array of byte arrays.

Given a DN and a desired attribute (using X.509 names such as userCertificate, dn, cn, email, and so on), this method returns a byte array containing the attributes certificate, CRL, DN, and email address.

The following code fragment is an example of typical usage. In this case each element of the result is a byte array representation of one of the user's certificates.

     getAttr( "cn=Roger Ramjet, o=Lompoc, c=US", "userCertificate" );
 

Specified by:

getAttr in interface LdapDirectory

Parameters:

dn - the distinguished name

attributeToFind - the attribute to find

Returns:

The desired attribute as a byte array.

Throws:

javax.naming.NamingException - thrown if the search fails

getCRLs

public X509CRL[] getCRLs(java.lang.String distributionPoint,
                         boolean wantARL)
                  throws javax.naming.NamingException,
                         java.security.cert.CRLException

Implements the getCRLs() method of the LdapDirectory interface.

This method sends an HTML GET request to the proxy servlet, requesting a Directory search for CRLs or ARLs at a particular distribution point. It reads the servlet's response and returns an array of CRLs or ARLs.

Specified by:

getCRLs in interface LdapDirectory

Parameters:

distributionPoint - the DN as defined in a certificate

wantARL - a boolean flag indicating that an ARL is required

Returns:

An array of CRLs or ARLs.

Throws:

javax.naming.NamingException - thrown if the search fails

java.security.cert.CRLException - thrown for other errors

setClientCredentials

public void setClientCredentials(java.security.cert.X509Certificate verificationCertificate,
                                 java.security.cert.X509Certificate caCertificate,
                                 java.security.PrivateKey signingKey)

This method does nothing.

Specified by:

setClientCredentials in interface LdapDirectory

Parameters:

verificationCertificate - a verification certificate

caCertificate - the CA certificate that issued verificationCertificate

signingKey - the private signing key that signs messages verified by verificationCertificate

setWebProxy

public void setWebProxy(java.lang.String ipAddress,
                        int port)
                 throws java.net.UnknownHostException,
                        java.io.IOException

Sets the Web proxy.

Parameters:

ipAddress - the IP address of the Web proxy

port - the port number of the proxy

Throws:

java.net.UnknownHostException - if the specified IP address cannot be contacted.

java.io.IOException - if an IO error occurs after connecting to the proxy.

addHttpHeader

public void addHttpHeader(java.lang.String name,
                          java.lang.String value)

Adds additional HTTP header information.

This method does not check the validity of the HTTP request header. The host and accept fields are ignored — these headers are reserved for the tunneling request.

Parameters:

name - the header name

value - the header value