jespa.http

Class HttpSecurityFilter

java.lang.Object

jespa.http.HttpSecurityService

jespa.http.HttpSecurityFilter

All Implemented Interfaces:

javax.servlet.Filter

public class HttpSecurityFilter
extends HttpSecurityService
implements javax.servlet.Filter

A Servlet Filter that implements a variety of security features for HTTP services using the HttpSecurityService.

To configure the HttpSecurityFilter, specify HttpSecurityService properties using init-params or indirectly using the properties.path property to load properties from a properties file.

The following web.xml fragment illustrates how to use the properties.path property to indirectly load all HttpSecurityService properties:

<filter>
    <filter-name>HttpSecurityFilter</filter-name>
    <filter-class>jespa.http.HttpSecurityFilter</filter-class>
    <init-param>
        <param-name>properties.path</param-name>
        <param-value><b>WEB-INF/ntlm.prp</b></param-value>
    </init-param>
</filter>
<filter-mapping>
    <filter-name>HttpSecurityFilter</filter-name>
    <url-pattern><b>/*</b></url-pattern>
</filter-mapping>

<session-config>
    <session-timeout><b>600</b></session-timeout> 
</session-config>

A web.xml fragment that initializes the HttpSecurityFilter with a properties File

The above web.xml references the WEB-INF/ntlm.prp file which might contain properties such as the following:

provider.classname = jespa.ntlm.NtlmSecurityProvider
jespa.bindstr = dc100.busicorp.local
jespa.dns.servers = 192.168.44.110,192.168.22.115
jespa.dns.site = Paris
jespa.service.acctname = jespa5$@busicorp.local
jespa.service.password = iuy.98sap.29

The properties file loaded by the above web.xml

Most of the above property values may be generated using the Jespa Setup Wizard as described in the Installation section of the Jespa Operator's Manual (although most property names must be prefixed with "jespa." as described in the HttpSecurityService documentation).

Because the HttpSecurityFilter is a wrapper around the HttpSecurityService, see the HttpSecurityService API documentation for instructions and descriptions of properties supported by the HttpSecurityService. Also see the API documentation of the SecurityProvider being used.

See also the src/jespa/examples/MyHttpSecurityFilter.java source code for an example of how to create a custom HTTP security Filter.

The complete HttpSecurityFilter is the following:

package jespa.http;

import java.util.Map;
import java.util.HashMap;
import java.util.Enumeration;

import javax.servlet.Filter;
import javax.servlet.FilterConfig;
import javax.servlet.ServletException;

import jespa.security.SecurityProviderException;

public class HttpSecurityFilter extends HttpSecurityService implements Filter
{

    public void init(FilterConfig config) throws ServletException
    {
        Map properties = new HashMap();
        Enumeration e = config.getInitParameterNames();
        while (e.hasMoreElements()) {
            String name = (String)e.nextElement();
            properties.put(name, config.getInitParameter(name));
        }
        try {
            super.init(config.getFilterName(), config.getServletContext(), properties);
        } catch (SecurityProviderException spe) {
            throw new ServletException(spe);
        }
    }
}

The complete source code of the HttpSecurityFilter

The above code listing shows that this class simply converts all init-params into a Map of properties which it then passes to the HttpSecurityService.init(Map) method. After the Filter is initialized, HttpSecurityService.doFilter will be invoked directly by the Servlet container for each request.

Constructor Summary

Constructors

Constructor and Description
HttpSecurityFilter()

Method Summary

Modifier and Type	Method and Description
void	init(javax.servlet.FilterConfig config)

Methods inherited from class jespa.http.HttpSecurityService

destroy, doFilter, getBindingsCertHashPolicy, getBindingsTargetSpnsPolicy, getConnectionId, getRequestCredential, getRequestPath, getServletContext, init, init, isAllowedAccess, isAnonymous, isLogout, isProtected, matchWildcard, onException, onPropertiesUpdate, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface javax.servlet.Filter

destroy, doFilter

Constructor Detail

HttpSecurityFilter

public HttpSecurityFilter()

Method Detail

init

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

Specified by:

init in interface javax.servlet.Filter

Throws:

javax.servlet.ServletException