/ 
Siebel-Srvrmgr-0.07
River stage zero No dependents
/ Siebel::Srvrmgr::ListParser::Output::ListParams

NAME

Siebel::Srvrmgr::ListParser::Output::ListParams - subclass to parse output of the command list comp params.

SYNOPSIS

use Siebel::Srvrmgr::ListParser::Output::ListParams;

my $comp_params = Siebel::Srvrmgr::ListParser::Output::ListParams->new({ data_type => 'list_comp_params', 
																		 raw_data => \@com_data, 
														                 cmd_line => 'list params for server XXXX component YYYY'});

my $server_params = Siebel::Srvrmgr::ListParser::Output::ListParams->new({ data_type => 'sometype', 
																		   raw_data => \@server_data,
														                   cmd_line => 'list params for server XXXX'});

DESCRIPTION

This module parses the output of the command list comp params. Beware that those parameters may be of the server if a component alias is omitted from the command line.

The parser expects to have the following configuration of fields for the respective command.

srvrmgr> configure list params
	PA_ALIAS (31):  Parameter alias
	PA_VALUE (101):  Parameter value
	PA_DATATYPE (31):  Parameter value datatype
	PA_SCOPE (31):  Parameter level
	PA_SUBSYSTEM (31):  Parameter subsystem
	PA_SETLEVEL (31):  Internal level at which value was set
	PA_DISP_SETLEVEL (61):  Display level at which value was set (translatable)
	PA_NAME (76):  Parameter name

The data_parsed attribute will return the following data estructure:

'data_parsed' => {
	'Parameter1' => {
		'PA_NAME' => 'Private key file name',
		'PA_DATATYPE' => 'String',
		'PA_SCOPE' => 'Subsystem',
		'PA_VALUE' => '',
		'PA_ALIAS' => 'KeyFileName',
		'PA_SETLEVEL' => 'SIS_NEVER_SET',
		'PA_DISP_SETLEVEL' => 'SIS_NEVER_SET',
		'PA_SUBSYSTEM' => 'Networking'
		},
	'Parameter2' => {
		'PA_NAME' => 'Private key file name',
		'PA_DATATYPE' => 'String',
		'PA_SCOPE' => 'Subsystem',
		'PA_VALUE' => '',
		'PA_ALIAS' => 'KeyFileName',
		'PA_SETLEVEL' => 'SIS_NEVER_SET',
		'PA_DISP_SETLEVEL' => 'SIS_NEVER_SET',
		'PA_SUBSYSTEM' => 'Networking'
		},
		# N parameters
}

Until now there is no method implementation that would return a parameter name and it's properties, it's necessary to access the hashes directly.

ATTRIBUTES

params

An array reference with the parameters attributes representing the output of the command list comp params. If this description looks confusing, is the same columns shown in the command configure list params.

server

An string representing the server from where the parameter were got.

comp_alias

An string of the component alias respective to the command executed, if available (considering that the parameter may be of the server, not a component).

METHODS

get_params

Returns the attribute params.

set_params

Set the attribute params. Expects an array reference as parameter.

_set_details

A "private" method used to get the servername and component alias from the command line given as parameter during object creation.

BUILD

Execute the method _set_details right after object creation.

parse

Parses the data in the raw_data attribute setting the data_parsed at the end of process.

Beware that the raw_data attribute will be set to an empty array reference at the end of the process.

CAVEATS

On Win32 system the method load inherited from the superclass is not recovering the related data of data_parsed attribute, even when that data is saved with the store method.

Despite that, the Storable retrieve function is capable to recover such data (but not the class methods).

SEE ALSO

AUTHOR

Alceu Rodrigues de Freitas Junior, <arfreitas@cpan.org<>

COPYRIGHT AND LICENSE

This software is copyright (c) 2012 of Alceu Rodrigues de Freitas Junior, <arfreitas@cpan.org<>

This file is part of Siebel Monitoring Tools.

Siebel Monitoring Tools 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 3 of the License, or (at your option) any later version.

Siebel Monitoring Tools 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 Siebel Monitoring Tools. If not, see <http://www.gnu.org/licenses/>.