net::openid::extension::simpleregistration(3pm) [debian man page]

Net::OpenID::Extension::SimpleRegistration(3pm) 	User Contributed Perl Documentation	   Net::OpenID::Extension::SimpleRegistration(3pm)

NAME

       Net::OpenID::Extension::SimpleRegistration - Support for the Simple Registration extension (SREG)

VERSION

       version 1.14

SYNOPSIS

       In Consumer...

	   my $sreg_req = $claimed_identity->add_extension_request('Net::OpenID::Extension::SimpleRegistration', (
	       required_fields => [qw(nickname email)],
	       optional_fields => [qw(country language timezone)],
	       policy_url => "http://example.com/policy.html",
	   ));

       Then, in Server, when handling the authentication request...

	   # FIXME: What object do we have in ::Server that can hold this method?
	   my $sreg_req = $something->get_extension_request('Net::OpenID::Extension::SimpleRegistration');
	   my $required_fields = $sreg_req->required_fields;
	   my $optional_fields = $sreg_req->optional_fields;
	   my $policy_url = $sreg_req->policy_url;

       When Server sends back its response...

	   # FIXME: Again, what object do we have to hold this method?
	   my $sreg_res = $something->add_extension_response('Net::OpenID::Extension::SimpleRegistration', (
	       nickname => $nickname,
	       email => $email,
	   ));

       And finally, when back in Consumer recieving the response:

	   my $sreg_res = $verified_identity->get_extension_response('Net::OpenID::Extension::SimpleRegistration');
	   my $nickname = $sreg_res->nickname;
	   my $email = $sreg_res->email;
	   my $country = $sreg_res->country;
	   my $language = $sreg_res->language;
	   my $timezone = $sreg_res->timezone;

perl v5.12.4							    2011-11-11			   Net::OpenID::Extension::SimpleRegistration(3pm)

Net::OpenID::Extension(3pm)				User Contributed Perl Documentation			       Net::OpenID::Extension(3pm)

NAME

       Net::OpenID::Extension - Base class for OpenID extensions

VERSION

       version 1.14

METHODS

   CLASS->namespace_uris
       Return a hashref mapping namespace URIs to the aliases you will use to refer to them in the other methods. For example:

	   return {
	       'http://example.com/some-extension' => 'someext',
	   };

   CLASS->new_request(@parameters)
       When your extension is added to the Net::OpenID::ClaimedIdentity object in consumer-land, this method will be called to create a request
       object. Any additional arguments passed when adding the extension will be passed through verbatim in @parameters.

       The object you return here should at minimum provide the interface defined in Net::OpenID::ExtensionMessage.

       You can return "undef" here if you have nothing useful to return.

   CLASS->received_request(\%args)
       In server-land, when a caller asks for the request object for your extension this method will be called to create a request object.  %args
       maps the aliases you returned from the "namespace_uris" method to a hashref of the key-value pairs provided in that namespace.

       The object you return here should at minimum provide the interface defined in Net::OpenID::ExtensionMessage, and should behave identically
       to the corresponding object returned from "new_request".

       You can return "undef" here if you have nothing useful to return.

   CLASS->new_response(@parameters)
       When your extension is added to the response in server-land, this method will be called to create a response object. Any additional
       arguments passed when adding the extension will be passed through verbatim in @parameters.

       You can return "undef" here if you have nothing useful to return.

   CLASS->received_response(\%args)
       In consumer-land, when a caller asks for the request object for your extension in Net::OpenID::VerifiedIdentity this method will be called
       to create a response object.  %args maps the aliases you returned from the "namespace_uris" method to a hashref of the key-value pairs
       provided in that namespace.

       You can return "undef" here if you have nothing useful to return.

perl v5.12.4							    2011-11-11					       Net::OpenID::Extension(3pm)