.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.40) .\" .\" Standard preamble: .\" ======================================================================== .de Sp \" Vertical space (when we can't use .PP) .if t .sp .5v .if n .sp .. .de Vb \" Begin verbatim text .ft CW .nf .ne \\$1 .. .de Ve \" End verbatim text .ft R .fi .. .\" Set up some character translations and predefined strings. \*(-- will .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left .\" double quote, and \*(R" will give a right double quote. \*(C+ will .\" give a nicer C++. Capital omega is used to do unbreakable dashes and .\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff, .\" nothing in troff, for use with C<>. .tr \(*W- .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p' .ie n \{\ . ds -- \(*W- . ds PI pi . if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch . if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch . ds L" "" . ds R" "" . ds C` "" . ds C' "" 'br\} .el\{\ . ds -- \|\(em\| . ds PI \(*p . ds L" `` . ds R" '' . ds C` . ds C' 'br\} .\" .\" Escape single quotes in literal strings from groff's Unicode transform. .ie \n(.g .ds Aq \(aq .el .ds Aq ' .\" .\" If the F register is >0, we'll generate index entries on stderr for .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index .\" entries marked with X<> in POD. Of course, you'll have to process the .\" output yourself in some meaningful fashion. .\" .\" Avoid warning from groff about undefined register 'F'. .de IX .. .nr rF 0 .if \n(.g .if rF .nr rF 1 .if (\n(rF:(\n(.g==0)) \{\ . if \nF \{\ . de IX . tm Index:\\$1\t\\n%\t"\\$2" .. . if !\nF==2 \{\ . nr % 0 . nr F 2 . \} . \} .\} .rr rF .\" .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2). .\" Fear. Run. Save yourself. No user-serviceable parts. . \" fudge factors for nroff and troff .if n \{\ . ds #H 0 . ds #V .8m . ds #F .3m . ds #[ \f1 . ds #] \fP .\} .if t \{\ . ds #H ((1u-(\\\\n(.fu%2u))*.13m) . ds #V .6m . ds #F 0 . ds #[ \& . ds #] \& .\} . \" simple accents for nroff and troff .if n \{\ . ds ' \& . ds ` \& . ds ^ \& . ds , \& . ds ~ ~ . ds / .\} .if t \{\ . ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u" . ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u' . ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u' . ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u' . ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u' . ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u' .\} . \" troff and (daisy-wheel) nroff accents .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V' .ds 8 \h'\*(#H'\(*b\h'-\*(#H' .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#] .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H' .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u' .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#] .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#] .ds ae a\h'-(\w'a'u*4/10)'e .ds Ae A\h'-(\w'A'u*4/10)'E . \" corrections for vroff .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u' .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u' . \" for low resolution devices (crt and lpr) .if \n(.H>23 .if \n(.V>19 \ \{\ . ds : e . ds 8 ss . ds o a . ds d- d\h'-1'\(ga . ds D- D\h'-1'\(hy . ds th \o'bp' . ds Th \o'LP' . ds ae ae . ds Ae AE .\} .rm #[ #] #H #V #F C .\" ======================================================================== .\" .IX Title "LWP::Authen::OAuth2::AccessToken 3pm" .TH LWP::Authen::OAuth2::AccessToken 3pm "2021-01-11" "perl v5.32.0" "User Contributed Perl Documentation" .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l .nh .SH "NAME" LWP::Authen::OAuth2::AccessToken \- Access tokens for OAuth2. .SH "VERSION" .IX Header "VERSION" version 0.18 .SH "SYNOPSIS" .IX Header "SYNOPSIS" This is a base class for signing \s-1API\s0 requests with OAuth2 access tokens. A subclass should override the \f(CW\*(C`request\*(C'\fR method with something that knows how to make a request, detect the need to try to refresh, and attmpts to do that. See lWP::Authen::OAuth2::AccessToken::Bearer for an example. .PP Subclasses of this one are not directly useful. Please see LWP::Authen::OAuth2 for the interface that you should be using. .SH "METHODS" .IX Header "METHODS" .ie n .SS """from_ref""" .el .SS "\f(CWfrom_ref\fP" .IX Subsection "from_ref" Construct an access token from a hash reference. The default implementation merely blesses it as an object, defaulting the \f(CW\*(C`create_time\*(C'\fR field to the current time. .PP .Vb 1 \& my $access_token = $class\->from_ref($data); .Ve .PP If you roll your own, be aware that the fields \f(CW\*(C`refresh_token\*(C'\fR and \&\f(CW\*(C`_class\*(C'\fR get used for purposes out of this class' control. Any other fields may be used. Please die fatally if you cannot construct an object. .ie n .SS """to_ref""" .el .SS "\f(CWto_ref\fP" .IX Subsection "to_ref" Construct an unblessed data structure to represent the object that can be serialized as \s-1JSON.\s0 The default implementation just creates a shallow copy and assumes there are no blessed subobjects. .ie n .SS """expires_time""" .el .SS "\f(CWexpires_time\fP" .IX Subsection "expires_time" Estimate expiration time. Not always correct, due to transit delays, clock skew, etc. .ie n .SS """expires_in""" .el .SS "\f(CWexpires_in\fP" .IX Subsection "expires_in" Estimate the seconds until expiration. Not always correct, due to transit delays, clock skew, etc. .ie n .SS """should_refresh""" .el .SS "\f(CWshould_refresh\fP" .IX Subsection "should_refresh" Boolean saying whether a refresh should be emitted now. .ie n .SS """for_refresh""" .el .SS "\f(CWfor_refresh\fP" .IX Subsection "for_refresh" Returns key/value pairs for \f(CW$oauth2\fR (and eventually the service provider class) to use in trying to refresh. .ie n .SS """copy_refresh_from""" .el .SS "\f(CWcopy_refresh_from\fP" .IX Subsection "copy_refresh_from" Pass in a previous access token, copy anything needed to refresh. .ie n .SS """request""" .el .SS "\f(CWrequest\fP" .IX Subsection "request" Make a request. If expiration is detected, refreshing by the best available method (if any). .PP .Vb 1 \& my $response = $access_token\->request($oauth2, @request_for_lwp); .Ve .ie n .SS """_request""" .el .SS "\f(CW_request\fP" .IX Subsection "_request" Make a request with no retry logic, and return a response, and a flag for whether it is possible the access token is expired.. .PP .Vb 2 \& my ($response, $try_refresh) \& = $access_token\->_request($oauth2, @request_for_lwp); .Ve .PP \&\fB\s-1THIS IS THE ONLY METHOD A SUBCLASS MUST OVERRIDE\s0!\fR .SH "AUTHORS" .IX Header "AUTHORS" .IP "\(bu" 4 Ben Tilly, .IP "\(bu" 4 Thomas Klausner .SH "COPYRIGHT AND LICENSE" .IX Header "COPYRIGHT AND LICENSE" This software is copyright (c) 2013 \- 2021 by Ben Tilly, Rent.com, Thomas Klausner. .PP This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.