core/src/main/java/com/att/cadi/filter/RolesAllowed.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 /**\r
  25  * RolesAllowed \r
  26  * \r
  27  * \r
  28  * Similar to Java EE's Spec from Annotations 1.1, 2.8\r
  29  * \r
  30  * That Spec, however, was geared towards being able to route calls to Methods on Objects, and thus needed a more refined\r
  31  * sense of permissions hierarchy.  The same mechanism, however, can easily be achieved on single Servlet/Handlers in\r
  32  * POJOs like Jetty by simply adding the Roles Allowed in a similar Annotation\r
  33  * \r
  34  */\r
  35 package com.att.cadi.filter;\r
  36 import static java.lang.annotation.ElementType.TYPE;\r
  37 import static java.lang.annotation.RetentionPolicy.RUNTIME;\r
  38 \r
  39 import java.lang.annotation.Retention;\r
  40 import java.lang.annotation.Target;\r
  41 \r
  42 /**\r
  43  * JASPI Style Annotation of RolesAllowed when the coding style is desired but actually including all \r
  44  * JEE jars is not. If using actual JASPI, use official @interface classes, not this one...\r
  45  * \r
  46  */\r
  47 @Target({TYPE})\r
  48 @Retention(RUNTIME)\r
  49 public @interface RolesAllowed {\r
  50         /**\r
  51          * Security role of the implementation, which doesn't have to be an EJB or CORBA like object.  Can be just a\r
  52          * Handler\r
  53          * @return\r
  54          */\r
  55         String[] value();\r
  56 }\r