opendaylight/md-sal/sal-common-api/src/main/java/org/opendaylight/controller/md/sal/common/api/routing/RoutedRegistration.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 package org.opendaylight.controller.md.sal.common.api.routing;
   9
  10 import org.opendaylight.yangtools.concepts.Path;
  11 import org.opendaylight.yangtools.concepts.Registration;
  12
  13 /**
  14  * Base interface for a routed RPC RPC implementation registration.
  15  *
  16  * @param <C> the context type used for routing
  17  * @param <P> the path identifier type
  18  * @param <S> the RPC implementation type
  19  */
  20 public interface RoutedRegistration<C, P extends Path<P>, S> extends Registration<S> {
  21
  22     /**
  23      * Registers the RPC implementation associated with this registration for the given path
  24      * identifier and context.
  25      *
  26      * @param context the context used for routing RPCs to this implementation.
  27      * @param path the path identifier for which to register.
  28      */
  29     void registerPath(C context, P path);
  30
  31     /**
  32      * Unregisters the RPC implementation associated with this registration for the given path
  33      * identifier and context.
  34      *
  35      * @param context the context used for routing RPCs to this implementation.
  36      * @param path the path identifier for which to unregister.
  37      */
  38     void unregisterPath(C context, P path);
  39
  40     @Override
  41     void close();
  42 }