/* * $Header: /home/wistrand/cvs/knopflerfish.org/osgi/bundles/useradmin/src/org/osgi/service/useradmin/User.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; /** * A User role managed by a User Admin service. * *

In this context, the term "user" is not limited to just * human beings. * Instead, it refers to any entity that may have any number of * credentials associated with it that it may use to authenticate itself. *

* In general, Userobjects are associated with a specific User Admin * service (namely the one that created them), and cannot be used with other * User Admin services. *

* A Userobject may have credentials (and properties, inherited from the {@link Role}class) * associated with it. Specific {@link UserAdminPermission}objects are required to * read or change a User object's credentials. *

* Credentials are Dictionary objects and have semantics that are similar * to the properties in the Role class. * @version $Revision: 1.1.1.1 $ * @author Open Services Gateway Initiative */ public interface User extends Role { /** * Returns a Dictionary of the credentials of this User object. Any changes * to the returned Dictionary object will change the credentials of this User object. * This will cause a UserAdminEvent object of type * {@link UserAdminEvent#ROLE_CHANGED}to be broadcast to any * UserAdminListeners objects. * *

Only objects of type String may be used as credential keys, and only * objects of type String or of type byte[] * may be used as credential values. Any other types will cause an exception * of type IllegalArgumentException to be raised. * *

In order to retrieve a credential from the returned Dictionary object, * a {@link UserAdminPermission}named after the credential name (or * a prefix of it) with action getCredential is required. *

* In order to add or remove a credential from the returned Dictionary object, * a {@link UserAdminPermission}named after the credential name (or * a prefix of it) with action changeCredential is required. * * @return Dictionary object containing the credentials of this User object. */ public Dictionary getCredentials(); /** * Checks to see if this User object has a credential with the specified key * set to the specified value. * *

If the specified credential value is not of type String or * byte[], it is ignored, that is, false is returned * (as opposed to an IllegalArgumentException being raised). * * @param key The credential key. * @param value The credential value. * * @return true if this user has the specified credential; * false otherwise. * * @throws SecurityException If a security manager exists and the caller * does not have the UserAdminPermission named after the credential * key (or a prefix of it) with action getCredential. */ public boolean hasCredential(String key, Object value); }