/* ====================================================================
* The Apache Software License, Version 1.1
*
* Copyright (c) 2000-2001 The Apache Software Foundation. All rights
* reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
*
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
*
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in
* the documentation and/or other materials provided with the
* distribution.
*
* 3. The end-user documentation included with the redistribution,
* if any, must include the following acknowledgment:
* "This product includes software developed by the
* Apache Software Foundation (http://www.apache.org/)."
* Alternately, this acknowledgment may appear in the software itself,
* if and wherever such third-party acknowledgments normally appear.
*
* 4. The names "Apache" and "Apache Software Foundation" and
* "Apache Jetspeed" must not be used to endorse or promote products
* derived from this software without prior written permission. For
* written permission, please contact apache@apache.org.
*
* 5. Products derived from this software may not be called "Apache" or
* "Apache Jetspeed", nor may "Apache" appear in their name, without
* prior written permission of the Apache Software Foundation.
*
* THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
* WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
* OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
* DISCLAIMED. IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
* ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
* LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
* USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
* ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
* OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
* OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
* SUCH DAMAGE.
* ====================================================================
*
* This software consists of voluntary contributions made by many
* individuals on behalf of the Apache Software Foundation. For more
* information on the Apache Software Foundation, please see
* <http://www.apache.org/>.
*/
package org.apache.jetspeed.services.security.nosecurity;
import org.apache.turbine.services.TurbineBaseService;
import org.apache.turbine.services.TurbineServices;
import org.apache.turbine.services.InitializationException;
import org.apache.jetspeed.services.security.PortalAuthentication;
import org.apache.jetspeed.services.security.LoginException;
import org.apache.jetspeed.services.JetspeedSecurity;
import org.apache.jetspeed.om.security.JetspeedUser;
import org.apache.jetspeed.services.security.FailedLoginException;
import org.apache.jetspeed.services.rundata.JetspeedRunDataService;
import org.apache.jetspeed.services.rundata.JetspeedRunData;
import org.apache.jetspeed.services.security.nosecurity.FakeJetspeedUser;
import org.apache.turbine.services.rundata.RunDataService;
/**
* <p> The <code>NoAuthentication</code> class is a Jetspeed
* security provider, implementing the <code>PortalAuthentication</code> interface.
* It provides no authentication - all login attempts are allowed.
*
* @author <a href="mailto:ggolden@apache.org">Glenn R. Golden</a>
* @version $Id: NoAuthentication.java,v 1.2 2003/03/04 00:05:12 sgala Exp $
*/
public class NoAuthentication
extends TurbineBaseService
implements PortalAuthentication
{
/** The JetspeedRunData Service. */
private JetspeedRunDataService m_runDataService = null;
/**
* Given a public credential(username) and private credential(password),
* perform authentication. If authentication succeeds, a <code>JetspeedUser</code>
* is returned representing the authenticated subject.
*
* @param username a public credential of the subject to be authenticated.
* @param password a private credentialof the subject to be authenticated.
* @return a <code>JetspeedUser</code> object representing the authenticated subject.
* @exception LoginException when general security provider failure.
* @exception FailedLoginException when the authentication failed.
* @exception AccountExpiredException when the subject's account is expired.
* @exception CredentialExpiredException when the subject's credential is expired.
*/
public JetspeedUser login(String username, String password)
throws LoginException
{
// we let anyone in!
if (false) throw new FailedLoginException("Invalid user id or password");
// create a user object with this username for Jetspeed use
FakeJetspeedUser user = new FakeJetspeedUser(username, true);
// make it the logged in user for Jetspeed
putUserIntoContext(user);
return user;
} // login
/**
* Automatically authenticates and retrieves the portal anonymous user.
*
* @return a <code>JetspeedUser</code> object representing the authenticated subject.
* @exception LoginException if the authentication fails.
*/
public JetspeedUser getAnonymousUser()
throws LoginException
{
// create a user object with this username for Jetspeed use
FakeJetspeedUser user = new FakeJetspeedUser(JetspeedSecurity.getAnonymousUserName(), false);
// make it the logged in user for Jetspeed
putUserIntoContext(user);
return user;
} // getAnonymousUser
/**
* Logout the <code>JetspeedUser</code>.
*
* The logout procedure my may include removing/destroying
* <code>Principal</code> and <code>Credential</code> information
* if relevant to the security provider.
*
* @exception LoginException if the logout fails.
*/
public void logout()
throws LoginException
{
// revert to the anon. user as the current user
getAnonymousUser();
} // logout
/**
* Performs late initialization. Called just before the first use of the service.
*
* If your class relies on early initialization, and the object it
* expects was not received, you can use late initialization to
* throw an exception and complain.
*
* @exception InitializationException, if initialization of this class was not successful.
*/
public synchronized void init()
throws InitializationException
{
super.init();
m_runDataService =
(JetspeedRunDataService)TurbineServices.getInstance()
.getService(RunDataService.SERVICE_NAME);
} // init
////////////////////////////////////////////////////////////////////////////
protected JetspeedRunData getRunData()
{
JetspeedRunData rundata = null;
if (m_runDataService != null)
{
rundata = m_runDataService.getCurrentRunData();
}
return rundata;
}
protected JetspeedUser getUserFromContext()
{
JetspeedRunData rundata = getRunData();
JetspeedUser user = null;
if (rundata != null)
{
user = (JetspeedUser)rundata.getUser();
}
return user;
}
protected JetspeedRunData putUserIntoContext(JetspeedUser user)
{
JetspeedRunData rundata = getRunData();
if (rundata != null)
{
rundata.setUser(user);
rundata.save();
}
return rundata;
}
}