1203b8d2627685b699acf7e9dd8826feeefcc241
[aaf/authz.git] / cadi / core / src / main / java / org / onap / aaf / cadi / Transmutate.java
1 /**
2  * ============LICENSE_START====================================================
3  * org.onap.aaf
4  * ===========================================================================
5  * Copyright (c) 2018 AT&T Intellectual Property. All rights reserved.
6  * ===========================================================================
7  * Licensed under the Apache License, Version 2.0 (the "License");
8  * you may not use this file except in compliance with the License.
9  * You may obtain a copy of the License at
10  * 
11  *      http://www.apache.org/licenses/LICENSE-2.0
12  * 
13  * Unless required by applicable law or agreed to in writing, software
14  * distributed under the License is distributed on an "AS IS" BASIS,
15  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
16  * See the License for the specific language governing permissions and
17  * limitations under the License.
18  * ============LICENSE_END====================================================
19  *
20  */
21
22 package org.onap.aaf.cadi;
23
24 import java.security.Principal;
25
26 /**
27  * The unique element of TAF is that we establish the relationship/mechanism to mutate the Principal derived from
28  * one Authentication mechanism into a trustable Principal of another.  The mechanism needs to be decided by system
29  * trusting.  
30  * 
31  * The Generic "T" is used so that the code used will be very specific for the implementation, enforced by Compiler
32  * 
33  * This interface will allow differences of trusting Transmutation of Authentication 
34  * @author Jonathan
35  *
36  */
37 public interface Transmutate<T> {
38     /**
39      * Mutate the (assumed validated) Principal into the expected Principal name to be used to construct
40      * 
41      * @param p
42      * @return
43      */
44     public T mutate(Principal p);
45 }