epugh 2003/08/24 18:04:00
Added: security/src/java/org/apache/fulcrum/security/spi/torque/turbine/peer
UserGroupRolePeer.java TorqueUserPeer.java
GroupPeer.java PermissionPeer.java
RolePermissionPeer.java RolePeer.java UserPeer.java
Log:
Moved the Torque code around a bit to mimi the other SPI's.
Revision Changes Path
1.1
jakarta-turbine-fulcrum/security/src/java/org/apache/fulcrum/security/spi/torque/turbine/peer/UserGroupRolePeer.java
Index: UserGroupRolePeer.java
===================================================================
package org.apache.fulcrum.security.spi.torque.turbine.peer;
/* ====================================================================
* The Apache Software License, Version 1.1
*
* Copyright (c) 2001-2003 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 Turbine" must not be used to endorse or promote products
* derived from this software without prior written permission. For
* written permission, please contact [EMAIL PROTECTED]
*
* 5. Products derived from this software may not be called "Apache",
* "Apache Turbine", 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/>.
*/
import org.apache.fulcrum.security.spi.torque.turbine.db.map.TurbineMapBuilder;
import org.apache.torque.util.BasePeer;
/**
* This class handles all database access for the VISITOR_ROLE table.
* This table contains all the roles that a given user can play.
*
* @author <a href="mailto:[EMAIL PROTECTED]">Frank Y. Kim</a>
* @author <a href="mailto:[EMAIL PROTECTED]">John D. McNally</a>
* @author <a href="mailto:[EMAIL PROTECTED]">Brett McLaughlin</a>
* @version $Id: UserGroupRolePeer.java,v 1.1 2003/08/25 01:04:00 epugh Exp $
*/
public class UserGroupRolePeer extends BasePeer
{
/** The map builder for this Peer. */
private static final TurbineMapBuilder MAP_BUILDER = (TurbineMapBuilder)
getMapBuilder(TurbineMapBuilder.class.getName());
/** The table name for this peer. */
public static final String TABLE_NAME = MAP_BUILDER.getTableUserGroupRole();
/** The column name for the visitor id field. */
public static final String USER_ID = MAP_BUILDER.getUserGroupRole_UserId();
/** The column name for the group id field. */
public static final String GROUP_ID = MAP_BUILDER.getUserGroupRole_GroupId();
/** The column name for the role id field. */
public static final String ROLE_ID = MAP_BUILDER.getUserGroupRole_RoleId();
/**
* Get the name of this table.
*
* @return A String with the name of the table.
*/
public static String getTableName()
{
return TABLE_NAME;
}
/**
* Returns the full name of a column.
*
* @param name name of a column
* @return A String with the full name of the column.
*/
public static String getColumnName(String name)
{
StringBuffer sb = new StringBuffer();
sb.append(TABLE_NAME);
sb.append(".");
sb.append(name);
return sb.toString();
}
}
1.1
jakarta-turbine-fulcrum/security/src/java/org/apache/fulcrum/security/spi/torque/turbine/peer/TorqueUserPeer.java
Index: TorqueUserPeer.java
===================================================================
package org.apache.fulcrum.security.spi.torque.turbine.peer;
/* ====================================================================
* The Apache Software License, Version 1.1
*
* Copyright (c) 2001-2003 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 Turbine" must not be used to endorse or promote products
* derived from this software without prior written permission. For
* written permission, please contact [EMAIL PROTECTED]
*
* 5. Products derived from this software may not be called "Apache",
* "Apache Turbine", 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/>.
*/
import java.sql.Connection;
import java.util.ArrayList;
import java.util.Hashtable;
import java.util.List;
import org.apache.fulcrum.security.entity.User;
import org.apache.fulcrum.security.spi.torque.turbine.ClassicTorqueUser;
import org.apache.fulcrum.security.spi.torque.turbine.TorqueSecurity;
import org.apache.fulcrum.security.spi.torque.turbine.TorqueUser;
import org.apache.fulcrum.security.spi.torque.turbine.db.map.TurbineMapBuilder;
import org.apache.fulcrum.security.spi.torque.util.TorqueObjectUtils;
import org.apache.fulcrum.security.util.DataBackendException;
import org.apache.torque.TorqueException;
import org.apache.torque.map.TableMap;
import org.apache.torque.om.NumberKey;
import org.apache.torque.om.Persistent;
import org.apache.torque.util.BasePeer;
import org.apache.torque.util.Criteria;
import com.workingdogs.village.Column;
import com.workingdogs.village.Record;
import com.workingdogs.village.Schema;
import com.workingdogs.village.Value;
/**
* This class handles all the database access for the User/User
* table. This table contains all the information for a given user.
*
* @author <a href="mailto:[EMAIL PROTECTED]">Frank Y. Kim</a>
* @author <a href="mailto:[EMAIL PROTECTED]">John D. McNally</a>
* @author <a href="mailto:[EMAIL PROTECTED]">Brett McLaughlin</a>
* @version $Id: TorqueUserPeer.java,v 1.1 2003/08/25 01:04:00 epugh Exp $
*/
public class TorqueUserPeer extends BasePeer implements UserPeer
{
/** The mapBuilder for this Peer. */
private static final TurbineMapBuilder MAP_BUILDER = (TurbineMapBuilder)
getMapBuilder(TurbineMapBuilder.class.getName());
// column names
/** The column name for the visitor id field. */
private static final String USER_ID_COLUMN = MAP_BUILDER.getUserId();
/** This is the value that is stored in the database for confirmed users. */
public static final String CONFIRM_DATA
= TorqueUser.CONFIRM_DATA;
/** The column name for the visitor id field. */
private static final String OBJECT_DATA_COLUMN = MAP_BUILDER.getObjectData();
/** The table name for this peer. */
private static final String TABLE_NAME = MAP_BUILDER.getTableUser();
// Criteria Keys
/** The key name for the visitor id field. */
public static final String USER_ID = MAP_BUILDER.getUser_UserId();
/** The key name for the username field. */
public static final String USERNAME = MAP_BUILDER.getUser_Username();
/** The key name for the password field. */
public static final String PASSWORD = MAP_BUILDER.getUser_Password();
/** The key name for the first name field. */
public static final String FIRST_NAME = MAP_BUILDER.getUser_FirstName();
/** The key name for the last name field. */
public static final String LAST_NAME = MAP_BUILDER.getUser_LastName();
/** The key name for the modified field. */
public static final String MODIFIED = MAP_BUILDER.getUser_Modified();
/** The key name for the created field. */
public static final String CREATED = MAP_BUILDER.getUser_Created();
/** The key name for the email field. */
public static final String EMAIL = MAP_BUILDER.getUser_Email();
/** The key name for the last_login field. */
public static final String LAST_LOGIN = MAP_BUILDER.getUser_LastLogin();
/** The key name for the confirm_value field. */
public static final String CONFIRM_VALUE
= MAP_BUILDER.getUser_ConfirmValue();
/** The key name for the object_data field. */
public static final String OBJECT_DATA = MAP_BUILDER.getUser_ObjectData();
/** The schema. */
private static Schema schema = initTableSchema(TABLE_NAME);
/** The columns. */
private static Column[] columns
= initTableColumns(schema);
/** The names of the columns. */
public static String[] columnNames = initColumnNames(columns);
/** The keys for the criteria. */
public static String[] criteriaKeys
= initCriteriaKeys(TABLE_NAME, columnNames);
/**
* Get the name of this table.
*
* @return A String with the name of the table.
*/
public static String getTableName()
{
return TABLE_NAME;
}
/**
* Returns the full name of a column.
*
* @param name name of a column
* @return A String with the full name of the column.
*/
public static String getColumnName(String name)
{
StringBuffer sb = new StringBuffer();
sb.append(TABLE_NAME);
sb.append(".");
sb.append(name);
return sb.toString();
}
/**
*
* Returns the full name of a column.
*
* @param name name of a column
* @return A String with the full name of the column.
*/
public String getFullColumnName(String name)
{
StringBuffer sb = new StringBuffer();
sb.append(TABLE_NAME);
sb.append(".");
sb.append(name);
return sb.toString();
}
/**
* Builds a criteria object based upon an User object. Data
* stored in the permData table which a key matching a column
* name is removed from the permData table and added as a criterion.
* All remaining data in the permData table is serialized and
* added as a criterion for the OBJECT_DATA column.
*
* @param user object to build the criteria
* @return the Criteria
*/
public static Criteria buildCriteria(ClassicTorqueUser user)
{
Hashtable permData = (Hashtable) user.getPermStorage().clone();
Criteria criteria = new Criteria();
if (!((Persistent) user).isNew())
{
criteria.add(USER_ID, ((Persistent) user).getPrimaryKey());
}
for (int i = 1; i < TorqueUserPeer.columnNames.length; i++)
{
if (permData.containsKey(TorqueUserPeer.columnNames[i]))
{
criteria.add(TorqueUserPeer.criteriaKeys[i],
permData.remove(TorqueUserPeer.columnNames[i]));
}
}
criteria.add(TorqueUserPeer.OBJECT_DATA, permData);
return criteria;
}
/**
* Add all the columns needed to create a new object
*
* @param criteria The criteria to use.
* @exception TorqueException a generic exception.
*/
public static void addSelectColumns(Criteria criteria)
throws TorqueException
{
for (int i = 0; i < columnNames.length; i++)
{
criteria.addSelectColumn(new StringBuffer()
.append(TABLE_NAME)
.append(".")
.append(columnNames[i]).toString());
}
}
/**
*
* @param row
* @param offset
* @param obj
* @throws TorqueException
*/
public static void populateObject(Record row, int offset, ClassicTorqueUser obj)
throws TorqueException
{
try
{
// Set values are where columns are expected. They are not
// required to be in these positions, as we set the positions
// immediately following.
int idPosition = 1;
int objectDataPosition = columnNames.length;
for (int i = 0; i < columnNames.length; i++)
{
if (columnNames[i].equals(USER_ID_COLUMN))
{
idPosition = i + 1;
}
if (columnNames[i].equals(OBJECT_DATA_COLUMN))
{
objectDataPosition = i + 1;
}
}
((Persistent) obj).setPrimaryKey(
new NumberKey(row.getValue(idPosition).asBigDecimal()));
// Restore the Permanent Storage Hashtable. First the
// Hashtable is restored, then any explicit table columns
// which should be included in the Hashtable are added.
byte[] objectData = (byte[])
row.getValue(objectDataPosition).asBytes();
Hashtable tempHash = (Hashtable)
TorqueObjectUtils.deserialize(objectData);
if (tempHash == null)
{
tempHash = new Hashtable(10);
}
for (int j = 0; j < columnNames.length; j++)
{
if (!(columnNames[j].equalsIgnoreCase(USER_ID_COLUMN)
|| columnNames[j].equalsIgnoreCase(OBJECT_DATA_COLUMN)))
{
Object obj2 = null;
Value value = row.getValue(j + 1);
if (value.isByte())
{
obj2 = new Byte(value.asByte());
}
if (value.isBigDecimal())
{
obj2 = value.asBigDecimal();
}
if (value.isBytes())
{
obj2 = value.asBytes();
}
if (value.isDate())
{
obj2 = value.asDate();
}
if (value.isShort())
{
obj2 = new Short(value.asShort());
}
if (value.isInt())
{
obj2 = new Integer(value.asInt());
}
if (value.isLong())
{
obj2 = new Long(value.asLong());
}
if (value.isDouble())
{
obj2 = new Double(value.asDouble());
}
if (value.isFloat())
{
obj2 = new Float(value.asFloat());
}
if (value.isBoolean())
{
obj2 = new Boolean(value.asBoolean());
}
if (value.isString())
{
obj2 = value.asString();
}
if (value.isTime())
{
obj2 = value.asTime();
}
if (value.isTimestamp())
{
obj2 = value.asTimestamp();
}
if (value.isUtilDate())
{
obj2 = value.asUtilDate();
}
if (obj2 != null)
{
tempHash.put(columnNames[j], obj2);
}
}
}
obj.setPermStorage(tempHash);
}
catch (Exception ex)
{
throw new TorqueException(ex);
}
}
/**
* Issues a select based on a criteria.
*
* @param criteria Object containing data that is used to create
* the SELECT statement.
* @return Vector containing TurbineUser objects.
* @exception TorqueException a generic exception.
*/
public static List doSelect(Criteria criteria)
throws TorqueException
{
return doSelect(criteria, (ClassicTorqueUser) null);
}
/**
* Issues a select based on a criteria.
*
* @param criteria Object containing data that is used to create
* the SELECT statement.
* @param current User object that is to be used as part of the
* results - if not passed, then a new one is created.
* @return Vector containing TurbineUser objects.
* @exception TorqueException a generic exception.
*/
public static List doSelect(Criteria criteria, ClassicTorqueUser current)
throws TorqueException
{
// add User table columns
addSelectColumns(criteria);
if (criteria.getOrderByColumns() == null)
{
criteria.addAscendingOrderByColumn(LAST_NAME);
}
// Place any checks here to intercept criteria which require
// custom SQL. For example:
// if ( criteria.containsKey("SomeTable.SomeColumn") )
// {
// String whereSql = "SomeTable.SomeColumn IN (Select ...";
// criteria.add("SomeTable.SomeColumn",
// whereSQL, criteria.CUSTOM);
// }
// BasePeer returns a Vector of Record (Village) objects. The
// array order follows the order columns were placed in the
// Select clause.
List rows = BasePeer.doSelect(criteria);
List results = new ArrayList();
// Populate the object(s).
for (int i = 0; i < rows.size(); i++)
{
Record row = (Record) rows.get(i);
// Add User to the return Vector.
if (current == null)
{
results.add(row2Object(row, 1, null));
}
else
{
populateObject(row, 1, current);
((Persistent) current).setNew(false);
}
}
return results;
}
/**
* Issues a select based on a criteria.
*
* @param criteria Object containing data that is used to create
* the SELECT statement.
* @param dbConn
* @return List containing TurbineUser objects.
* @exception TorqueException a generic exception.
*/
public static List doSelect(Criteria criteria, Connection dbConn)
throws TorqueException
{
// add User table columns
addSelectColumns(criteria);
if (criteria.getOrderByColumns() == null)
{
criteria.addAscendingOrderByColumn(LAST_NAME);
}
// BasePeer returns a List of Record (Village) objects. The
// array order follows the order columns were placed in the
// Select clause.
List rows = BasePeer.doSelect(criteria, dbConn);
List results = new ArrayList();
// Populate the object(s).
for (int i = 0; i < rows.size(); i++)
{
Record row = (Record) rows.get(i);
// Add User to the return Vector.
results.add(row2Object(row, 1, null));
}
return results;
}
/**
* Implementss torque peers' method. Does not use the Class argument
* as Users need to go through TorqueSecurity
*
* @exception TorqueException a generic exception.
*/
public static ClassicTorqueUser row2Object(Record row, int offset, Class cls)
throws TorqueException
{
try
{
ClassicTorqueUser obj =
(ClassicTorqueUser)TorqueSecurity.getUserInstance();
populateObject(row, offset, obj);
((Persistent) obj).setNew(false);
((Persistent) obj).setModified(false);
return obj;
}
catch (Exception ex)
{
throw new TorqueException (ex);
}
}
/**
* The type of User this peer will instantiate.
*
* @exception Exception a generic exception.
*/
public static Class getOMClass() throws Exception
{
return TorqueSecurity.getUserClass();
}
/**
* Issues an update based on a criteria.
* The criteria only uses USER_ID.
*
* @param criteria Object containing data that is used to create
* the UPDATE statement.
* @exception TorqueException a generic exception.
*/
public static void doUpdate(Criteria criteria)
throws TorqueException
{
Criteria selectCriteria = new Criteria(2);
selectCriteria.put(USER_ID, criteria.remove(USER_ID));
BasePeer.doUpdate(selectCriteria, criteria);
}
/**
* Checks if a User is defined in the system. The name
* is used as query criteria.
*
* @param user The User to be checked.
* @return <code>true</code> if given User exists in the system.
* @throws DataBackendException when more than one User with
* the same name exists.
* @throws Exception a generic exception.
*/
public static boolean checkExists(User user)
throws DataBackendException, Exception
{
Criteria criteria = new Criteria();
criteria.addSelectColumn(USER_ID);
criteria.add(USERNAME, user.getName());
List results = BasePeer.doSelect(criteria);
if (results.size() > 1)
{
throw new DataBackendException("Multiple users named '"
+ user.getName() + "' exist!");
}
return (results.size() == 1);
}
/**
* Returns a vector of all User objects.
*
* @return A Vector with all users in the system.
* @exception Exception a generic exception.
*/
public static List selectAllUsers()
throws Exception
{
Criteria criteria = new Criteria();
criteria.addAscendingOrderByColumn(TorqueUserPeer.LAST_NAME);
criteria.addAscendingOrderByColumn(TorqueUserPeer.FIRST_NAME);
criteria.setIgnoreCase(true);
return TorqueUserPeer.doSelect(criteria);
}
/**
* Returns a vector of all confirmed User objects.
*
* @return A Vector with all confirmed users in the system.
* @exception Exception a generic exception.
*/
public static List selectAllConfirmedUsers()
throws Exception
{
Criteria criteria = new Criteria();
criteria.add(ClassicTorqueUser.CONFIRM_VALUE, TorqueUser.CONFIRM_DATA);
criteria.addAscendingOrderByColumn(TorqueUserPeer.LAST_NAME);
criteria.addAscendingOrderByColumn(TorqueUserPeer.FIRST_NAME);
criteria.setIgnoreCase(true);
return TorqueUserPeer.doSelect(criteria);
}
/**
* Returns the TableMap related to this peer. This method is not
* needed for general use but a specific application could have a
* need.
*/
protected static TableMap getTableMap()
{
return MAP_BUILDER.getDatabaseMap().getTable(TABLE_NAME);
}
}
1.1
jakarta-turbine-fulcrum/security/src/java/org/apache/fulcrum/security/spi/torque/turbine/peer/GroupPeer.java
Index: GroupPeer.java
===================================================================
package org.apache.fulcrum.security.spi.torque.turbine.peer;
/* ====================================================================
* The Apache Software License, Version 1.1
*
* Copyright (c) 2001-2003 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 Turbine" must not be used to endorse or promote products
* derived from this software without prior written permission. For
* written permission, please contact [EMAIL PROTECTED]
*
* 5. Products derived from this software may not be called "Apache",
* "Apache Turbine", 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/>.
*/
import java.util.ArrayList;
import java.util.List;
import java.util.Map;
import org.apache.fulcrum.security.entity.Group;
import org.apache.fulcrum.security.spi.torque.turbine.SecurityObject;
import org.apache.fulcrum.security.spi.torque.turbine.TorqueGroup;
import org.apache.fulcrum.security.spi.torque.turbine.TorqueSecurity;
import org.apache.fulcrum.security.spi.torque.turbine.db.map.TurbineMapBuilder;
import org.apache.fulcrum.security.spi.torque.util.TorqueObjectUtils;
import org.apache.fulcrum.security.util.DataBackendException;
import org.apache.fulcrum.security.util.GroupSet;
import org.apache.torque.TorqueException;
import org.apache.torque.om.BaseObject;
import org.apache.torque.om.NumberKey;
import org.apache.torque.util.BasePeer;
import org.apache.torque.util.Criteria;
import com.workingdogs.village.Record;
/**
* This class handles all the database access for the Group table.
* This table contains all the Groups that a given member can play.
*
* @author <a href="mailto:[EMAIL PROTECTED]">Frank Y. Kim</a>
* @author <a href="mailto:[EMAIL PROTECTED]">John D. McNally</a>
* @author <a href="mailto:[EMAIL PROTECTED]">Brett McLaughlin</a>
* @author <a href="mailto:[EMAIL PROTECTED]">Rafal Krzewski</a>
* @version $Id: GroupPeer.java,v 1.1 2003/08/25 01:04:00 epugh Exp $
*/
public class GroupPeer extends BasePeer
{
/** The map builder for this Peer. */
private static final TurbineMapBuilder MAP_BUILDER = (TurbineMapBuilder)
getMapBuilder(TurbineMapBuilder.class.getName());
/** The table name for this peer. */
private static final String TABLE_NAME = MAP_BUILDER.getTableGroup();
/** The column name for the Group id field. */
public static final String GROUP_ID = MAP_BUILDER.getGroup_GroupId();
/** The column name for the name field. */
public static final String NAME = MAP_BUILDER.getGroup_Name();
/** The column name for the ObjectData field */
public static final String OBJECTDATA = MAP_BUILDER.getGroup_ObjectData();
/**
* Retrieves/assembles a GroupSet of all of the Groups.
*
* @return A GroupSet.
* @exception Exception a generic exception.
*/
public static GroupSet retrieveSet() throws Exception
{
return retrieveSet(new Criteria());
}
/**
* Retrieves/assembles a GroupSet based on the Criteria passed in
*
* @param criteria The criteria to use.
* @throws Exception a generic exception.
* @return a GroupSet
*/
public static GroupSet retrieveSet(Criteria criteria) throws Exception
{
List results = GroupPeer.doSelect(criteria);
GroupSet rs = new GroupSet();
for (int i = 0; i < results.size(); i++)
{
rs.add((Group) results.get(i));
}
return rs;
}
/**
* Issues a select based on a criteria.
*
* @param criteria object containing data that is used to create
* the SELECT statement.
* @return Vector containing Group objects.
* @exception TorqueException a generic exception.
*/
public static List doSelect(Criteria criteria) throws TorqueException
{
try
{
criteria.addSelectColumn(GROUP_ID)
.addSelectColumn(NAME)
.addSelectColumn(OBJECTDATA);
if (criteria.getOrderByColumns() == null
|| criteria.getOrderByColumns().size() == 0)
{
criteria.addAscendingOrderByColumn(NAME);
}
// Place any checks here to intercept criteria which require
// custom SQL. For example:
// if ( criteria.containsKey("SomeTable.SomeColumn") )
// {
// String whereSql = "SomeTable.SomeColumn IN (Select ...";
// criteria.add("SomeTable.SomeColumn",
// whereSQL, criteria.CUSTOM);
// }
// BasePeer returns a Vector of Value (Village) arrays. The
// array order follows the order columns were placed in the
// Select clause.
List rows = BasePeer.doSelect(criteria);
List results = new ArrayList();
// Populate the object(s).
for (int i = 0; i < rows.size(); i++)
{
Group obj = TorqueSecurity.getGroupInstance(null);
Record row = (Record) rows.get(i);
((SecurityObject) obj).setPrimaryKey(
new NumberKey(row.getValue(1).asInt()));
((SecurityObject) obj).setName(row.getValue(2).asString());
byte[] objectData = (byte[]) row.getValue(3).asBytes();
Map temp = (Map) TorqueObjectUtils.deserialize(objectData);
if (temp != null)
{
((SecurityObject) obj).setAttributes(temp);
}
results.add(obj);
}
return results;
}
catch (Exception ex)
{
throw new TorqueException(ex);
}
}
/**
* Issues an update based on a criteria.
*
* @param criteria object containing data that is used to create
* the UPDATE statement.
* @exception TorqueException a generic exception.
*/
public static void doUpdate(Criteria criteria)
throws TorqueException
{
Criteria selectCriteria = new Criteria(2);
selectCriteria.put(GROUP_ID, criteria.remove(GROUP_ID));
BasePeer.doUpdate(selectCriteria, criteria);
}
/**
* Checks if a Group is defined in the system. The name
* is used as query criteria.
*
* @param group The Group to be checked.
* @return <code>true</code> if given Group exists in the system.
* @throws DataBackendException when more than one Group with
* the same name exists.
* @throws Exception a generic exception.
*/
public static boolean checkExists(Group group)
throws DataBackendException, Exception
{
Criteria criteria = new Criteria();
criteria.addSelectColumn(GROUP_ID);
criteria.add(NAME, ((SecurityObject) group).getName());
List results = BasePeer.doSelect(criteria);
if (results.size() > 1)
{
throw new DataBackendException("Multiple groups named '"
+ ((TorqueGroup) group).getName() + "' exist!");
}
return (results.size() == 1);
}
/**
* Get the name of this table.
*
* @return A String with the name of the table.
*/
public static String getTableName()
{
return TABLE_NAME;
}
/**
* Returns the full name of a column.
*
* @param name name of the column
* @return A String with the full name of the column.
*/
public static String getColumnName(String name)
{
StringBuffer sb = new StringBuffer();
sb.append(TABLE_NAME);
sb.append(".");
sb.append(name);
return sb.toString();
}
/**
* Builds a criteria object based upon an Group object
*
* @param group object to build the Criteria
* @return the Criteria
*/
public static Criteria buildCriteria(Group group)
{
Criteria criteria = new Criteria();
criteria.add(NAME, ((SecurityObject) group).getName());
if (!((BaseObject) group).isNew())
{
criteria.add(GROUP_ID, ((BaseObject) group).getPrimaryKey());
}
// Causing the removal and updating of a group to
// crap out.
//criteria.add(OBJECTDATA, group.getAttributes());
return criteria;
}
}
1.1
jakarta-turbine-fulcrum/security/src/java/org/apache/fulcrum/security/spi/torque/turbine/peer/PermissionPeer.java
Index: PermissionPeer.java
===================================================================
package org.apache.fulcrum.security.spi.torque.turbine.peer;
/* ====================================================================
* The Apache Software License, Version 1.1
*
* Copyright (c) 2001-2003 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 Turbine" must not be used to endorse or promote products
* derived from this software without prior written permission. For
* written permission, please contact [EMAIL PROTECTED]
*
* 5. Products derived from this software may not be called "Apache",
* "Apache Turbine", 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/>.
*/
import java.util.ArrayList;
import java.util.Enumeration;
import java.util.List;
import java.util.Map;
import java.util.Vector;
import org.apache.fulcrum.security.entity.Permission;
import org.apache.fulcrum.security.entity.Role;
import org.apache.fulcrum.security.entity.SecurityEntity;
import org.apache.fulcrum.security.spi.torque.turbine.SecurityObject;
import org.apache.fulcrum.security.spi.torque.turbine.TorqueRole;
import org.apache.fulcrum.security.spi.torque.turbine.TorqueSecurity;
import org.apache.fulcrum.security.spi.torque.turbine.db.map.TurbineMapBuilder;
import org.apache.fulcrum.security.spi.torque.util.TorqueObjectUtils;
import org.apache.fulcrum.security.util.DataBackendException;
import org.apache.fulcrum.security.util.PermissionSet;
import org.apache.torque.TorqueException;
import org.apache.torque.om.BaseObject;
import org.apache.torque.om.NumberKey;
import org.apache.torque.util.BasePeer;
import org.apache.torque.util.Criteria;
import com.workingdogs.village.Record;
/**
* This class handles all the database access for the PERMISSION
* table. This table contains all the permissions that are used in
* the system.
*
* @author <a href="mailto:[EMAIL PROTECTED]">Frank Y. Kim</a>
* @author <a href="mailto:[EMAIL PROTECTED]">John D. McNally</a>
* @author <a href="mailto:[EMAIL PROTECTED]">Brett McLaughlin</a>
* @version $Id: PermissionPeer.java,v 1.1 2003/08/25 01:04:00 epugh Exp $
*/
public class PermissionPeer extends BasePeer
{
/** The map builder for this Peer. */
private static final TurbineMapBuilder MAP_BUILDER = (TurbineMapBuilder)
getMapBuilder(TurbineMapBuilder.class.getName());
/** The table name for this peer. */
private static final String TABLE_NAME = MAP_BUILDER.getTablePermission();
/** The column name for the permission id field. */
public static final String PERMISSION_ID
= MAP_BUILDER.getPermission_PermissionId();
/** The column name for the name field. */
public static final String NAME = MAP_BUILDER.getPermission_Name();
/** The column name for the ObjectData field */
public static final String OBJECTDATA
= MAP_BUILDER.getPermission_ObjectData();
/**
* Retrieves/assembles a PermissionSet
*
* @param criteria The criteria to use.
* @return A PermissionSet.
* @exception Exception a generic exception.
*/
public static PermissionSet retrieveSet(Criteria criteria)
throws Exception
{
List results = PermissionPeer.doSelect(criteria);
PermissionSet ps = new PermissionSet();
for (int i = 0; i < results.size(); i++)
{
ps.add((Permission) results.get(i));
}
return ps;
}
/**
* Retrieves a set of Permissions associated with a particular Role.
*
* @param role The role to query permissions of.
* @return A set of permissions associated with the Role.
* @exception Exception a generic exception.
*/
public static PermissionSet retrieveSet(Role role)
throws Exception
{
Criteria criteria = new Criteria();
criteria.add(RolePermissionPeer.ROLE_ID,
((TorqueRole) role).getPrimaryKey());
criteria.addJoin(RolePermissionPeer.PERMISSION_ID,
PermissionPeer.PERMISSION_ID);
return retrieveSet(criteria);
}
/**
* Issues a select based on a criteria.
*
* @param criteria Object containing data that is used to create
* the SELECT statement.
* @return Vector containing Permission objects.
* @exception TorqueException a generic exception.
*/
public static List doSelect(Criteria criteria)
throws TorqueException
{
try
{
criteria.addSelectColumn(PERMISSION_ID)
.addSelectColumn(NAME)
.addSelectColumn(OBJECTDATA);
if (criteria.getOrderByColumns() == null
|| criteria.getOrderByColumns().size() == 0)
{
criteria.addAscendingOrderByColumn(NAME);
}
// Place any checks here to intercept criteria which require
// custom SQL. For example:
// if ( criteria.containsKey("SomeTable.SomeColumn") )
// {
// String whereSql = "SomeTable.SomeColumn IN (Select ...";
// criteria.add("SomeTable.SomeColumn",
// whereSQL, criteria.CUSTOM);
// }
// BasePeer returns a Vector of Value (Village) arrays. The
// array order follows the order columns were placed in the
// Select clause.
List rows = BasePeer.doSelect(criteria);
List results = new ArrayList();
// Populate the object(s).
for (int i = 0; i < rows.size(); i++)
{
Permission obj = TorqueSecurity.getPermissionInstance(null);
Record row = (Record) rows.get(i);
((SecurityObject) obj).setPrimaryKey(
new NumberKey(row.getValue(1).asInt()));
((SecurityEntity) obj).setName(row.getValue(2).asString());
byte[] objectData = (byte[]) row.getValue(3).asBytes();
Map temp = (Map) TorqueObjectUtils.deserialize(objectData);
if (temp != null)
{
((SecurityObject) obj).setAttributes(temp);
}
results.add(obj);
}
return results;
}
catch (Exception ex)
{
throw new TorqueException(ex);
}
}
/**
* Builds a criteria object based upon an Permission object
*
* @param permission object to build the criteria
* @return the Criteria
*/
public static Criteria buildCriteria(Permission permission)
{
Criteria criteria = new Criteria();
if (!((BaseObject) permission).isNew())
{
criteria.add(PERMISSION_ID,
((BaseObject) permission).getPrimaryKey());
}
criteria.add(NAME, ((SecurityEntity) permission).getName());
/*
* This is causing the the removal and updating of
* a permission to crap out. This addition to the
* criteria produces something like:
*
* where OBJECTDATA = {}
*
* Is the NAME even necessary. Wouldn't
* criteria.add(PERMISSION_ID, N) be enough to
* generate a where clause that would remove the
* permission?
*
* criteria.add(OBJECTDATA, permission.getAttributes());
*/
return criteria;
}
/**
* Issues an update based on a criteria.
*
* @param criteria Object containing data that is used to create
* the UPDATE statement.
* @exception TorqueException a generic exception.
*/
public static void doUpdate(Criteria criteria)
throws TorqueException
{
Criteria selectCriteria = new Criteria(2);
selectCriteria.put(PERMISSION_ID, criteria.remove(PERMISSION_ID));
BasePeer.doUpdate(selectCriteria, criteria);
}
/**
* Checks if a Permission is defined in the system. The name
* is used as query criteria.
*
* @param permission The Permission to be checked.
* @return <code>true</code> if given Permission exists in the system.
* @throws DataBackendException when more than one Permission with
* the same name exists.
* @throws Exception a generic exception.
*/
public static boolean checkExists(Permission permission)
throws DataBackendException, Exception
{
Criteria criteria = new Criteria();
criteria.addSelectColumn(PERMISSION_ID);
criteria.add(NAME, ((SecurityObject) permission).getName());
List results = BasePeer.doSelect(criteria);
if (results.size() > 1)
{
throw new DataBackendException("Multiple permissions named '"
+ ((SecurityObject) permission).getName() + "' exist!");
}
return (results.size() == 1);
}
/**
* Get the name of this table.
*
* @return A String with the name of the table.
*/
public static String getTableName()
{
return TABLE_NAME;
}
/**
* Returns the full name of a column.
*
* @param name name of a column
* @return A String with the full name of the column.
*/
public static String getColumnName(String name)
{
StringBuffer sb = new StringBuffer();
sb.append(TABLE_NAME);
sb.append(".");
sb.append(name);
return sb.toString();
}
/**
* Pass in two Vector's of Permission Objects. It will return a
* new Vector with the difference of the two Vectors: C = (A - B).
*
* @param some Vector B in C = (A - B).
* @param all Vector A in C = (A - B).
* @return Vector C in C = (A - B).
*/
public static final Vector getDifference(Vector some, Vector all)
{
Vector clone = (Vector) all.clone();
for (Enumeration e = some.elements(); e.hasMoreElements();)
{
Permission tmp = (Permission) e.nextElement();
for (Enumeration f = clone.elements(); f.hasMoreElements();)
{
Permission tmp2 = (Permission) f.nextElement();
if (((BaseObject) tmp).getPrimaryKey()
== ((BaseObject) tmp2).getPrimaryKey())
{
clone.removeElement(tmp2);
break;
}
}
}
return clone;
}
}
1.1
jakarta-turbine-fulcrum/security/src/java/org/apache/fulcrum/security/spi/torque/turbine/peer/RolePermissionPeer.java
Index: RolePermissionPeer.java
===================================================================
package org.apache.fulcrum.security.spi.torque.turbine.peer;
/* ====================================================================
* The Apache Software License, Version 1.1
*
* Copyright (c) 2001-2003 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 Turbine" must not be used to endorse or promote products
* derived from this software without prior written permission. For
* written permission, please contact [EMAIL PROTECTED]
*
* 5. Products derived from this software may not be called "Apache",
* "Apache Turbine", 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/>.
*/
import org.apache.fulcrum.security.spi.torque.turbine.db.map.TurbineMapBuilder;
import org.apache.torque.util.BasePeer;
import org.apache.torque.util.Criteria;
/**
* This class handles all database access for the
* ROLE_PERMISSION table. This table contains all
* the permissions for a given role.
*
* @author <a href="mailto:[EMAIL PROTECTED]">Frank Y. Kim</a>
* @author <a href="mailto:[EMAIL PROTECTED]">Brett McLaughlin</a>
* @author <a href="mailto:[EMAIL PROTECTED]">John D. McNally</a>
* @author <a href="mailto:[EMAIL PROTECTED]">Jon S. Stevens</a>
* @version $Id: RolePermissionPeer.java,v 1.1 2003/08/25 01:04:00 epugh Exp $
*/
public class RolePermissionPeer extends BasePeer
{
/** The map builder for this Peer. */
private static final TurbineMapBuilder MAP_BUILDER = (TurbineMapBuilder)
getMapBuilder(TurbineMapBuilder.class.getName());
/** The table name for this peer. */
public static final String TABLE_NAME = MAP_BUILDER.getTableRolePermission();
/** The column name for the permission id field. */
public static final String PERMISSION_ID
= MAP_BUILDER.getRolePermission_PermissionId();
/** The column name for the role id field. */
public static final String ROLE_ID = MAP_BUILDER.getRolePermission_RoleId();
/**
* Deletes the mappings for a role_id.
*
* @param role_id An int with the role id.
* @exception Exception a generic exception.
*/
public static void deleteRole(int role_id) throws Exception
{
Criteria criteria = new Criteria();
criteria.add(ROLE_ID, role_id);
doDelete(criteria);
}
/**
* Deletes the mappings for a permission_id.
*
* @param permission_id An int with the permission id.
* @exception Exception a generic exception.
*/
public static void deletePermission(int permission_id) throws Exception
{
Criteria criteria = new Criteria();
criteria.add(PERMISSION_ID, permission_id);
doDelete(criteria);
}
}
1.1
jakarta-turbine-fulcrum/security/src/java/org/apache/fulcrum/security/spi/torque/turbine/peer/RolePeer.java
Index: RolePeer.java
===================================================================
package org.apache.fulcrum.security.spi.torque.turbine.peer;
/* ====================================================================
* The Apache Software License, Version 1.1
*
* Copyright (c) 2001-2003 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 Turbine" must not be used to endorse or promote products
* derived from this software without prior written permission. For
* written permission, please contact [EMAIL PROTECTED]
*
* 5. Products derived from this software may not be called "Apache",
* "Apache Turbine", 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/>.
*/
import java.util.ArrayList;
import java.util.List;
import java.util.Map;
import org.apache.fulcrum.security.entity.Group;
import org.apache.fulcrum.security.entity.Role;
import org.apache.fulcrum.security.entity.User;
import org.apache.fulcrum.security.spi.torque.turbine.SecurityObject;
import org.apache.fulcrum.security.spi.torque.turbine.TorqueRole;
import org.apache.fulcrum.security.spi.torque.turbine.db.map.TurbineMapBuilder;
import org.apache.fulcrum.security.spi.torque.util.TorqueObjectUtils;
import org.apache.fulcrum.security.util.DataBackendException;
import org.apache.fulcrum.security.util.RoleSet;
import org.apache.torque.TorqueException;
import org.apache.torque.om.BaseObject;
import org.apache.torque.om.NumberKey;
import org.apache.torque.om.Persistent;
import org.apache.torque.util.BasePeer;
import org.apache.torque.util.Criteria;
import com.workingdogs.village.Record;
/**
* This class handles all the database access for the ROLE table.
* This table contains all the roles that a given member can play.
*
* @author <a href="mailto:[EMAIL PROTECTED]">Frank Y. Kim</a>
* @author <a href="mailto:[EMAIL PROTECTED]">John D. McNally</a>
* @author <a href="mailto:[EMAIL PROTECTED]">Brett McLaughlin</a>
* @version $Id: RolePeer.java,v 1.1 2003/08/25 01:04:00 epugh Exp $
*/
public class RolePeer extends BasePeer
{
/** The map builder for this Peer. */
private static final TurbineMapBuilder MAP_BUILDER = (TurbineMapBuilder)
getMapBuilder(TurbineMapBuilder.class.getName());
/** The table name for this peer. */
private static final String TABLE_NAME = MAP_BUILDER.getTableRole();
/** The column name for the role id field. */
public static final String ROLE_ID = MAP_BUILDER.getRole_RoleId();
/** The column name for the name field. */
public static final String NAME = MAP_BUILDER.getRole_Name();
/** The column name for the ObjectData field */
public static final String OBJECTDATA = MAP_BUILDER.getRole_ObjectData();
/**
* Retrieves/assembles a RoleSet based on the Criteria passed in
*
* @param criteria The criteria to use.
* @return a RoleSet
* @exception Exception a generic exception.
*/
public static RoleSet retrieveSet(Criteria criteria) throws Exception
{
List results = RolePeer.doSelect(criteria);
RoleSet rs = new RoleSet();
for (int i = 0; i < results.size(); i++)
{
rs.add((Role) results.get(i));
}
return rs;
}
/**
* Retrieves a set of Roles that an User was assigned in a Group
*
* @param user An user.
* @param group A group
* @return A Set of Roles of this User in the Group
* @exception Exception a generic exception.
*/
public static RoleSet retrieveSet(User user, Group group) throws Exception
{
Criteria criteria = new Criteria();
criteria.add(UserGroupRolePeer.USER_ID,
((Persistent) user).getPrimaryKey());
criteria.add(UserGroupRolePeer.GROUP_ID,
((Persistent) group).getPrimaryKey());
criteria.addJoin(UserGroupRolePeer.ROLE_ID, RolePeer.ROLE_ID);
return retrieveSet(criteria);
}
/**
* Issues a select based on a criteria.
*
* @param criteria object containing data that is used to create
* the SELECT statement.
* @return Vector containing Role objects.
* @exception TorqueException a generic exception.
*/
public static List doSelect(Criteria criteria) throws TorqueException
{
try
{
criteria.addSelectColumn(ROLE_ID)
.addSelectColumn(NAME)
.addSelectColumn(OBJECTDATA);
if (criteria.getOrderByColumns() == null
|| criteria.getOrderByColumns().size() == 0)
{
criteria.addAscendingOrderByColumn(NAME);
}
// Place any checks here to intercept criteria which require
// custom SQL. For example:
// if ( criteria.containsKey("SomeTable.SomeColumn") )
// {
// String whereSql = "SomeTable.SomeColumn IN (Select ...";
// criteria.add("SomeTable.SomeColumn",
// whereSQL, criteria.CUSTOM);
// }
// BasePeer returns a Vector of Value (Village) arrays. The
// array order follows the order columns were placed in the
// Select clause.
List rows = BasePeer.doSelect(criteria);
List results = new ArrayList();
// Populate the object(s).
for (int i = 0; i < rows.size(); i++)
{
//Role obj = new Role();
Role obj = new TorqueRole();
Record row = (Record) rows.get(i);
((TorqueRole) obj).setPrimaryKey(
new NumberKey(row.getValue(1).asInt()));
((TorqueRole) obj).setName(row.getValue(2).asString());
byte[] objectData = (byte[]) row.getValue(3).asBytes();
Map temp = (Map) TorqueObjectUtils.deserialize(objectData);
if (temp != null)
{
((SecurityObject) obj).setAttributes(temp);
}
results.add(obj);
}
return results;
}
catch (Exception ex)
{
throw new TorqueException (ex);
}
}
/**
* Builds a criteria object based upon an Role object
*
* @param role object to build the criteria
* @return the Criteria
*/
public static Criteria buildCriteria(Role role)
{
Criteria criteria = new Criteria();
if (!((BaseObject) role).isNew())
{
criteria.add(ROLE_ID, ((BaseObject) role).getPrimaryKey());
}
criteria.add(NAME, role.getName());
// causing the removal and updating of roles to
// crap out because of the generated SQL.
//criteria.add(OBJECTDATA, role.getAttributes());
return criteria;
}
/**
* Issues an update based on a criteria.
*
* @param criteria object containing data that is used to create
* the UPDATE statement.
* @exception TorqueException a generic exception.
*/
public static void doUpdate(Criteria criteria)
throws TorqueException
{
Criteria selectCriteria = new Criteria(2);
selectCriteria.put(ROLE_ID, criteria.remove(ROLE_ID));
BasePeer.doUpdate(selectCriteria, criteria);
}
/**
* Checks if a Role is defined in the system. The name
* is used as query criteria.
*
* @param role The Role to be checked.
* @return <code>true</code> if given Role exists in the system.
* @throws DataBackendException when more than one Role with
* the same name exists.
* @throws Exception a generic exception.
*/
public static boolean checkExists(Role role)
throws DataBackendException, Exception
{
Criteria criteria = new Criteria();
criteria.addSelectColumn(ROLE_ID);
criteria.add(NAME, role.getName());
List results = BasePeer.doSelect(criteria);
if (results.size() > 1)
{
throw new DataBackendException("Multiple roles named '"
+ role.getName() + "' exist!");
}
return (results.size() == 1);
}
/**
* Get the name of this table.
*
* @return A String with the name of the table.
*/
public static String getTableName()
{
return TABLE_NAME;
}
/**
* Returns the full name of a column.
*
* @param name name of a column
* @return A String with the full name of the column.
*/
public static String getColumnName (String name)
{
StringBuffer sb = new StringBuffer();
sb.append(TABLE_NAME);
sb.append(".");
sb.append(name);
return sb.toString();
}
}
1.1
jakarta-turbine-fulcrum/security/src/java/org/apache/fulcrum/security/spi/torque/turbine/peer/UserPeer.java
Index: UserPeer.java
===================================================================
package org.apache.fulcrum.security.spi.torque.turbine.peer;
/* ====================================================================
* The Apache Software License, Version 1.1
*
* Copyright (c) 2001-2003 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 Turbine" must not be used to endorse or promote products
* derived from this software without prior written permission. For
* written permission, please contact [EMAIL PROTECTED]
*
* 5. Products derived from this software may not be called "Apache",
* "Apache Turbine", 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/>.
*/
/**
* Peer classes for an User object need to implement this interface.
*
* The purpose of this class is to decouple DBSecurityService from
* the default User implementation and it's related Peer class.
*
* @author <a href="mailto:[EMAIL PROTECTED]">Leandro Rodrigo Saad Cruz</a>
* @version $Id: UserPeer.java,v 1.1 2003/08/25 01:04:00 epugh Exp $
*/
public interface UserPeer
{
/** The key name for the visitor id field. */
static String USERNAME = "LOGIN_NAME";
/** The key name for the username field. */
static String USER_ID = "USER_ID";
/**
* Returns the full name of a column.
*
* @param name name of a column
* @return A String with the full name of the column.
*/
String getFullColumnName(String name);
}
---------------------------------------------------------------------
To unsubscribe, e-mail: [EMAIL PROTECTED]
For additional commands, e-mail: [EMAIL PROTECTED]
