Authen::CAS::Client::Response(3pm)

1Authen::CAS::Client::ReUsspeornsCeo(n3t)ributed Perl DocAuumtehnetna:t:iCoAnS::Client::Response(3)
2
3
4

NAME

6       Authen::CAS::Client::Response - A set of classes for implementing
7       responses from a CAS server
8

DESCRIPTION

10       Authen::CAS::Client::Response implements a base class that is used to
11       build a hierarchy of response objects that are returned from methods in
12       Authen::CAS::Client.  Most response objects are meant to encapsulate a
13       type of response from a CAS server.
14

CLASSES AND METHODS

16   Authen::CAS::Client::Response
17       Authen::CAS::Client::Response is the base class from which all other
18       response classes inherit.  As such it is very primitive and is never
19       used directly.
20
21       new( %args )
22
23       new() creates an instance of an "Authen::CAS::Client::Response" object
24       and assigns its data members according to the values in %args.
25
26       is_error()
27
28       is_error() returns true if the response represents an error object.
29
30       is_failure()
31
32       is_failure() returns true if the response represents a failure object.
33
34       is_success()
35
36       is_success() returns true if the response represents a success object.
37
38       doc()
39
40       doc() returns the response document used to create the response object.
41       For errors and CAS v1.0 requests this will be the raw text response
42       from the server.  Otherwise an XML::LibXML object will be returned.
43       This can be used for debugging or retrieving additional information
44       from the CAS server's response.
45
46   Authen::CAS::Client::Response::Error
47       Authen::CAS::Client::Response::Error is used when an error occurs that
48       prevents further processing of a request.  This would include not being
49       able connect to the CAS server, receiving an unexpected response from
50       the server or being unable to correctly parse the server's response
51       according to the guidelines in the CAS protocol specification.
52
53       new( error => $error, doc => $doc )
54
55       new() creates an instance of an "Authen::CAS::Client::Response::Error"
56       object.  $error is the error string.  $doc is the response document.
57
58       error()
59
60       error() returns the error string.
61
62   Authen::CAS::Client::Response::Failure
63       Authen::CAS::Client::Response::Failure is used as a base class for
64       other failure responses.  These correspond to the
65       "cas:authenticationFailure" and "cas:proxyFailure" server responses
66       outlined in the CAS protocol specification.
67
68       new( code => $code, message => $message, doc => $doc )
69
70       new() creates an instance of an
71       "Authen::CAS::Client::Response::Failure" object.  $code is the failure
72       code.  $message is the failure message.  $doc is the response document.
73
74       code()
75
76       code() returns the failure code.
77
78       message()
79
80       message() returns the failure message.
81
82   Authen::CAS::Client::Response::AuthFailure
83       Authen::CAS::Client::Response::AuthFailure is a subclass of
84       "Authen::CAS::Client::Response::Failure" and is used when a validation
85       attempt fails.  When using the CAS v2.0 protocol, $code, $message and
86       $doc are set according to what is parsed from the server response.
87       When using the CAS v1.0 protocol, $code is set to 'V10_AUTH_FAILURE',
88       $message is set to the empty string and $doc is set to the server's
89       response content.
90
91       No additional methods are defined.
92
93   Authen::CAS::Client::Response::ProxyFailure
94       Authen::CAS::Client::Response::ProxyFailure is a subclass of
95       "Authen::CAS::Client::Response::Failure" and is used when a
96       "cas:proxyFailure" response is received from the CAS server during a
97       proxy attempt.  $code, $message and $doc are set according to what is
98       parsed from the server response.
99
100       No additional methods are defined.
101
102   Authen::CAS::Client::Response::Success
103       "Authen::CAS::Client::Response::Success" is used as base class for
104       other success responses.  These correspond to the
105       "cas:authenticationSuccess" and "cas:proxySuccess" server responses.
106
107       new( doc => $doc )
108
109       new() creates an instance of an
110       "Authen::CAS::Client::Response::Success" object.  $doc is the response
111       document.
112
113   Authen::CAS::Client::Response::AuthSuccess
114       Authen::CAS::Client::Response::AuthSuccess is a subclass of
115       "Authen::CAS::Client::Response::Success" and is used when validation
116       succeeds.
117
118       new( user => $user, iou => $iou, proxies => \@proxies, doc => $doc )
119
120       new() creates an instance of an
121       "Authen::CAS::Client::Response::AuthSuccess" object.  $user is the
122       username received in the response.  $iou is the proxy granting ticket
123       IOU, if present.  "\@proxies" is the list of proxies used during
124       validation, if present.  $doc is the response document.
125
126       user()
127
128       user() returns the user name that was contained in the server response.
129
130       iou()
131
132       iou() returns the proxy granting ticket IOU, if it was present in the
133       server response.  Otherwise it is set to "undef".
134
135       proxies()
136
137       proxies() returns the list of proxies present in the server response.
138       If no proxies are found, an empty list is returned.  In scalar context
139       an array reference will be returned instead.
140
141   Authen::CAS::Client::Response::ProxySuccess
142       Authen::CAS::Client::Response::ProxySuccess is a subclass of
143       "Authen::CAS::Client::Response::Success" and is used when a
144       "cas:proxySuccess" response is received from the CAS server during a
145       proxy attempt.
146
147       new( proxy_ticket => $proxy_ticket, doc => $doc )
148
149       new() creates an instance of an
150       "Authen::CAS::Client::Response::ProxySuccess" object.  $proxy_ticket is
151       the proxy ticket received in the response.  $doc is the response
152       document.
153
154       proxy_ticket()
155
156       proxy_ticket() returns the proxy ticket that was contained in the
157       server response.
158

BUGS

160       None are known at this time, but if you find one, please feel free to
161       submit a report to the author.
162

AUTHOR

164       jason hord <pravus@cpan.org>
165

COPYRIGHT

170       Copyright (c) 2007-2014, jason hord
171
172       Permission is hereby granted, free of charge, to any person obtaining a
173       copy of this software and associated documentation files (the
174       "Software"), to deal in the Software without restriction, including
175       without limitation the rights to use, copy, modify, merge, publish,
176       distribute, sublicense, and/or sell copies of the Software, and to
177       permit persons to whom the Software is furnished to do so, subject to
178       the following conditions:
179
180       The above copyright notice and this permission notice shall be included
181       in all copies or substantial portions of the Software.
182
183       THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
184       OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
185       MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
186       IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
187       CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
188       TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
189       SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
190
191
192
193perl v5.36.0                      2023-01-19  Authen::CAS::Client::Response(3)

NAME

DESCRIPTION

CLASSES AND METHODS

BUGS

AUTHOR

SEE ALSO

COPYRIGHT