opendaylight/netconf/netconf-mapping-api/src/main/java/org/opendaylight/controller/netconf/mapping/api/NetconfOperationFilter.java

   1 /*
   2  * Copyright (c) 2013 Cisco Systems, Inc. and others.  All rights reserved.
   3  *
   4  * This program and the accompanying materials are made available under the
   5  * terms of the Eclipse Public License v1.0 which accompanies this distribution,
   6  * and is available at http://www.eclipse.org/legal/epl-v10.html
   7  */
   8
   9 package org.opendaylight.controller.netconf.mapping.api;
  10
  11 import org.opendaylight.controller.netconf.api.NetconfDocumentedException;
  12 import org.opendaylight.controller.netconf.api.NetconfOperationRouter;
  13 import org.w3c.dom.Document;
  14
  15 /**
  16  * Filters wrap each netconf operation, if there is one found. Filters are
  17  * sorted and applied from the greatest to smallest sorting order.
  18  */
  19 public interface NetconfOperationFilter extends Comparable<NetconfOperationFilter> {
  20
  21     Document doFilter(Document message, NetconfOperationRouter operationRouter, NetconfOperationFilterChain filterChain)
  22             throws NetconfDocumentedException;
  23
  24     int getSortingOrder();
  25
  26 }