/usr/share/perl5/VM/EC2/Dispatch.pm is in libvm-ec2-perl 1.23-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 | package VM::EC2::Dispatch;
use strict;
use XML::Simple;
use URI::Escape;
=head1 NAME
VM::EC2::Dispatch - Create Perl objects from AWS XML requests
=head1 SYNOPSIS
use VM::EC2;
VM::EC2::Dispatch->add_override('DescribeRegions'=>\&mysub);
VM::EC2::Dispatch->add_override('DescribeTags'=>'My::Type');
sub mysub {
my ($parsed_xml_object,$ec2) = @_;
my $payload = $parsed_xml_object->{regionInfo}
return My::Type->new($payload,$ec2);
}
=head1 DESCRIPTION
This class handles turning the XML response to AWS requests into perl
objects. Only one method is likely to be useful to developers, the
add_override() class method. This allows you to replace the handlers
used to map the response onto objects.
=head2 VM::EC2::Dispatch->add_override($request_name => \&sub)
=head2 VM::EC2::Dispatch->add_override($request_name => 'Class::Name')
=head2 VM::EC2::Dispatch->add_override($request_name => 'method_name,arg1,arg2,...')
Before invoking a VM::EC2 request you wish to customize, call the
add_override() method with two arguments. The first argument is the
name of the request you wish to customize, such as
"DescribeVolumes". The second argument is either a code reference, a
VM::EC2::Dispatch method name and arguments (separated by commas), or
a class name.
In the case of a code reference as the second argument, the subroutine
you provide will be invoked with four arguments consisting of the
parsed XML response, the VM::EC2 object, the XML namespace string from
the request, and the Amazon-assigned request ID. In practice, only the
first two arguments are useful.
In the case of a string containing a classname, the class will be
loaded if it needs to be, and then its new() method invoked as
follows:
Your::Class->new($parsed_xml,$ec2,$xmlns,$requestid)
Your new() method should return one or more objects. It is suggested
that you subclass VM::EC2::Generic and use the inherited new() method
to store the parsed XML and EC2 object. See the code for
L<VM::EC2::AvailabilityRegion> for a simple template.
If the second argument is neither a code reference nor a classname, it
will be treated as a VM::EC2::Dispatch method name and its arguments,
separated by commas. The method will be invoked as follows:
$dispatch->$method_name($raw_xml,$ec2,$arg1,$arg2,$arg3,...)
There are two methods currently defined for this purpose, boolean(),
and fetch_items(), which handle the preprocessing of several common
XML representations of EC2 data. Note that in this form, the RAW XML
is passed in, not the parsed data structure.
The parsed XML response is generated by the XML::Simple module using
these options:
$parser = XML::Simple->new(ForceArray => ['item', 'member'],
KeyAttr => ['key'],
SuppressEmpty => undef);
$parsed = $parser->XMLin($raw_xml)
In general, this will give you a hash of hashes. Any tag named 'item'
or 'member' will be forced to point to an array reference, and any tag
named "key" will be flattened as described in the XML::Simple
documentation.
A simple way to examine the raw parsed XML is to invoke any
VM::EC2::Object's as_string method:
my ($i) = $ec2->describe_instances;
print $i->as_string;
This will give you a Data::Dumper representation of the XML after it
has been parsed.
Look at the data structure "ObjectRegistration" in the source code for
this module to see many examples of response to object mapping.
=head1 OBJECT CREATION METHODS
The following methods perform simple pre-processing of the parsed XML
(a hash of hashes) before passing the modified data structure to the
designated object class. They are used as the second argument to
add_override()
=cut
my %OVERRIDE;
use constant ObjectRegistration => {
Error => 'VM::EC2::Error',
DescribeInstances => sub { load_module('VM::EC2::ReservationSet');
my $r = VM::EC2::ReservationSet->new(@_) or return;
return $r->instances;
},
RunInstances => sub { load_module('VM::EC2::Instance::Set');
my $s = VM::EC2::Instance::Set->new(@_) or return;
return $s->instances;
},
EnableVolumeIO => 'boolean',
DescribeSnapshots => 'fetch_items,snapshotSet,VM::EC2::Snapshot',
DescribeVolumes => 'fetch_items,volumeSet,VM::EC2::Volume',
DescribeImages => 'fetch_items,imagesSet,VM::EC2::Image',
DescribeRegions => 'fetch_items,regionInfo,VM::EC2::Region',
DescribeInstanceStatus => 'fetch_items_iterator,instanceStatusSet,VM::EC2::Instance::StatusItem,instance_status',
DescribeAvailabilityZones => 'fetch_items,availabilityZoneInfo,VM::EC2::AvailabilityZone',
DescribeSecurityGroups => 'fetch_items,securityGroupInfo,VM::EC2::SecurityGroup',
DescribeVolumeStatus => 'fetch_items_iterator,volumeStatusSet,VM::EC2::Volume::StatusItem,volume_status',
CreateSecurityGroup => 'VM::EC2::SecurityGroup',
DeleteSecurityGroup => 'boolean',
AuthorizeSecurityGroupIngress => 'boolean',
AuthorizeSecurityGroupEgress => 'boolean',
RevokeSecurityGroupIngress => 'boolean',
RevokeSecurityGroupEgress => 'boolean',
DescribeTags => 'fetch_items,tagSet,VM::EC2::Tag,nokey',
CreateVolume => 'VM::EC2::Volume',
DeleteVolume => 'boolean',
AttachVolume => 'VM::EC2::BlockDevice::Attachment',
DetachVolume => 'VM::EC2::BlockDevice::Attachment',
CreateSnapshot => 'VM::EC2::Snapshot',
DeleteSnapshot => 'boolean',
CopySnapshot => sub { shift->{snapshotId} },
ModifySnapshotAttribute => 'boolean',
ResetSnapshotAttribute => 'boolean',
ModifyInstanceAttribute => 'boolean',
ModifyImageAttribute => 'boolean',
ResetInstanceAttribute => 'boolean',
ResetImageAttribute => 'boolean',
CreateImage => sub {
my ($data,$aws) = @_;
my $image_id = $data->{imageId} or return;
sleep 2; # wait for the thing to register
return $aws->describe_images($image_id);
},
RegisterImage => sub {
my ($data,$aws) = @_;
my $image_id = $data->{imageId} or return;
sleep 2; # wait for the thing to register
return $aws->describe_images($image_id);
},
DeregisterImage => 'boolean',
DescribeAddresses => 'fetch_items,addressesSet,VM::EC2::ElasticAddress',
AssociateAddress => sub {
my $data = shift;
return $data->{associationId} || ($data->{return} eq 'true');
},
DisassociateAddress => 'boolean',
AllocateAddress => 'VM::EC2::ElasticAddress',
ReleaseAddress => 'boolean',
CreateTags => 'boolean',
DeleteTags => 'boolean',
StartInstances => 'fetch_items,instancesSet,VM::EC2::Instance::State::Change',
StopInstances => 'fetch_items,instancesSet,VM::EC2::Instance::State::Change',
TerminateInstances => 'fetch_items,instancesSet,VM::EC2::Instance::State::Change',
RebootInstances => 'boolean',
ConfirmProductInstance => 'boolean',
MonitorInstances => 'fetch_items,instancesSet,VM::EC2::Instance::MonitoringState',
UnmonitorInstances => 'fetch_items,instancesSet,VM::EC2::Instance::MonitoringState',
GetConsoleOutput => 'VM::EC2::Instance::ConsoleOutput',
GetPasswordData => 'VM::EC2::Instance::PasswordData',
DescribeKeyPairs => 'fetch_items,keySet,VM::EC2::KeyPair',
CreateKeyPair => 'VM::EC2::KeyPair',
ImportKeyPair => 'VM::EC2::KeyPair',
DeleteKeyPair => 'boolean',
DescribeReservedInstancesOfferings
=> 'fetch_items,reservedInstancesOfferingsSet,VM::EC2::ReservedInstance::Offering',
DescribeReservedInstances => 'fetch_items,reservedInstancesSet,VM::EC2::ReservedInstance',
PurchaseReservedInstancesOffering => sub { my ($data,$ec2) = @_;
my $ri_id = $data->{reservedInstancesId} or return;
return $ec2->describe_reserved_instances($ri_id);
},
CreateSpotDatafeedSubscription => 'fetch_one,spotDatafeedSubscription,VM::EC2::Spot::DatafeedSubscription',
DescribeSpotDatafeedSubscription => 'fetch_one,spotDatafeedSubscription,VM::EC2::Spot::DatafeedSubscription',
DeleteSpotDatafeedSubscription => 'boolean',
DescribeSpotPriceHistory => 'fetch_items_iterator,spotPriceHistorySet,VM::EC2::Spot::PriceHistory,spot_price_history',
RequestSpotInstances => 'fetch_items,spotInstanceRequestSet,VM::EC2::Spot::InstanceRequest',
CancelSpotInstanceRequests => 'fetch_items,spotInstanceRequestSet,VM::EC2::Spot::InstanceRequest',
DescribeSpotInstanceRequests => 'fetch_items,spotInstanceRequestSet,VM::EC2::Spot::InstanceRequest',
GetFederationToken => 'fetch_one,GetFederationTokenResult,VM::EC2::Security::Token',
GetSessionToken => 'fetch_one,GetSessionTokenResult,VM::EC2::Security::Token',
# placement groups
DescribePlacementGroups => 'fetch_items,placementGroupSet,VM::EC2::PlacementGroup',
CreatePlacementGroup => 'boolean',
DeletePlacementGroup => 'boolean',
# vpcs
CreateVpc => 'fetch_one,vpc,VM::EC2::VPC',
DescribeVpcs => 'fetch_items,vpcSet,VM::EC2::VPC',
DeleteVpc => 'boolean',
# dhcp options
DescribeDhcpOptions => 'fetch_items,dhcpOptionsSet,VM::EC2::VPC::DhcpOptions,nokey',
CreateDhcpOptions => 'fetch_one,dhcpOptions,VM::EC2::VPC::DhcpOptions,nokey',
DeleteDhcpOptions => 'boolean',
AssociateDhcpOptions => 'boolean',
# network interfaces
CreateNetworkInterface => 'fetch_one,networkInterface,VM::EC2::NetworkInterface',
DeleteNetworkInterface => 'boolean',
DescribeNetworkInterfaces => 'fetch_items,networkInterfaceSet,VM::EC2::NetworkInterface',
ModifyNetworkInterfaceAttribute => 'boolean',
ResetNetworkInterfaceAttribute => 'boolean',
AttachNetworkInterface => sub { shift->{attachmentId} },
DetachNetworkInterface => 'boolean',
AssignPrivateIpAddresses => 'boolean',
UnassignPrivateIpAddresses => 'boolean',
# subnets
CreateSubnet => 'fetch_one,subnet,VM::EC2::VPC::Subnet',
DeleteSubnet => 'boolean',
DescribeSubnets => 'fetch_items,subnetSet,VM::EC2::VPC::Subnet',
# internet gateways
DescribeInternetGateways => 'fetch_items,internetGatewaySet,VM::EC2::VPC::InternetGateway',
# route tables
CreateRouteTable => 'fetch_one,routeTable,VM::EC2::VPC::RouteTable',
DeleteRouteTable => 'boolean',
DescribeRouteTables => 'fetch_items,routeTableSet,VM::EC2::VPC::RouteTable',
AssociateRouteTable => sub { shift->{associationId} },
ReplaceRouteTableAssociation => sub { shift->{newAssociationId} },
# route rules
CreateRoute => 'boolean',
DeleteRoute => 'boolean',
ReplaceRoute => 'boolean',
# internet gateways
CreateInternetGateway => 'fetch_one,internetGateway,VM::EC2::VPC::InternetGateway',
DescribeInternetGateways => 'fetch_items,internetGatewaySet,VM::EC2::VPC::InternetGateway',
DeleteInternetGateway => 'boolean',
AttachInternetGateway => 'boolean',
DetachInternetGateway => 'boolean',
# network acls
DescribeNetworkAcls => 'fetch_items,networkAclSet,VM::EC2::VPC::NetworkAcl',
CreateNetworkAcl => 'fetch_one,networkAcl,VM::EC2::VPC::NetworkAcl',
DeleteNetworkAcl => 'boolean',
CreateNetworkAclEntry => 'boolean',
DeleteNetworkAclEntry => 'boolean',
ReplaceNetworkAclAssociation => sub { shift->{newAssociationId} },
ReplaceNetworkAclEntry => 'boolean',
# virtual private networks
DescribeVpnGateways => 'fetch_items,vpnGatewaySet,VM::EC2::VPC::VpnGateway',
CreateVpnGateway => 'fetch_one,vpnGateway,VM::EC2::VPC::VpnGateway',
DeleteVpnGateway => 'boolean',
AttachVpnGateway => sub { shift->{attachment}{state} },
DetachVpnGateway => 'boolean',
DescribeVpnConnections => 'fetch_items,vpnConnectionSet,VM::EC2::VPC::VpnConnection',
CreateVpnConnection => 'fetch_one,vpnConnection,VM::EC2::VPC::VpnConnection',
DeleteVpnConnection => 'boolean',
DescribeCustomerGateways => 'fetch_items,customerGatewaySet,VM::EC2::VPC::CustomerGateway',
CreateCustomerGateway => 'fetch_one,customerGateway,VM::EC2::VPC::CustomerGateway',
DeleteCustomerGateway => 'boolean',
CreateVpnConnectionRoute => 'boolean',
DeleteVpnConnectionRoute => 'boolean',
DisableVgwRoutePropagation => 'boolean',
EnableVgwRoutePropagation => 'boolean',
# elastic load balancers
DescribeLoadBalancers => 'fetch_members,LoadBalancerDescriptions,VM::EC2::ELB',
ConfigureHealthCheck => 'elb_fetch_one,HealthCheck,VM::EC2::ELB::HealthCheck',
CreateAppCookieStickinessPolicy => sub { exists shift->{CreateAppCookieStickinessPolicyResult} },
CreateLBCookieStickinessPolicy => sub { exists shift->{CreateLBCookieStickinessPolicyResult} },
CreateLoadBalancer => sub { shift->{CreateLoadBalancerResult}{DNSName} },
DeleteLoadBalancer => sub { exists shift->{DeleteLoadBalancerResult} },
CreateLoadBalancerListeners => sub { exists shift->{CreateLoadBalancerListenersResult} },
DeleteLoadBalancerListeners => sub { exists shift->{DeleteLoadBalancerListenersResult} },
DisableAvailabilityZonesForLoadBalancer => 'elb_member_list,AvailabilityZones',
EnableAvailabilityZonesForLoadBalancer => 'elb_member_list,AvailabilityZones',
RegisterInstancesWithLoadBalancer => 'elb_member_list,Instances,InstanceId',
DeregisterInstancesFromLoadBalancer => 'elb_member_list,Instances,InstanceId',
SetLoadBalancerListenerSSLCertificate
=> sub { exists shift->{SetLoadBalancerListenerSSLCertificateResult} },
DescribeInstanceHealth => 'fetch_members,InstanceStates,VM::EC2::ELB::InstanceState',
CreateLoadBalancerPolicy => sub { exists shift->{CreateLoadBalancerPolicyResult} },
DeleteLoadBalancerPolicy => sub { exists shift->{DeleteLoadBalancerPolicyResult} },
DescribeLoadBalancerPolicies => 'fetch_members,PolicyDescriptions,VM::EC2::ELB::PolicyDescription',
DescribeLoadBalancerPolicyTypes => 'fetch_members,PolicyTypeDescriptions,VM::EC2::ELB::PolicyTypeDescription',
SetLoadBalancerPoliciesOfListener => sub { exists shift->{SetLoadBalancerPoliciesOfListenerResult} },
ApplySecurityGroupsToLoadBalancer => 'elb_member_list,SecurityGroups',
AttachLoadBalancerToSubnets => 'elb_member_list,Subnets',
DetachLoadBalancerFromSubnets => 'elb_member_list,Subnets',
SetLoadBalancerPoliciesForBackendServer => sub { exists shift->{SetLoadBalancerPoliciesForBackendServerResult} },
# auto scaling and launch controls
DescribeLaunchConfigurations => 'fetch_members,LaunchConfigurations,VM::EC2::LaunchConfiguration',
DescribeAutoScalingGroups => 'fetch_members,AutoScalingGroups,VM::EC2::ASG',
};
sub new {
my $self = shift;
return bless {},ref $self || $self;
}
sub add_override {
my $self = shift;
my ($request_name,$object_creator) = @_;
$OVERRIDE{$request_name} = $object_creator;
}
sub response2objects {
my $self = shift;
my ($response,$ec2) = @_;
my $handler = $self->class_from_response($response) or return;
my $content = $response->decoded_content;
my ($method,@params) = split /,/,$handler;
if (ref $handler eq 'CODE') {
my $parsed = $self->new_xml_parser->XMLin($content);
$handler->($parsed,$ec2,@{$parsed}{'xmlns','requestId'});
}
elsif ($self->can($method)) {
return $self->$method($content,$ec2,@params);
}
else {
load_module($handler);
my $parser = $self->new();
$parser->parse($content,$ec2,$handler);
}
}
sub class_from_response {
my $self = shift;
my $response = shift;
my ($action) = $response->request->content =~ /Action=([^&]+)/;
$action = uri_unescape($action);
return $OVERRIDE{$action} || ObjectRegistration->{$action} || 'VM::EC2::Generic';
}
sub parser {
my $self = shift;
return $self->{xml_parser} ||= $self->new_xml_parser;
}
sub parse {
my $self = shift;
my ($content,$ec2,$class) = @_;
$self = $self->new unless ref $self;
my $parsed = $self->parser->XMLin($content);
return $self->create_objects($parsed,$ec2,$class);
}
sub new_xml_parser {
my $self = shift;
my $nokey = shift;
return XML::Simple->new(ForceArray => ['item', 'member'],
KeyAttr => $nokey ? [] : ['key'],
SuppressEmpty => undef,
);
}
=head2 $bool = $dispatch->boolean($raw_xml,$ec2,$tag)
This is used for XML responses like this:
<DeleteVolumeResponse xmlns="http://ec2.amazonaws.com/doc/2011-05-15/">
<requestId>59dbff89-35bd-4eac-99ed-be587EXAMPLE</requestId>
<return>true</return>
</DeleteVolumeResponse>
It looks inside the structure for the tag named $tag ("return" if not
provided), and returns a true value if the contents equals "true".
Pass it to add_override() like this:
VM::EC2::Dispatch->add_override(DeleteVolume => 'boolean,return';
or, since "return" is the default tag:
VM::EC2::Dispatch->add_override(DeleteVolume => 'boolean';
=cut
sub boolean {
my $self = shift;
my ($content,$ec2,$tag) = @_;
my $parsed = $self->new_xml_parser()->XMLin($content);
$tag ||= 'return';
return $parsed->{$tag} eq 'true';
}
=head2 @list = $dispatch->elb_member_list($raw_xml,$ec2,$tag)
This is used for XML responses from the ELB API such as this:
<DisableAvailabilityZonesForLoadBalancerResponse xmlns="http://elasticloadbalancing.amazonaws.com/doc/2011-11-15/">
<DisableAvailabilityZonesForLoadBalancerResult>
<AvailabilityZones>
<member>us-west-2a</member>
<member>us-west-2b</member>
</AvailabilityZones>
</DisableAvailabilityZonesForLoadBalancerResult>
<ResponseMetadata>
<RequestId>02eadcfc-fc38-11e1-a1bf-9de31EXAMPLE</RequestId>
</ResponseMetadata>
</DisableAvailabilityZonesForLoadBalancerResponse>
It looks inside the Result structure for the tag named $tag and returns the
list wrapped in member elements. In this case the tag is 'AvailabilityZones'
and the return value would be:
( 'us-west-2a', 'us-west-2b' )
If $embedded_tag is passed, then it is used for XML responses such as this,
where the member list has an embedded tag:
<RegisterInstancesWithLoadBalancerResponse xmlns="http://elasticloadbalancing.amazonaws.com/doc/2011-11-15/">
<RegisterInstancesWithLoadBalancerResult>
<Instances>
<member>
<InstanceId>i-12345678</InstanceId>
</member>
<member>
<InstanceId>i-90abcdef</InstanceId>
</member>
</Instances>
</RegisterInstancesWithLoadBalancerResult>
<ResponseMetadata>
<RequestId>f4f12596-fc3b-11e1-be5a-f71ecEXAMPLE</RequestId>
</ResponseMetadata>
</RegisterInstancesWithLoadBalancerResponse>
It looks inside the Result structure for the tag named $tag and returns the
list wrapped in a member element plus the embedded tag. In this case the
tag is 'Instances', the embedded tag is 'InstanceId' and the return value would
be: ( 'i-12345678', 'i-90abcdef' )
=cut
sub elb_member_list {
my $self = shift;
my ($content,$ec2,$tag,$embedded_tag) = @_;
my $parsed = $self->new_xml_parser()->XMLin($content);
my ($result_key) = grep /Result$/,keys %$parsed;
return $embedded_tag ? map { $_->{$embedded_tag} } @{$parsed->{$result_key}{$tag}{member}} :
@{$parsed->{$result_key}{$tag}{member}};
}
# identical to fetch_one, except looks inside the *Result tag that ELB API calls
# return
sub elb_fetch_one {
my $self = shift;
my ($content,$ec2,$tag,$class,$nokey) = @_;
load_module($class);
my $parser = $self->new_xml_parser($nokey);
my $parsed = $parser->XMLin($content);
my ($result_key) = grep /Result$/,keys %$parsed;
my $obj = $parsed->{$result_key}{$tag} or return;
return $class->new($obj,$ec2,@{$parsed}{'xmlns','requestId'});
}
sub fetch_one {
my $self = shift;
my ($content,$ec2,$tag,$class,$nokey) = @_;
load_module($class);
my $parser = $self->new_xml_parser($nokey);
my $parsed = $parser->XMLin($content);
my $obj = $parsed->{$tag} or return;
return $class->new($obj,$ec2,@{$parsed}{'xmlns','requestId'});
}
=head2 fetch_items($raw_xml,$ec2,$container_tag,$object_class,$nokey)
@objects = $dispatch->fetch_items($raw_xml,$ec2,$container_tag,$object_class,$nokey)
This is used for XML responses like this:
<DescribeKeyPairsResponse xmlns="http://ec2.amazonaws.com/doc/2011-05-15/">
<requestId>59dbff89-35bd-4eac-99ed-be587EXAMPLE</requestId>
<keySet>
<item>
<keyName>gsg-keypair</keyName>
<keyFingerprint>
1f:51:ae:28:bf:89:e9:d8:1f:25:5d:37:2d:7d:b8:ca:9f:f5:f1:6f
</keyFingerprint>
</item>
<item>
<keyName>default-keypair</keyName>
<keyFingerprint>
0a:93:bb:e8:c2:89:e9:d8:1f:42:5d:37:1d:8d:b8:0a:88:f1:f1:1a
</keyFingerprint>
</item>
</keySet>
</DescribeKeyPairsResponse>
It looks inside the structure for the tag named $container_tag, pulls
out the items that are stored under <item> and then passes the parsed
contents to $object_class->new(). The optional $nokey argument is used
to suppress XML::Simple's default flattening behavior turning tags
named "key" into hash keys.
Pass it to add_override() like this:
VM::EC2::Dispatch->add_override(DescribeVolumes => 'fetch_items,volumeSet,VM::EC2::Volume')
=cut
sub fetch_items {
my $self = shift;
my ($content,$ec2,$tag,$class,$nokey) = @_;
load_module($class);
my $parser = $self->new_xml_parser($nokey);
my $parsed = $parser->XMLin($content);
my $list = $parsed->{$tag}{item} or return;
return map {$class->new($_,$ec2,@{$parsed}{'xmlns','requestId'})} @$list;
}
=head2 @objects = $dispatch->fetch_members($raw_xml,$ec2,$container_tag,$object_class,$nokey)
Used for XML responses from ELB API calls which contain a key that is the name
of the API call with 'Result' appended. All these XML responses contain
'member' as the item delimter instead of 'item'
=cut
sub fetch_members {
my $self = shift;
my ($content,$ec2,$tag,$class,$nokey) = @_;
load_module($class);
my $parser = $self->new_xml_parser($nokey);
my $parsed = $parser->XMLin($content);
my ($result_key) = grep /Result$/,keys %$parsed;
my $list = $parsed->{$result_key}{$tag}{member} or return;
return map {$class->new($_,$ec2,@{$parsed}{'xmlns','requestId'})} @$list;
}
=head2 @objects = $dispatch->fetch_items_iterator($raw_xml,$ec2,$container_tag,$object_class,$token_name)
This is used for requests that have a -max_results argument. In this
case, the response will have a nextToken field, which can be used to
fetch the "next page" of results.
The $token_name is some unique identifying token. It will be turned
into two temporary EC2 instance variables, one named
"${token_name}_token", which contains the nextToken value, and the
other "${token_name}_stop", which flags the caller that no more
results will be forthcoming.
This must all be coordinated with the request subroutine. See how
describe_instance_status() and describe_spot_price_history() do it.
=cut
sub fetch_items_iterator {
my $self = shift;
my ($content,$ec2,$tag,$class,$base_name) = @_;
my $token = "${base_name}_token";
my $stop = "${base_name}_stop";
load_module($class);
my $parser = $self->new_xml_parser();
my $parsed = $parser->XMLin($content);
my $list = $parsed->{$tag}{item} or return;
if ($ec2->{$token} && !$parsed->{nextToken}) {
delete $ec2->{$token};
$ec2->{$stop}++;
} else {
$ec2->{$token} = $parsed->{nextToken};
}
return map {$class->new($_,$ec2,@{$parsed}{'xmlns','requestId'})} @$list;
}
sub create_objects {
my $self = shift;
my ($parsed,$ec2,$class) = @_;
return $class->new($parsed,$ec2,@{$parsed}{'xmlns','requestId'});
}
sub create_error_object {
my $self = shift;
my ($content,$ec2,$API_call) = @_;
my $class = ObjectRegistration->{Error};
eval "require $class; 1" || die $@ unless $class->can('new');
my $parsed = $self->new_xml_parser->XMLin($content);
if (defined $API_call) {
$parsed->{Errors}{Error}{Message} =~ s/\.$//;
$parsed->{Errors}{Error}{Message} .= " from API call '$API_call'";
}
return $class->new($parsed->{Errors}{Error},$ec2,@{$parsed}{'xmlns','requestId'});
}
# not a method!
sub load_module {
my $class = shift;
eval "require $class; 1" || die $@ unless $class->can('new');
}
=head1 EXAMPLE OF USING OVERRIDE TO SUBCLASS VM::EC2::Volume
The author decided that a volume object should not be able to delete
itself; you disagree with that decision. Let's subclass
VM::EC2::Volume to add a delete() method.
First subclass the VM::EC2::Volume class:
package MyVolume;
use base 'VM::EC2::Volume';
sub delete {
my $self = shift;
$self->ec2->delete_volume($self);
}
Now subclass VM::EC2 to add the appropriate overrides to the new() method:
package MyEC2;
use base 'VM::EC2';
sub new {
my $class = shift;
VM::EC2::Dispatch->add_override(CreateVolume =>'MyVolume');
VM::EC2::Dispatch->add_override(DescribeVolumes=>'fetch_items,volumeSet,MyVolume');
return $class->SUPER::new(@_);
}
Now we can test it out:
use MyEC2;
# find all volumes that are "available" and not in-use
my @vol = $ec2->describe_volumes({status=>'available'});
for my $vol (@vol) {
$vol->delete && print "$vol deleted\n"
}
=head1 SEE ALSO
L<VM::EC2>
L<VM::EC2::Object>
L<VM::EC2::Generic>
L<VM::EC2::BlockDevice>
L<VM::EC2::BlockDevice::Attachment>
L<VM::EC2::BlockDevice::Mapping>
L<VM::EC2::BlockDevice::Mapping::EBS>
L<VM::EC2::Error>
L<VM::EC2::Generic>
L<VM::EC2::Group>
L<VM::EC2::Image>
L<VM::EC2::Instance>
L<VM::EC2::Instance::ConsoleOutput>
L<VM::EC2::Instance::Set>
L<VM::EC2::Instance::State>
L<VM::EC2::Instance::State::Change>
L<VM::EC2::Instance::State::Reason>
L<VM::EC2::Region>
L<VM::EC2::ReservationSet>
L<VM::EC2::SecurityGroup>
L<VM::EC2::Snapshot>
L<VM::EC2::Tag>
L<VM::EC2::Volume>
=head1 AUTHOR
Lincoln Stein E<lt>lincoln.stein@gmail.comE<gt>.
Copyright (c) 2011 Ontario Institute for Cancer Research
This package and its accompanying libraries is free software; you can
redistribute it and/or modify it under the terms of the GPL (either
version 1, or at your option, any later version) or the Artistic
License 2.0. Refer to LICENSE for the full license text. In addition,
please see DISCLAIMER.txt for disclaimers of warranty.
=cut
1;
|