opendaylight/web/root/src/main/java/org/opendaylight/controller/web/IDaylightWeb.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.web;
  10
  11 import org.opendaylight.controller.sal.authorization.UserLevel;
  12
  13 public interface IDaylightWeb {
  14     /**
  15      * Returns the name of the bundle. In the GUI, this name will be displayed
  16      * on the tab.
  17      *
  18      * @return Name assigned to the bundle.
  19      */
  20     public String getWebName();
  21
  22     /**
  23      * Returns the Id assigned to the web bundle.
  24      *
  25      * @return Id assigned to the web bundle.
  26      */
  27     public String getWebId();
  28
  29     /**
  30      * Returns the position where the bundle tab will be placed in the GUI.
  31      *
  32      * @return Position number for the bundle tab.
  33      */
  34     public short getWebOrder();
  35
  36     /**
  37      * This method checks if the user is authorized to access the bundle.
  38      *
  39      * @param userLevel
  40      *            user role level in the controller space.
  41      *
  42      * @return true, if user is authorized to access the bundle, else false.
  43      */
  44     public boolean isAuthorized(UserLevel userLevel);
  45 }