Update project structure for aaf/cadi
[aaf/cadi.git] / core / src / main / java / org / onap / aaf / cadi / UserChain.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 /**\r
26  * Interface to add a User Chain String to Principal\r
27  * \r
28  * \r
29  * \r
30  *  Where\r
31  *  APP is name suitable for Logging (i.e. official App Acronym) \r
32  *  ID is official User or MechID, best if includes Identity Source (i.e. ab1234@csp.att.com)\r
33  *  Protocol is the Security protocol,\r
34  *  \r
35  *  Format:<ID>:<APP>:<protocol>[:AS][,<ID>:<APP>:<protocol>]*\r
36  *  \r
37  * \r
38  *\r
39  */\r
40 public interface UserChain  {\r
41         public enum Protocol {BasicAuth,Cookie,Cert,OAuth};\r
42         public String userChain();\r
43 }\r