org.jasig.portal.portlet.container.services
Class AdministrativeRequestListenerController

java.lang.Object
  org.jasig.portal.portlet.container.services.AdministrativeRequestListenerController

All Implemented Interfaces:

org.apache.pluto.spi.optional.AdministrativeRequestListener

public class AdministrativeRequestListenerController
extends Object
implements org.apache.pluto.spi.optional.AdministrativeRequestListener

AdministrativeRequestListener that delegates to another AdministrativeRequestListener based on a request attribute.
Configuration:

Property	Description	Required	Default
listenerKeyAttribute	The PortletRequest attribute to get the key for the AdministrativeRequestListener from.	No	org.jasig.portal.portlet.common.AdministrativeRequestListenerControler.LISTENER_KEY
listeners	The Map of String keys to AdministrativeRequestListeners.	No	HashMap()
failOnKeyNotFound	If an exception should be thrown if a listenerKeyAttribute request attribute is not found. If false a warning will be logged and the method will return.	No	false
failOnListenerNotFound	If an exception should be thrown if a AdministrativeRequestListener isn't found for the request attribute key. If false a warning will be logged and the method will return.	No	false

Version:

$Revision$

Author:

Eric Dalquist

Field Summary

static String	DEFAULT_LISTENER_KEY_ATTRIBUTE
protected org.apache.commons.logging.Log	logger

Constructor Summary

AdministrativeRequestListenerController()

Method Summary

void	administer(PortletRequest request, PortletResponse response)
String	getListenerKeyAttribute()
Map<String,org.apache.pluto.spi.optional.AdministrativeRequestListener>	getListeners()
boolean	isFailOnKeyNotFound()
boolean	isFailOnListenerNotFound()
void	setFailOnKeyNotFound(boolean failOnKeyNotFound)
void	setFailOnListenerNotFound(boolean failOnListenerNotFound)
void	setListenerKeyAttribute(String listenerKeyAttribute)
void	setListeners(Map<String,org.apache.pluto.spi.optional.AdministrativeRequestListener> listeners)

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_LISTENER_KEY_ATTRIBUTE

public static final String DEFAULT_LISTENER_KEY_ATTRIBUTE

logger

protected final org.apache.commons.logging.Log logger

Constructor Detail

AdministrativeRequestListenerController

public AdministrativeRequestListenerController()

Method Detail

isFailOnKeyNotFound

public boolean isFailOnKeyNotFound()

Returns:

the failOnKeyNotFound

setFailOnKeyNotFound

public void setFailOnKeyNotFound(boolean failOnKeyNotFound)

Parameters:

failOnKeyNotFound - the failOnKeyNotFound to set

isFailOnListenerNotFound

public boolean isFailOnListenerNotFound()

Returns:

the failOnListenerNotFound

setFailOnListenerNotFound

public void setFailOnListenerNotFound(boolean failOnListenerNotFound)

Parameters:

failOnListenerNotFound - the failOnListenerNotFound to set

getListenerKeyAttribute

public String getListenerKeyAttribute()

Returns:

the listenerKeyAttribute

setListenerKeyAttribute

public void setListenerKeyAttribute(String listenerKeyAttribute)

Parameters:

listenerKeyAttribute - the listenerKeyAttribute to set

getListeners

public Map<String,org.apache.pluto.spi.optional.AdministrativeRequestListener> getListeners()

Returns:

the listeners

setListeners

public void setListeners(Map<String,org.apache.pluto.spi.optional.AdministrativeRequestListener> listeners)

Parameters:

listeners - the listeners to set

administer

public void administer(PortletRequest request,
                       PortletResponse response)

Specified by:

administer in interface org.apache.pluto.spi.optional.AdministrativeRequestListener

See Also:

AdministrativeRequestListener.administer(javax.portlet.PortletRequest, javax.portlet.PortletResponse)