apps/bgpmonitoring/api/src/main/java/org/onosproject/bgpmonitoring/TerminationMessage.java

/*
 * Copyright 2024-present Open Networking Foundation
 *
 * 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.onosproject.bgpmonitoring;


/**
 * Abstraction of an BMP termination message.
 */
public abstract class TerminationMessage extends BmpMessage {

    public static final int TERMINATION_HEADER_MIN_LENGTH = 4;

    /**
     * Returns BMP session termination type.
     *
     * @return BMP session termination type
     */
    public abstract TerminationType getTerminationType();

    /**
     * Returns BMP session termination message length.
     *
     * @return BMP session termination message length
     */
    public abstract int getInformationLength();

    /**
     * Returns BMP session termination message.
     *
     * @return BMP session termination message
     */
    public abstract String getInformation();

}