org.opendaylight.protocol.bgp.parser.spi.AttributeParser Maven / Gradle / Ivy
/*
* Copyright (c) 2013 Cisco Systems, Inc. and others. All rights reserved.
*
* This program and the accompanying materials are made available under the
* terms of the Eclipse Public License v1.0 which accompanies this distribution,
* and is available at http://www.eclipse.org/legal/epl-v10.html
*/
package org.opendaylight.protocol.bgp.parser.spi;
import io.netty.buffer.ByteBuf;
import org.eclipse.jdt.annotation.NonNull;
import org.eclipse.jdt.annotation.Nullable;
import org.opendaylight.protocol.bgp.parser.BGPDocumentedException;
import org.opendaylight.protocol.bgp.parser.BGPError;
import org.opendaylight.protocol.bgp.parser.BGPParsingException;
import org.opendaylight.protocol.bgp.parser.BGPTreatAsWithdrawException;
import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev200120.path.attributes.AttributesBuilder;
/**
* Common interface for attribute parser implementation. Implementations should consider deriving from
* {@link AbstractAttributeParser} and provide an RFC7606-compliant interface.
*/
public interface AttributeParser {
/**
* Parses attribute from ByteBuf buffer.
*
* @param buffer Encoded attribute body in ByteBuf.
* @param builder Path attributes builder. Guaranteed to contain all valid attributes whose type is numerically
* lower than this attribute's type.
* @param constraint Peer specific constraints, may be null
* @throws BGPDocumentedException when an irrecoverable error occurred which has a {@link BGPError} assigned
* @throws BGPParsingException when a general unspecified parsing error occurs.
*/
void parseAttribute(@NonNull ByteBuf buffer, @NonNull AttributesBuilder builder,
@Nullable PeerSpecificParserConstraint constraint) throws BGPDocumentedException, BGPParsingException;
/**
* Parses attribute from ByteBuf buffer with the specified {@link RevisedErrorHandling}. Default implementation
* ignores error handling and defers to
* {@link #parseAttribute(ByteBuf, AttributesBuilder, PeerSpecificParserConstraint)}.
*
* @param buffer Encoded attribute body in ByteBuf.
* @param builder Path attributes builder. Guaranteed to contain all valid attributes whose type is numerically
* lower than this attribute's type.
* @param errorHandling RFC7606 error handling type
* @param constraint Peer specific constraints, may be null
* @throws BGPDocumentedException when an irrecoverable error occurred which has a {@link BGPError} assigned
* @throws BGPParsingException when a general unspecified parsing error occurs.
* @throws BGPTreatAsWithdrawException when parsing according to revised error handling indicates the
* message should be treated as withdraw.
*/
default void parseAttribute(final @NonNull ByteBuf buffer, final @NonNull AttributesBuilder builder,
final @NonNull RevisedErrorHandling errorHandling, final @Nullable PeerSpecificParserConstraint constraint)
throws BGPDocumentedException, BGPParsingException, BGPTreatAsWithdrawException {
parseAttribute(buffer, builder, constraint);
}
/**
* Determine whether a duplicate attribute should be ignored or {@link BGPError#MALFORMED_ATTR_LIST} should be
* raised. This is useful for MP_REACH/MP_UNREACH attributes, which need to emit a Notification under RFC7606
* rules.
*
* @param errorHandling Revised error handling type
* @return True if the duplicate attribute should be ignored, false if a BGPError should be raised.
*/
default boolean ignoreDuplicates(final @NonNull RevisedErrorHandling errorHandling) {
return true;
}
}