org.jasig.portal.events.handlers
Class AbstractLimitedSupportEventHandler

java.lang.Object
  org.jasig.portal.events.handlers.AbstractLimitedSupportEventHandler

All Implemented Interfaces:

EventHandler

Direct Known Subclasses:

JpaPortalEventStore, LoggingEventHandler, PortalEventMulticaster, QueueingEventHandler

public abstract class AbstractLimitedSupportEventHandler
extends Object
implements EventHandler

Abstract implemenation that allows for one EventHandler to handle many events configurably without being defined multiple times.
The supports(PortalEvent) method checks three criteria for a PortalEvent to determine if it is supported or not.

If the user is a guest or not
If the userName matches a specified set of names
If the PortalEvents's type matches a set of PortalEvent classes

Since:

2.6

Version:

$Revision: 19776 $ $Date: 2010-01-14 16:17:21 -0600 (Thu, 14 Jan 2010) $

Author:

Scott Battaglia

Field Summary

protected org.apache.commons.logging.Log

logger Protected logging instance.

Constructor Summary

AbstractLimitedSupportEventHandler()


Method Summary

Collection<String>	getIgnoredUserNames()
Collection<Class<? extends PortalEvent>>	getSupportedEvents()
Collection<String>	getSupportedUserNames()
boolean	isExplicitMatching()
boolean	isRequireAll()
boolean	isSupportGuest()
void	setExplicitMatching(boolean explicitMatching)
void	setIgnoredUserNames(Collection<String> ignoredUserNames) If no ignoredUserNames Collection is configured all user-names are supported otherwise exact String equality matching is done to determine ignored userNames.
void	setRequireAll(boolean requireAll) The requireAll can be used to require either any one criteria match for support or all three criteria.
void	setSupportedEvents(Collection<Class<? extends PortalEvent>> supportedEvents) If no supportedEvents Collection is configured all PortalEvent sub-classes are supported otherwise matching is done.
void	setSupportedUserNames(Collection<String> supportedUserNames) If no supportedUserNames Collection is configured all user-names are supported otherwise exact String equality matching is done to determine supported userNames.
void	setSupportGuest(boolean supportGuest) If the supportGuest property is true PortalEvents where IPerson.isGuest() is true or false will be supported.
boolean	supports(PortalEvent event) Method to check if this handler will be able to process the event.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.jasig.portal.events.EventHandler

handleEvent

Field Detail

logger

protected org.apache.commons.logging.Log logger

Protected logging instance.

Constructor Detail

AbstractLimitedSupportEventHandler

public AbstractLimitedSupportEventHandler()

Method Detail

supports

public final boolean supports(PortalEvent event)

Description copied from interface: EventHandler

Method to check if this handler will be able to process the event.

Specified by:

supports in interface EventHandler

Parameters:

event - the event we want to check if we support.

Returns:

true if the event is supported, false otherwise.

getSupportedEvents

public Collection<Class<? extends PortalEvent>> getSupportedEvents()

Returns:

the supportedEvents

setSupportedEvents

public void setSupportedEvents(Collection<Class<? extends PortalEvent>> supportedEvents)

If no supportedEvents Collection is configured all PortalEvent sub-classes are supported otherwise matching is done. If explicitMatching is true Class equality matching is used, if it is false Class.isAssignableFrom(Class) is called on each supported event type passing the tested event as the argument. The property defaults to null (all event types)

Parameters:

supportedEvents - the supportedEvents to set

isExplicitMatching

public boolean isExplicitMatching()

Returns:

the explicitMatching

setExplicitMatching

public void setExplicitMatching(boolean explicitMatching)

Parameters:

explicitMatching - the explicitMatching to set

getSupportedUserNames

public Collection<String> getSupportedUserNames()

Returns:

the supportedUserNames

setSupportedUserNames

public void setSupportedUserNames(Collection<String> supportedUserNames)

If no supportedUserNames Collection is configured all user-names are supported otherwise exact String equality matching is done to determine supported userNames. The property defaults to null (all user names)

Parameters:

supportedUserNames - the supportedUserNames to set

getIgnoredUserNames

public Collection<String> getIgnoredUserNames()

setIgnoredUserNames

public void setIgnoredUserNames(Collection<String> ignoredUserNames)

If no ignoredUserNames Collection is configured all user-names are supported otherwise exact String equality matching is done to determine ignored userNames. The property defaults to null (all user names)

Parameters:

ignoredUserNames - the ignoredUserNames to set

isSupportGuest

public boolean isSupportGuest()

Returns:

the supportGuest

setSupportGuest

public void setSupportGuest(boolean supportGuest)

If the supportGuest property is true PortalEvents where IPerson.isGuest() is true or false will be supported. If the supportGuest property is false only PortalEvents where IPerson.isGuest() is false will be supported. The property defaults to true.

Parameters:

supportGuest - the supportGuest to set

isRequireAll

public boolean isRequireAll()

Returns:

the requireAll

setRequireAll

public void setRequireAll(boolean requireAll)

The requireAll can be used to require either any one criteria match for support or all three criteria.

Parameters:

requireAll - the requireAll to set