Roland van Ipenburg > WWW-Wookie > WWW::Wookie::Server::Connection

Download:
WWW-Wookie-0.100.tar.gz

Dependencies

Annotate this POD

CPAN RT

Open  1
View/Report Bugs
Module Version: 0.100   Source  

NAME ^

WWW::Wookie::Server::Connection - A connection to a Wookie server

VERSION ^

This document describes WWW::Wookie::Server::Connection version 0.100

SYNOPSIS ^

    use WWW::Wookie::Server::Connection;
    $c = WWW::Wookie::Server::Connection->new($url, $api_key, $data_key);

DESCRIPTION ^

A connection to a Wookie server. This maintains the necessary data for connecting to the server and provides utility methods for making common calls via the Wookie REST API.

SUBROUTINES/METHODS ^

new

Create a connection to a Wookie server at a given URL.

1. The URL of the Wookie server as string
2. The API key for the server as string
3. The shared data key for the server connection as string

getURL

Get the URL of the Wookie server. Returns the current Wookie connection's URL as string.

setURL

Set the URL of the Wookie server.

getApiKey

Get the API key for this server. Returns the current Wookie connection's API key as string. Throws a WookieConnectorException.

setApiKey

Set the API key for this server.

getSharedDataKey

Get the shared data key for this server. Returns the current Wookie connection's shared data key. Throws a WookieConnectorException.

setSharedDataKey

Set the shared data key for this server.

as_string

Output connection information as string.

test

Test the Wookie server connection.

CONFIGURATION AND ENVIRONMENT ^

DEPENDENCIES ^

INCOMPATIBILITIES ^

DIAGNOSTICS ^

BUGS AND LIMITATIONS ^

Please report any bugs or feature requests at RT for rt.cpan.org.

AUTHOR ^

Roland van Ipenburg, <ipenburg@xs4all.nl>

LICENSE AND COPYRIGHT ^

Copyright 2016 by Roland van Ipenburg

This library is free software; you can redistribute it and/or modify it under the same terms as Perl itself, either Perl version 5.14.0 or, at your option, any later version of Perl 5 you may have available.

DISCLAIMER OF WARRANTY ^

BECAUSE THIS SOFTWARE IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY FOR THE SOFTWARE, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES PROVIDE THE SOFTWARE "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE SOFTWARE IS WITH YOU. SHOULD THE SOFTWARE PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR, OR CORRECTION.

IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR REDISTRIBUTE THE SOFTWARE AS PERMITTED BY THE ABOVE LICENSE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE SOFTWARE (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF THE SOFTWARE TO OPERATE WITH ANY OTHER SOFTWARE), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.

syntax highlighting: