Michael Bayne
591dc1541a
easily make use of different permission policies in different circumstances (one can imagine a hypothetical partner who has different access control requirements, perhaps). git-svn-id: svn+ssh://src.earth.threerings.net/narya/trunk@5118 542714f4-19e9-0310-aa3c-eee0fc999fb1
116 lines
2.9 KiB
Java
116 lines
2.9 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.crowd.data;
|
|
|
|
import com.threerings.io.SimpleStreamableObject;
|
|
|
|
/**
|
|
* Defines access control tokens that convey certain privileges to users.
|
|
*
|
|
* @see CrowdPermissionPolicy
|
|
*/
|
|
public class TokenRing extends SimpleStreamableObject
|
|
{
|
|
/** Indicates that this user is an administrator. */
|
|
public static final int ADMIN = (1 << 0);
|
|
|
|
/**
|
|
* A default constructor, used when unserializing token rings.
|
|
*/
|
|
public TokenRing ()
|
|
{
|
|
}
|
|
|
|
/**
|
|
* Constructs a token ring with the supplied set of tokens.
|
|
*/
|
|
public TokenRing (int tokens)
|
|
{
|
|
_tokens = tokens;
|
|
}
|
|
|
|
/**
|
|
* Returns true if this token ring contains the specified token or tokens, exactly. For
|
|
* example, if you pass in the OR of two or more tokens, then the ring must contain all of
|
|
* those tokens.
|
|
*/
|
|
public boolean holdsToken (int token)
|
|
{
|
|
return (_tokens & token) == token;
|
|
}
|
|
|
|
/**
|
|
* Returns true if this token ring contains any one of the specified tokens.
|
|
*/
|
|
public boolean holdsAnyToken (int tokens)
|
|
{
|
|
return (_tokens & tokens) != 0;
|
|
}
|
|
|
|
/**
|
|
* Convenience function for checking whether this ring holds the {@link #ADMIN} token.
|
|
*/
|
|
public boolean isAdmin ()
|
|
{
|
|
return holdsToken(ADMIN);
|
|
}
|
|
|
|
/**
|
|
* Returns the bitmask that stores the various tokens.
|
|
*/
|
|
public int getTokens ()
|
|
{
|
|
return _tokens;
|
|
}
|
|
|
|
/**
|
|
* Set the specified token to be on or off.
|
|
*/
|
|
public void setToken (int token, boolean on)
|
|
{
|
|
if (on) {
|
|
setToken(token);
|
|
} else {
|
|
clearToken(token);
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Adds the specified token to this ring.
|
|
*/
|
|
public void setToken (int token)
|
|
{
|
|
_tokens |= token;
|
|
}
|
|
|
|
/**
|
|
* Clears the specified token from this ring.
|
|
*/
|
|
public void clearToken (int token)
|
|
{
|
|
_tokens &= ~token;
|
|
}
|
|
|
|
/** The tokens contained in this ring (composed together bitwise). */
|
|
protected int _tokens;
|
|
}
|