Overview | Package | Class | Use | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

## org.apache.turbine.om.security
Class TurbinePermission

    java.lang.Object
      org.apache.turbine.om.security.SecurityObject<Permission>
          org.apache.turbine.om.security.TurbinePermission

All Implemented Interfaces:
  Serializable, Comparable<Permission>, Permission, SecurityEntity

    public class TurbinePermission

extends SecurityObject<Permission>
implements Permission

This class represents the permissions that a Role has to access certain pages/functions within the system. The class implements Comparable so that when Permissions are added to a Set, they will be in alphabetical order by name.

Version:
  $Id: TurbinePermission.java 1078552 2011-03-06 19:58:46Z tv $
Author:
  Frank Y. Kim, John D. McNally, Brett McLaughlin
See Also:
  Serialized Form

Constructor Summary
`TurbinePermission()` Constructs a new TurbinePermission.
`TurbinePermission(String name)` Constructs a new TurbinePermission with the sepcified name.

Method Summary
`void` | `remove()` Removes a permission from the system.
`void` | `rename(String name)` Renames the permission.
`void` | `save()` Makes changes made to the Permission attributes permanent.
`void` | `save(Connection conn)` not implemented
`void` | `save(String dbname)` not implemented

Methods inherited from class org.apache.turbine.om.security.SecurityObject
`compareTo, getAttribute, getAttributes, getId, getIdAsObj, getName, setAttribute, setAttributes, setId, setName, toString`

Methods inherited from class java.lang.Object
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait`

Methods inherited from interface org.apache.turbine.om.security.SecurityEntity
`getId, getIdAsObj, getName, setId, setName`

Constructor Detail

### TurbinePermission

    public TurbinePermission()

  Constructs a new TurbinePermission.

### TurbinePermission

    public TurbinePermission(String name)

  Constructs a new TurbinePermission with the sepcified name.

  Parameters:
    `name` - The name of the new object.

Method Detail

### save

    public void save()
              throws TurbineSecurityException

  Makes changes made to the Permission attributes permanent.

  Specified by:
    `save` in interface `Permission`
  Throws:
    `TurbineSecurityException` - if there is a problem while saving data.

### save

    public void save(Connection conn)
              throws Exception

  not implemented

  Parameters:
    `conn` -
  Throws:
    `Exception`

### save

    public void save(String dbname)
              throws Exception

  not implemented

  Parameters:
    `dbname` -
  Throws:
    `Exception`

### remove

    public void remove()
                throws TurbineSecurityException

  Removes a permission from the system.

  Specified by:
    `remove` in interface `Permission`
  Throws:
    `TurbineSecurityException` - if the Permission could not be removed.

### rename

    public void rename(String name)
                throws TurbineSecurityException

  Renames the permission.

  Specified by:
    `rename` in interface `Permission`
  Parameters:
    `name` - The new Permission name.
  Throws:
    `TurbineSecurityException` - if the Permission could not be renamed.

Overview | Package | Class | Use | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

Copyright © 2000-2011 The Apache Software Foundation. All Rights Reserved.