1 /*

     2  * Copyright 2001-2003 Sun Microsystems, Inc.  All Rights Reserved.

     3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.

     4  *

     5  * This code is free software; you can redistribute it and/or modify it

     6  * under the terms of the GNU General Public License version 2 only, as

     7  * published by the Free Software Foundation.  Sun designates this

     8  * particular file as subject to the "Classpath" exception as provided

     9  * by Sun in the LICENSE file that accompanied this code.

    10  *

    11  * This code is distributed in the hope that it will be useful, but WITHOUT

    12  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or

    13  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License

    14  * version 2 for more details (a copy is included in the LICENSE file that

    15  * accompanied this code).

    16  *

    17  * You should have received a copy of the GNU General Public License version

    18  * 2 along with this work; if not, write to the Free Software Foundation,

    19  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.

    20  *

    21  * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,

    22  * CA 95054 USA or visit www.sun.com if you need additional information or

    23  * have any questions.

    24  */

    25 

    26 package com.sun.jmx.snmp;

    27 

    28 

    29 // java import

    30 //

    31 import java.util.Enumeration;

    32 import java.net.InetAddress;

    33 

    34 /**

    35  * Defines the user based ACL used by the SNMP protocol adaptor.

    36  * <p>

    37  * <p><b>This API is a Sun Microsystems internal API  and is subject

    38  * to change without notice.</b></p>

    39  * @since 1.5

    40  */

    41 

    42 public interface UserAcl {

    43 

    44     /**

    45      * Returns the name of the ACL.

    46      *

    47      * @return The name of the ACL.

    48      */

    49     public String getName();

    50 

    51     /**

    52      * Checks whether or not the specified user has <CODE>READ</CODE> access.

    53      *

    54      * @param user The user name to check.

    55      *

    56      * @return <CODE>true</CODE> if the host has read permission, <CODE>false</CODE> otherwise.

    57      */

    58     public boolean checkReadPermission(String user);

    59 

    60     /**

    61      * Checks whether or not the specified user and context name have <CODE>READ</CODE> access.

    62      *

    63      * @param user The user name to check.

    64      * @param contextName The context name associated with the user.

    65      * @param securityLevel The request security level.

    66      * @return <CODE>true</CODE> if the pair (user, context) has read permission, <CODE>false</CODE> otherwise.

    67      */

    68     public boolean checkReadPermission(String user, String contextName, int securityLevel);

    69 

    70     /**

    71      * Checks whether or not a context name is defined.

    72      *

    73      * @param contextName The context name to check.

    74      *

    75      * @return <CODE>true</CODE> if the context is known, <CODE>false</CODE> otherwise.

    76      */

    77     public boolean checkContextName(String contextName);

    78 

    79     /**

    80      * Checks whether or not the specified user has <CODE>WRITE</CODE> access.

    81      *

    82      * @param user The user to check.

    83      *

    84      * @return <CODE>true</CODE> if the user has write permission, <CODE>false</CODE> otherwise.

    85      */

    86     public boolean checkWritePermission(String user);

    87 

    88     /**

    89      * Checks whether or not the specified user and context name have <CODE>WRITE</CODE> access.

    90      *

    91      * @param user The user name to check.

    92      * @param contextName The context name associated with the user.

    93      * @param securityLevel The request security level.

    94      * @return <CODE>true</CODE> if the pair (user, context) has write permission, <CODE>false</CODE> otherwise.

    95      */

    96     public boolean checkWritePermission(String user, String contextName, int securityLevel);

    97 }