org.apache.turbine.om.security.peer
Class RolePeer

java.lang.Object
  |
  +--org.apache.turbine.om.peer.BasePeer
        |
        +--org.apache.turbine.om.security.peer.RolePeer

public class RolePeer
extends BasePeer

This class handles all the database access for the ROLE table. This table contains all the roles that a given member can play.

Version:
$Id$
Author:
Frank Y. Kim, John D. McNally, Brett McLaughlin

Field Summary
private static TurbineMapBuilder mapBuilder
           
static java.lang.String NAME
          The column name for the name field.
static java.lang.String OBJECTDATA
          The column name for the ObjectData field
static java.lang.String ROLE_ID
          The column name for the role id field.
private static java.lang.String SEQUENCE_NAME
          The Oracle sequence name for this peer.
private static java.lang.String TABLE_NAME
          The table name for this peer.
 
Fields inherited from class org.apache.turbine.om.peer.BasePeer
DEFAULT_MAP_BUILDER, IGNORE_CASE, mapBuilders, ORDER_BY
 
Constructor Summary
RolePeer()
           
 
Method Summary
static Criteria buildCriteria(Role role)
          Builds a criteria object based upon an Role object
static boolean checkExists(Role role)
          Checks if a Role is defined in the system.
static java.util.Vector doSelect(Criteria criteria)
          Issues a select based on a criteria.
static void doUpdate(Criteria criteria)
          Issues an update based on a criteria.
static java.lang.String getColumnName(java.lang.String name)
          Returns the full name of a column.
static java.lang.String getTableName()
          Get the name of this table.
static RoleSet retrieveSet(Criteria criteria)
          Retrieves/assembles a RoleSet based on the Criteria passed in
static RoleSet retrieveSet(User user, Group group)
          Retrieves a set of Roles that an User was assigned in a Group
 
Methods inherited from class org.apache.turbine.om.peer.BasePeer
beginTransaction, commitTransaction, createPreparedStatement, createQueryString, deleteAll, deleteAll, doDelete, doDelete, doInsert, doInsert, doPSSelect, doPSSelect, doSelect, doUpdate, doUpdate, doUpdate, executeQuery, executeQuery, executeQuery, executeQuery, executeQuery, executeQuery, executeStatement, executeStatement, executeStatement, getMapBuilder, getMapBuilder, getPrimaryKey, getSelectResults, getSelectResults, getSelectResults, getSelectResults, handleMultiple, handleMultipleRecords, hashtableToByteArray, initColumnNames, initCriteriaKeys, initTableColumns, initTableSchema, initTableSchema, insertOrUpdateRecord, rollBackTransaction
 
Methods inherited from class java.lang.Object
, clone, equals, finalize, getClass, hashCode, notify, notifyAll, registerNatives, toString, wait, wait, wait
 

Field Detail

mapBuilder

private static final TurbineMapBuilder mapBuilder

TABLE_NAME

private static final java.lang.String TABLE_NAME
The table name for this peer.

ROLE_ID

public static final java.lang.String ROLE_ID
The column name for the role id field.

NAME

public static final java.lang.String NAME
The column name for the name field.

OBJECTDATA

public static final java.lang.String OBJECTDATA
The column name for the ObjectData field

SEQUENCE_NAME

private static final java.lang.String SEQUENCE_NAME
The Oracle sequence name for this peer.
Constructor Detail

RolePeer

public RolePeer()
Method Detail

retrieveSet

public static RoleSet retrieveSet(Criteria criteria)
                           throws java.lang.Exception
Retrieves/assembles a RoleSet based on the Criteria passed in

retrieveSet

public static RoleSet retrieveSet(User user,
                                  Group group)
                           throws java.lang.Exception
Retrieves a set of Roles that an User was assigned in a Group
Parameters:
user - An user.
group - A group
Returns:
A Set of Roles of this User in the Group
Throws:
Exception, - a generic exception.

doSelect

public static java.util.Vector doSelect(Criteria criteria)
                                 throws java.lang.Exception
Issues a select based on a criteria.
Parameters:
Criteria - object containing data that is used to create the SELECT statement.
Returns:
Vector containing Role objects.
Throws:
Exception, - a generic exception.

buildCriteria

public static Criteria buildCriteria(Role role)
Builds a criteria object based upon an Role object

doUpdate

public static void doUpdate(Criteria criteria)
                     throws java.lang.Exception
Issues an update based on a criteria.
Parameters:
Criteria - object containing data that is used to create the UPDATE statement.
Throws:
Exception, - a generic exception.

checkExists

public static boolean checkExists(Role role)
                           throws DataBackendException,
                                  java.lang.Exception
Checks if a Role is defined in the system. The name is used as query criteria.
Parameters:
permission - The Role to be checked.
Returns:
true if given Role exists in the system.
Throws:
DataBackendException - when more than one Role with the same name exists.
Exception, - a generic exception.

getTableName

public static java.lang.String getTableName()
Get the name of this table.
Returns:
A String with the name of the table.

getColumnName

public static java.lang.String getColumnName(java.lang.String name)
Returns the full name of a column.
Returns:
A String with the full name of the column.


Copyright © 1999-2001 Apache Software Foundation. All Rights Reserved.