| org.apache.cocoon.auth.ApplicationManager
All known Subclasses: org.apache.cocoon.auth.impl.StandardApplicationManager,
| ApplicationManager | | public interface ApplicationManager (Code) | | This is the central component of Cocoon Authentication. It controls all applications
defined in the current Cocoon instance and provides ways to authenticate
a user.
version:
$Id: ApplicationManager.java 433543 2006-08-22 06:22:54Z crossley $ |
| Method Summary | |
| boolean | isLoggedIn(String appName)
Test, if the current user is already logged into the application.
Parameters:
appName - The name of the application. | | User | login(String appName, Map loginContext)
Log the user in to the application. | | void | logout(String appName, Map logoutContext)
Logout the user from an application. |
| APPLICATION | | String APPLICATION(Code) | | The string used to store the application in the object model.
|
| APPLICATION_DATA | | String APPLICATION_DATA(Code) | | The string used to store the application data in the object model .
|
| LOGIN_CONTEXT_PARAMETERS_KEY | | String LOGIN_CONTEXT_PARAMETERS_KEY(Code) | | The key for parameters in the login context.
|
| LOGOUT_CONTEXT_MODE_KEY | | String LOGOUT_CONTEXT_MODE_KEY(Code) | | The key for the logout method in the logout context.
|
| LOGOUT_CONTEXT_PARAMETERS_KEY | | String LOGOUT_CONTEXT_PARAMETERS_KEY(Code) | | The key for parameters in the logout context.
|
| LOGOUT_MODE_KEEP_SESSION | | String LOGOUT_MODE_KEEP_SESSION(Code) | | logout mode: don't terminate the session.
|
| LOGOUT_MODE_TERMINATE_SESSION_IF_UNUSED | | String LOGOUT_MODE_TERMINATE_SESSION_IF_UNUSED(Code) | | logout mode: terminate session if the user is not logged into
any application anymore (default).
|
| USER | | String USER(Code) | | The string used to store the user in the object model and the prefix
for the session.
|
| isLoggedIn | | boolean isLoggedIn(String appName)(Code) | | Test, if the current user is already logged into the application.
Parameters:
appName - The name of the application. Returns true if the user is already logged in, false otherwise. |
| login | | User login(String appName, Map loginContext) throws Exception(Code) | | Log the user in to the application. If the user is already logged in
then the corresponding user object is returned.
If the login process is started, the login context is passed to
SecurityHandler.login(Map) and on successful login to
Application.userDidLogin(UserMap) .
Parameters:
appName - The name of the application.
Parameters:
loginContext - The context for the login operation. The user object on a successful login, null otherwise.
throws:
Exception - If anything goes wrong. |
|
|