PcepError.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.pcepio.protocol;

import java.util.List;

import org.jboss.netty.buffer.ChannelBuffer;
import org.onosproject.pcepio.exceptions.PcepParseException;

/**
 * Abstraction of an entity which provides PCEP error for PCEP error message.
 */
public interface PcepError {

    /**
     * Returns the PcepRPObject List.
     *
     * @return list of type PcepRPObject
     */
    List<PcepRPObject> getRPObjList();

    /**
     * Sets the RP Objects lists.
     *
     * @param rpObjList list of type PcepRPObject
     */
    void setRPObjList(List<PcepRPObject> rpObjList);

    /**
     * Returns the PcepLSObject List.
     *
     * @return list of type PcepLSObject
     */
    List<PcepLSObject> getLSObjList();

    /**
     * Sets the LS Objects lists.
     *
     * @param lsObjList list of type PcepLSObject
     */
    void setLSObjList(List<PcepLSObject> lsObjList);

    /**
     * Returns the PcepErrorObject.
     *
     * @return list of type PcepErrorObject
     */
    List<PcepErrorObject> getErrorObjList();

    /**
     * Sets the Error Objects lists.
     *
     * @param errorObjList list of type PcepErrorObject
     */
    void setErrorObjList(List<PcepErrorObject> errorObjList);

    /**
     * Writes the byte stream of PCEP error to the channel buffer.
     *
     * @param bb of type channel buffer
     * @return object length index
     * @throws PcepParseException while writing Error part into ChannelBuffer
     */
    int write(ChannelBuffer bb) throws PcepParseException;

    /**
     * Builder interface with get and set functions to build PcepError.
     */
    interface Builder {

        /**
         * Builds PcepError Object.
         *
         * @return PcepError Object
         */
        PcepError build();

        /**
         * Returns the PcepRPObject.
         *
         * @return list of type PcepRPObject
         */
        List<PcepRPObject> getRPObjList();

        /**
         * Sets RP Object lists and returns its builder.
         *
         * @param rpObjList list of type PcepRpObject
         * @return builder by setting Linked list of RP Object
         */
        Builder setRPObjList(List<PcepRPObject> rpObjList);

        /**
         * Returns the PcepLSObject.
         *
         * @return lsObjList of type PcepLSObject
         */
        List<PcepLSObject> getLSObjList();

        /**
         * Sets LS Object lists and returns its builder.
         *
         * @param lsObjList list of type PcepLSObject
         * @return builder by setting list of type PcepLSObject
         */
        Builder setLSObjList(List<PcepLSObject> lsObjList);

        /**
         * Returns the PcepErrorObject.
         *
         * @return list of type PcepErrorObject
         */
        List<PcepErrorObject> getErrorObjList();

        /**
         * Sets Error Object lists and returns its builder.
         *
         * @param errorObjList list of type PcepErrorObject
         * @return builder by setting list of type PcepErrorObject
         */
        Builder setErrorObjList(List<PcepErrorObject> errorObjList);
    }
}