001 //$HeadURL: svn+ssh://jwilden@svn.wald.intevation.org/deegree/base/branches/2.5_testing/src/org/deegree/security/drm/model/SecurableObject.java $
002 /*----------------------------------------------------------------------------
003 This file is part of deegree, http://deegree.org/
004 Copyright (C) 2001-2009 by:
005 Department of Geography, University of Bonn
006 and
007 lat/lon GmbH
008
009 This library is free software; you can redistribute it and/or modify it under
010 the terms of the GNU Lesser General Public License as published by the Free
011 Software Foundation; either version 2.1 of the License, or (at your option)
012 any later version.
013 This library is distributed in the hope that it will be useful, but WITHOUT
014 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
015 FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more
016 details.
017 You should have received a copy of the GNU Lesser General Public License
018 along with this library; if not, write to the Free Software Foundation, Inc.,
019 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
020
021 Contact information:
022
023 lat/lon GmbH
024 Aennchenstr. 19, 53177 Bonn
025 Germany
026 http://lat-lon.de/
027
028 Department of Geography, University of Bonn
029 Prof. Dr. Klaus Greve
030 Postfach 1147, 53001 Bonn
031 Germany
032 http://www.geographie.uni-bonn.de/deegree/
033
034 e-mail: info@deegree.org
035 ----------------------------------------------------------------------------*/
036 package org.deegree.security.drm.model;
037
038 import org.deegree.security.drm.SecurityRegistry;
039
040 /**
041 * Abstract superclass of objects that are securable, i.e. which carry
042 * information about which <code>Role</code>s have which <code>Right</code>s
043 * concerning these objects.
044 *
045 * @author <a href="mailto:mschneider@lat-lon.de">Markus Schneider</a>
046 * @version $Revision: 18195 $
047 */
048
049 public abstract class SecurableObject {
050
051 protected int id;
052 protected int type;
053 protected String name;
054 protected String title;
055 protected SecurityRegistry registry;
056
057
058 /**
059 * Returns the unique identifier of this <code>SecurableObject</code>.
060 */
061 public int getID () {
062 return id;
063 }
064
065 /**
066 * Returns the type of this <code>SecurableObject</code>.
067 * <p>
068 * NOTE: Unique in conjunction with name field.
069 *
070 */
071 public int getType() {
072 return type;
073 }
074
075 /**
076 * Returns the name of this <code>SecurableObject</code>.
077 * <p>
078 * NOTE: Unique in conjunction with type field.
079 *
080 */
081 public String getName() {
082 return name;
083 }
084
085 /**
086 * Returns the human readable name of this <code>SecurableObject</code>.
087 * <p>
088 * NOTE: This may not be unique.
089 *
090 */
091 public String getTitle() {
092 return title;
093 }
094
095 /**
096 * Indicates whether some other object is "equal to" this one.
097 *
098 * @param that
099 */
100 public boolean equals (Object that) {
101 if (that instanceof SecurableObject) {
102 return (((SecurableObject) that).getID () == getID ());
103 }
104 return false;
105 }
106
107 /**
108 * Returns a hash code value for the object. This method is supported
109 * for the benefit of hashtables such as those provided by
110 * java.util.Hashtable.
111 */
112 public int hashCode () {
113 return id;
114 }
115
116 /**
117 * Returns a <code>String</code> representation of this object.
118 */
119 public String toString () {
120 StringBuffer sb = new StringBuffer ("Id: ").
121 append (id).append (", Name: ").append (name);
122 return sb.toString ();
123 }
124 }