File Coverage

blib/lib/Unix/Conf/Bind8.pm

Criterion	Covered	Total	%
statement	10	12	83.3
branch			n/a
condition			n/a
subroutine	4	4	100.0
pod			n/a
total	14	16	87.5

# Bind8 front.
#
# Copyright Karthik Krishnamurthy

=head1 NAME

Unix::Conf::Bind8 - Front end for a suite of classes for manipulating a
Bind8 conf and associated zone record files.

=head1 SYNOPSIS

    use Unix::Conf::Bind8;
    my ($conf, $ret);

    # get a new Bind8::Conf object. If one exists with the same
    # name it is parsed.
    $conf = Unix::Conf::Bind8->new_conf (
        FILE => 'named.conf',
        SECURE_OPEN => 1
    ) or $conf->die ('could not open \'named.conf\'');

    $db = Unix::Conf::Bind8->new_db (
        FILE	=> '/etc/namedb/db.extremix.net',
        ORIGIN	=> 'extremix.net',
        CLASS	=> 'IN',
        SECURE_OPEN	=> 0,
    ) or $db->die ("couldn't create db");

=head1 METHODS

=cut

package Unix::Conf::Bind8;

use 5.6.0;
use strict;
use warnings;

use Unix::Conf::Bind8::Conf;
use Unix::Conf::Bind8::DB;

$Unix::Conf::Bind8::VERSION = "0.3";

=over 4

=item new_conf ()

 Arguments
 FILE        => PATHNAME,
 SECURE_OPEN => 1/0,       # default 1 (enabled)

Class Method
Read Bind8 configuration file PATHNAME or create one if none
exists.
Returns a Bind8::Conf object in case of success or an Err object
in case of failure. Refer to docs for Bind8::Conf for further
information.

=cut

sub new_conf ()
{
	shift ();
	return (Unix::Conf::Bind8::Conf->new (@_));
}

=item new_db ()

 Arguments
 FILE        => PATHNAME,	 # pathname of the records file
 ORIGIN      => ZONE_ORIGIN, # from the zone statement
 CLASS       => ZONE_CLASS,	 # from the zone statement
 SECURE_OPEN => 1/0,         # default 1 (enabled)

Class method.
Read a zone records file PATHNAME or create one if none exists.
Returns a Bind8::DB object in case of success or an Err object in
case of failure. Do not use this method. Use
Unix::Conf::Bind8::Conf::Zone::get_db (), or better still,
Unix::Conf::Bind8::Conf::get_db () instead.
Refer to docs for Bind8::DB for further information.

=cut

sub new_db ()
{
	shift ();
	return (Unix::Conf::Bind8::DB->new (@_));
}

1;
__END__