XML::Atom::Service(3) Atom Service Document object

COMPATIBILITY ISSUES

XML::Atom::Service has changed the default namespace since v0.15.0. The new namespaces are 'http://www.w3.org/2005/Atom' and 'http://www.w3.org/2007/app'.

See NAMESPACES in details.

SYNOPSIS


use XML::Atom::Service;
my $category = XML::Atom::Category->new;
$category->term('joke');
$category->scheme('http://example.org/extra-cats/');
my $categories = XML::Atom::Categories->new;
$categories->add_category($category);
my $collection = XML::Atom::Collection->new;
$collection->href('http://example.org/reilly/main');
$collection->title('My Blog Entries');
$collection->add_accept('application/atom+xml;type=entry');
$collection->add_categories($categories);
my $workspace = XML::Atom::Workspace->new;
$workspace->title('Main Site');
$workspace->add_collection($collection);
my $service = XML::Atom::Service->new;
$service->add_workspace($workspace);
my $xml = $service->as_xml;
# Get lists of the workspace, collection, and categories elements
my @workspace = $service->workspaces;
my @collection = $workspace[0]->collections;
my @categories = $collection[0]->categories;

DESCRIPTION

The Atom Publishing Protocol (Atompub) is a protocol for publishing and editing Web resources described at <http://www.ietf.org/internet-drafts/draft-ietf-atompub-protocol-17.txt>.

XML::Atom::Service is an Service Document implementation. In the Atom Publishing Protocol, a client needs to first discover the capabilities and locations of Collections. The Service Document is designed to support this discovery process. The document describes the location and capabilities of Collections.

The Atom Publishing Protocol introduces some new XML elements, such as app:edited and app:draft, which are imported into XML::Atom. See XML::Atom::Atompub in detail.

This module was tested in InteropTokyo2007 <http://intertwingly.net/wiki/pie/July2007InteropTokyo>, and interoperated with other implementations.

METHODS

XML::Atom::Service->new([ $stream ])

Creates a new Service Document object, and if $stream is supplied, fills it with the data specified by $stream.

Automatically handles autodiscovery if $stream is a URI (see below).

Returns the new XML::Atom::Service object. On failure, returns "undef".

$stream can be any one of the following:

  • Reference to a scalar

    This is treated as the XML body of the Service Document.

  • Scalar

    This is treated as the name of a file containing the Service Document XML.

  • Filehandle

    This is treated as an open filehandle from which the Service Document XML can be read.

  • URI object

    This is treated as a URI, and the Service Document XML will be retrieved from the URI.

$service->workspace

If called in scalar context, returns an XML::Atom::Workspace object corresponding to the first ``app:workspace'' element found in the Service Document.

If called in list context, returns a list of XML::Atom::Workspace objects corresponding to all of the app:workspace elements found in the Service Document.

$service->add_workspace($workspace)

Adds the workspace $workspace, which must be an XML::Atom::Workspace object, to the Service Document as a new app:workspace element. For example: 

    my $workspace = XML::Atom::Workspace->new;
    $workspace->title('Foo Bar');
    $service->add_workspace($workspace);

$service->element_name

$service->element_ns

NAMESPACES

By default, XML::Atom::Service will create entities using the new Atom namespaces, 'http://www.w3.org/2005/Atom' and 'http://www.w3.org/2007/app'. In order to use old ones, you can set them by setting global variables like: 

  use XML::Atom;
  use XML::Atom::Service;
  $XML::Atom::DefaultVersion = '0.3';   # 'http://purl.org/atom/ns#'
  $XML::Atom::Service::DefaultNamespace = 'http://purl.org/atom/app#';

AUTHOR

Takeru INOUE, <takeru.inoue _ gmail.com>

LICENCE AND COPYRIGHT

Copyright (c) 2007, Takeru INOUE "<takeru.inoue _ gmail.com>". All rights reserved.

This module is free software; you can redistribute it and/or modify it under the same terms as Perl itself. See perlartistic.

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 LICENCE, 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.

LAST SEARCHED