1 /*******************************************************************************
\r
2 * ============LICENSE_START====================================================
\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
11 * * http://www.apache.org/licenses/LICENSE-2.0
\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
20 * * ECOMP is a trademark and service mark of AT&T Intellectual Property.
\r
22 ******************************************************************************/
\r
23 package com.att.cmd;
\r
25 import java.io.PrintWriter;
\r
26 import java.io.StringReader;
\r
27 import java.sql.Date;
\r
28 import java.text.DateFormat;
\r
29 import java.text.SimpleDateFormat;
\r
30 import java.util.ArrayList;
\r
31 import java.util.Comparator;
\r
32 import java.util.GregorianCalendar;
\r
33 import java.util.List;
\r
34 import java.util.Stack;
\r
35 import java.util.concurrent.ConcurrentHashMap;
\r
37 import com.att.cadi.CadiException;
\r
38 import com.att.cadi.LocatorException;
\r
39 import com.att.cadi.client.Future;
\r
40 import com.att.cadi.client.Rcli;
\r
41 import com.att.cadi.client.Retryable;
\r
42 import com.att.cadi.http.HMangr;
\r
43 import com.att.cssa.rserv.HttpMethods;
\r
44 import com.att.inno.env.APIException;
\r
45 import com.att.inno.env.Data.TYPE;
\r
46 import com.att.inno.env.Env;
\r
47 import com.att.inno.env.util.Chrono;
\r
48 import com.att.rosetta.env.RosettaDF;
\r
49 import com.att.rosetta.env.RosettaEnv;
\r
51 import aaf.v2_0.Error;
\r
52 import aaf.v2_0.History;
\r
53 import aaf.v2_0.History.Item;
\r
54 import aaf.v2_0.Request;
\r
57 public abstract class Cmd {
\r
58 private static final String AAF_DEFAULT_REALM = "aaf_default_realm";
\r
60 private static final DateFormat dateFmt = new SimpleDateFormat("yyyy-MM-dd HH:mm:ss:SSS");
\r
61 protected static final String BLANK = "";
\r
62 protected static final String COMMA = ","; // for use in splits
\r
64 protected static final int lineLength = 80;
\r
66 private final static String hformat = "%-23s %-5s %-20s %-35s\n";
\r
68 public static final String STARTDATE = "startdate";
\r
69 public static final String ENDDATE = "enddate";
\r
71 private String name;
\r
72 private final Param[] params;
\r
73 private int required;
\r
74 protected final Cmd parent;
\r
75 protected final List<Cmd> children;
\r
76 private final ConcurrentHashMap<Class<?>,RosettaDF<?>> dfs = new ConcurrentHashMap<Class<?>,RosettaDF<?>>();
\r
77 public final AAFcli aafcli;
\r
80 public Cmd(AAFcli aafcli, String name, Param ... params) {
\r
81 this(aafcli,null, name,params);
\r
84 public Cmd(Cmd parent, String name, Param ... params) {
\r
85 this(parent.aafcli,parent, name,params);
\r
88 Cmd(AAFcli aafcli, Cmd parent, String name, Param ... params) {
\r
89 this.parent = parent;
\r
90 this.aafcli = aafcli;
\r
91 this.env = aafcli.env;
\r
93 parent.children.add(this);
\r
95 children = new ArrayList<Cmd>();
\r
96 this.params = params;
\r
99 for(Param p : params) {
\r
106 public final int exec(int idx, String ... args) throws CadiException, APIException, LocatorException {
\r
107 if(args.length-idx<required) {
\r
108 throw new CadiException(build(new StringBuilder("Too few args: "),null).toString());
\r
110 return _exec(idx,args);
\r
113 protected abstract int _exec(int idx, final String ... args) throws CadiException, APIException, LocatorException;
\r
115 public void detailedHelp(int indent,StringBuilder sb) {
\r
118 protected void detailLine(StringBuilder sb, int length, String s) {
\r
119 multiChar(sb,length,' ',0);
\r
123 public void apis(int indent,StringBuilder sb) {
\r
126 protected void api(StringBuilder sb, int _indent, HttpMethods hmeth, String pathInfo, Class<?> cls,boolean head) {
\r
127 int indent = _indent;
\r
128 final String meth = hmeth.name();
\r
131 detailLine(sb,indent,"APIs:");
\r
134 multiChar(sb,indent,' ',0);
\r
137 sb.append(pathInfo);
\r
138 String cliString = aafcli.typeString(cls,true);
\r
139 if(indent+meth.length()+pathInfo.length()+cliString.length()+2>80) {
\r
141 multiChar(sb,indent+3+meth.length(),' ',0);
\r
142 } else { // same line
\r
145 sb.append(cliString);
\r
148 protected void multiChar(StringBuilder sb, int length, char c, int indent) {
\r
150 for(int i=0;i<indent;++i)sb.append(' ');
\r
151 for(int i=indent;i<length;++i)sb.append(c);
\r
154 public StringBuilder build(StringBuilder sb, StringBuilder detail) {
\r
159 int line = sb.lastIndexOf("\n")+1;
\r
163 int indent = sb.length()-line;
\r
164 for(Param p : params) {
\r
165 sb.append(p.required?'<':'[');
\r
167 sb.append(p.required?"> ": "] ");
\r
170 boolean first = true;
\r
171 for(Cmd child : children) {
\r
174 } else if(detail==null) {
\r
175 multiChar(sb,indent,' ',0);
\r
177 // Write parents for Detailed Report
\r
178 Stack<String> stack = new Stack<String>();
\r
179 for(Cmd c = child.parent;c!=null;c=c.parent) {
\r
181 stack.push(c.name);
\r
184 if(!stack.isEmpty()) {
\r
186 while(!stack.isEmpty()) {
\r
187 sb.append(stack.pop());
\r
192 child.build(sb,detail);
\r
194 child.detailedHelp(4, detail);
\r
195 // If Child wrote something, then add, bracketing by lines
\r
196 if(detail.length()>0) {
\r
197 multiChar(sb,80,'-',2);
\r
200 multiChar(sb,80,'-',2);
\r
202 detail.setLength(0); // reuse
\r
211 protected void error(Future<?> future) {
\r
212 StringBuilder sb = new StringBuilder("Failed");
\r
213 String desc = future.body();
\r
214 int code = future.code();
\r
215 if(desc==null || desc.length()==0) {
\r
217 } else if(desc.startsWith("{")) {
\r
218 StringReader sr = new StringReader(desc);
\r
220 // Note: 11-18-2013. This rather convoluted Message Structure required by TSS Restful Specs, reflecting "Northbound" practices.
\r
221 Error err = getDF(Error.class).newData().in(TYPE.JSON).load(sr).asObject();
\r
223 sb.append(err.getMessageId());
\r
225 String messageBody = err.getText();
\r
226 List<String> vars = err.getVariables();
\r
228 for (int varCounter=0;varCounter<vars.size();) {
\r
229 String var = vars.get(varCounter);
\r
231 if (messageBody.indexOf("%" + varCounter) >= 0) {
\r
232 if((pipe = var.indexOf('|'))>=0) { // In AAF, we use a PIPE for Choice
\r
233 if (aafcli.isTest()) {
\r
234 String expiresStr = var.substring(pipe);
\r
235 var = var.replace(expiresStr, "[Placeholder]");
\r
237 StringBuilder varsb = new StringBuilder(var);
\r
238 varsb.deleteCharAt(pipe);
\r
239 var = varsb.toString();
\r
241 messageBody = messageBody.replace("%" + varCounter, varCounter-1 + ") " + var);
\r
243 messageBody = messageBody.replace("%" + varCounter, var);
\r
247 sb.append(messageBody);
\r
248 } catch (Exception e) {
\r
250 sb.append(" (Note: Details cannot be obtained from Error Structure)");
\r
252 } else if(desc.startsWith("<html>")){ // Core Jetty, etc sends HTML for Browsers
\r
255 sb.append(" with code ");
\r
264 private void withCode(StringBuilder sb, Integer code) {
\r
265 sb.append(" with code ");
\r
269 sb.append(" (HTTP Not Authenticated)");
\r
272 sb.append(" (HTTP Forbidden)");
\r
275 sb.append(" (HTTP Not Found)");
\r
282 * Consistently set start and end dates from Requests (all derived from Request)
\r
285 protected void setStartEnd(Request req) {
\r
286 // Set Start/End Dates, if exist
\r
288 if((str = env.getProperty(Cmd.STARTDATE,null))!=null) {
\r
289 req.setStart(Chrono.timeStamp(Date.valueOf(str)));
\r
292 if((str = env.getProperty(Cmd.ENDDATE,null))!=null) {
\r
293 req.setEnd(Chrono.timeStamp(Date.valueOf(str)));
\r
297 @SuppressWarnings("unchecked")
\r
298 protected<T> RosettaDF<T> getDF(Class<T> cls) throws APIException {
\r
299 RosettaDF<T> rdf = (RosettaDF<T>)dfs.get(cls);
\r
301 rdf = env().newDataFactory(cls);
\r
307 public void activity(History history, String header) {
\r
308 if (history.getItem().isEmpty()) {
\r
309 int start = header.indexOf('[');
\r
311 pw().println("No Activity Found for " + header.substring(start));
\r
314 pw().println(header);
\r
315 for(int i=0;i<lineLength;++i)pw().print('-');
\r
318 pw().format(hformat,"Date","Table","User","Memo");
\r
319 for(int i=0;i<lineLength;++i)pw().print('-');
\r
322 // Save Server time by Sorting locally
\r
323 List<Item> items = history.getItem();
\r
324 java.util.Collections.sort(items, new Comparator<Item>() {
\r
326 public int compare(Item o1, Item o2) {
\r
327 return o2.getTimestamp().compare(o1.getTimestamp());
\r
331 for(History.Item item : items) {
\r
332 GregorianCalendar gc = item.getTimestamp().toGregorianCalendar();
\r
333 pw().format(hformat,
\r
334 dateFmt.format(gc.getTime()),
\r
343 * Turn String Array into a | delimited String
\r
347 public static String optionsToString(String[] options) {
\r
348 StringBuilder sb = new StringBuilder();
\r
349 boolean first = true;
\r
350 for(String s : options) {
\r
358 return sb.toString();
\r
362 * return which index number the Option matches.
\r
364 * throws an Exception if not part of this Option Set
\r
369 * @throws Exception
\r
371 public int whichOption(String[] options, String test) throws CadiException {
\r
372 for(int i=0;i<options.length;++i) {
\r
373 if(options[i].equals(test)) {
\r
377 throw new CadiException(build(new StringBuilder("Invalid Option: "),null).toString());
\r
380 protected RosettaEnv env() {
\r
384 protected HMangr hman() {
\r
385 return aafcli.hman;
\r
388 public<RET> RET same(Retryable<RET> retryable) throws APIException, CadiException, LocatorException {
\r
389 // We're storing in AAFCli, because we know it's always the same, and single threaded
\r
390 if(aafcli.prevCall!=null) {
\r
391 retryable.item(aafcli.prevCall.item());
\r
392 retryable.lastClient=aafcli.prevCall.lastClient;
\r
395 RET ret = aafcli.hman.same(aafcli.ss,retryable);
\r
397 // Store last call in AAFcli, because Cmds are all different instances.
\r
398 aafcli.prevCall = retryable;
\r
402 public<RET> RET all(Retryable<RET> retryable) throws APIException, CadiException, LocatorException {
\r
403 this.setQueryParamsOn(retryable.lastClient);
\r
404 return aafcli.hman.all(aafcli.ss,retryable);
\r
407 public<RET> RET oneOf(Retryable<RET> retryable,String host) throws APIException, CadiException, LocatorException {
\r
408 this.setQueryParamsOn(retryable.lastClient);
\r
409 return aafcli.hman.oneOf(aafcli.ss,retryable,true,host);
\r
412 protected PrintWriter pw() {
\r
416 public String getName() {
\r
420 public void reportHead(String ... str) {
\r
422 boolean first = true;
\r
424 for(String s : str) {
\r
442 public String reportColHead(String format, String ... args) {
\r
443 pw().format(format,(Object[])args);
\r
448 public void reportLine() {
\r
449 for(int i=0;i<lineLength;++i)pw().print('-');
\r
453 protected void setQueryParamsOn(Rcli<?> rcli) {
\r
454 StringBuilder sb=null;
\r
456 if((force=aafcli.forceString())!=null) {
\r
457 sb = new StringBuilder("force=");
\r
460 if(aafcli.addRequest()) {
\r
462 sb = new StringBuilder("request=true");
\r
464 sb.append("&request=true");
\r
467 if(sb!=null && rcli!=null) {
\r
468 rcli.setQueryParams(sb.toString());
\r
473 // * If Force is set, will return True once only, then revert to "FALSE".
\r
477 // protected String checkForce() {
\r
478 // if(TRUE.equalsIgnoreCase(env.getProperty(FORCE, FALSE))) {
\r
479 // env.setProperty(FORCE, FALSE);
\r
485 public String toString() {
\r
486 StringBuilder sb = new StringBuilder();
\r
487 if(parent==null) { // ultimate parent
\r
489 return sb.toString();
\r
491 return parent.toString();
\r
495 public String getOrgRealm() {
\r
496 return env.getProperty(AAF_DEFAULT_REALM);
\r