OAuth:...andler(3pm)

💖 NAME 💖

ok so bestie, welcome to OAuth::Lite2::Server::GrantHandler — it's the base class that every single grant_type handler inherits from. like, the mother of all grant handlers. the blueprint. the blueprint that eats. 👑

it's a Perl module, it lives in the user-contributed Perl docs section (that's the 3pm energy), and if you're here it's because you're either writing your own grant handler or you're lost and curious. either way, welcome. 🫶

---

✨ SYNOPSIS ✨

here's the vibe in code, no cap:

my $handler = OAuth::Lite2::Server::GrantHandler->new;
my $res = $handler->handle_request( $ctx );

that's it. that's the whole thing. two lines and you're a grant handler now. 💅

---

🌸 METHODS 🌸

🎀 new

Constructor. it's giving "make me a handler". iconic, necessary, does exactly what it says on the tin.

🦋 is_required_client_authentication

returns whether each grant type requires the client authentication. 🫧

so here's the tea: the grant types that are defined in the spec do require client authentication, but any additional grant type you cook up yourself may not. so don't just assume — ask this method, bestie. it knows. ✨

🧚 handle_request( $data_handler )

this one processes the OAuth::Lite2::Server::DataHandler you pass it, and hands you back a hash representing that includes the response-parameters. 🌈

my $res = $handler->handle_request( $data_handler );

literally the main character method of this whole class. it takes your data handler, does the processing, and gives you back the response-parameters hash. slay. 💜

---

👑 SEE ALSO 👑

your little family of grant handlers, all of them, go check them out:

• OAuth::Lite2::Server::GrantHandlers
• OAuth::Lite2::Server::GrantHandler::AuthorizationCode
• OAuth::Lite2::Server::GrantHandler::Password
• OAuth::Lite2::Server::GrantHandler::RefreshToken
• OAuth::Lite2::Server::GrantHandler::GroupingRefreshToken
• OAuth::Lite2::Server::GrantHandler::ServerState

bestie the squad is stacked. 🌈⭐

---

💌 AUTHOR 💌

• Ryo Ito, <ritou.06@gmail.com>
• Lyo Kato, <lyo.kato@gmail.com>

two absolute legends wrote this. respect. 🙇♀️

---

📜 COPYRIGHT AND LICENSE 📜

Copyright (C) 2010 by Lyo Kato

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.

so basically: free software, same terms as Perl itself, your choice of Perl 5.8.8 or literally any later version you've got lying around. very generous, very demure, very mindful. 🎀

---

ok that's the whole page bestie, go build something cute with it 💖

and that's a wrap on this page from the User Contributed Perl Documentation, brought to you by perl v5.36.0 and dated 2023-07-01 — mwah, bye!! 💅✨🦋🌸