mappingservice/api/src/main/java/org/opendaylight/lispflowmapping/interfaces/mappingservice/IMappingServiceShell.java

   1 /*
   2  * Copyright (c) 2015 Cisco Systems, Inc.  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.lispflowmapping.interfaces.mappingservice;
   9
  10 /**
  11  * This interface defines the methods that need to be implemented in order to
  12  * provide commands for the Karaf shell.
  13  *
  14  * @author Lorand Jakab
  15  *
  16  */
  17 public interface IMappingServiceShell {
  18     /**
  19      * Print the full mapping database.
  20      *
  21      * @return the text to be printed on the Karaf console.
  22      */
  23     String printMappings();
  24
  25     /**
  26      * Print the full mapping database in human readable form.
  27      *
  28      * @return the text to be printed on the Karaf console.
  29      */
  30     String prettyPrintMappings();
  31
  32     /**
  33      * Print the full authentication key database.
  34      *
  35      * @return the text to be printed on the Karaf console.
  36      */
  37     String printKeys();
  38
  39     /**
  40      * Add the default key "password" for the IPv4 prefix 0.0.0.0/0.
  41      */
  42     void addDefaultKeyIPv4();
  43 }