NAME

BZ::Client::Exception - Exception class thrown by BZ::Client in case of errors.

VERSION

version 4.4004

SYNOPSIS

BZ::Client does not return error codes or do similar stuff. Instead, it throws instances of BZ::Client::Exception.

  my $exception = BZ::Client::Exception->new( message     => $message,
                                              http_code   => $httpCode,
                                              xmlrpc_code => $xmlrpcCode );

  BZ::Client::Exception->throw( message     => $message,
                                http_code   => $httpCode,
                                xmlrpc_code => $xmlrpcCode );

METHODS

new

Creates the exception object

throw

Creates the exception object then dies, so make sure you catch it!

message

Returns the error message text

xmlrpc_code

Returns the error code from XMLRPC

http_code

Returns the http code (200, 404, etc)

EXAMPLE

Here are two examples. The first uses Perl's inbuilt eval() function, the second uses the Try::Tiny module. Further alternatives exist and may be perfectly good options if they suit you.

eval

 use BZ::Client;
 use BZ::Client::Bug::Attachment;
 use v5.10;

 my $client = BZ::Client->new( %etc );

 eval {
     my $att = BZ::Client::Bug::Attachment->get($client, { ids => 30505 });
 };

 if ($@) {
     say 'An Error Occured';
     say 'Message: ', $@->message();
     say 'HTTP Code: ', $@->http_code() if $@->http_code();
     say 'XMLrpc Code: ', $@->xmlrpc_code() if $@->xmlrpc_code();
 };

Try::Tiny

 use BZ::Client;
 use BZ::Client::Bug::Attachment;
 use Try::Tiny;
 use v5.10;

 my $client = BZ::Client->new( %etc );

 try {
     my $att = BZ::Client::Bug::Attachment->get($client, { ids => 30505 });
 }

 catch {
     say 'An Error Occured';
     say 'Message: ', $_->message();
     say 'HTTP Code: ', $_->http_code() if $_->http_code();
     say 'XMLrpc Code: ', $_->xmlrpc_code() if $_->xmlrpc_code();
 };

SEE ALSO

BZ::Client

AUTHORS

• Dean Hamstead <dean@bytefoundry.com.au>

• Jochen Wiedmann <jochen.wiedmann@gmail.com>

COPYRIGHT AND LICENSE

This software is copyright (c) 2021 by Dean Hamstad.

This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.

cpanm BZ::Client

perl -MCPAN -e shell
install BZ::Client