Update AAF Version 1.0.0
[aaf/authz.git] / authz-cmd / src / main / java / com / att / cmd / user / ListForPermission.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 com.att.cmd.user;\r
24 \r
25 import java.util.Collections;\r
26 import java.util.Comparator;\r
27 \r
28 import com.att.cadi.CadiException;\r
29 import com.att.cadi.LocatorException;\r
30 import com.att.cadi.client.Future;\r
31 import com.att.cadi.client.Rcli;\r
32 import com.att.cadi.client.Retryable;\r
33 import com.att.cmd.AAFcli;\r
34 import com.att.cmd.Cmd;\r
35 import com.att.cmd.Param;\r
36 import com.att.cssa.rserv.HttpMethods;\r
37 import com.att.inno.env.APIException;\r
38 \r
39 import aaf.v2_0.Users;\r
40 import aaf.v2_0.Users.User;\r
41 \r
42 /**\r
43  * p\r
44  *\r
45  */\r
46 public class ListForPermission extends Cmd {\r
47         private static final String HEADER = "List Users for Permission";\r
48         public ListForPermission(List parent) {\r
49                 super(parent,"perm", \r
50                                 new Param("type",true),\r
51                                 new Param("instance",true),\r
52                                 new Param("action",true)); \r
53         }\r
54 \r
55         @Override\r
56         public int _exec(final int index, final String ... args) throws CadiException, APIException, LocatorException {\r
57                 return same(new Retryable<Integer>() {\r
58                         @Override\r
59                         public Integer code(Rcli<?> client) throws CadiException, APIException {\r
60                                 int idx = index;\r
61                                 String type = args[idx++];\r
62                                 String instance = args[idx++];\r
63                                 if("\\*".equals(instance))instance="*";\r
64                                 String action = args[idx++];\r
65                                 if("\\*".equals(action))action="*";\r
66                                 Future<Users> fp = client.read(\r
67                                                 "/authz/users/perm/"+type+'/'+instance+'/'+action, \r
68                                                 getDF(Users.class)\r
69                                                 );\r
70                                 if(fp.get(AAFcli.timeout())) {\r
71                                         if (aafcli.isTest())\r
72                                                 Collections.sort(fp.value.getUser(), new Comparator<User>() {\r
73                                                         @Override\r
74                                                         public int compare(User u1, User u2) {\r
75                                                                 return u1.getId().compareTo(u2.getId());\r
76                                                         }                       \r
77                                                 });\r
78                                         ((com.att.cmd.user.List)parent).report(fp.value,false,HEADER,type+"|"+instance+"|"+action);\r
79                                         if(fp.code()==404)return 200;\r
80                                 } else {\r
81                                         error(fp);\r
82                                 }\r
83                                 return fp.code();\r
84                         }\r
85                 });\r
86         }\r
87         \r
88         @Override\r
89         public void detailedHelp(int _indent, StringBuilder sb) {\r
90                 int indent = _indent;\r
91                 detailLine(sb,indent,HEADER);\r
92                 indent+=2;\r
93                 detailLine(sb,indent,"This report lists the users associated to Permissions.  Since Users");\r
94                 detailLine(sb,indent,"are associated to Roles, and Roles have Permissions, this report");\r
95                 detailLine(sb,indent,"accomodates all these linkages.");\r
96                 sb.append('\n');\r
97                 detailLine(sb,indent,"The URL must contain the Permission's type,instance and action, and ");\r
98                 detailLine(sb,indent,"may include \"*\"s (type in as \\\\*).");\r
99                 detailLine(sb,indent,"See Perm Create Documentation for definitions.");\r
100                 indent-=2;\r
101                 api(sb,indent,HttpMethods.GET,"authz/users/perm/<type>/<instance>/<action>",Users.class,true);\r
102         }\r
103 }\r