/*_############################################################################
  _## 
  _##  SNMP4J - SecurityProtocol.java  
  _## 
  _##  Copyright (C) 2003-2026  Frank Fock (SNMP4J.org)
  _##  
  _##  Licensed under the Apache License, Version 2.0 (the "License");
  _##  you may not use this file except in compliance with the License.
  _##  You may obtain a copy of the License at
  _##  
  _##      http://www.apache.org/licenses/LICENSE-2.0
  _##  
  _##  Unless required by applicable law or agreed to in writing, software
  _##  distributed under the License is distributed on an "AS IS" BASIS,
  _##  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  _##  See the License for the specific language governing permissions and
  _##  limitations under the License.
  _##  
  _##########################################################################*/
package org.snmp4j.security;

import java.io.Serializable;
import org.snmp4j.smi.OID;

/**
 * The {@code SecurityProtocol} class defines common methods of
 * authentication and privacy protocols.
 *
 * @author Frank Fock
 * @author Jochen Katz
 * @version 2.6.0
 */
public interface SecurityProtocol extends Serializable {

    /**
     * Gets the OID uniquely identifying the privacy protocol.
     * @return
     *    an {@code OID} instance.
     */
    OID getID();

    /**
     * Checks whether this security protocol is actually supported by this Java runtime environment.
     * @return
     *    {@code true} if this security protocol is supported, {@code false} otherwise.
     * @since 2.5.0
     */
    boolean isSupported();

    /**
     * Get the maximum length of the key in bytes for this security protocol.
     * @return
     *    the (maximum) length of the security protocols key.
     * @since 2.6.0
     */
    int getMaxKeyLength();

}

