role.java

OSGI这是一个中间件,与UPNP齐名,是用于移植到嵌入式平台之上

/*
 * $Header: /home/wistrand/cvs/knopflerfish.org/osgi/bundles/useradmin/src/org/osgi/service/useradmin/Role.java,v 1.1.1.1 2004/03/05 20:35:16 wistrand Exp $
 *
 * Copyright (c) The Open Services Gateway Initiative (2001).
 * All Rights Reserved.
 *
 * Implementation of certain elements of the Open Services Gateway Initiative
 * (OSGI) Specification may be subject to third party intellectual property
 * rights, including without limitation, patent rights (such a third party may
 * or may not be a member of OSGi). OSGi is not responsible and shall not be
 * held responsible in any manner for identifying or failing to identify any or
 * all such third party intellectual property rights.
 *
 * This document and the information contained herein are provided on an "AS
 * IS" basis and OSGI DISCLAIMS ALL WARRANTIES, EXPRESS OR IMPLIED, INCLUDING
 * BUT NOT LIMITED TO ANY WARRANTY THAT THE USE OF THE INFORMATION HEREIN WILL
 * NOT INFRINGE ANY RIGHTS AND ANY IMPLIED WARRANTIES OF MERCHANTABILITY OR
 * FITNESS FOR A PARTICULAR PURPOSE. IN NO EVENT WILL OSGI BE LIABLE FOR ANY
 * LOSS OF PROFITS, LOSS OF BUSINESS, LOSS OF USE OF DATA, INTERRUPTION OF
 * BUSINESS, OR FOR DIRECT, INDIRECT, SPECIAL OR EXEMPLARY, INCIDENTIAL,
 * PUNITIVE OR CONSEQUENTIAL DAMAGES OF ANY KIND IN CONNECTION WITH THIS
 * DOCUMENT OR THE INFORMATION CONTAINED HEREIN, EVEN IF ADVISED OF THE
 * POSSIBILITY OF SUCH LOSS OR DAMAGE.
 *
 * All Company, brand and product names may be trademarks that are the sole
 * property of their respective owners. All rights reserved.
 */

package org.osgi.service.useradmin;

import java.util.Dictionary;

/**
 * The base interface for <tt>Role</tt> objects managed by the User Admin
 * service.
 * 
 * <p>
 * This interface exposes the characteristics shared by all <tt>Role</tt>
 * classes: a name, a type, and a set of properties.
 * <p>
 * Properties represent public information about the <tt>Role</tt> object that
 * can be read by anyone. Specific {@link UserAdminPermission}objects are
 * required to change a <tt>Role</tt> object's properties.
 * <p>
 * <tt>Role</tt> object properties are <tt>Dictionary</tt> objects. Changes
 * to these objects are propagated to the User Admin service and made
 * persistent.
 * <p>
 * Every User Admin service contains a set of predefined <tt>Role</tt> objects
 * that are always present and cannot be removed. All predefined <tt>Role</tt>
 * objects are of type <tt>ROLE</tt>. This version of the
 * <tt>org.osgi.service.useradmin</tt> package defines a single predefined
 * role named &quot;user.anyone&quot;, which is inherited by any other role.
 * Other predefined roles may be added in the future. Since
 * &quot;user.anyone&quot; is a <tt>Role</tt> object that has properties
 * associated with it that can be read and modified. Access to these properties
 * and their use is application specific and is controlled using
 * <tt>UserAdminPermission</tt> in the same way that properties for other
 * <tt>Role</tt> objects are.
 * 
 * @version $Revision: 1.1.1.1 $
 * @author Open Services Gateway Initiative
 */

public interface Role {

    /**
     * The type of a predefined role.
     * 
     * <p>
     * The value of <tt>ROLE</tt> is 0.
     */
    public static final int ROLE = 0;

    /**
     * The type of a {@link User}role.
     * 
     * <p>
     * The value of <tt>USER</tt> is 1.
     */
    public static final int USER = 1;

    /**
     * The type of a {@link Group}role.
     * 
     * <p>
     * The value of <tt>GROUP</tt> is 2.
     */
    public static final int GROUP = 2;

    /**
     * Returns the name of this role.
     * 
     * @return The role's name.
     */
    public String getName();

    /**
     * Returns the type of this role.
     * 
     * @return The role's type.
     */
    public int getType();

    /**
     * Returns a <tt>Dictionary</tt> of the (public) properties of this
     * <tt>Role</tt> object. Any changes to the returned <tt>Dictionary</tt>
     * will change the properties of this <tt>Role</tt> object. This will
     * cause a <tt>UserAdminEvent</tt> object of type
     * {@link UserAdminEvent#ROLE_CHANGED}to be broadcast to any
     * <tt>UserAdminListener</tt> objects.
     * 
     * <p>
     * Only objects of type <tt>String</tt> may be used as property keys, and
     * only objects of type <tt>String</tt> or <tt>byte[]</tt> may be used
     * as property values. Any other types will cause an exception of type
     * <tt>IllegalArgumentException</tt> to be raised.
     * 
     * <p>
     * In order to add, change, or remove a property in the returned
     * <tt>Dictionary</tt>, a {@link UserAdminPermission}named after the
     * property name (or a prefix of it) with action <code>changeProperty</code>
     * is required.
     * 
     * @return <tt>Dictionary</tt> containing the properties of this
     *         <tt>Role</tt> object.
     */
    public Dictionary getProperties();
}