# OVDr11.ctl: Defines Common Macros for Oracle Virtual Directory 11g
# $Id: OVDr11.ctl,v 1.3 2013/12/19 14:16:42 RDA Exp $
# ARCS: $Header: /home/cvs/cvs/RDA_8/src/scripting/lib/collect/OFM/OVDr11.ctl,v 1.3 2013/12/19 14:16:42 RDA Exp $
#
# Change History
# 20131219  KRA  Fix spell.

=head1 NAME

OFM:OVDr11 - Defines Common Macros for Oracle Virtual Directory 11g

=head1 DESCRIPTION

This persistent submodule regroups macros that are common to Oracle Virtual
Directory in Oracle Fusion Middleware 11g.

The following macros are available:

=cut

# Make the module persistent and share macros
keep $KEEP_BLOCK,@SHARE_MACROS
var @SHARE_MACROS = ('collect_ovd_generic','collect_ovd_instance')

# Load the common macros
run RDA:library()

=head2 S<collect_ovd_generic($hom)>

This macro gathers Oracle Virtual Directory list of executable files.

=cut

macro collect_ovd_generic
{var ($hom) = @arg

 debug ' Inside OVD module, gathering list of executable files'
 report ovd_bin
 var $dir = catDir($hom,'bin')
 prefix
  write '---+ List of Files in ',encode($dir)
 call statDir('an',$dir)
 if isCreated(true)
  toc '2:[[',getFile(),'][rda_report][Executable List]]'
}

=head2 S<collect_ovd_instance($pre,$top,\%cmp)>

This macro collects Oracle Virtual Directory-related configuration and log
files.

=cut

macro collect_ovd_instance
{var ($pre,$top,\%cmp) = @arg
 import $TAIL

 debug ' - Getting Oracle Virtual Directory configuration and log files'
 loop $key (keys(%cmp))
 {var ($typ,$cmp) = split('\|',$key,2)
  next !match($typ,'^OVD$',true)
  debug '   - ',$cmp,' component'
  call setPrefix(concat($pre,'_c_',$cmp))
  pretoc "2:'",$cmp,"' OVD Component"

  # Collect the config files
  pretoc '3:Configuration Files'
  call sort_files(4,$TAIL,\
                    grepDir(catDir($top,'config',$typ,$cmp),'^\.+$','drv'))
  unpretoc

  # Collect the log files
  pretoc '3:Log Files'
  call sort_files(4,$TAIL,\
   grepDir(catDir($top,'diagnostics','logs',$typ,$cmp),'\.log','inp'))
  unpretoc 2
 }
 call setPrefix($pre)
}

=head1 SEE ALSO

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

=begin credits

=over 10

=item RDA 4.15: Greg Cook, Andrew Salt.

=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