org.apache.jetspeed.services.security.turbine
Class TurbineAuthentication

java.lang.Object
  org.apache.turbine.services.BaseInitable
      org.apache.turbine.services.BaseService
          org.apache.turbine.services.TurbineBaseService
              org.apache.jetspeed.services.security.turbine.TurbineAuthentication

All Implemented Interfaces:

org.apache.turbine.services.Initable, PortalAuthentication, org.apache.turbine.services.Service

public class TurbineAuthentication

extends org.apache.turbine.services.TurbineBaseService

implements PortalAuthentication

The TurbineAuthentication class is a default Jetspeed security provider, implementing the PortalAuthentication interface. It provides authentication services using a User database table mimicking the legacy Turbine-2 user table. This service does not use any of the Turbine security or user management classes.

Version:

$Id: TurbineAuthentication.java,v 1.10 2004/05/18 19:58:25 jford Exp $

Author:

David Sean Taylor, Mark Orciuch

Field Summary

Fields inherited from class org.apache.turbine.services.BaseService

configuration, name, properties, serviceBroker

Fields inherited from class org.apache.turbine.services.BaseInitable

initableBroker, isInitialized

Fields inherited from interface org.apache.jetspeed.services.security.PortalAuthentication

SERVICE_NAME

Constructor Summary

TurbineAuthentication()

Method Summary

JetspeedUser	getAnonymousUser() Automatically authenticates and retrieves the portal anonymous user.
protected JetspeedRunData	getRunData()
protected JetspeedUser	getUserFromContext()
void	init(javax.servlet.ServletConfig conf) This is the early initialization method called by the Turbine Service framework
JetspeedUser	login(java.lang.String username, java.lang.String password) Given a public credential(username) and private credential(password), perform authentication.
void	logout() Logout the JetspeedUser.
protected JetspeedRunData	putUserIntoContext(JetspeedUser user)

Methods inherited from class org.apache.turbine.services.TurbineBaseService

init, init, init, shutdown

Methods inherited from class org.apache.turbine.services.BaseService

getConfiguration, getName, getProperties, getServiceBroker, setName, setServiceBroker

Methods inherited from class org.apache.turbine.services.BaseInitable

getInit, getInitableBroker, setInit, setInitableBroker

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.turbine.services.Service

getConfiguration, getName, getProperties, setName, setServiceBroker

Methods inherited from interface org.apache.turbine.services.Initable

getInit, init, init, setInitableBroker, shutdown

Constructor Detail

TurbineAuthentication

public TurbineAuthentication()

Method Detail

login

public JetspeedUser login(java.lang.String username,
                          java.lang.String password)
                   throws LoginException

Given a public credential(username) and private credential(password), perform authentication. If authentication succeeds, a JetspeedUser is returned representing the authenticated subject.

Specified by:

login in interface PortalAuthentication

Parameters:

username - a public credential of the subject to be authenticated.

password - a private credentialof the subject to be authenticated.

Returns:

a JetspeedUser object representing the authenticated subject.

Throws:

LoginException - when general security provider failure.

FailedLoginException - when the authentication failed.

AccountExpiredException - when the subject's account is expired.

CredentialExpiredException - when the subject's credential is expired.

getAnonymousUser

public JetspeedUser getAnonymousUser()
                              throws LoginException

Automatically authenticates and retrieves the portal anonymous user.

Specified by:

getAnonymousUser in interface PortalAuthentication

Returns:

a JetspeedUser object representing the authenticated subject.

Throws:

LoginException - if the authentication fails.

logout

public void logout()
            throws LoginException

Logout the JetspeedUser. The logout procedure my may include removing/destroying Principal and Credential information if relevant to the security provider.

Specified by:

logout in interface PortalAuthentication

Throws:

LoginException - if the logout fails.

init

public void init(javax.servlet.ServletConfig conf)
          throws org.apache.turbine.services.InitializationException

This is the early initialization method called by the Turbine Service framework

Parameters:

conf - The ServletConfig

Throws:

throws - a InitializationException if the service fails to initialize

org.apache.turbine.services.InitializationException

getRunData

protected JetspeedRunData getRunData()

getUserFromContext

protected JetspeedUser getUserFromContext()

putUserIntoContext

protected JetspeedRunData putUserIntoContext(JetspeedUser user)