core/src/main/java/org/onap/aaf/cadi/Transmutate.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.security.Principal;\r
  26 \r
  27 /**\r
  28  * The unique element of TAF is that we establish the relationship/mechanism to mutate the Principal derived from\r
  29  * one Authentication mechanism into a trustable Principal of another.  The mechanism needs to be decided by system\r
  30  * trusting.  \r
  31  * \r
  32  * The Generic "T" is used so that the code used will be very specific for the implementation, enforced by Compiler\r
  33  * \r
  34  * This interface will allow differences of trusting Transmutation of Authentication \r
  35  *\r
  36  */\r
  37 public interface Transmutate<T> {\r
  38         /**\r
  39          * Mutate the (assumed validated) Principal into the expected Principal name to be used to construct\r
  40          * \r
  41          * @param p\r
  42          * @return\r
  43          */\r
  44         public T mutate(Principal p);\r
  45 }\r