HH::Unispool::Config::File::Token::Numbered::System - abstract class for system I<S> tokens

package HH::Unispool::Config::File::Token::Numbered::System;

use 5.006;
use base qw( HH::Unispool::Config::File::Token::Numbered );
use strict;
use warnings;
use AutoLoader qw(AUTOLOAD);
use Error qw(:try);

# Used by _value_is_allowed
our %ALLOW_ISA = (
    'execution_priority' => [ 'HH::Unispool::Config::ExecPri' ],
);

# Used by _value_is_allowed
our %ALLOW_REF = (
);

# Used by _value_is_allowed
our %ALLOW_RX = (
    'acct' => [ '^.*$' ],
    'apass' => [ '^.*$' ],
    'block_delay' => [ '^\d*$' ],
    'remote_system_name' => [ '^.+$' ],
    'timeout' => [ '^\d*$' ],
    'upass' => [ '^.*$' ],
);

# Used by _value_is_allowed
our %ALLOW_VALUE = (
);

# Package version
our ($VERSION) = '$Revision: 0.3 $' =~ /\$Revision:\s+([^\s]+)/;

1;

__END__

sub _initialize {
    my $self = shift;
    my $opt = defined($_[0]) ? shift : {};

    # Check $opt
    ref($opt) eq 'HASH' || throw Error::Simple("ERROR: HH::Unispool::Config::File::Token::Numbered::System::_initialize, first argument must be 'HASH' reference.");

    # acct, SINGLE
    exists( $opt->{acct} ) && $self->set_acct( $opt->{acct} );

    # apass, SINGLE
    exists( $opt->{apass} ) && $self->set_apass( $opt->{apass} );

    # block_delay, SINGLE
    exists( $opt->{block_delay} ) && $self->set_block_delay( $opt->{block_delay} );

    # execution_priority, SINGLE
    exists( $opt->{execution_priority} ) && $self->set_execution_priority( $opt->{execution_priority} );

    # high_priority_login, BOOLEAN
    exists( $opt->{high_priority_login} ) && $self->set_high_priority_login( $opt->{high_priority_login} );

    # initially_open, BOOLEAN
    exists( $opt->{initially_open} ) && $self->set_initially_open( $opt->{initially_open} );

    # remote_system_name, SINGLE, mandatory
    exists( $opt->{remote_system_name} ) || throw Error::Simple("ERROR: HH::Unispool::Config::File::Token::Numbered::System::_initialize, option 'remote_system_name' is mandatory.");
    $self->set_remote_system_name( $opt->{remote_system_name} );

    # timeout, SINGLE
    exists( $opt->{timeout} ) && $self->set_timeout( $opt->{timeout} );

    # upass, SINGLE
    exists( $opt->{upass} ) && $self->set_upass( $opt->{upass} );

    # Call the superclass' _initialize
    $self->SUPER::_initialize($opt);

    # Return $self
    return($self);
}

sub _value_is_allowed {
    my $name = shift;

    # Value is allowed if no ALLOW clauses exist for the named attribute
    if ( ! exists( $ALLOW_ISA{$name} ) && ! exists( $ALLOW_REF{$name} ) && ! exists( $ALLOW_RX{$name} ) && ! exists( $ALLOW_VALUE{$name} ) ) {
        return(1);
    }

    # At this point, all values in @_ must to be allowed
    CHECK_VALUES:
    foreach my $val (@_) {
        # Check ALLOW_ISA
        if ( ref($val) && exists( $ALLOW_ISA{$name} ) ) {
            foreach my $class ( @{ $ALLOW_ISA{$name} } ) {
                &UNIVERSAL::isa( $val, $class ) && next CHECK_VALUES;
            }
        }

        # Check ALLOW_REF
        if ( ref($val) && exists( $ALLOW_REF{$name} ) ) {
            exists( $ALLOW_REF{$name}{ ref($val) } ) && next CHECK_VALUES;
        }

        # Check ALLOW_RX
        if ( ! ref($val) && exists( $ALLOW_RX{$name} ) ) {
            foreach my $rx ( @{ $ALLOW_RX{$name} } ) {
                $val =~ /$rx/ && next CHECK_VALUES;
            }
        }

        # Check ALLOW_VALUE
        if ( ! ref($val) && exists( $ALLOW_VALUE{$name} ) ) {
            exists( $ALLOW_VALUE{$name}{$val} ) && next CHECK_VALUES;
        }

        # We caught a not allowed value
        return(0);
    }

    # OK, all values are allowed
    return(1);
}

sub get_acct {
    my $self = shift;

    return( $self->{HH_Unispool_Config_File_Token_Numbered_System}{acct} );
}

sub get_apass {
    my $self = shift;

    return( $self->{HH_Unispool_Config_File_Token_Numbered_System}{apass} );
}

sub get_block_delay {
    my $self = shift;

    return( $self->{HH_Unispool_Config_File_Token_Numbered_System}{block_delay} );
}

sub get_execution_priority {
    my $self = shift;

    return( $self->{HH_Unispool_Config_File_Token_Numbered_System}{execution_priority} );
}

sub get_remote_system_name {
    my $self = shift;

    return( $self->{HH_Unispool_Config_File_Token_Numbered_System}{remote_system_name} );
}

sub get_timeout {
    my $self = shift;

    return( $self->{HH_Unispool_Config_File_Token_Numbered_System}{timeout} );
}

sub get_upass {
    my $self = shift;

    return( $self->{HH_Unispool_Config_File_Token_Numbered_System}{upass} );
}

sub is_high_priority_login {
    my $self = shift;

    if ( $self->{HH_Unispool_Config_File_Token_Numbered_System}{high_priority_login} ) {
        return(1);
    }
    else {
        return(0);
    }
}

sub is_initially_open {
    my $self = shift;

    if ( $self->{HH_Unispool_Config_File_Token_Numbered_System}{initially_open} ) {
        return(1);
    }
    else {
        return(0);
    }
}

sub read_string {
    my $self = shift;

    $self->SUPER::read_string(@_);
}

sub set_acct {
    my $self = shift;
    my $val = shift;

    # Check if isa/ref/rx/value is allowed
    &_value_is_allowed( 'acct', $val ) || throw Error::Simple("ERROR: HH::Unispool::Config::File::Token::Numbered::System::set_acct, the specified value '$val' is not allowed.");

    # Assignment
    $self->{HH_Unispool_Config_File_Token_Numbered_System}{acct} = $val;
}

sub set_apass {
    my $self = shift;
    my $val = shift;

    # Check if isa/ref/rx/value is allowed
    &_value_is_allowed( 'apass', $val ) || throw Error::Simple("ERROR: HH::Unispool::Config::File::Token::Numbered::System::set_apass, the specified value '$val' is not allowed.");

    # Assignment
    $self->{HH_Unispool_Config_File_Token_Numbered_System}{apass} = $val;
}

sub set_block_delay {
    my $self = shift;
    my $val = shift;

    # Check if isa/ref/rx/value is allowed
    &_value_is_allowed( 'block_delay', $val ) || throw Error::Simple("ERROR: HH::Unispool::Config::File::Token::Numbered::System::set_block_delay, the specified value '$val' is not allowed.");

    # Assignment
    $self->{HH_Unispool_Config_File_Token_Numbered_System}{block_delay} = $val;
}

sub set_execution_priority {
    my $self = shift;
    my $val = shift;

    # Check if isa/ref/rx/value is allowed
    &_value_is_allowed( 'execution_priority', $val ) || throw Error::Simple("ERROR: HH::Unispool::Config::File::Token::Numbered::System::set_execution_priority, the specified value '$val' is not allowed.");

    # Assignment
    $self->{HH_Unispool_Config_File_Token_Numbered_System}{execution_priority} = $val;
}

sub set_high_priority_login {
    my $self = shift;

    if (shift) {
        $self->{HH_Unispool_Config_File_Token_Numbered_System}{high_priority_login} = 1;
    }
    else {
        $self->{HH_Unispool_Config_File_Token_Numbered_System}{high_priority_login} = 0;
    }
}

sub set_initially_open {
    my $self = shift;

    if (shift) {
        $self->{HH_Unispool_Config_File_Token_Numbered_System}{initially_open} = 1;
    }
    else {
        $self->{HH_Unispool_Config_File_Token_Numbered_System}{initially_open} = 0;
    }
}

sub set_remote_system_name {
    my $self = shift;
    my $val = shift;

    # Check if isa/ref/rx/value is allowed
    &_value_is_allowed( 'remote_system_name', $val ) || throw Error::Simple("ERROR: HH::Unispool::Config::File::Token::Numbered::System::set_remote_system_name, the specified value '$val' is not allowed.");

    # Assignment
    $self->{HH_Unispool_Config_File_Token_Numbered_System}{remote_system_name} = $val;
}

sub set_timeout {
    my $self = shift;
    my $val = shift;

    # Check if isa/ref/rx/value is allowed
    &_value_is_allowed( 'timeout', $val ) || throw Error::Simple("ERROR: HH::Unispool::Config::File::Token::Numbered::System::set_timeout, the specified value '$val' is not allowed.");

    # Assignment
    $self->{HH_Unispool_Config_File_Token_Numbered_System}{timeout} = $val;
}

sub set_upass {
    my $self = shift;
    my $val = shift;

    # Check if isa/ref/rx/value is allowed
    &_value_is_allowed( 'upass', $val ) || throw Error::Simple("ERROR: HH::Unispool::Config::File::Token::Numbered::System::set_upass, the specified value '$val' is not allowed.");

    # Assignment
    $self->{HH_Unispool_Config_File_Token_Numbered_System}{upass} = $val;
}

sub write_string {
    my $self = shift;

    $self->SUPER::read_string(@_);
}