NAME

XML::Atom::Service - Atom Service Document object

SYNOPSIS

  use XML::Atom::Service;
  use XML::Atom::Categories;

  my $categories = XML::Atom::Categories->new;
  $categories->href('http://example.com/cats/forMain.cats');
  $categories->add_category($category);

  my $collection = XML::Atom::Collection->new;
  $collection->href('http://example.org/reilly/main');
  $collection->title('My Blog Entries');
  $collection->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->workspace;
  my @collection = $workspace[0]->collection;
  my @categories = $collection[0]->categories;

DESCRIPTION

For authoring to commence, a client needs to first discover the capabilities and locations of the available collections. Service Documents are designed to support this discovery process. They describe the location and capabilities of one or more Collection.

The Service Document is defined in "The Atom Publishing Protocol," IETF Internet-Draft.

USAGE

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 feed.

• 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 <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 <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 <workspace> element. For example:

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

$service->element_name

$service->element_ns

SEE ALSO

XML::Atom

XML::Atom::Categories

AUTHOR

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

COPYRIGHT AND LICENSE

Copyright (C) 2007 by Takeru INOUE

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