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