core/src/main/java/org/onap/aaf/cadi/StrLur.java

   1 /*******************************************************************************\r
   2  * ============LICENSE_START====================================================\r
   3  * * org.onap.aaf\r
   4  * * ===========================================================================\r
   5  * * Copyright © 2017 AT&T Intellectual Property. All rights reserved.\r
   6  * * ===========================================================================\r
   7  * * Licensed under the Apache License, Version 2.0 (the "License");\r
   8  * * you may not use this file except in compliance with the License.\r
   9  * * You may obtain a copy of the License at\r
  10  * * \r
  11  *  *      http://www.apache.org/licenses/LICENSE-2.0\r
  12  * * \r
  13  *  * Unless required by applicable law or agreed to in writing, software\r
  14  * * distributed under the License is distributed on an "AS IS" BASIS,\r
  15  * * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\r
  16  * * See the License for the specific language governing permissions and\r
  17  * * limitations under the License.\r
  18  * * ============LICENSE_END====================================================\r
  19  * *\r
  20  * * ECOMP is a trademark and service mark of AT&T Intellectual Property.\r
  21  * *\r
  22  ******************************************************************************/\r
  23 package org.onap.aaf.cadi;\r
  24 \r
  25 import java.util.List;\r
  26 \r
  27 \r
  28 \r
  29 /**\r
  30  * StrLUR: Implements fish with String, skipping the need to be a Principal where it doesn't make sense.\r
  31  *\r
  32  *\r
  33  */\r
  34 public interface StrLur extends Lur {\r
  35         /** \r
  36          * Fish for Principals in a Pond\r
  37          * \r
  38          *   or more boringly, is the User identified within a named collection representing permission.\r
  39          * \r
  40          * @param principalName\r
  41          * @return\r
  42          */\r
  43         public boolean fish(String bait, Permission pond);\r
  44 \r
  45         /** \r
  46          * Fish all the Principals out a Pond\r
  47          * \r
  48          *   For additional humor, pronounce the following with a Southern Drawl, "FishOil"\r
  49          * \r
  50          *   or more boringly, load the List with Permissions found for Principal\r
  51          * \r
  52          * @param principalName\r
  53          * @return\r
  54          */\r
  55         public void fishAll(String bait, List<Permission> permissions);\r
  56 }\r