NAME

Net::YADIS::Server - simple library for YADIS enabled servers to generate capability discovery documents

SYNOPSIS use Net::YADIS::Server;

my $news = new Net::YADIS::Server();

$nys->add_service(
                  'type' => URI including version number representing service
                  'URI'  => URI endpoint requuests should be made against
                  );

DESCRIPTION

This is the PERL API for the server half of the YADIS identity interoperability project. This library is designed to make it easy to create capability discovery documents for an identity enabled URL. More information can be found at: http://yadis.org

CONSTRUCTOR

Net::YADIS::Server->new()

The constructor currently takes no arguments and returns a Net::YADIS::Server object.

METHODS

$nys->add_service( %opts )

Adds a service element to the capabilities document. Any unknown elements will be added to the XRD service declaration as well. Thus allowing service specific elements.

type

Required. URI/XRI including version number representing service

URI

Required. URI/XRI of the service's endpoint that a consumer (relying party) should make their requests against.

priority

Optional. You can specify a "priority" element with a whole number value greater than or equal to zero. This value can then be used, via XRD resolution, by consumers (relying parties) if one of your identity services, of the same type, is currently unavailiable. More can be learned about XRD resolution at http://www.oasis-open.org/committees/tc_home.php?wg_abbrev=xri

$nys->add_namespaces( namespace => descriptor, namespace => descriptor, ... )

Add, one or more, additional namespace declarations to your capabilities document. Useful for services such as OpenID which can declare custom Service elements.

$nys->get_document()

Returns the capability discovery document as XML designed to be directly output via your webserver.

COPYRIGHT

This module is Copyright (c) 2005 David Recordon. All rights reserved.

You may distribute under the terms of either the GNU General Public License or the Artistic License, as specified in the Perl README file. If you need more liberal licensing terms, please contact the maintainer.

WARRANTY

This is free software. IT COMES WITHOUT WARRANTY OF ANY KIND.

SEE ALSO

YADIS website: http://www.yadis.org/

AUTHORS

David Recordon <david@sixapart.com>