1 /*

     2  * Copyright (c) 2002, 2003, Oracle and/or its affiliates. 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.  Oracle designates this

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

     9  * by Oracle 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 Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA

    22  * or visit www.oracle.com if you need additional information or have any

    23  * questions.

    24  */

    25 package com.sun.jmx.snmp;

    26 

    27 /**

    28  * This <CODE>SnmpEngineFactory</CODE> is instantiating an <CODE>SnmpEngine</CODE> containing :

    29  * <ul>

    30  * <li> Message Processing Sub System + V1, V2 et V3 Message Processing Models</li>

    31  * <li> Security Sub System + User based Security Model (Id 3)</li>

    32  * <li> Access Control Sub System + Ip Acl + User based Access Control Model. See <CODE> IpAcl </CODE> and <CODE> UserAcl </CODE>.</li>

    33  * </ul>

    34  *

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

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

    37  * @since 1.5

    38  */

    39 public interface SnmpEngineFactory {

    40     /**

    41      * The engine instantiation method.

    42      * @param p The parameters used to instantiate a new engine.

    43      * @throws IllegalArgumentException Throwed if one of the configuration file file doesn't exist (Acl files, security file).

    44      * @return The newly created SnmpEngine.

    45      */

    46     public SnmpEngine createEngine(SnmpEngineParameters p);

    47 

    48     /**

    49      * The engine instantiation method.

    50      * @param p The parameters used to instantiate a new engine.

    51      * @param ipacl The Ip ACL to pass to the Access Control Model.

    52      * @throws IllegalArgumentException Throwed if one of the configuration

    53      *         file file doesn't exist (Acl files, security file).

    54      * @return The newly created SnmpEngine.

    55      */

    56     public SnmpEngine createEngine(SnmpEngineParameters p,

    57                                    InetAddressAcl ipacl);

    58 }