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