AppserversReportsBuilder.java
/*
** Module : AppserversReportsBuilder.java
** Abstract : AppserversReportsBuilder is a PDF report builder to produce Appservers reports.
**
** Copyright (c) 2024, Golden Code Development Corporation.
**
** -#- -I- --Date-- ----------------Description----------------------
** 001 GBB 20241009 Created initial version.
*/
/*
** This program is free software: you can redistribute it and/or modify
** it under the terms of the GNU Affero General Public License as
** published by the Free Software Foundation, either version 3 of the
** License, or (at your option) any later version.
**
** This program is distributed in the hope that it will be useful,
** but WITHOUT ANY WARRANTY; without even the implied warranty of
** MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
** GNU Affero General Public License for more details.
**
** You may find a copy of the GNU Affero GPL version 3 at the following
** location: https://www.gnu.org/licenses/agpl-3.0.en.html
**
** Additional terms under GNU Affero GPL version 3 section 7:
**
** Under Section 7 of the GNU Affero GPL version 3, the following additional
** terms apply to the works covered under the License. These additional terms
** are non-permissive additional terms allowed under Section 7 of the GNU
** Affero GPL version 3 and may not be removed by you.
**
** 0. Attribution Requirement.
**
** You must preserve all legal notices or author attributions in the covered
** work or Appropriate Legal Notices displayed by works containing the covered
** work. You may not remove from the covered work any author or developer
** credit already included within the covered work.
**
** 1. No License To Use Trademarks.
**
** This license does not grant any license or rights to use the trademarks
** Golden Code, FWD, any Golden Code or FWD logo, or any other trademarks
** of Golden Code Development Corporation. You are not authorized to use the
** name Golden Code, FWD, or the names of any author or contributor, for
** publicity purposes without written authorization.
**
** 2. No Misrepresentation of Affiliation.
**
** You may not represent yourself as Golden Code Development Corporation or FWD.
**
** You may not represent yourself for publicity purposes as associated with
** Golden Code Development Corporation, FWD, or any author or contributor to
** the covered work, without written authorization.
**
** 3. No Misrepresentation of Source or Origin.
**
** You may not represent the covered work as solely your work. All modified
** versions of the covered work must be marked in a reasonable way to make it
** clear that the modified work is not originating from Golden Code Development
** Corporation or FWD. All modified versions must contain the notices of
** attribution required in this license.
*/
package com.goldencode.p2j.admin.server.reports;
import com.goldencode.p2j.admin.*;
import com.goldencode.p2j.admin.shared.*;
import java.text.*;
import java.util.*;
import java.util.stream.Stream;
/**
* AppserversReportsBuilder is a PDF report builder to produce appservers reports.
*/
class AppserversReportsBuilder
extends AbstractReportBuilder<AbstractReportBuilder.SimpleHeader,
AppserverInfo.AgentInfo,
AbstractReportBuilder.SimpleFooter>
{
/** The data and time format, same as in ClassicAppserverView. */
private static final String RFC_2822_FORMAT = "EEE, d MMM yyyy HH:mm:ss Z";
/** The data and time formatter, same as in ClassicAppserverView. */
private static final SimpleDateFormat DATE_FORMATTER = new SimpleDateFormat(RFC_2822_FORMAT);
/** The report header */
private final SimpleHeader header;
/** The report footer */
private final SimpleFooter footer;
/**
* Creates the users reports builder.
*
* @param request
* The report request
*/
AppserversReportsBuilder(ReportRequest request)
{
super(Reports.APPSERVERS.name());
Map<String, String> reportParameters = request.getReportParameters();
String title = reportParameters.getOrDefault(ReportParameters.TITLE.getParameter(), "");
header = new SimpleHeader();
header.setHeader(title);
footer = new SimpleFooter();
int pageToPreview = getPreviewPageNumber(reportParameters);
if (pageToPreview > 0)
{
setPreviewPage(pageToPreview);
}
String action = reportParameters.getOrDefault(ReportParameters.ACTION.getParameter(), "");
setSelfPrintedDocument(!action.isEmpty());
}
/**
* Returns the stream of {@link UserAccountData} objects.
*
* @return see above
*/
@Override
protected Stream<AppserverInfo.AgentInfo> getDataStream()
{
List<AppserverInfo.AgentInfo> agentInfoList = new ArrayList<>();
for (AppserverInfo appserverInfo : AdminServerImpl.getAppserverList())
{
if (appserverInfo.agentInfos != null && appserverInfo.agentInfos.length > 0)
{
agentInfoList.addAll(Arrays.asList(appserverInfo.agentInfos));
}
}
agentInfoList.sort(Comparator.comparing((AppserverInfo.AgentInfo a) -> a.appserverName)
.thenComparingInt(a -> a.agentId));
return agentInfoList.stream();
}
/**
* Returns report columns.
*
* @return see above
*/
@Override
protected List<ColumnInfo<AppserverInfo.AgentInfo>> getColumns()
{
ArrayList<ColumnInfo<AppserverInfo.AgentInfo>> columns = new ArrayList<>();
columns.add(new ColumnInfo<>("Appserver", agentInfo -> agentInfo.appserverName));
columns.add(new ColumnInfo<>("Agent ID", agentInfo -> String.valueOf(agentInfo.agentId)));
columns.add(new ColumnInfo<>("Agent PID", agentInfo -> String.valueOf(agentInfo.pid)));
columns.add(new ColumnInfo<>("Agent Start Time",
agentInfo -> formatDate(agentInfo.agentStartTime)));
columns.add(new ColumnInfo<>("State", agentInfo -> agentInfo.state));
columns.add(new ColumnInfo<>("Bound", agentInfo -> String.valueOf(agentInfo.bound)));
columns.add(new ColumnInfo<>("Session Start Time",
agentInfo -> formatDate(agentInfo.sessionStartTime)));
columns.add(new ColumnInfo<>("Session Procedure", agentInfo -> agentInfo.sessionProcedure));
columns.add(new ColumnInfo<>("Client", agentInfo -> agentInfo.clientType));
return columns;
}
/**
* Returns the header data. The concrete implementation must provide the header data.
*
* @return The header data
*/
@Override
protected SimpleHeader getReportHeader()
{
return header;
}
/**
* Returns the footer data. The concrete implementation must provide the footer data.
*
* @return The footer data
*/
@Override
protected SimpleFooter getReportFooter()
{
return footer;
}
/**
* Formats the date using {@link #DATE_FORMATTER}.
*
* @param date
* The date to be formatted.
*
* @return The formatted date.
*/
private String formatDate(Date date)
{
return date == null ? "" : DATE_FORMATTER.format(date);
}
}