ARTEMIS-649 deprecate the HTML based JMX reports

The HTML output methods are hold-overs from way back when the code-base
started off as JBoss Messaging 2 and the broker mainly ran in JBoss AS 4
and 5 which leveraged an HTML-based JMX console where these methods
would be executed and spit out nicely formatted data. That stuff has all
long since been retired so this commit deprecates the HTML-based
management methods so they can be removed completely in a future release.
JSON is a better structured output format for this and most of the
deprecated methods have JSON alternatives.
This commit is contained in:
Justin Bertram 2021-10-26 12:35:16 -05:00 committed by clebertsuconic
parent 657e4bf842
commit 4367ec40a6
7 changed files with 10 additions and 0 deletions

View File

@ -1139,6 +1139,7 @@ public interface ActiveMQServerControl {
* List all the prepared transaction, sorted by date, * List all the prepared transaction, sorted by date,
* oldest first, with details, in HTML format * oldest first, with details, in HTML format
*/ */
@Deprecated
@Operation(desc = "List all the prepared transaction, sorted by date, oldest first, with details, in HTML format") @Operation(desc = "List all the prepared transaction, sorted by date, oldest first, with details, in HTML format")
String listPreparedTransactionDetailsAsHTML() throws Exception; String listPreparedTransactionDetailsAsHTML() throws Exception;

View File

@ -632,6 +632,7 @@ public interface QueueControl {
/** /**
* Lists the message counter history for this queue as a HTML table. * Lists the message counter history for this queue as a HTML table.
*/ */
@Deprecated
@Operation(desc = "List the message counters history HTML", impact = MBeanOperationInfo.INFO) @Operation(desc = "List the message counters history HTML", impact = MBeanOperationInfo.INFO)
String listMessageCounterHistoryAsHTML() throws Exception; String listMessageCounterHistoryAsHTML() throws Exception;

View File

@ -337,6 +337,7 @@ public interface JMSServerManager extends ActiveMQComponent {
String listPreparedTransactionDetailsAsJSON() throws Exception; String listPreparedTransactionDetailsAsJSON() throws Exception;
@Deprecated
String listPreparedTransactionDetailsAsHTML() throws Exception; String listPreparedTransactionDetailsAsHTML() throws Exception;
ActiveMQServer getActiveMQServer(); ActiveMQServer getActiveMQServer();

View File

@ -1324,6 +1324,7 @@ public class JMSServerManagerImpl extends CleaningActivateCallback implements JM
return server.getActiveMQServerControl().listPreparedTransactionDetailsAsJSON((xid, tx, creation) -> new JMSTransactionDetail(xid, tx, creation)); return server.getActiveMQServerControl().listPreparedTransactionDetailsAsJSON((xid, tx, creation) -> new JMSTransactionDetail(xid, tx, creation));
} }
@Deprecated
@Override @Override
public String listPreparedTransactionDetailsAsHTML() throws Exception { public String listPreparedTransactionDetailsAsHTML() throws Exception {
return server.getActiveMQServerControl().listPreparedTransactionDetailsAsHTML((xid, tx, creation) -> new JMSTransactionDetail(xid, tx, creation)); return server.getActiveMQServerControl().listPreparedTransactionDetailsAsHTML((xid, tx, creation) -> new JMSTransactionDetail(xid, tx, creation));

View File

@ -1985,11 +1985,13 @@ public class ActiveMQServerControlImpl extends AbstractControl implements Active
} }
} }
@Deprecated
@Override @Override
public String listPreparedTransactionDetailsAsHTML() throws Exception { public String listPreparedTransactionDetailsAsHTML() throws Exception {
return listPreparedTransactionDetailsAsHTML((xid, tx, creation) -> new CoreTransactionDetail(xid, tx, creation)); return listPreparedTransactionDetailsAsHTML((xid, tx, creation) -> new CoreTransactionDetail(xid, tx, creation));
} }
@Deprecated
public String listPreparedTransactionDetailsAsHTML(TransactionDetailFactory factory) throws Exception { public String listPreparedTransactionDetailsAsHTML(TransactionDetailFactory factory) throws Exception {
if (AuditLogger.isBaseLoggingEnabled()) { if (AuditLogger.isBaseLoggingEnabled()) {
AuditLogger.listPreparedTransactionDetailsAsHTML(this.server, factory); AuditLogger.listPreparedTransactionDetailsAsHTML(this.server, factory);

View File

@ -1416,6 +1416,7 @@ public class QueueControlImpl extends AbstractControl implements QueueControl {
} }
} }
@Deprecated
@Override @Override
public String listMessageCounterAsHTML() { public String listMessageCounterAsHTML() {
if (AuditLogger.isBaseLoggingEnabled()) { if (AuditLogger.isBaseLoggingEnabled()) {
@ -1446,6 +1447,7 @@ public class QueueControlImpl extends AbstractControl implements QueueControl {
} }
} }
@Deprecated
@Override @Override
public String listMessageCounterHistoryAsHTML() { public String listMessageCounterHistoryAsHTML() {
if (AuditLogger.isBaseLoggingEnabled()) { if (AuditLogger.isBaseLoggingEnabled()) {

View File

@ -44,6 +44,7 @@ public class MessageCounterHelper {
return DayCounterInfo.toJSON(infos); return DayCounterInfo.toJSON(infos);
} }
@Deprecated
public static String listMessageCounterAsHTML(final MessageCounter[] counters) { public static String listMessageCounterAsHTML(final MessageCounter[] counters) {
if (counters == null) { if (counters == null) {
return null; return null;
@ -84,6 +85,7 @@ public class MessageCounterHelper {
return ret.toString(); return ret.toString();
} }
@Deprecated
public static String listMessageCounterHistoryAsHTML(final MessageCounter[] counters) { public static String listMessageCounterHistoryAsHTML(final MessageCounter[] counters) {
if (counters == null) { if (counters == null) {
return null; return null;