2001-04-25 17:45:15 +02:00
|
|
|
/* GuardedObject.java -- An object protected by a Guard
|
2002-05-24 13:57:40 +02:00
|
|
|
Copyright (C) 1998, 2002 Free Software Foundation, Inc.
|
2001-04-25 17:45:15 +02:00
|
|
|
|
|
|
|
This file is part of GNU Classpath.
|
|
|
|
|
|
|
|
GNU Classpath is free software; you can redistribute it and/or modify
|
|
|
|
it under the terms of the GNU General Public License as published by
|
|
|
|
the Free Software Foundation; either version 2, or (at your option)
|
|
|
|
any later version.
|
|
|
|
|
|
|
|
GNU Classpath is distributed in the hope that it will be useful, but
|
|
|
|
WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
|
|
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
|
|
|
|
General Public License for more details.
|
|
|
|
|
|
|
|
You should have received a copy of the GNU General Public License
|
|
|
|
along with GNU Classpath; see the file COPYING. If not, write to the
|
|
|
|
Free Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA
|
|
|
|
02111-1307 USA.
|
|
|
|
|
2002-01-22 23:40:42 +01:00
|
|
|
Linking this library statically or dynamically with other modules is
|
|
|
|
making a combined work based on this library. Thus, the terms and
|
|
|
|
conditions of the GNU General Public License cover the whole
|
|
|
|
combination.
|
|
|
|
|
|
|
|
As a special exception, the copyright holders of this library give you
|
|
|
|
permission to link this library with independent modules to produce an
|
|
|
|
executable, regardless of the license terms of these independent
|
|
|
|
modules, and to copy and distribute the resulting executable under
|
|
|
|
terms of your choice, provided that you also meet, for each linked
|
|
|
|
independent module, the terms and conditions of the license of that
|
|
|
|
module. An independent module is a module which is not derived from
|
|
|
|
or based on this library. If you modify this library, you may extend
|
|
|
|
this exception to your version of the library, but you are not
|
|
|
|
obligated to do so. If you do not wish to do so, delete this
|
|
|
|
exception statement from your version. */
|
2001-04-25 17:45:15 +02:00
|
|
|
|
|
|
|
package java.security;
|
|
|
|
|
|
|
|
import java.io.Serializable;
|
2002-05-24 13:57:40 +02:00
|
|
|
import java.io.IOException;
|
|
|
|
import java.io.ObjectOutputStream;
|
2001-04-25 17:45:15 +02:00
|
|
|
|
|
|
|
/**
|
|
|
|
* This class is an object that is guarded by a <code>Guard</code> object.
|
2002-05-24 13:57:40 +02:00
|
|
|
* The object that is being guarded is retrieved by a call to the only
|
2001-04-25 17:45:15 +02:00
|
|
|
* method in this class - <code>getObject</code>. That method returns the
|
2002-05-24 13:57:40 +02:00
|
|
|
* guarded <code>Object</code> after first checking with the
|
2001-04-25 17:45:15 +02:00
|
|
|
* <code>Guard</code>. If the <code>Guard</code> disallows access, an
|
|
|
|
* exception will be thrown.
|
|
|
|
*
|
2002-05-24 13:57:40 +02:00
|
|
|
* @author Aaron M. Renn <arenn@urbanophile.com>
|
|
|
|
* @since 1.1
|
|
|
|
* @status updated to 1.4
|
2001-04-25 17:45:15 +02:00
|
|
|
*/
|
|
|
|
public class GuardedObject implements Serializable
|
|
|
|
{
|
2002-05-24 13:57:40 +02:00
|
|
|
/**
|
|
|
|
* Compatible with JDK 1.1+.
|
|
|
|
*/
|
|
|
|
private static final long serialVersionUID = -5240450096227834308L;
|
|
|
|
|
2001-04-25 17:45:15 +02:00
|
|
|
/**
|
|
|
|
* This is the Guard that is protecting the object.
|
2002-05-24 13:57:40 +02:00
|
|
|
*
|
|
|
|
* @serial the guard
|
2001-04-25 17:45:15 +02:00
|
|
|
*/
|
2002-05-24 13:57:40 +02:00
|
|
|
private final Guard guard;
|
2001-04-25 17:45:15 +02:00
|
|
|
|
|
|
|
/**
|
|
|
|
* This is the object that is being guarded.
|
2002-05-24 13:57:40 +02:00
|
|
|
*
|
|
|
|
* @serial the protected object
|
2001-04-25 17:45:15 +02:00
|
|
|
*/
|
2002-05-24 13:57:40 +02:00
|
|
|
private final Object object;
|
2001-04-25 17:45:15 +02:00
|
|
|
|
|
|
|
/**
|
|
|
|
* This method initializes a new instance of <code>GuardedObject</code>
|
|
|
|
* that protects the specified <code>Object</code> using the specified
|
2002-05-24 13:57:40 +02:00
|
|
|
* <code>Guard</code>. A null guard means there are no restrictions on
|
|
|
|
* accessing the object.
|
2001-04-25 17:45:15 +02:00
|
|
|
*
|
2002-05-24 13:57:40 +02:00
|
|
|
* @param object the <code>Object</code> to guard
|
|
|
|
* @param guard the <code>Guard</code> that is protecting the object
|
2001-04-25 17:45:15 +02:00
|
|
|
*/
|
|
|
|
public GuardedObject(Object object, Guard guard)
|
|
|
|
{
|
|
|
|
this.object = object;
|
|
|
|
this.guard = guard;
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
2002-05-24 13:57:40 +02:00
|
|
|
* This method first call the <code>checkGuard</code> method on the
|
|
|
|
* <code>Guard</code> object protecting the guarded object. If the
|
2001-04-25 17:45:15 +02:00
|
|
|
* <code>Guard</code> disallows access, an exception is thrown, otherwise
|
|
|
|
* the <code>Object</code> is returned.
|
|
|
|
*
|
|
|
|
* @return The object being guarded
|
2002-05-24 13:57:40 +02:00
|
|
|
* @throws SecurityException if access is denied
|
|
|
|
*/
|
|
|
|
public Object getObject()
|
|
|
|
{
|
|
|
|
if (guard != null)
|
|
|
|
guard.checkGuard(object);
|
|
|
|
return object;
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Ensures that serialization is legal, by checking the guard.
|
2001-04-25 17:45:15 +02:00
|
|
|
*
|
2002-05-24 13:57:40 +02:00
|
|
|
* @param s the stream to write to
|
|
|
|
* @throws IOException if the underlying stream fails
|
2001-04-25 17:45:15 +02:00
|
|
|
*/
|
2002-05-24 13:57:40 +02:00
|
|
|
private void writeObject(ObjectOutputStream s) throws IOException
|
2001-04-25 17:45:15 +02:00
|
|
|
{
|
2002-05-24 13:57:40 +02:00
|
|
|
if (guard != null)
|
|
|
|
guard.checkGuard(object);
|
|
|
|
s.defaultWriteObject();
|
2001-04-25 17:45:15 +02:00
|
|
|
}
|
2002-05-24 13:57:40 +02:00
|
|
|
} // class GuardedObject
|