fedora.server.security.servletfilters
Class BaseContributing

java.lang.Object
  fedora.server.security.servletfilters.Base
      fedora.server.security.servletfilters.FilterSetup
          fedora.server.security.servletfilters.BaseContributing

All Implemented Interfaces:

javax.servlet.Filter

Direct Known Subclasses:

BaseCaching

public abstract class BaseContributing
extends FilterSetup

Author:

Bill Niebel (niebel@virginia.edu)

Field Summary

protected boolean	AUTHENTICATE
static java.lang.String[]	EMPTY_ARRAY
static java.util.Hashtable	EMPTY_MAP
java.lang.String	EMPTY_RESULTS
static java.lang.String	EMPTY_RESULTS_KEY
protected java.util.Collection	FILTERS_CONTRIBUTING_AUTHENTICATED_ATTRIBUTES
protected java.util.Collection	FILTERS_CONTRIBUTING_SPONSORED_ATTRIBUTES
protected static org.apache.commons.logging.Log	log
protected boolean	LOG_STACK_TRACES
static java.lang.String	LOG_STACK_TRACES_KEY
static java.util.HashSet	NULL_SET
java.lang.String	PW_0
static java.lang.String	PW_0_KEY
java.lang.String	PW_NULL
static java.lang.String	PW_NULL_KEY
static java.lang.String	SKIP_FILTER
protected java.lang.String	SURROGATE_ATTRIBUTE
static java.lang.String	SURROGATE_ATTRIBUTE_KEY
protected java.lang.String	SURROGATE_ROLE
static java.lang.String	SURROGATE_ROLE_KEY
static java.lang.String	UNAUTHENTICATE_USER_CONDITIONALLY
static java.lang.String	UNAUTHENTICATE_USER_UNCONDITIONALLY
static java.lang.String	USE_FILTER

Fields inherited from class fedora.server.security.servletfilters.FilterSetup

FILTER_NAME, inited, NOT_SET

Fields inherited from class fedora.server.security.servletfilters.Base

initErrors, StringArrayPrototype

Constructor Summary

BaseContributing()

Method Summary

protected abstract boolean	authenticate(boolean alreadyAuthenticated)
protected abstract void	authenticate(ExtendedHttpServletRequest extendedHttpServletRequest)
protected abstract void	contributeAuthenticatedAttributes(ExtendedHttpServletRequest extendedHttpServletRequest)
protected abstract void	contributeSponsoredAttributes(ExtendedHttpServletRequest extendedHttpServletRequest)
void	destroy()
boolean	doThisSubclass(ExtendedHttpServletRequest extendedHttpServletRequest, javax.servlet.http.HttpServletResponse response)
void	init(javax.servlet.FilterConfig filterConfig)
protected void	initThisSubclass(java.lang.String key, java.lang.String value)

Methods inherited from class fedora.server.security.servletfilters.FilterSetup

doFilter, getFilterNameAbbrev, wrap

Methods inherited from class fedora.server.security.servletfilters.Base

booleanValue, enter, enterExit, exit, fail, format, format, format, getClassName, pass, passFail, showThrowable

Methods inherited from class java.lang.Object

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

Field Detail

log

protected static org.apache.commons.logging.Log log

NULL_SET

public static final java.util.HashSet NULL_SET

EMPTY_MAP

public static final java.util.Hashtable EMPTY_MAP

EMPTY_ARRAY

public static final java.lang.String[] EMPTY_ARRAY

AUTHENTICATE

protected boolean AUTHENTICATE

FILTERS_CONTRIBUTING_AUTHENTICATED_ATTRIBUTES

protected java.util.Collection FILTERS_CONTRIBUTING_AUTHENTICATED_ATTRIBUTES

FILTERS_CONTRIBUTING_SPONSORED_ATTRIBUTES

protected java.util.Collection FILTERS_CONTRIBUTING_SPONSORED_ATTRIBUTES

SURROGATE_ROLE_KEY

public static final java.lang.String SURROGATE_ROLE_KEY

See Also:

Constant Field Values

SURROGATE_ROLE

protected java.lang.String SURROGATE_ROLE

SURROGATE_ATTRIBUTE_KEY

public static final java.lang.String SURROGATE_ATTRIBUTE_KEY

See Also:

Constant Field Values

SURROGATE_ATTRIBUTE

protected java.lang.String SURROGATE_ATTRIBUTE

USE_FILTER

public static final java.lang.String USE_FILTER

See Also:

Constant Field Values

SKIP_FILTER

public static final java.lang.String SKIP_FILTER

See Also:

Constant Field Values

UNAUTHENTICATE_USER_UNCONDITIONALLY

public static final java.lang.String UNAUTHENTICATE_USER_UNCONDITIONALLY

See Also:

Constant Field Values

UNAUTHENTICATE_USER_CONDITIONALLY

public static final java.lang.String UNAUTHENTICATE_USER_CONDITIONALLY

See Also:

Constant Field Values

PW_NULL_KEY

public static final java.lang.String PW_NULL_KEY

See Also:

Constant Field Values

PW_NULL

public java.lang.String PW_NULL

PW_0_KEY

public static final java.lang.String PW_0_KEY

See Also:

Constant Field Values

PW_0

public java.lang.String PW_0

EMPTY_RESULTS_KEY

public static final java.lang.String EMPTY_RESULTS_KEY

See Also:

Constant Field Values

EMPTY_RESULTS

public java.lang.String EMPTY_RESULTS

LOG_STACK_TRACES_KEY

public static final java.lang.String LOG_STACK_TRACES_KEY

See Also:

Constant Field Values

LOG_STACK_TRACES

protected boolean LOG_STACK_TRACES

Constructor Detail

BaseContributing

public BaseContributing()

Method Detail

init

public void init(javax.servlet.FilterConfig filterConfig)

Specified by:

init in interface javax.servlet.Filter

Overrides:

init in class FilterSetup

destroy

public void destroy()

Specified by:

destroy in interface javax.servlet.Filter

Overrides:

destroy in class FilterSetup

initThisSubclass

protected void initThisSubclass(java.lang.String key,
                                java.lang.String value)

Overrides:

initThisSubclass in class FilterSetup

doThisSubclass

public boolean doThisSubclass(ExtendedHttpServletRequest extendedHttpServletRequest,
                              javax.servlet.http.HttpServletResponse response)
                       throws java.lang.Throwable

Overrides:

doThisSubclass in class FilterSetup

Throws:

java.lang.Throwable

authenticate

protected abstract void authenticate(ExtendedHttpServletRequest extendedHttpServletRequest)
                              throws java.lang.Exception

Throws:

java.lang.Exception

contributeAuthenticatedAttributes

protected abstract void contributeAuthenticatedAttributes(ExtendedHttpServletRequest extendedHttpServletRequest)
                                                   throws java.lang.Exception

Throws:

java.lang.Exception

contributeSponsoredAttributes

protected abstract void contributeSponsoredAttributes(ExtendedHttpServletRequest extendedHttpServletRequest)
                                               throws java.lang.Exception

Throws:

java.lang.Exception

authenticate

protected abstract boolean authenticate(boolean alreadyAuthenticated)