org.apache.turbine.om.security
Class SecurityObject

java.lang.Object
  |
  +--org.apache.turbine.om.BaseObject
        |
        +--org.apache.turbine.om.security.SecurityObject
All Implemented Interfaces:
java.lang.Comparable, Persistent, java.io.Serializable
Direct Known Subclasses:
TurbineGroup, TurbinePermission, TurbineRole, TurbineUser

public abstract class SecurityObject
extends BaseObject
implements java.lang.Comparable

This class represents a generic object used in the Access Control Lists.

Version:
$Id: SecurityObject.java,v 1.1.1.1 2001/08/16 05:08:42 jvanzyl Exp $
Author:
Frank Y. Kim, John D. McNally, Brett McLaughlin, Rafal Krzewski
See Also:
Serialized Form

Field Summary
private  java.util.Map attributes
          The attributes of this object.
private  java.lang.String name
          The name of this object.
 
Fields inherited from class org.apache.turbine.om.BaseObject
errMsg, is_new, modified, NEW_ID, primaryKey
 
Constructor Summary
SecurityObject()
          Constructs a new SecurityObject
SecurityObject(java.lang.String name)
          Constructs a new SecurityObject with the specified name.
 
Method Summary
 int compareTo(java.lang.Object obj)
          Used for ordering SecurityObjects.
 java.lang.Object getAttribute(java.lang.String name)
          Retrieves the value of specific attribute of this object.
 java.util.Map getAttributes()
          Returns a Map containing this object's attributes.
 java.lang.String getName()
          Returns the name of this object.
 void setAttribute(java.lang.String name, java.lang.Object value)
          Sets the value of specific attribute of this object.
 void setAttributes(java.util.Map attributes)
          Replaces this object's attributes with the specified Map.
 void setName(java.lang.String name)
          Sets the name of this object.
 java.lang.String toString()
          Returns a textual representation of this object, consisted by it's name and attributes.
 
Methods inherited from class org.apache.turbine.om.BaseObject
equals, equals, getByName, getByPeerName, getByPosition, getPrimaryKey, getPrimaryKeyAsBigDecimal, getPrimaryKeyAsInt, getPrimaryKeyAsLong, getPrimaryKeyAsString, hashCode, isModified, isNew, resetModified, save, save, save, setModified, setNew, setPrimaryKey, setPrimaryKey, setPrimaryKey, setPrimaryKey, setPrimaryKey
 
Methods inherited from class java.lang.Object
, clone, finalize, getClass, notify, notifyAll, registerNatives, wait, wait, wait
 

Field Detail

name

private java.lang.String name
The name of this object.

attributes

private java.util.Map attributes
The attributes of this object.
Constructor Detail

SecurityObject

public SecurityObject()
Constructs a new SecurityObject

SecurityObject

public SecurityObject(java.lang.String name)
Constructs a new SecurityObject with the specified name.
Parameters:
name - The name of the new object.
Method Detail

getAttributes

public java.util.Map getAttributes()
Returns a Map containing this object's attributes.
Returns:
the object's attributes.

setAttributes

public void setAttributes(java.util.Map attributes)
Replaces this object's attributes with the specified Map.
Parameters:
attributes - The new attributes of the object.

getAttribute

public java.lang.Object getAttribute(java.lang.String name)
Retrieves the value of specific attribute of this object.
Parameters:
name - the name of the attribute
Returns:
the value of the attribute

setAttribute

public void setAttribute(java.lang.String name,
                         java.lang.Object value)
Sets the value of specific attribute of this object.
Parameters:
name - the name of the attribute
Returns:
the value of the attribute

getName

public java.lang.String getName()
Returns the name of this object.
Returns:
The name of the object.

setName

public void setName(java.lang.String name)
Sets the name of this object.
Parameters:
name - The name of the object.

compareTo

public int compareTo(java.lang.Object obj)
Used for ordering SecurityObjects.
Specified by:
compareTo in interface java.lang.Comparable
Parameters:
obj - The Object to compare to.
Returns:
-1 if the name of the other object is lexically greater than this group, 1 if it is lexically lesser, 0 if they are equal.

toString

public java.lang.String toString()
Returns a textual representation of this object, consisted by it's name and attributes.
Overrides:
toString in class java.lang.Object
Returns:
a textual representation of this group.


Copyright © 2000-2002 Apache Software Foundation. All Rights Reserved.