API-Eulerian
view release on metacpan or search on metacpan
lib/API/Eulerian/EDW/Peer.pm view on Meta::CPAN
#/usr/bin/env perl
###############################################################################
#
# @file Peer.pm
#
# @brief Eulerian Data Warehouse Peer Base class Module definition.
#
# @author Thorillon Xavier:x.thorillon@eulerian.com
#
# @date 26/11/2021
#
# @version 1.0
#
###############################################################################
package API::Eulerian::EDW::Peer;
use strict;
use API::Eulerian::EDW::Status();
#
# @brief Allocate a new Eulerian Data Warehouse Peer.
#
# @param $class - Eulerian Data Warehouse Peer Class.
# @param $setup - Setup attributes.
#
# @return Eulerian Data Warehouse Peer instance.
#
sub new
{
my $proto = shift();
my $class = ref($proto) || $proto;
my $setup = shift() || {};
return bless({
_CLASS => $class,
_KIND => 'access',
_PLATFORM => 'fr',
_HOOKS => undef,
_TOKEN => undef,
_GRID => undef,
_HOST => undef,
_PORTS => [ 80, 443 ],
_SECURE => 1,
_IP => undef
});
}
#
# @brief Class attribute getter.
#
# @param $self - Eulerian Data Warehouse Peer.
#
# @return Eulerian Data Warehouse Peer Class name.
#
sub class
{
return shift->{ _CLASS };
}
# @brief Token Kind attribute accessors.
#
# @param $self - Eulerian Data Warehouse Peer.
# @param $kind - Token kind.
#
# @return Token Kind.
#
sub kind
{
my ( $self, $kind ) = @_;
$self->{ _KIND } = $kind if defined( $kind );
return $self->{ _KIND };
}
#
# @brief Host attribute accessors.
#
# @param $self - Eulerian Data Warehouse Peer.
# @param $host - Eulerian Data Warehouse Host name.
#
# @return Eulerian Data Warehouse Host Name.
#
sub host
{
my ( $self, $host ) = @_;
$self->{ _HOST } = $host if defined( $host );
return $self->{ _HOST };
}
#
# @brief Ports attribute accessors.
#
# @param $self - Eulerian Data Warehouse Peer.
# @param $ports - Eulerian Data Warehouse Host Ports.
#
# @return Eulerian Data Warehouse Host Ports.
#
lib/API/Eulerian/EDW/Peer.pm view on Meta::CPAN
#
# @brief Grid attribute accessors.
#
# @param $self - Eulerian Data Warehouse Peer.
# @param $grid - Eulerian Data Warehouse Grid.
#
# @return Eulerian Data Warehouse Grid.
#
sub grid
{
my ( $self, $grid ) = @_;
$self->{ _GRID } = $grid if defined( $grid );
return $self->{ _GRID };
}
#
# @brief Secure attribute accessors.
#
# @param $self - Eulerian Data Warehouse Peer.
# @param $secure - Secure mode flag.
#
# @return Secure mode flag.
#
sub secure
{
my ( $self, $secure ) = @_;
$self->{ _SECURE } = $secure if defined( $secure );
return $self->{ _SECURE };
}
#
# @brief IP attribute accessors.
#
# @param $self - Eulerian Data Warehouse Peer.
# @param $ip - Eulerian Data Warehouse Peer IP.
#
# @return Secure mode flag.
#
sub ip
{
my ( $self, $ip ) = @_;
$self->{ _IP } = $ip if defined( $ip );
return $self->{ _IP };
}
#
# @brief Token attribute accessors.
#
# @param $self - Eulerian Data Warehouse Peer.
# @param $token - Eulerian Token.
#
# @return Eulerian Token.
#
sub token
{
my ( $self, $token ) = @_;
$self->{ _TOKEN } = $token if defined( $token );
return $self->{ _TOKEN };
}
#
# @brief Setup Eulerian Data Warehouse Peer.
#
# @param $self - Eulerian Data Warehouse Peer.
# @param $setup - Setup entries.
#
sub setup
{
my ( $self, $setup ) = @_;
foreach my $param ( qw/
kind platform hook secure token grid ip host ports / ) {
if ( $self->can($param) && exists $setup->{ $param } ) {
$self->$param( $setup->{$param} );
}
}
return $self;
}
#
# @brief Dump Eulerian Data Warehouse Peer settings.
#
# @param $self - Eulerian Data Warehouse Peer.
#
sub dump
{
my ( $self ) = @_;
my $hook = $self->hook() ? 'Set' : 'Unset';
my $secure = $self->secure() ? 'True' : 'False';
my $ports = $self->ports();
my $dump = "\n";
$ports = $ports ? $ports->[ 0 ] . ',' . $ports->[ 1 ] : undef;
$dump .= 'Host : ' . $self->host() . "\n" if $self->host();
$dump .= 'Ports : ' . $ports . "\n" if $ports;
$dump .= 'Class : ' . $self->class() . "\n";
$dump .= 'Kind : ' . $self->kind() . "\n";
$dump .= 'Platform : ' . $self->platform() . "\n";
$dump .= 'Hook : ' . $hook . "\n";
$dump .= 'Token : ' . $self->token() . "\n";
$dump .= 'Grid : ' . $self->grid() . "\n";
$dump .= 'Secure : ' . $secure . "\n";
$dump .= 'Ip : ' . $self->ip() . "\n";
print( $dump );
return $self;
}
#
# @brief Get Authorization bearer value from Eulerian Authority Services.
#
# @param $self - Eulerian Data Warehouse Peer.
#
# @return API::Eulerian::EDW::Status. On success a new entry 'bearer' is inserted into
# the Status.
#
sub _bearer
{
my $self = shift;
my $bearer = $self->{ _BEARER };
my $status;
if( ! defined( $bearer ) ) {
# Request Authority Services for a valid bearer
$status = API::Eulerian::EDW::Authority->bearer(
$self->kind(), $self->platform(),
$self->grid(), $self->ip(),
$self->token()
);
# Cache bearer value for next use
$self->{ _BEARER } = $status->{ bearer } if ! $status->error();
} else {
# Return Cached bearer value
$status = API::Eulerian::EDW::Status->new();
$status->{ bearer } = $bearer;
}
return $status;
}
#
# @brief Create HTTP Request Headers.
#
# @param $self - Eulerian Data Warehouse Peer.
#
# @return API::Eulerian::EDW::Status. On success a new entry 'headers' is inserted into
# the status.
#
sub headers
{
my $self = shift;
my $status = $self->_bearer();
my $headers;
if( ! $status->error() ) {
# Create a new Object Headers
$headers = API::Eulerian::EDW::Request->headers();
# Setup Authorization Header value
$headers->push_header( 'Authorization', $status->{ bearer } );
# Setup reply context
$status->{ headers } = $headers;
# Remove bearer
delete $status->{ bearer };
}
return $status;
}
1;
__END__
=pod
=head1 NAME
API::Eulerian::EDW::Peer - Eulerian Data Warehouse Peer module.
=head1 DESCRIPTION
This module is the base interface of an Eulerian Data Warehouse Peer.
=head1 METHODS
=head2 new()
I<Allocate and initialize a new API::Eulerian::EDW::Peer instance.>
=head3 input
=over 4
=item * setup - Hash Perl of initialization parameters
o class : Eulerian Data Warehouse Peer class name.
o kind : Eulerian Authority token kind.
o platform : Eulerian Authority platform.
o hook : API::Eulerian::EDW::Hook instance.
o token : Eulerian customer token.
o grid : Eulerian customer Grid.
o ip : Eulerian customer IP.
=back
=head3 output
=over 4
=item * Instance of an API::Eulerian::EDW::Peer.
=back
=head2 create()
I<Create a new Eulerian Data Warehouse Peer instance.>
=head3 input
=over 4
=item * name - Eulerian Data Warehouse Peer class name.
=back
=head3 output
=over 4
=item * Eulerian Data Warehouse Peer instance.
=back
=head2 request()
I<Send command to Eulerian Data Warehouse Platform>
=head3 input
=over 4
=item * command. Eulerian Data Warehouse command.
=back
=head3 output
=over 4
lib/API/Eulerian/EDW/Peer.pm view on Meta::CPAN
=head2 grid()
I<Get/Set Eulerian Custormer Grid.>
=head3 input
=over 4
=item * kind - Eulerian Customer Grid.
=back
=head3 output
=over 4
=item * Eulerian Custormer Grid.
=back
=head2 ip()
I<Get/Set Eulerian Customer IP.>
=head3 input
=over 4
=item * kind - Eulerian Customer IP.
=back
=head3 output
=over 4
=item * Eulerian Customer IP.
=back
=head2 token()
I<Get/Set Eulerian Customer token.>
=head3 input
=over 4
=item * kind - Eulerian Customer token.
=back
=head3 output
=over 4
=item * Eulerian Customer token.
=back
=head2 setup()
I<Setup Eulerian Data Warehouse Peer.>
=head3 input
=over 4
=item * setup - Perl Hash of peer parameters.
o class : Eulerian Data Warehouse Peer class name.
o kind : Eulerian Authority token kind.
o platform : Eulerian Authority platform.
o hook : API::Eulerian::EDW::Hook instance.
o token : Eulerian customer token.
o grid : Eulerian customer Grid.
o ip : Eulerian customer IP.
=back
=head2 headers()
I<Allocate and initialize a valid HTTP headers>
=head3 output
=over 4
=item * HTTP::Headers instance.
=back
=head1 AUTHOR
Xavier Thorillon <x.thorillon@eulerian.com>
=head1 COPYRIGHT
Copyright (c) 2008 Eulerian Technologies Ltd L<http://www.eulerian.com>
This program 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.
This program 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 this program; if not, write to the Free Software
Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
=cut
( run in 1.008 second using v1.01-cache-2.11-cpan-ceb78f64989 )