Files
narya/src/java/com/threerings/presents/server/InvocationException.java
T
Dave Hoover 7ee6ace683 Javadoc warnings cleanups.
Note: this involves generated code from a samskivert patch I only just sent to mdb,
but he's in a meeting, so that won't show up for a little.


git-svn-id: svn+ssh://src.earth.threerings.net/narya/trunk@5369 542714f4-19e9-0310-aa3c-eee0fc999fb1
2008-09-12 17:59:26 +00:00

75 lines
2.4 KiB
Java

//
// $Id$
//
// Narya library - tools for developing networked games
// Copyright (C) 2002-2007 Three Rings Design, Inc., All Rights Reserved
// http://www.threerings.net/code/narya/
//
// This library is free software; you can redistribute it and/or modify it
// under the terms of the GNU Lesser General Public License as published
// by the Free Software Foundation; either version 2.1 of the License, or
// (at your option) any later version.
//
// This library 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
// Lesser General Public License for more details.
//
// You should have received a copy of the GNU Lesser General Public
// License along with this library; if not, write to the Free Software
// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
package com.threerings.presents.server;
import com.threerings.util.MessageBundle;
import com.threerings.presents.data.ClientObject;
import com.threerings.presents.data.Permission;
/**
* Used to report failures when executing service requests.
*/
public class InvocationException extends Exception
{
/**
* Requires that the specified client have the specified permissions.
*
* @throws InvocationException if they do not.
*/
public static void requireAccess (ClientObject clobj, Permission perm, Object context)
throws InvocationException
{
String errmsg = clobj.checkAccess(perm, context);
if (errmsg != null) {
throw new InvocationException(errmsg);
}
}
/**
* A version of {@link #requireAccess(ClientObject,Permission,Object)} that takes no context.
*/
public static void requireAccess (ClientObject clobj, Permission perm)
throws InvocationException
{
requireAccess(clobj, perm, null);
}
/**
* Constructs an invocation exception with the supplied cause code string.
*/
public InvocationException (String cause)
{
super(cause);
}
/**
* Constructs an invocation exception with the supplied cause code
* string and qualifying message bundle. The error code will be
* qualified with the message bundle (see {@link MessageBundle#qualify}).
*/
public InvocationException (String bundle, String code)
{
this(MessageBundle.qualify(bundle, code));
}
}