1 /*
   2  * Copyright (c) 2001, 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 import com.sun.jmx.snmp.SnmpStatusException;
  27 import com.sun.jmx.snmp.SnmpTooBigException;
  28 
  29 /**
  30  * Security parameters are security model dependent. Every security parameters class wishing to be passed to a security model must implement this marker interface.
  31  * This interface has to be implemented when developing customized security models.
  32  * <p><b>This API is a Sun Microsystems internal API  and is subject
  33  * to change without notice.</b></p>
  34  * @since 1.5
  35  */
  36 public interface SnmpSecurityParameters {
  37     /**
  38      * BER encoding of security parameters.
  39      * @param outputBytes Array to fill.
  40      * @return Encoded parameters length.
  41      */
  42     int encode(byte[] outputBytes) throws SnmpTooBigException;
  43     /**
  44      * BER decoding of security parameters.
  45      * @param params Encoded parameters.
  46      */
  47     void decode(byte[] params) throws SnmpStatusException;
  48 
  49     /**
  50      * Principal coded inside the security parameters.
  51      * @return The security principal.
  52      */
  53     String getPrincipal();
  54 }