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

Download:
WWW-Wookie-0.03.tar.gz

Dependencies

Annotate this POD

CPAN RT

Open  3
View/Report Bugs
Module Version: 0.03   Source  

NAME ^

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

VERSION ^

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

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 ^

Data::Dumper LWP::UserAgent Moose Moose::Util::TypeConstraints Readonly URI XML::Simple overload

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 2010 Roland van Ipenburg

    Licensed under the Apache License, Version 2.0 (the "License");
    you may not use this file except in compliance with the License.
    You may obtain a copy of the License at

        http://www.apache.org/licenses/LICENSE-2.0

DISCLAIMER OF WARRANTY ^

    Unless required by applicable law or agreed to in writing, software
    distributed under the License is distributed on an "AS IS" BASIS,
    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    See the License for the specific language governing permissions and
    limitations under the License.
syntax highlighting: