package HH::Unispool::Config::File::Token::Numbered::Device; 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 = ( 'block_delay' => [ '^\d*$' ], 'buffer_size' => [ '^\d*$' ], 'connect_retry' => [ '^\d*$' ], 'device_name' => [ '^.+$' ], 'device_password' => [ '^.*$' ], 'page_length' => [ '^\d*$' ], 'page_width' => [ '^\d*$' ], 'remote_device_name' => [ '^.*$' ], 'remote_system_name' => [ '^.*$' ], ); # Used by _value_is_allowed our %ALLOW_VALUE = ( ); # Package version our ($VERSION) = '$Revision: 0.3 $' =~ /\$Revision:\s+([^\s]+)/; 1; __END__ =head1 NAME HH::Unispool::Config::File::Token::Numbered::Device - abstract class for device I tokens =head1 SYNOPSIS Application programmers don't need to use this class and API programmers read code. =head1 ABSTRACT abstract class for device I tokens =head1 DESCRIPTION C is an abstract class for device I tokens. =head1 CONSTRUCTOR =over =item new(OPT_HASH_REF) Creates a new C object. C is a hash reference used to pass initialization options. C is mandatory. On error an exception C is thrown. Options for C may include: =over =item B> Passed to L. =item B> Passed to L. =item B> Passed to L. =item B> Passed to L. Mandatory option. =item B> Passed to L. =item B> Passed to L. =item B> Passed to L. =item B> Passed to L. =item B> Passed to L. =item B> Passed to L. =item B> Passed to L. =item B> Passed to L. =item B> Passed to L. =item B> Passed to L. =item B> Passed to L. =back Options for C inherited through package B> may include: =over =item B> Passed to L. =back Options for C inherited through package B> may include: =over =item B> Passed to L. =back =item new_from_string(LINE) Creates a new object from the specified Unispool config file line string. =back =head1 METHODS =over =item get_block_delay() Returns the time in seconds UNISPOOL should pause between sending two blocks. =item get_buffer_size() Returns the number of bytes sent to the printer in one write operation. =item get_connect_retry() Returns the number of seconds UNISPOOL should wait if the connection can not be established immediately. =item get_device_name() Returns the unique name for the device. =item get_device_password() Returns the password required to access the device. =item get_execution_priority() Returns the execution priority of the driver process on MPE hosts. =item get_input_line_number() This method is inherited from package C. Returns the line number from from which the token is read. =item get_number() This method is inherited from package C. Returns the number of the entry. =item get_page_length() Returns the page length (lines) for determining the size of UNISPOOL banners. =item get_page_width() Returns the page width (bytes) for determining the size of UNISPOOL banners. =item get_remote_device_name() Returns the device on the remote system that will receive the output. =item get_remote_system_name() Returns the name of the system to which the output for this device must be routed. =item is_initially_spooled() Returns whether an automatic STARTSPOOL must be performed when UNISPOOL is started or not. =item is_networkwide() Returns whether the device must be made available from each node in the configuration cluster or not. =item is_save_printfile() Returns whether printfiles printed on this device should be saved or not. =item is_unispool_control() Returns whether the UNISPOOL control is on (is not available on development system used) or not. =item is_unispool_header() Returns whether standard UNISPOOL banners pages are printed initially or not. =item read_string(LINE) This method is overloaded from package C. Reads the Unispool config file token from a line string. C is a plain line string. On error an exception C is thrown. =item set_block_delay(VALUE) Set the time in seconds UNISPOOL should pause between sending two blocks. C is the value. On error an exception C is thrown. =over =item VALUE must match regular expression: =over =item ^\d*$ =back =back =item set_buffer_size(VALUE) Set the number of bytes sent to the printer in one write operation. C is the value. On error an exception C is thrown. =over =item VALUE must match regular expression: =over =item ^\d*$ =back =back =item set_connect_retry(VALUE) Set the number of seconds UNISPOOL should wait if the connection can not be established immediately. C is the value. On error an exception C is thrown. =over =item VALUE must match regular expression: =over =item ^\d*$ =back =back =item set_device_name(VALUE) Set the unique name for the device. C is the value. On error an exception C is thrown. =over =item VALUE must match regular expression: =over =item ^.+$ =back =back =item set_device_password(VALUE) Set the password required to access the device. C is the value. On error an exception C is thrown. =over =item VALUE must match regular expression: =over =item ^.*$ =back =back =item set_execution_priority(VALUE) Set the execution priority of the driver process on MPE hosts. C is the value. On error an exception C is thrown. =over =item VALUE must be a (sub)class of: =over =item HH::Unispool::Config::ExecPri =back =back =item set_initially_spooled(VALUE) State that an automatic STARTSPOOL must be performed when UNISPOOL is started. C is the value. On error an exception C is thrown. =item set_input_line_number(VALUE) This method is inherited from package C. Set the line number from from which the token is read. C is the value. On error an exception C is thrown. =over =item VALUE must match regular expression: =over =item ^\d*$ =back =back =item set_networkwide(VALUE) State that the device must be made available from each node in the configuration cluster. C is the value. On error an exception C is thrown. =item set_number(VALUE) This method is inherited from package C. Set the number of the entry. C is the value. On error an exception C is thrown. =over =item VALUE must match regular expression: =over =item ^\d*$ =back =back =item set_page_length(VALUE) Set the page length (lines) for determining the size of UNISPOOL banners. C is the value. On error an exception C is thrown. =over =item VALUE must match regular expression: =over =item ^\d*$ =back =back =item set_page_width(VALUE) Set the page width (bytes) for determining the size of UNISPOOL banners. C is the value. On error an exception C is thrown. =over =item VALUE must match regular expression: =over =item ^\d*$ =back =back =item set_remote_device_name(VALUE) Set the device on the remote system that will receive the output. C is the value. On error an exception C is thrown. =over =item VALUE must match regular expression: =over =item ^.*$ =back =back =item set_remote_system_name(VALUE) Set the name of the system to which the output for this device must be routed. C is the value. On error an exception C is thrown. =over =item VALUE must match regular expression: =over =item ^.*$ =back =back =item set_save_printfile(VALUE) State that printfiles printed on this device should be saved. C is the value. On error an exception C is thrown. =item set_unispool_control(VALUE) State that the UNISPOOL control is on (is not available on development system used). C is the value. On error an exception C is thrown. =item set_unispool_header(VALUE) State that standard UNISPOOL banners pages are printed initially. C is the value. On error an exception C is thrown. =item write_string() This method is overloaded from package C. Returns a Unispool config file token line string. =back =head1 SEE ALSO L, L, L, L, L, L, L, L, L, L, L, L, L, L, L, L, L, L, L, L, L, L, L, L, L, L, L, L, L, L, L, L, L, L, L, L, L, L, L, L, L, L, L, L, L, L, L, L, L, L, L, L, L, L, L, L, L, L, L, L, L, L, L, L, L, L, L =head1 BUGS None known (yet.) =head1 HISTORY First development: February 2003 Last update: September 2003 =head1 AUTHOR Vincenzo Zocca =head1 COPYRIGHT Copyright 2003 by Vincenzo Zocca =head1 LICENSE This file is part of the C 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 =cut 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::Device::_initialize, first argument must be 'HASH' reference."); # block_delay, SINGLE exists( $opt->{block_delay} ) && $self->set_block_delay( $opt->{block_delay} ); # buffer_size, SINGLE exists( $opt->{buffer_size} ) && $self->set_buffer_size( $opt->{buffer_size} ); # connect_retry, SINGLE exists( $opt->{connect_retry} ) && $self->set_connect_retry( $opt->{connect_retry} ); # device_name, SINGLE, mandatory exists( $opt->{device_name} ) || throw Error::Simple("ERROR: HH::Unispool::Config::File::Token::Numbered::Device::_initialize, option 'device_name' is mandatory."); $self->set_device_name( $opt->{device_name} ); # device_password, SINGLE exists( $opt->{device_password} ) && $self->set_device_password( $opt->{device_password} ); # execution_priority, SINGLE exists( $opt->{execution_priority} ) && $self->set_execution_priority( $opt->{execution_priority} ); # initially_spooled, BOOLEAN exists( $opt->{initially_spooled} ) && $self->set_initially_spooled( $opt->{initially_spooled} ); # networkwide, BOOLEAN exists( $opt->{networkwide} ) && $self->set_networkwide( $opt->{networkwide} ); # page_length, SINGLE exists( $opt->{page_length} ) && $self->set_page_length( $opt->{page_length} ); # page_width, SINGLE exists( $opt->{page_width} ) && $self->set_page_width( $opt->{page_width} ); # remote_device_name, SINGLE exists( $opt->{remote_device_name} ) && $self->set_remote_device_name( $opt->{remote_device_name} ); # remote_system_name, SINGLE exists( $opt->{remote_system_name} ) && $self->set_remote_system_name( $opt->{remote_system_name} ); # save_printfile, BOOLEAN exists( $opt->{save_printfile} ) && $self->set_save_printfile( $opt->{save_printfile} ); # unispool_control, BOOLEAN exists( $opt->{unispool_control} ) && $self->set_unispool_control( $opt->{unispool_control} ); # unispool_header, BOOLEAN exists( $opt->{unispool_header} ) && $self->set_unispool_header( $opt->{unispool_header} ); # 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_block_delay { my $self = shift; return( $self->{HH_Unispool_Config_File_Token_Numbered_Device}{block_delay} ); } sub get_buffer_size { my $self = shift; return( $self->{HH_Unispool_Config_File_Token_Numbered_Device}{buffer_size} ); } sub get_connect_retry { my $self = shift; return( $self->{HH_Unispool_Config_File_Token_Numbered_Device}{connect_retry} ); } sub get_device_name { my $self = shift; return( $self->{HH_Unispool_Config_File_Token_Numbered_Device}{device_name} ); } sub get_device_password { my $self = shift; return( $self->{HH_Unispool_Config_File_Token_Numbered_Device}{device_password} ); } sub get_execution_priority { my $self = shift; return( $self->{HH_Unispool_Config_File_Token_Numbered_Device}{execution_priority} ); } sub get_page_length { my $self = shift; return( $self->{HH_Unispool_Config_File_Token_Numbered_Device}{page_length} ); } sub get_page_width { my $self = shift; return( $self->{HH_Unispool_Config_File_Token_Numbered_Device}{page_width} ); } sub get_remote_device_name { my $self = shift; return( $self->{HH_Unispool_Config_File_Token_Numbered_Device}{remote_device_name} ); } sub get_remote_system_name { my $self = shift; return( $self->{HH_Unispool_Config_File_Token_Numbered_Device}{remote_system_name} ); } sub is_initially_spooled { my $self = shift; if ( $self->{HH_Unispool_Config_File_Token_Numbered_Device}{initially_spooled} ) { return(1); } else { return(0); } } sub is_networkwide { my $self = shift; if ( $self->{HH_Unispool_Config_File_Token_Numbered_Device}{networkwide} ) { return(1); } else { return(0); } } sub is_save_printfile { my $self = shift; if ( $self->{HH_Unispool_Config_File_Token_Numbered_Device}{save_printfile} ) { return(1); } else { return(0); } } sub is_unispool_control { my $self = shift; if ( $self->{HH_Unispool_Config_File_Token_Numbered_Device}{unispool_control} ) { return(1); } else { return(0); } } sub is_unispool_header { my $self = shift; if ( $self->{HH_Unispool_Config_File_Token_Numbered_Device}{unispool_header} ) { return(1); } else { return(0); } } sub read_string { my $self = shift; $self->SUPER::read_string(@_); } 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::Device::set_block_delay, the specified value '$val' is not allowed."); # Assignment $self->{HH_Unispool_Config_File_Token_Numbered_Device}{block_delay} = $val; } sub set_buffer_size { my $self = shift; my $val = shift; # Check if isa/ref/rx/value is allowed &_value_is_allowed( 'buffer_size', $val ) || throw Error::Simple("ERROR: HH::Unispool::Config::File::Token::Numbered::Device::set_buffer_size, the specified value '$val' is not allowed."); # Assignment $self->{HH_Unispool_Config_File_Token_Numbered_Device}{buffer_size} = $val; } sub set_connect_retry { my $self = shift; my $val = shift; # Check if isa/ref/rx/value is allowed &_value_is_allowed( 'connect_retry', $val ) || throw Error::Simple("ERROR: HH::Unispool::Config::File::Token::Numbered::Device::set_connect_retry, the specified value '$val' is not allowed."); # Assignment $self->{HH_Unispool_Config_File_Token_Numbered_Device}{connect_retry} = $val; } sub set_device_name { my $self = shift; my $val = shift; # Check if isa/ref/rx/value is allowed &_value_is_allowed( 'device_name', $val ) || throw Error::Simple("ERROR: HH::Unispool::Config::File::Token::Numbered::Device::set_device_name, the specified value '$val' is not allowed."); # Assignment $self->{HH_Unispool_Config_File_Token_Numbered_Device}{device_name} = $val; } sub set_device_password { my $self = shift; my $val = shift; # Check if isa/ref/rx/value is allowed &_value_is_allowed( 'device_password', $val ) || throw Error::Simple("ERROR: HH::Unispool::Config::File::Token::Numbered::Device::set_device_password, the specified value '$val' is not allowed."); # Assignment $self->{HH_Unispool_Config_File_Token_Numbered_Device}{device_password} = $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::Device::set_execution_priority, the specified value '$val' is not allowed."); # Assignment $self->{HH_Unispool_Config_File_Token_Numbered_Device}{execution_priority} = $val; } sub set_initially_spooled { my $self = shift; if (shift) { $self->{HH_Unispool_Config_File_Token_Numbered_Device}{initially_spooled} = 1; } else { $self->{HH_Unispool_Config_File_Token_Numbered_Device}{initially_spooled} = 0; } } sub set_networkwide { my $self = shift; if (shift) { $self->{HH_Unispool_Config_File_Token_Numbered_Device}{networkwide} = 1; } else { $self->{HH_Unispool_Config_File_Token_Numbered_Device}{networkwide} = 0; } } sub set_page_length { my $self = shift; my $val = shift; # Check if isa/ref/rx/value is allowed &_value_is_allowed( 'page_length', $val ) || throw Error::Simple("ERROR: HH::Unispool::Config::File::Token::Numbered::Device::set_page_length, the specified value '$val' is not allowed."); # Assignment $self->{HH_Unispool_Config_File_Token_Numbered_Device}{page_length} = $val; } sub set_page_width { my $self = shift; my $val = shift; # Check if isa/ref/rx/value is allowed &_value_is_allowed( 'page_width', $val ) || throw Error::Simple("ERROR: HH::Unispool::Config::File::Token::Numbered::Device::set_page_width, the specified value '$val' is not allowed."); # Assignment $self->{HH_Unispool_Config_File_Token_Numbered_Device}{page_width} = $val; } sub set_remote_device_name { my $self = shift; my $val = shift; # Check if isa/ref/rx/value is allowed &_value_is_allowed( 'remote_device_name', $val ) || throw Error::Simple("ERROR: HH::Unispool::Config::File::Token::Numbered::Device::set_remote_device_name, the specified value '$val' is not allowed."); # Assignment $self->{HH_Unispool_Config_File_Token_Numbered_Device}{remote_device_name} = $val; } 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::Device::set_remote_system_name, the specified value '$val' is not allowed."); # Assignment $self->{HH_Unispool_Config_File_Token_Numbered_Device}{remote_system_name} = $val; } sub set_save_printfile { my $self = shift; if (shift) { $self->{HH_Unispool_Config_File_Token_Numbered_Device}{save_printfile} = 1; } else { $self->{HH_Unispool_Config_File_Token_Numbered_Device}{save_printfile} = 0; } } sub set_unispool_control { my $self = shift; if (shift) { $self->{HH_Unispool_Config_File_Token_Numbered_Device}{unispool_control} = 1; } else { $self->{HH_Unispool_Config_File_Token_Numbered_Device}{unispool_control} = 0; } } sub set_unispool_header { my $self = shift; if (shift) { $self->{HH_Unispool_Config_File_Token_Numbered_Device}{unispool_header} = 1; } else { $self->{HH_Unispool_Config_File_Token_Numbered_Device}{unispool_header} = 0; } } sub write_string { my $self = shift; $self->SUPER::read_string(@_); }