core/src/main/java/com/att/cadi/Lur.java

   1 /*******************************************************************************\r
   2  * ============LICENSE_START====================================================\r
   3  * * org.onap.aai\r
   4  * * ===========================================================================\r
   5  * * Copyright © 2017 AT&T Intellectual Property. All rights reserved.\r
   6  * * Copyright © 2017 Amdocs\r
   7  * * ===========================================================================\r
   8  * * Licensed under the Apache License, Version 2.0 (the "License");\r
   9  * * you may not use this file except in compliance with the License.\r
  10  * * You may obtain a copy of the License at\r
  11  * * \r
  12  *  *      http://www.apache.org/licenses/LICENSE-2.0\r
  13  * * \r
  14  *  * Unless required by applicable law or agreed to in writing, software\r
  15  * * distributed under the License is distributed on an "AS IS" BASIS,\r
  16  * * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\r
  17  * * See the License for the specific language governing permissions and\r
  18  * * limitations under the License.\r
  19  * * ============LICENSE_END====================================================\r
  20  * *\r
  21  * * ECOMP is a trademark and service mark of AT&T Intellectual Property.\r
  22  * *\r
  23  ******************************************************************************/\r
  24 package com.att.cadi;\r
  25 \r
  26 import java.security.Principal;\r
  27 import java.util.List;\r
  28 \r
  29 \r
  30 \r
  31 /**\r
  32  * LUR: Local User Registry\r
  33  *\r
  34  * Concept by Robert Garskof, Implementation by Jonathan Gathman\r
  35  * \r
  36  * Where we can keep local copies of users and roles for faster Authorization when asked.\r
  37  * \r
  38  * Note: Author cannot resist the mental image of using a Fishing Lure to this LUR pattern \r
  39  * \r
  40  *\r
  41  */\r
  42 public interface Lur {\r
  43         /**\r
  44          * Allow the Lur, which has correct Permission access, to create and hand back. \r
  45          */\r
  46         public Permission createPerm(String p);\r
  47         \r
  48         /** \r
  49          * Fish for Principals in a Pond\r
  50          * \r
  51          *   or more boringly, is the User identified within a named collection representing permission.\r
  52          * \r
  53          * @param principalName\r
  54          * @return\r
  55          */\r
  56         public boolean fish(Principal bait, Permission pond);\r
  57 \r
  58         /** \r
  59          * Fish all the Principals out a Pond\r
  60          * \r
  61          *   For additional humor, pronounce the following with a Southern Drawl, "FishOil"\r
  62          * \r
  63          *   or more boringly, load the List with Permissions found for Principal\r
  64          * \r
  65          * @param principalName\r
  66          * @return\r
  67          */\r
  68         public void fishAll(Principal bait, List<Permission> permissions);\r
  69 \r
  70         /**\r
  71          * Allow implementations to disconnect, or cleanup resources if unneeded\r
  72          */\r
  73         public void destroy();\r
  74 \r
  75         /**\r
  76          * Does this LUR handle this pond exclusively?  Important for EpiLUR to determine whether \r
  77          * to try another (more expensive) LUR \r
  78          * @param pond\r
  79          * @return\r
  80          */\r
  81         public boolean handlesExclusively(Permission pond);  \r
  82         \r
  83         /**\r
  84          * What domain of User does this LUR support?  (used to avoid asking when not possible)\r
  85          * \r
  86          * @param bait\r
  87          * @return\r
  88          */\r
  89         public boolean supports(String userName);\r
  90         \r
  91         /**\r
  92          * Clear: Clear any Caching, if exists\r
  93          */\r
  94         public void clear(Principal p, StringBuilder report);\r
  95 }\r