NAME

HH::Unispool::Config - HollandHouse' UNISPOOL configuration

SYNOPSIS

use strict;

use HH::Unispool::Config;
use HH::Unispool::Config::OS;
use HH::Unispool::Config::Entry::Filter;
use HH::Unispool::Config::Entry::System;
use HH::Unispool::Config::Entry::Device::5;
use HH::Unispool::Config::Entry::Device::6;
use HH::Unispool::Config::Entry::RemoteSystem::8;

# Read and write config
my $conf1 = HH::Unispool::Config->new_from_file('t/config.sample');
$conf1->write('t/config.sample.1.out');

# Read again, modify a little and diff config
my $conf2 = HH::Unispool::Config->new_from_file('t/config.sample');
$conf2->delete_system('foobar.bar.org');
my $diff = $conf1->diff($conf2);
if ($diff) {
    print STDERR "\nTHIS OUTPUT IS EXPECTED\n";
    print STDERR "DIFFERENCES\n";
    print STDERR  $diff;
    print STDERR "\nTHIS OUTPUT WAS EXPECTED\n";
}


# Create a config from scratch
my $conf3 = HH::Unispool::Config->new();

# Create a filter and add it to the configuration
my $flt = HH::Unispool::Config::Entry::Filter->new( {
    name => 'cat',
    file => '/usr/bin/cat',
} );
$conf3->add_filter($flt);

# Create the _Network_ system and add it to the configuration
my $sysn = HH::Unispool::Config::Entry::System->new( {
    name => '_Network_',
} );
$conf3->add_system($sysn);

# Add a type 8 remote system to _Network_
my $rsys = HH::Unispool::Config::Entry::RemoteSystem::8->new( {
    name => 'foo',
    os => HH::Unispool::Config::OS->new( { os => 'Solaris' } ),
    remote_node_name => 'foo.bar.org',
} );
$sysn->add_remote_system($rsys);

# Add a type 5 device to _Network_
my $dev = HH::Unispool::Config::Entry::Device::5->new( {
    name => 'lp',
    filter_name => 'cat',
    remote_device_name => 'lp',
    remote_system_name => 'foo',
    description => 'lp',
} );
$sysn->add_device($dev);

# Create the foo.bar.org system and add it to the configuration
my $sysf = HH::Unispool::Config::Entry::System->new( {
    name => 'foo.bar.org',
    local_system_name => 'foo',
    network_name => 'foo.bar.org',
    os => HH::Unispool::Config::OS->new( { os => 'Solaris' } ),
    type => 'cs',
} );
$conf3->add_system($sysf);

# Add a type 6 device to foo.bar.org
$dev = HH::Unispool::Config::Entry::Device::6->new( {
    name => 'lp1',
    filter_name => 'cat',
    remote_node_name => 'lp1.foo.bar.org',
    description => 'lp1',
} );
$sysf->add_device($dev);

# Add another type 6 device to foo.bar.org
$dev = HH::Unispool::Config::Entry::Device::6->new( {
    name => 'lp2',
    filter_name => 'cat',
    remote_node_name => 'lp2.foo.bar.org',
    description => 'lp2',
} );
$sysf->add_device($dev);

# Add another type 3 device to foo.bar.org
$dev = HH::Unispool::Config::Entry::Device::3->new( {
    name => 'lp',
    filter_name => 'cat',
    member_device_name => [ qw( lp1 lp2 ) ],
    description => 'lp',
} );
$sysf->add_device($dev);

# Write the configuration
$conf3->write('t/config.sample.3.out');

ABSTRACT

HollandHouse' UNISPOOL configuration

DESCRIPTION

HH::Unispool::Config manages HollandHouse' UNISPOOL configuration files. Files can be read, written, generated from scratch and diff-ed.

CONSTRUCTOR

new( [ OPT_HASH_REF ] )

Creates a new HH::Unispool::Config object. OPT_HASH_REF is a hash reference used to pass initialization options. On error an exception Error::Simple is thrown.

Options for OPT_HASH_REF may include:

diff_host

Passed to set_diff_host(). Defaults to 0.

diff_number

Passed to set_diff_number(). Defaults to 0.

diff_time

Passed to set_diff_time(). Defaults to 0.

diff_version

Passed to set_diff_version(). Defaults to 0.

filter

Passed to set_filter(). Must be an ARRAY reference.

host

Passed to set_host(). Defaults to the first part of &Sys::Hostname::hostname().

scope

Passed to set_scope(). Defaults to HH::Unispool::Config::Scope->new().

system

Passed to set_system(). Must be an ARRAY reference.

time

Passed to set_time(). Defaults to 'time()'.

version

Passed to set_version(). Defaults to the version number of the installed UNISPOOL instance or 0.

new_from_file(FILE)

Constructs a new HH::Unispool::Config object using a file. FILE is either a file name or an IO::Handle reference. On error an exception Error::Simple is thrown.

new_from_unispool()

Dumps the configuration of the UNISPOOL instance running on this machine into a temporary file, creates a new HH::Unispool::Config object using the temporary file and cleans up the temporary file. On error an exception Error::Simple is thrown.

METHODS

diff(TO)

Finds differences between two objects. In diff terms, the object is the from object and the specified TO parameter the to object. TO is a reference to an identical object class. Returns an empty string if no difference found and a difference descritpion string otherwise. On error an exception Error::Simple is thrown.

write(FILE)

Writes the object to file. FILE is either a file name or an IO::Handle reference. On error an exception Error::Simple is thrown.

write_to_unispool()

Writes the object to file and loads the file into UNISPOOL using config -load. On error an exception Error::Simple is thrown.

set_diff_host(VALUE)

State that diff() should consider the host attribtute. VALUE is the value. Default value at initialization is 0. On error an exception Error::Simple is thrown.

is_diff_host()

Returns whether diff() should consider the host attribtute or not.

set_diff_number(VALUE)

State that diff() should consider the number attribtutes of devices and remote systems. VALUE is the value. Default value at initialization is 0. On error an exception Error::Simple is thrown.

is_diff_number()

Returns whether diff() should consider the number attribtutes of devices and remote systems or not.

set_diff_time(VALUE)

State that diff() should consider the time attribtute. VALUE is the value. Default value at initialization is 0. On error an exception Error::Simple is thrown.

is_diff_time()

Returns whether diff() should consider the time attribtute or not.

set_diff_version(VALUE)

State that diff() should consider the version attribtute. VALUE is the value. Default value at initialization is 0. On error an exception Error::Simple is thrown.

is_diff_version()

Returns whether diff() should consider the version attribtute or not.

set_filter( [ VALUE ... ] )

Set the list of filters absolutely using values. Each VALUE is an object out of which the id is obtained through method get_name(). The obtained key is used to store the value and may be used for deletion and to fetch the value. 0 or more values may be supplied. Multiple occurences of the same key yield in the last occuring key to be inserted and the rest to be ignored. Each key of the specified values is allowed to occur only once. On error an exception Error::Simple is thrown.

The values in ARRAY must be a (sub)class of:

HH::Unispool::Config::Entry::Filter

add_filter( [ VALUE ... ] )

Add additional values on the list of filters. Each VALUE is an object out of which the id is obtained through method get_name(). The obtained key is used to store the value and may be used for deletion and to fetch the value. 0 or more values may be supplied. Multiple occurences of the same key yield in the last occuring key to be inserted and the rest to be ignored. Each key of the specified values is allowed to occur only once. On error an exception Error::Simple is thrown.

The values in ARRAY must be a (sub)class of:

HH::Unispool::Config::Entry::Filter

delete_filter(ARRAY)

Delete elements from the list of filters. Returns the number of deleted elements. On error an exception Error::Simple is thrown.

exists_filter(ARRAY)

Returns the count of items in ARRAY that are in the list of filters.

keys_filter()

Returns an ARRAY containing the keys of the list of filters.

values_filter( [ KEY_ARRAY ] )

Returns an ARRAY containing the values of the list of filters. If KEY_ARRAY contains one or more KEYs the values related to the KEYs are returned. If no KEYs specified all values are returned.

set_host(VALUE)

Set the host in the comment. VALUE is the value. Default value at initialization is the first part of &Sys::Hostname::hostname(). VALUE may not be undef. On error an exception Error::Simple is thrown.

VALUE must match regular expression:

^.+$

get_host()

Returns the host in the comment.

set_scope(VALUE)

Set not described option. VALUE is the value. Default value at initialization is HH::Unispool::Config::Scope->new(). VALUE may not be undef. On error an exception Error::Simple is thrown.

VALUE must be a (sub)class of:

HH::Unispool::Config::Scope

get_scope()

Returns not described option.

set_system( [ VALUE ... ] )

Set the list of systems absolutely using values. Each VALUE is an object out of which the id is obtained through method get_name(). The obtained key is used to store the value and may be used for deletion and to fetch the value. 0 or more values may be supplied. Multiple occurences of the same key yield in the last occuring key to be inserted and the rest to be ignored. Each key of the specified values is allowed to occur only once. On error an exception Error::Simple is thrown.

The values in ARRAY must be a (sub)class of:

HH::Unispool::Config::Entry::System

add_system( [ VALUE ... ] )

Add additional values on the list of systems. Each VALUE is an object out of which the id is obtained through method get_name(). The obtained key is used to store the value and may be used for deletion and to fetch the value. 0 or more values may be supplied. Multiple occurences of the same key yield in the last occuring key to be inserted and the rest to be ignored. Each key of the specified values is allowed to occur only once. On error an exception Error::Simple is thrown.

The values in ARRAY must be a (sub)class of:

HH::Unispool::Config::Entry::System

delete_system(ARRAY)

Delete elements from the list of systems. Returns the number of deleted elements. On error an exception Error::Simple is thrown.

exists_system(ARRAY)

Returns the count of items in ARRAY that are in the list of systems.

keys_system()

Returns an ARRAY containing the keys of the list of systems.

values_system( [ KEY_ARRAY ] )

Returns an ARRAY containing the values of the list of systems. If KEY_ARRAY contains one or more KEYs the values related to the KEYs are returned. If no KEYs specified all values are returned.

set_time(VALUE)

Set the date in the comment in Unix time. VALUE is the value. Default value at initialization is 'time()'. VALUE may not be undef. On error an exception Error::Simple is thrown.

VALUE must match regular expression:

^\d+$

get_time()

Returns the date in the comment in Unix time.

set_version(VALUE)

Set the version in the comment. VALUE is the value. Default value at initialization is the version number of the installed UNISPOOL instance or 0. VALUE may not be undef. On error an exception Error::Simple is thrown.

VALUE must match regular expression:

^.+$

get_version()

Returns the version in the comment.

SEE ALSO

HH::Unispool::Config::DateFormat, HH::Unispool::Config::Entry, HH::Unispool::Config::Entry::Device, HH::Unispool::Config::Entry::Device::0, HH::Unispool::Config::Entry::Device::1, HH::Unispool::Config::Entry::Device::2, HH::Unispool::Config::Entry::Device::3, HH::Unispool::Config::Entry::Device::4, HH::Unispool::Config::Entry::Device::5, HH::Unispool::Config::Entry::Device::6, HH::Unispool::Config::Entry::Device::7, HH::Unispool::Config::Entry::Filter, HH::Unispool::Config::Entry::Numbered, HH::Unispool::Config::Entry::RemoteSystem, HH::Unispool::Config::Entry::RemoteSystem::3, HH::Unispool::Config::Entry::RemoteSystem::6, HH::Unispool::Config::Entry::RemoteSystem::7, HH::Unispool::Config::Entry::RemoteSystem::8, HH::Unispool::Config::Entry::System, HH::Unispool::Config::ExecPri, HH::Unispool::Config::File::Token, HH::Unispool::Config::File::Token::Comment, HH::Unispool::Config::File::Token::Comment::Cs, HH::Unispool::Config::File::Token::Comment::Date, HH::Unispool::Config::File::Token::Comment::Device, HH::Unispool::Config::File::Token::Comment::Filter, HH::Unispool::Config::File::Token::Comment::Group, HH::Unispool::Config::File::Token::Comment::Head, HH::Unispool::Config::File::Token::Comment::Misc, HH::Unispool::Config::File::Token::Comment::NetDesc, HH::Unispool::Config::File::Token::Comment::RSys, HH::Unispool::Config::File::Token::Comment::Scope, HH::Unispool::Config::File::Token::Comment::Tail, HH::Unispool::Config::File::Token::Factory, HH::Unispool::Config::File::Token::Numbered, HH::Unispool::Config::File::Token::Numbered::Device, HH::Unispool::Config::File::Token::Numbered::Device::0, HH::Unispool::Config::File::Token::Numbered::Device::1, HH::Unispool::Config::File::Token::Numbered::Device::2, HH::Unispool::Config::File::Token::Numbered::Device::3, HH::Unispool::Config::File::Token::Numbered::Device::4, HH::Unispool::Config::File::Token::Numbered::Device::5, HH::Unispool::Config::File::Token::Numbered::Device::6, HH::Unispool::Config::File::Token::Numbered::Device::7, HH::Unispool::Config::File::Token::Numbered::Device::Group, HH::Unispool::Config::File::Token::Numbered::Device::Info, HH::Unispool::Config::File::Token::Numbered::Device::P, HH::Unispool::Config::File::Token::Numbered::Network, HH::Unispool::Config::File::Token::Numbered::System, HH::Unispool::Config::File::Token::Numbered::System::3, HH::Unispool::Config::File::Token::Numbered::System::6, HH::Unispool::Config::File::Token::Numbered::System::7, HH::Unispool::Config::File::Token::Numbered::System::8, HH::Unispool::Config::File::Token::Numbered::System::Info, HH::Unispool::Config::File::Token::Numbered::X, HH::Unispool::Config::File::Token::Unnumbered, HH::Unispool::Config::File::Token::Unnumbered::Bcs, HH::Unispool::Config::File::Token::Unnumbered::CSN, HH::Unispool::Config::File::Token::Unnumbered::Cs, HH::Unispool::Config::File::Token::Unnumbered::CsBcs, HH::Unispool::Config::File::Token::Unnumbered::Filter, HH::Unispool::Config::File::Token::Unnumbered::Host, HH::Unispool::Config::File::Token::Unnumbered::Misc, HH::Unispool::Config::File::Tokenizer, HH::Unispool::Config::FilterType, HH::Unispool::Config::OS, HH::Unispool::Config::Scope

BUGS

None known (yet.)

HISTORY

First development: February 2003

AUTHOR

Vincenzo Zocca

COPYRIGHT

Copyright 2003 by Vincenzo Zocca

LICENSE

This file is part of the HH::Unispool::Config module hierarchy for Perl by Vincenzo Zocca.

The HH::Unispool::Config module hierarchy 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.

The HH::Unispool::Config module hierarchy 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.

You should have received a copy of the GNU General Public License along with the HH::Unispool::Config module hierarchy; if not, write to the Free Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA