# DCtomcat.ctl:304:Collects Apache Tomcat Information
# $Id: DCtomcat.ctl,v 1.1 2015/03/18 23:06:15 RDA Exp $
# ARCS: $Header: /home/cvs/cvs/RDA_8/src/scripting/lib/collect/OFM/DCtomcat.ctl,v 1.1 2015/03/18 23:06:15 RDA Exp $
#
# Change History
# 20150311  KRA  Initial version.

=head1 NAME

OFM:DCtomcat - Collects Apache Tomcat Information

=head1 DESCRIPTION

This module collects Apache Tomcat-related information. The module covers
Apache Tomcat 7 and later.

The following reports can be generated and are regrouped under C<Apache
Tomcat>:

=head1 REPORTS

=cut

echo tput('bold'),'Processing OFM.TOMCAT module ...',tput('off')

# Initialization
var $HOME = ${D_HOME/P:''}
var $TAIL = ${DFT.N_TAIL:1000}

var $TOC = '%TOC%'
var $TOP = '[[#Top][Back to top]]'
pretoc '1:Apache Tomcat'

# Set the symbols
call setSymbol('$TOMCAT_HOME',$HOME)

# Load the common macros
run RDA:library()

=head2 abbr - Abbreviations

Displays the RDA abbreviations defined for the Apache Tomcat home collection.

=cut

debug ' Inside TOMCAT module, collecting defined abbreviations'
report abbr
prefix
{write '---+ Apache Tomcat Home Abbreviations'
 write '|*Abbreviation*|*Location*|'
}
var %hsh = getSymbols()
loop $key (keys(%hsh))
 write '|',$key,' |',$hsh{$key},' |'
if isCreated(true)
 toc '2:[[',getFile(),'][rda_report][Abbreviations]]'

=head1 TOMCAT SERVER INFORMATION

=head2 Start Scripts

Gathers the Apache Tomcat-related start scripts.

=cut

debug ' Inside TOMCAT module, collecting the start scripts'
pretoc '2:Start Scripts'
call sort_files(3,0,grepDir(catDir($HOME,'bin'),'\.(bat|sh)$','p'))
unpretoc

=head2 Configuration Files

Gathers Apache Tomcat-related configuration files.

=cut

debug ' Inside TOMCAT module, collecting the domain configuration files'
pretoc '2:Configuration Files'
call sort_files(3,0,grepDir(catDir($HOME,'conf'),'^\.+$','pv'))
unpretoc

=head2 Log Files

Gathers Apache Tomcat-related log files.

=cut

debug ' Inside TOMCAT module, collecting the domain log files'
pretoc '2:Log Files'
call sort_files(3,$TAIL,grepDir(catDir($HOME,'logs'),'^\.+$','pv'))
unpretoc 2

=head1 SEE ALSO

L<RDA:library|collect::RDA:library>

=begin credits

=over 10

=item RDA 8.08: Ian Reid.

=back

=end credits

=head1 COPYRIGHT NOTICE

Copyright (c) 2002, 2016, Oracle and/or its affiliates. All rights reserved.

=head1 TRADEMARK NOTICE

Oracle and Java are registered trademarks of Oracle and/or its
affiliates. Other names may be trademarks of their respective owners.

=cut