X-Git-Url: https://git.opendaylight.org/gerrit/gitweb?p=controller.git;a=blobdiff_plain;f=opendaylight%2Fweb%2Froot%2Fsrc%2Fmain%2Fjava%2Forg%2Fopendaylight%2Fcontroller%2Fweb%2FIDaylightWeb.java;h=55e3ee51103ffd8d88a7d1a1dc8969af270eba00;hp=84bbd94bae12b41654de7c906387a005db83896e;hb=5af252e48a4d7aad13a88328d567891e811e9fba;hpb=6af337195781fc17e61d49250840ff60a19534f3 diff --git a/opendaylight/web/root/src/main/java/org/opendaylight/controller/web/IDaylightWeb.java b/opendaylight/web/root/src/main/java/org/opendaylight/controller/web/IDaylightWeb.java index 84bbd94bae..55e3ee5110 100644 --- a/opendaylight/web/root/src/main/java/org/opendaylight/controller/web/IDaylightWeb.java +++ b/opendaylight/web/root/src/main/java/org/opendaylight/controller/web/IDaylightWeb.java @@ -1,4 +1,3 @@ - /* * Copyright (c) 2013 Cisco Systems, Inc. and others. All rights reserved. * @@ -11,16 +10,36 @@ package org.opendaylight.controller.web; import org.opendaylight.controller.sal.authorization.UserLevel; -/** - * - * - */ public interface IDaylightWeb { + /** + * Returns the name of the bundle. In the GUI, this name will be displayed + * on the tab. + * + * @return Name assigned to the bundle. + */ public String getWebName(); + /** + * Returns the Id assigned to the web bundle. + * + * @return Id assigned to the web bundle. + */ public String getWebId(); + /** + * Returns the position where the bundle tab will be placed in the GUI. + * + * @return Position number for the bundle tab. + */ public short getWebOrder(); - + + /** + * This method checks if the user is authorized to access the bundle. + * + * @param userLevel + * user role level in the controller space. + * + * @return true, if user is authorized to access the bundle, else false. + */ public boolean isAuthorized(UserLevel userLevel); }