/ 
Catalyst-Controller-Atompub-0.3.7
River stage zero No dependents
/ Catalyst::Controller::Atompub::Service

NAME

Catalyst::Controller::Atompub::Service - A Catalyst controller for the Atom Service Document

SYNOPSIS

# Use the Catalyst helper
$ perl script/myatom_create.pl controller MyService Atompub::Service

# And edit lib/MyAtom/Controller/MyService.pm
package MyAtom::Controller::MyService;
use base 'Catalyst::Controller::Atompub::Service';

# Access to http://localhost:3000/myservice and get Service Document

DESCRIPTION

Catalyst::Controller::Atompub::Service generates a Service Document based on collection configuration.

SUBCLASSING

Just a single subclass is required in your Atompub server implementation. No methods are needed to be overridden.

METHODS

The following methods can be overridden to change the default behaviors.

$controller->modify_service

By overriding modify_service, modifies the default Service Documents:

sub modify_service {
    my ( $self, $c, $service ) = @_;

    # Edit $service (XML::Atom::Service) if you'd like to modify the 
    # Service Document

    return $service;
}

ACCESSORS

$controller->service

An accessor for a Service Document.

INTERNAL INTERFACES

$controller->default

$controller->_make_service

CONFIGURATION

By default (no configuration), this module provides a Service Document with a single atom:workspace. The order of atom:collections is not defined.

You can specify the title and the order of atom:workspaces and atom:collections like:

Controller::Service: workspace: - title: My Blog collection: - Controller::EntryCollection - Controller::MediaCollection

ERROR HANDLING

See ERROR HANDLING in Catalyst::Controller::Atompub::Base.

SAMPLES

See SAMPLES in Catalyst::Controller::Atompub.

SEE ALSO

XML::Atom XML::Atom::Service Atompub Catalyst::Controller::Atompub

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.