NAME

PkgForge::Handler::Initialise - Package Forge class for initialising the server

VERSION

This documentation refers to PkgForge::Handler::Initialise version 1.1.10

SYNOPSIS

    use PkgForge::Handler::Initialise ();

    my $init = PkgForge::Handler::Initialise->new_with_config();

    $init->execute;

DESCRIPTION

This class provides a method for initialising the Package Forge server. It creates any necessary directories and, optionally, wipes them to return them to a pristine starting position.

ATTRIBUTES

This class inherits from PkgForge::Handler, see the documentation for that module for full details of inherited attributes.

zap

Controls whether the contents of Package Forge directories which already exist should be wiped. Defaults to false.

configfile

This is inherited from MooseX::ConfigFromFile (via PkgForge::ConfigFile), if specified it can be used to initialise the class via the new_with_config method. It can be a string or a list of strings, each file should be a YAML file, see PkgForge::ConfigFile for details.

debug

A boolean value to control whether or not debugging messages are logged. The default is false.

incoming

The directory into which incoming package forge jobs will be submitted. The default is /var/lib/pkgforge/incoming

accepted

The directory into which package forge jobs will be transferred if they are accepted as valid. The default is /var/lib/pkgforge/accepted

results

The directory into which the results of finished package forge jobs will be stored. The default is /var/lib/pkgforge/results.

logdir

The directory into which log files will be stored by default. You can override the path to a log file to have any absolute path you wish so this attribute may have no effect on the log file used. The default is /var/log/pkgforge.

logfile

The file into which messages will be logged. The default value is default.log within the directory specified in the logdir attribute. You probably want a different log file for each handler.

logger

This is the logger object, you can call methods such as debug and error on this object to log messages. See Log::Dispatch and Log::Dispatch::Config for full details.

SUBROUTINES/METHODS

This class inherits from PkgForge::Handler, see the documentation for that module for full details of inherited methods.

new_with_config

This uses PkgForge::ConfigFile, which in turn uses MooseX::ConfigFromFile, to set the attributes for the module from configuration files.

execute

This method does the actual work of initialising the Package Forge server environment. It will create the required directories if they do not exist. If the zap attribute has been set to true then it will also wipe the contents of the directories if they already exist.

DEPENDENCIES

This module is powered by Moose and uses MooseX::ConfigFromFile and MooseX::Types.

SEE ALSO

PkgForge, PkgForge::Handler, PkgForge::Utils

PLATFORMS

This is the list of platforms on which we have tested this software. We expect this software to work on any Unix-like platform which is supported by Perl.

ScientificLinux5, Fedora13

BUGS AND LIMITATIONS

Please report any bugs or problems (or praise!) to bugs@lcfg.org, feedback and patches are also always very welcome.

AUTHOR

    Stephen Quinney <squinney@inf.ed.ac.uk>

LICENSE AND COPYRIGHT

    Copyright (C) 2010-2011 University of Edinburgh. All rights reserved.

This library is free software; you can redistribute it and/or modify it under the terms of the GPL, version 2 or later.