# OFMdft.ctl: Collects Common Oracle Fusion Middleware Plug-in Information
# $Id: OFMdft.ctl,v 1.11 2015/10/30 11:15:17 RDA Exp $
# ARCS: $Header: /home/cvs/cvs/RDA_8/src/scripting/lib/collect/OFM/OFMdft.ctl,v 1.11 2015/10/30 11:15:17 RDA Exp $
#
# Change History
# 20151029  KRA  Improve 'WLS_NodDomCfg_Config' section.

=head1 NAME

OFM:OFMdft - Collects Common Oracle Fusion Middleware Plug-in Information

=head1 DESCRIPTION

This module collects common Oracle Fusion Middleware Plug-in-related
information.

=head1 REPORTS

=cut

keep $KEEP_BLOCK

return

# --- begin section -----------------------------------------------------------
section begin

# Load the common macros
run OFM:WASlib()
run OFM:WLSlib()
run RDA:library()

# -----------------------------------------------------------------------------
# Section Init: Define the plugin capabilities
# -----------------------------------------------------------------------------

section Init

# Define the plugin capabilities
var $plg = $arg[0]
var $ctl = {\
  WLS => {domcfg    => {MinDomCfg => 'OFM:OFMdft-WLS_MinDomCfg_Config'},\
          domext    => {ExtDomCfg => 'OFM:OFMdft-WLS_ExtDomCfg_Config'},\
          domlog    => {NodDomLog => 'OFM:OFMdft-WLS_NodDomLog_Log'},\
          domnodcfg => {NodDomCfg => 'OFM:OFMdft-WLS_NodDomCfg_Config'},\
          srvcfg    => {MinSrvCfg => 'OFM:OFMdft-WLS_MinSrvCfg_Config'},\
          srvext    => {ExtSrvCfg => 'OFM:OFMdft-WLS_ExtSrvCfg_Config'},\
          srvnodext => {ExtSnmCfg => 'OFM:OFMdft-WLS_ExtSnmCfg_Config'}}}
loop $key (keys($ctl,'*'))
 var $plg->{@{$key}} = $ctl->{@{$key}}

# -----------------------------------------------------------------------------
# Section WLS_ExtDomCfg_Config: Collect extended domain common config files
# -----------------------------------------------------------------------------

section WLS_ExtDomCfg_Config

=head2 Extended Domain Configuration Files

Gathers domain-wide Oracle WebLogic Server-related C<properties> and C<xml>
domain configuration files from the F<$DOMAIN_HOME> directory structure but
outside the F<$DOMAIN_HOME/config> directory structure.

=cut

var ($dir) = @arg

debug '   - Inside OFMdft module, gathering extended domain configuration \
            files (can take time)'
var @tbl = ()
call get_config(\@tbl,$dir,\
  '^(appl|config|nodemanager|osb|sbgen|security|servers|sysman|ucm)$',false)
pretoc '2:Extended Domain Configuration Files'
call sort_files(3,0,@tbl)
unpretoc

# -----------------------------------------------------------------------------
# Section WLS_ExtSnmCfg_Config: Collect server node manager config files
# -----------------------------------------------------------------------------

section WLS_ExtSnmCfg_Config

=head2 Node Manager Configuration Files

Gathers server-wide node manager-related configuration files from the
F<$DOMAIN_HOME/servers/$SERVER/nodemanager> directory structure.

=cut

var ($dir) = @arg

debug '   - Inside OFMdft module, gathering server node manager config files'
var @tbl = ()
call get_app_conf(\@tbl,$dir,'nodemanager','data')
pretoc '2:Node Manager Configuration Files'
call sort_files(3,0,@tbl)
unpretoc

# -----------------------------------------------------------------------------
# Section WLS_ExtSrvCfg_Config: Collect extended server common config files
# -----------------------------------------------------------------------------

section WLS_ExtSrvCfg_Config

=head2 Extended Server Configuration Files

Gathers server-wide Oracle WebLogic Server-related C<properties> and C<xml>
server configuration files from the F<$DOMAIN_HOME/servers> directory structure
but outside F<$DOMAIN_HOME/config/servers> directory structure.

=cut

var ($dir) = @arg

debug '   - Inside OFMdft module, gathering extended server configuration files'
var @tbl = ()
call push(@tbl,grepDir($dir,'\.(properties|xml)$','dir'))
call get_app_conf(\@tbl,$dir,'ldap','data')
call get_app_conf(\@tbl,$dir,'OIF','stage')
pretoc '2:Extended Server Configuration Files'
call sort_files(3,0,@tbl)
unpretoc

# -----------------------------------------------------------------------------
# Section WLS_MinDomCfg_Config: Collect minimum domain common config files
# -----------------------------------------------------------------------------

section WLS_MinDomCfg_Config

=head2 Common Domain Configuration Files

Gathers domain-wide Oracle WebLogic Server-related configuration files
from the F<$DOMAIN_HOME/config> directory structure.

=cut

var ($dir) = @arg

debug '   - Inside OFMdft module, gathering minimum domain configuration files'
var @tbl = ()
call get_config(\@tbl,\
  catDir($dir,'config'),'^(backup|nodemanager|servers|bipublisher)$',true,\
  {catDir($dir,'config','jdbc') => \
    [['%R:PASSWORD%','i','<password-encrypted>','</password-encrypted>']]})
pretoc '2:Common Domain Configuration Files'
call sort_all_files(3,0,@tbl)
unpretoc

# -----------------------------------------------------------------------------
# Section WLS_MinSrvCfg_Config: Collect minimum server common config files
# -----------------------------------------------------------------------------

section WLS_MinSrvCfg_Config

=head2 Common Server Configuration Files

Gathers server-wide Oracle WebLogic Server-related configuration files from
the F<$DOMAIN_HOME/config/servers> directory structure.

=cut

var ($dir,$srv) = @arg

debug '   - Inside OFMdft module, gathering minimum server configuration files'
var @tbl = ()
call get_conf(\@tbl,catDir($dir,'fmwconfig','servers',$srv))
call get_conf(\@tbl,catDir($dir,'oracle','servers',$srv))
pretoc '2:Common Server Configuration Files'
call sort_files(3,0,@tbl)
unpretoc

# -----------------------------------------------------------------------------
# Section WLS_NodDomCfg_Config: Collect domain node manager config files
# -----------------------------------------------------------------------------

section WLS_NodDomCfg_Config

=head2 Node Manager Configuration Files

Gathers domain-wide node manager-related configuration files from the
F<$DOMAIN_HOME/config/nodemanager> directory structure and
F<$DOMAIN_HOME/nodemanager> (for version 12c and later) directory structure.

=cut

var ($dir) = @arg
import %STA

debug '   - Inside OFMdft module, gathering domain node manager config files'
pretoc '2:Node Manager Configuration Files'
var $STA{catFile($dir,'config','nodemanager','nm_password.properties')} = \
  ' due to the nature of its content'
call skip_files(catFile($dir,'config','nodemanager','nm_data.properties'),\
                catFile($dir,'nodemanager','nm_data.properties'))
call sort_files(3,0,grepDir(catDir($dir,'config','nodemanager'),'\.log','npv'),\
                    grepDir(catDir($dir,'nodemanager'),'\.log','npv'))
unpretoc

# -----------------------------------------------------------------------------
# Section WLS_NodDomLog_Log: Collect domain node manager log files
# -----------------------------------------------------------------------------

section WLS_NodDomLog_Log

=head2 Node Manager Log Files

Gathers domain-wide node manager-related log files from the
F<$DOMAIN_HOME/nodemanager> (for version 12c and later) directory structure.

=cut

var ($dir,$lim) = @arg

debug '   - Inside OFMdft module, gathering domain node manager log files'
pretoc '2:Node Manager Log Files'
call sort_files(3,$lim,grepDir(catDir($dir,'nodemanager'),'\.log\d*$','np'))
unpretoc

=head1 SEE ALSO

L<OFM:WASlib|collect::OFM:WASlib>,
L<OFM:WLSlib|collect::OFM:WLSlib>,
L<RDA:library|collect::RDA:library>

=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