protocols/bgp/bgpio/src/main/java/org/onosproject/bgpio/protocol/BgpFactory.java

/*
 * Copyright 2015-present Open Networking Laboratory
 *
 * 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.bgpio.protocol;

/**
 * Abstraction of an message factory providing builder functions to BGP messages
 * and objects.
 *
 */
public interface BgpFactory {

    /**
     * Gets the builder object for a open message.
     *
     * @return builder object for open message
     */
    BgpOpenMsg.Builder openMessageBuilder();

    /**
     * Gets the builder object for a keepalive message.
     *
     * @return builder object for keepalive message
     */
    BgpKeepaliveMsg.Builder keepaliveMessageBuilder();

    /**
     * Gets the builder object for a notification message.
     *
     * @return builder object for notification message.
     */
    BgpNotificationMsg.Builder notificationMessageBuilder();

    /**
     * Gets the builder object for a update message.
     *
     * @return builder object for update message
     */
    BgpUpdateMsg.Builder updateMessageBuilder();

    /**
     * Gets the BGP message reader.
     *
     * @return BGP message reader
     */
    BgpMessageReader<BgpMessage> getReader();

    /**
     * Returns BGP version.
     *
     * @return BGP version
     */
    BgpVersion getVersion();
}