1 /*
2 * Portions of this software was developed by employees of the National Institute
3 * of Standards and Technology (NIST), an agency of the Federal Government and is
4 * being made available as a public service. Pursuant to title 17 United States
5 * Code Section 105, works of NIST employees are not subject to copyright
6 * protection in the United States. This software may be subject to foreign
7 * copyright. Permission in the United States and in foreign countries, to the
8 * extent that NIST may hold copyright, to use, copy, modify, create derivative
9 * works, and distribute this software and its documentation without fee is hereby
10 * granted on a non-exclusive basis, provided that this notice and disclaimer
11 * of warranty appears in all copies.
12 *
13 * THE SOFTWARE IS PROVIDED 'AS IS' WITHOUT ANY WARRANTY OF ANY KIND, EITHER
14 * EXPRESSED, IMPLIED, OR STATUTORY, INCLUDING, BUT NOT LIMITED TO, ANY WARRANTY
15 * THAT THE SOFTWARE WILL CONFORM TO SPECIFICATIONS, ANY IMPLIED WARRANTIES OF
16 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, AND FREEDOM FROM
17 * INFRINGEMENT, AND ANY WARRANTY THAT THE DOCUMENTATION WILL CONFORM TO THE
18 * SOFTWARE, OR ANY WARRANTY THAT THE SOFTWARE WILL BE ERROR FREE. IN NO EVENT
19 * SHALL NIST BE LIABLE FOR ANY DAMAGES, INCLUDING, BUT NOT LIMITED TO, DIRECT,
20 * INDIRECT, SPECIAL OR CONSEQUENTIAL DAMAGES, ARISING OUT OF, RESULTING FROM,
21 * OR IN ANY WAY CONNECTED WITH THIS SOFTWARE, WHETHER OR NOT BASED UPON WARRANTY,
22 * CONTRACT, TORT, OR OTHERWISE, WHETHER OR NOT INJURY WAS SUSTAINED BY PERSONS OR
23 * PROPERTY OR OTHERWISE, AND WHETHER OR NOT LOSS WAS SUSTAINED FROM, OR AROSE OUT
24 * OF THE RESULTS OF, OR USE OF, THE SOFTWARE OR SERVICES PROVIDED HEREUNDER.
25 */
26
27 package gov.nist.secauto.metaschema.cli.processor;
28
29 import org.apache.logging.log4j.LogBuilder;
30 import org.apache.logging.log4j.LogManager;
31 import org.apache.logging.log4j.Logger;
32
33 import edu.umd.cs.findbugs.annotations.NonNull;
34 import edu.umd.cs.findbugs.annotations.Nullable;
35 import edu.umd.cs.findbugs.annotations.SuppressFBWarnings;
36
37 public abstract class AbstractExitStatus implements ExitStatus {
38 private static final Logger LOGGER = LogManager.getLogger(AbstractExitStatus.class);
39
40 @NonNull
41 private final ExitCode exitCode;
42
43 private Throwable throwable;
44
45 /**
46 * Construct a new exit status based on the provided {@code exitCode}.
47 *
48 * @param exitCode
49 * the exit code
50 */
51 public AbstractExitStatus(@NonNull ExitCode exitCode) {
52 this.exitCode = exitCode;
53 }
54
55 @Override
56 public ExitCode getExitCode() {
57 return exitCode;
58 }
59
60 /**
61 * Get the associated throwable.
62 *
63 * @return the throwable or {@code null}
64 */
65 @Override
66 public Throwable getThrowable() {
67 return throwable;
68 }
69
70 @Override
71 @SuppressFBWarnings(value = "EI_EXPOSE_REP2", justification = "intended as a exposed property")
72 public ExitStatus withThrowable(@NonNull Throwable throwable) {
73 this.throwable = throwable;
74 return this;
75 }
76
77 /**
78 * Get the associated message.
79 *
80 * @return the message or {@code null}
81 */
82 @Nullable
83 protected abstract String getMessage();
84
85 @Override
86 public void generateMessage(boolean showStackTrace) {
87 LogBuilder logBuilder = null;
88 if (getExitCode().getStatusCode() <= 0) {
89 if (LOGGER.isInfoEnabled()) {
90 logBuilder = LOGGER.atInfo();
91 }
92 } else if (LOGGER.isErrorEnabled()) {
93 logBuilder = LOGGER.atError();
94 }
95
96 if (logBuilder != null) {
97 Throwable throwable = getThrowable();
98 if (showStackTrace && throwable != null) {
99 logBuilder.withThrowable(throwable);
100 }
101
102 String message = getMessage();
103 if (message == null && throwable != null) {
104 message = throwable.getLocalizedMessage();
105 }
106
107 if (message != null && !message.isEmpty()) {
108 logBuilder.log(message);
109 } else if (throwable != null && showStackTrace) {
110 // log the throwable
111 logBuilder.log();
112 }
113 }
114 }
115
116 }