HH::Unispool::Config::File::Token::Numbered::Network - network I<N> token

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

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

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

# Used by _value_is_allowed
our %ALLOW_REF = (
);

# Used by _value_is_allowed
our %ALLOW_RX = (
    'remote_node_name' => [ '^.+$' ],
    'server_tcp_port' => [ '^.*$' ],
    'transfer_size' => [ '^\d*$' ],
    'transfer_time_out' => [ '^\d*$' ],
);

# Used by _value_is_allowed
our %ALLOW_VALUE = (
    'protocol' => {
        'LPD' => 1,
        'PJL' => 1,
        'TCP' => 1,
        'XPP' => 1,
    },
);

# 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::Network::_initialize, first argument must be 'HASH' reference.");

    # device_token, BOOLEAN
    exists( $opt->{device_token} ) && $self->set_device_token( $opt->{device_token} );

    # os, SINGLE
    exists( $opt->{os} ) && $self->set_os( $opt->{os} );

    # protocol, SINGLE
    exists( $opt->{protocol} ) && $self->set_protocol( $opt->{protocol} );

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

    # server_tcp_port, SINGLE
    exists( $opt->{server_tcp_port} ) && $self->set_server_tcp_port( $opt->{server_tcp_port} );

    # transfer_size, SINGLE
    exists( $opt->{transfer_size} ) && $self->set_transfer_size( $opt->{transfer_size} );

    # transfer_time_out, SINGLE
    exists( $opt->{transfer_time_out} ) && $self->set_transfer_time_out( $opt->{transfer_time_out} );

    # 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 ( defined($val) && ! 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_os {
    my $self = shift;

    return( $self->{HH_Unispool_Config_File_Token_Numbered_Network}{os} );
}

sub get_protocol {
    my $self = shift;

    return( $self->{HH_Unispool_Config_File_Token_Numbered_Network}{protocol} );
}

sub get_remote_node_name {
    my $self = shift;

    return( $self->{HH_Unispool_Config_File_Token_Numbered_Network}{remote_node_name} );
}

sub get_server_tcp_port {
    my $self = shift;

    return( $self->{HH_Unispool_Config_File_Token_Numbered_Network}{server_tcp_port} );
}

sub get_transfer_size {
    my $self = shift;

    return( $self->{HH_Unispool_Config_File_Token_Numbered_Network}{transfer_size} );
}

sub get_transfer_time_out {
    my $self = shift;

    return( $self->{HH_Unispool_Config_File_Token_Numbered_Network}{transfer_time_out} );
}

sub is_device_token {
    my $self = shift;

    if ( $self->{HH_Unispool_Config_File_Token_Numbered_Network}{device_token} ) {
        return(1);
    }
    else {
        return(0);
    }
}

sub read_string {
    my $self = shift;
    my $line = shift;

    # Parse line for name
    my ($number, $remote_node_name, $tail) = $line =~ /$USP_N_RX/;
    defined($number) || throw Error::Simple("ERROR: HH::Unispool::Config::File::Token::Numbered::Network::read_string, parameter 'LINE' does not match the regular expression for this token's line string.");
    $remote_node_name =~ s/\s*$//;
    my @tail = $self->_split_tail($tail);
    ( scalar(@tail) > 3 ) && throw Error::Simple("ERROR: HH::Unispool::Config::File::Token::Numbered::Network::read_string, parameter 'LINE' contains too many ';' separated entries after the remote node name '$remote_node_name'.");

    # Set attributes
    $self->set_number($number);
    defined($remote_node_name) && $self->set_remote_node_name($remote_node_name);

    if (defined ( $tail[1] ) && $tail[1] eq 'SERVER') {
        $self->set_device_token(1);
        defined( $tail[0] ) && $self->set_protocol( $tail[0] );
        defined( $tail[2] ) && $self->set_server_tcp_port( $tail[2] );
    }
    else {
        $self->set_device_token(0);
        if ( defined( $tail[0] ) && $tail[0] ) {
            require HH::Unispool::Config::OS;
            $self->set_os( HH::Unispool::Config::OS->new( { os => $tail[0] } ) );
        }
        defined( $tail[1] ) && $self->set_transfer_size( $tail[1] );
        defined( $tail[2] ) && $self->set_transfer_time_out( $tail[2] );
    }
}

sub set_device_token {
    my $self = shift;

    if (shift) {
        $self->{HH_Unispool_Config_File_Token_Numbered_Network}{device_token} = 1;
    }
    else {
        $self->{HH_Unispool_Config_File_Token_Numbered_Network}{device_token} = 0;
    }
}

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

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

    # Assignment
    $self->{HH_Unispool_Config_File_Token_Numbered_Network}{os} = $val;
}

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

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

    # Assignment
    $self->{HH_Unispool_Config_File_Token_Numbered_Network}{protocol} = $val;
}

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

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

    # Assignment
    $self->{HH_Unispool_Config_File_Token_Numbered_Network}{remote_node_name} = $val;
}

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

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

    # Assignment
    $self->{HH_Unispool_Config_File_Token_Numbered_Network}{server_tcp_port} = $val;
}

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

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

    # Assignment
    $self->{HH_Unispool_Config_File_Token_Numbered_Network}{transfer_size} = $val;
}

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

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

    # Assignment
    $self->{HH_Unispool_Config_File_Token_Numbered_Network}{transfer_time_out} = $val;
}

sub write_string {
    my $self = shift;

    # Make string and return it
    $self->is_device_token() && return(
        sprintf(
            $USP_ND_FRM,
            $self->get_number() || 0,
            $self->get_remote_node_name() || '',
            $self->get_protocol() || '',
            $self->get_server_tcp_port() || '',
        )
    );

    if ( defined( $self->get_os() ) && defined( $self->get_transfer_size() ) && $self->get_transfer_size() || defined( $self->get_transfer_time_out() ) && $self->get_transfer_time_out() ) {
        return(
            sprintf(
                $USP_N5_FRM,
                $self->get_number() || 0,
                $self->get_remote_node_name() || '',
                $self->get_os()->get_os() || '',
                $self->get_transfer_size() || 0,
                $self->get_transfer_time_out() || 0,
            )
        );
    }
    if ( defined( $self->get_os() ) ) {
        return(
            sprintf(
                $USP_N3_FRM,
                $self->get_number() || 0,
                $self->get_remote_node_name() || '',
                $self->get_os()->get_os() || '',
            )
        );
    }
    return(
        sprintf(
            $USP_N2_FRM,
            $self->get_number() || 0,
            $self->get_remote_node_name() || '',
        )
    );
}