.\" -*- mode: troff; coding: utf-8 -*-
.\" Automatically generated by Pod::Man v6.0.2 (Pod::Simple 3.45)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
.ie n \{\
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\"
.\" Required to disable full justification in groff 1.23.0.
.if n .ds AD l
.\" ========================================================================
.\"
.IX Title "ImportJob 3pm"
.TH ImportJob 3pm 2025-09-28 "Lire 2.1.1" "LogReport's Lire Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH NAME
Lire::ImportJob \- Object used to represent an periodical source of log data
.SH SYNOPSIS
.IX Header "SYNOPSIS"
.Vb 1
\&  use Lire::ImportJob;
\&
\&  my $src = new Lire::ImportJob( "name",
\&                                 \*(Aqpattern\*(Aq    => "/var/log/messsages",
\&                                 \*(Aqperiod\*(Aq     => "unique",
\&                                 \*(Aqprocessor\*(Aq  => $name,
\&                                );
\&
\&  my $file = $src\->file,
.Ve
.SH DESCRIPTION
.IX Header "DESCRIPTION"
The Lire::ImportJob object is used to represent a source of log data.
ImportJobs can also be instantiated from configuration data (The
\&\*(Aqimport_job\*(Aq configuration specification.)
.ie n .SH "new( $name, ... );"
.el .SH "new( \f(CW$name\fP, ... );"
.IX Header "new( $name, ... );"
Create a new Lire::ImportJob object. As mandatory parameter, it takes
the name of the log source.
.PP
Additional parameters:
.IP pattern 4
.IX Item "pattern"
The path to the file that contains the log data. This filename can
contain \fBstrftime\fR\|(3) patterns that will be substituted to obtain the
name of the file. (Useful for automatic rotation).
.IP period 4
.IX Item "period"
The periodicity to which this ImportJob should be processed. Defaults
to \*(Aqunique\*(Aq which means this is a one\-shot ImportJob. Other
recognized values are \*(Aqhourly\*(Aq, \*(Aqdaily\*(Aq, \*(Aqweekly\*(Aq, \*(Aqmonthly\*(Aq and \*(Aqyearly\*(Aq.
.IP converter 4
.IX Item "converter"
The name of the converter that can be used to process the ImportJob.
This must be known to the Lire::PluginManager.
.IP converter_config 4
.IX Item "converter_config"
Configuration parameter for the DlfConverter.
.IP filter 4
.IX Item "filter"
A shell command that will be used to filter the log file.
.IP encoding 4
.IX Item "encoding"
Encoding for the log file. If omitted, the default system encoding
will be used.
.SS \fBname()\fP
.IX Subsection "name()"
Returns the name of this ImportJob.
.SS "period( [$new_period] )"
.IX Subsection "period( [$new_period] )"
With no argument, returns the period of this ImportJob. With a
parameter, the ImportJob\*(Aqs period is set to this new value.
.SS "file( [$time] )"
.IX Subsection "file( [$time] )"
Returns the file to be used. The optional \f(CW$time\fR parameter (which
defaults to now) is used to compute the file name. To find the file to
use for yesterday\*(Aqs data, one could pass time \- 86400.
.SS "pattern( [$new_file] )"
.IX Subsection "pattern( [$new_file] )"
Returns the file pattern to use as log data source. This pattern may
contain \fBstrftime\fR\|(3) substitutions. If an argument is used, it will
change the file to use.
.SS "filter( [$new_filter] )"
.IX Subsection "filter( [$new_filter] )"
Returns the shell command that will be used as filter. Undef or \*(Aq\*(Aq
will not use a filter.
.SS "encoding( [$new_encoding] )"
.IX Subsection "encoding( [$new_encoding] )"
Returns the encoding of the log file. Undef and \*(Aq\*(Aq means to use
the system default encoding.
.SS "converter( [$new_name] )"
.IX Subsection "converter( [$new_name] )"
Returns the name of the converter that should be used for this
ImportJob.
.SS "converter_config( [$new_config] )"
.IX Subsection "converter_config( [$new_config] )"
Returns a configuration object that should be used by the DlfConverter
(through the \fBset_configuration()\fR method).
.ie n .SS "log_fh( [ $time ] )"
.el .SS "log_fh( [ \f(CW$time\fP ] )"
.IX Subsection "log_fh( [ $time ] )"
Returns a file handle that can be used to read from the log. \f(CW$time\fR is
the parameter taken by file to determine the final filename. All
filters and encoding will be setup properly.
.ie n .SS "run( $store, [$time] )"
.el .SS "run( \f(CW$store\fP, [$time] )"
.IX Subsection "run( $store, [$time] )"
Runs this ImportJob and import it into the \f(CW$store\fR DlfStore. The \f(CW$time\fR
parameter will be used to determine the time window covered by period.
It defaults to the current time.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
\&\fBLire::DlfStore\fR\|(3pm) \fBLire::DlfConverter\fR\|(3pm)
.SH AUTHOR
.IX Header "AUTHOR"
.Vb 1
\&  Francis J. Lacoste <flacoste@logreport.org>
.Ve
.SH VERSION
.IX Header "VERSION"
\&\f(CW$Id:\fR ImportJob.pm,v 1.14 2006/07/23 13:16:29 vanbaal Exp $
.SH COPYRIGHT
.IX Header "COPYRIGHT"
Copyright (C) 2002\-2004 Stichting LogReport Foundation LogReport@LogReport.org
.PP
This file is part of Lire.
.PP
Lire is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 2 of the License, or
(at your option) any later version.
.PP
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 General Public License for more details.
.PP
You should have received a copy of the GNU General Public License
along with this program (see COPYING); if not, check with
http://www.gnu.org/copyleft/gpl.html.