HibernateGroupManagerImpl.java
package org.apache.fulcrum.security.hibernate;
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (the
* "License"); you may not use this file except in compliance
* with the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
import java.util.List;
import org.apache.fulcrum.security.entity.Group;
import org.apache.fulcrum.security.spi.AbstractGroupManager;
import org.apache.fulcrum.security.util.DataBackendException;
import org.apache.fulcrum.security.util.EntityExistsException;
import org.apache.fulcrum.security.util.GroupSet;
import org.apache.fulcrum.security.util.UnknownEntityException;
import org.hibernate.HibernateException;
/**
* This implementation persists to a database via Hibernate.
*
* @author <a href="mailto:epugh@upstate.com">Eric Pugh</a>
* @version $Id: HibernateGroupManagerImpl.java 1374014 2012-08-16 19:47:27Z tv
* $
*/
@SuppressWarnings("unchecked")
public class HibernateGroupManagerImpl extends AbstractGroupManager
{
/**
*
*/
private static final long serialVersionUID = 1L;
private PersistenceHelper persistenceHelper;
/**
* Retrieve a Group object with specified name.
*
* @param name
* the name of the Group.
* @return an object representing the Group with specified name.
* @throws DataBackendException
* if there was an error accessing the data backend.
* @throws UnknownEntityException
* if the group does not exist.
*/
@Override
public Group getGroupByName(String name) throws DataBackendException, UnknownEntityException
{
Group group = null;
try
{
List<Group> groups = getPersistenceHelper().retrieveSession()
.createQuery("from " + Group.class.getName() + " g where g.name=:name").setString("name", name.toLowerCase()).list();
if (groups.size() == 0)
{
throw new UnknownEntityException("Could not find group" + name);
}
group = groups.get(0);
}
catch (HibernateException e)
{
throw new DataBackendException("Error retrieving group information", e);
}
return group;
}
/**
* Retrieves all groups defined in the system.
*
* @return the names of all groups defined in the system.
* @throws DataBackendException
* if there was an error accessing the data backend.
*/
public GroupSet getAllGroups() throws DataBackendException
{
GroupSet groupSet = new GroupSet();
try
{
List<Group> groups = getPersistenceHelper().retrieveSession().createQuery("from " + Group.class.getName()).list();
groupSet.add(groups);
}
catch (HibernateException e)
{
throw new DataBackendException("Error retrieving group information", e);
}
return groupSet;
}
/**
* Removes a Group from the system.
*
* @param group
* The object describing the group to be removed.
* @throws DataBackendException
* if there was an error accessing the data backend.
* @throws UnknownEntityException
* if the group does not exist.
*/
public synchronized void removeGroup(Group group) throws DataBackendException, UnknownEntityException
{
getPersistenceHelper().removeEntity(group);
}
/**
* Renames an existing Group.
*
* @param group
* The object describing the group to be renamed.
* @param name
* the new name for the group.
* @throws DataBackendException
* if there was an error accessing the data backend.
* @throws UnknownEntityException
* if the group does not exist.
*/
public synchronized void renameGroup(Group group, String name) throws DataBackendException, UnknownEntityException
{
boolean groupExists = false;
groupExists = checkExists(group);
if (groupExists)
{
group.setName(name);
getPersistenceHelper().updateEntity(group);
}
else
{
throw new UnknownEntityException("Unknown group '" + group + "'");
}
}
/**
* Determines if the <code>Group</code> exists in the security system.
*
* @param groupName
* a <code>Group</code> value
* @return true if the group name exists in the system, false otherwise
* @throws DataBackendException
* when more than one Group with the same name exists.
*/
public boolean checkExists(String groupName) throws DataBackendException
{
List<Group> groups;
try
{
groups = getPersistenceHelper().retrieveSession().createQuery("from " + Group.class.getName() + " sg where sg.name=:name")
.setString("name", groupName).list();
}
catch (HibernateException e)
{
throw new DataBackendException("Error retrieving user information", e);
}
if (groups.size() > 1)
{
throw new DataBackendException("Multiple groups with same name '" + groupName + "'");
}
return (groups.size() == 1);
}
/**
* Creates a new group with specified attributes.
*
* @param group
* the object describing the group to be created.
* @return a new Group object that has id set up properly.
* @throws DataBackendException
* if there was an error accessing the data backend.
*/
@Override
protected synchronized Group persistNewGroup(Group group) throws DataBackendException
{
getPersistenceHelper().addEntity(group);
return group;
}
/**
* @return Returns the persistenceHelper.
*/
public PersistenceHelper getPersistenceHelper()
{
if (persistenceHelper == null)
{
persistenceHelper = (PersistenceHelper) resolve(PersistenceHelper.ROLE);
}
return persistenceHelper;
}
/**
* Retrieve a Group object with specified id.
*
* @param id
* the id of the Group.
* @return an object representing the Group with specified id.
* @throws DataBackendException
* if there was an error accessing the data backend.
* @throws UnknownEntityException
* if the group does not exist.
*/
@Override
public Group getGroupById(Object id) throws DataBackendException, UnknownEntityException
{
Group group = null;
if (id != null)
{
try
{
List<Group> groups = getPersistenceHelper().retrieveSession()
.createQuery("from " + Group.class.getName() + " sr where sr.id=:id").setLong("id", ((Long) id).longValue()).list();
if (groups.size() == 0)
{
throw new UnknownEntityException("Could not find group by id " + id);
}
group = groups.get(0);
}
catch (HibernateException e)
{
throw new DataBackendException("Error retrieving group information", e);
}
}
return group;
}
}