This project has retired. For details please refer to its Attic page.

org.apache.cocoon.auth.portal
Class StandardPortalApplication

java.lang.Object
  org.apache.avalon.framework.logger.AbstractLogEnabled
      org.apache.cocoon.auth.StandardApplication
          org.apache.cocoon.auth.portal.StandardPortalApplication

All Implemented Interfaces:

Disposable, Configurable, LogEnabled, Serviceable, ThreadSafe, Application, PortalApplication

public class StandardPortalApplication
extends StandardApplication
implements PortalApplication

This is a default implementation for a portal application. Note: This class belongs to cauth but has to be defined in the portal block for now. This will be cleaned up with Cocoon 2.2.

Version:

$Id: StandardPortalApplication.html 1304258 2012-03-23 10:09:27Z ilgrosso $

Field Summary

protected Map

portalConfig The configuration.

Fields inherited from class org.apache.cocoon.auth.StandardApplication

attributes, handler, HANDLER_CONFIG_PREFIX, manager, store, STORE_CONFIG_PREFIX

Constructor Summary

StandardPortalApplication()

Method Summary

void	configure(Configuration conf)
Map	getPortalConfiguration() Return the configuration for the portal.
void	userDidLogin(User user, Map context) Notify the application about a successful login of a user.
void	userWillLogout(User user, Map context) Notify the application about a logout of a user.

Methods inherited from class org.apache.cocoon.auth.StandardApplication

configureAttributes, dispose, getApplicationStore, getAttribute, getSecurityHandler, removeAttribute, service, setAttribute, userIsAccessing

Methods inherited from class org.apache.avalon.framework.logger.AbstractLogEnabled

enableLogging, getLogger, setupLogger, setupLogger, setupLogger

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.cocoon.auth.Application

getApplicationStore, getAttribute, getSecurityHandler, removeAttribute, setAttribute, userIsAccessing

Field Detail

portalConfig

protected Map portalConfig

The configuration.

Constructor Detail

StandardPortalApplication

public StandardPortalApplication()

Method Detail

configure

public void configure(Configuration conf)
               throws ConfigurationException

Specified by:

configure in interface Configurable

Overrides:

configure in class StandardApplication

Throws:

ConfigurationException

See Also:

Configurable.configure(org.apache.avalon.framework.configuration.Configuration)

getPortalConfiguration

public Map getPortalConfiguration()

Description copied from interface: PortalApplication

Return the configuration for the portal.

Specified by:

getPortalConfiguration in interface PortalApplication

Returns:

A map containing the different configuration values as defined by the profile manager.

See Also:

PortalApplication.getPortalConfiguration()

userDidLogin

public void userDidLogin(User user,
                         Map context)

Description copied from interface: Application

Notify the application about a successful login of a user.

Specified by:

userDidLogin in interface Application

Overrides:

userDidLogin in class StandardApplication

Parameters:

user - The current user.

context - The context for the login operation.

See Also:

Application.userDidLogin(org.apache.cocoon.auth.User, java.util.Map)

userWillLogout

public void userWillLogout(User user,
                           Map context)

Description copied from interface: Application

Notify the application about a logout of a user.

Specified by:

userWillLogout in interface Application

Overrides:

userWillLogout in class StandardApplication

Parameters:

user - The current user.

context - The context for the logout operation.

See Also:

Application.userWillLogout(org.apache.cocoon.auth.User, java.util.Map)