.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.42)
.\"
.\" 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
.\" ========================================================================
.\"
.IX Title "Authen::CAS::Client::Response 3pm"
.TH Authen::CAS::Client::Response 3pm "2022-10-13" "perl v5.34.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"
Authen::CAS::Client::Response \- A set of classes for implementing
responses from a CAS server
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
Authen::CAS::Client::Response implements a base class that is used to
build a hierarchy of response objects that are returned from methods in
Authen::CAS::Client.  Most response objects are meant to encapsulate
a type of response from a \s-1CAS\s0 server.
.SH "CLASSES AND METHODS"
.IX Header "CLASSES AND METHODS"
.SS "Authen::CAS::Client::Response"
.IX Subsection "Authen::CAS::Client::Response"
Authen::CAS::Client::Response is the base class from which all other
response classes inherit.  As such it is very primitive and is never
used directly.
.PP
\fInew( \f(CI%args\fI )\fR
.IX Subsection "new( %args )"
.PP
\&\f(CW\*(C`new()\*(C'\fR creates an instance of an \f(CW\*(C`Authen::CAS::Client::Response\*(C'\fR object
and assigns its data members according to the values in \f(CW%args\fR.
.PP
\fI\f(BIis_error()\fI\fR
.IX Subsection "is_error()"
.PP
\&\f(CW\*(C`is_error()\*(C'\fR returns true if the response represents an error object.
.PP
\fI\f(BIis_failure()\fI\fR
.IX Subsection "is_failure()"
.PP
\&\f(CW\*(C`is_failure()\*(C'\fR returns true if the response represents a failure object.
.PP
\fI\f(BIis_success()\fI\fR
.IX Subsection "is_success()"
.PP
\&\f(CW\*(C`is_success()\*(C'\fR returns true if the response represents a success object.
.PP
\fI\f(BIdoc()\fI\fR
.IX Subsection "doc()"
.PP
\&\f(CW\*(C`doc()\*(C'\fR returns the response document used to create the response object.
For errors and \s-1CAS\s0 v1.0 requests this will be the raw text response
from the server.  Otherwise an XML::LibXML object will be returned.
This can be used for debugging or retrieving additional information
from the \s-1CAS\s0 server's response.
.SS "Authen::CAS::Client::Response::Error"
.IX Subsection "Authen::CAS::Client::Response::Error"
Authen::CAS::Client::Response::Error is used when an error occurs that
prevents further processing of a request.  This would include not being able
connect to the \s-1CAS\s0 server, receiving an unexpected response from the server
or being unable to correctly parse the server's response according to the
guidelines in the \s-1CAS\s0 protocol specification.
.PP
\fInew( error => \f(CI$error\fI, doc => \f(CI$doc\fI )\fR
.IX Subsection "new( error => $error, doc => $doc )"
.PP
\&\f(CW\*(C`new()\*(C'\fR creates an instance of an \f(CW\*(C`Authen::CAS::Client::Response::Error\*(C'\fR
object.  \f(CW$error\fR is the error string.  \f(CW$doc\fR is the response document.
.PP
\fI\f(BIerror()\fI\fR
.IX Subsection "error()"
.PP
\&\f(CW\*(C`error()\*(C'\fR returns the error string.
.SS "Authen::CAS::Client::Response::Failure"
.IX Subsection "Authen::CAS::Client::Response::Failure"
Authen::CAS::Client::Response::Failure is used as a base class for other
failure responses.  These correspond to the \f(CW\*(C`cas:authenticationFailure\*(C'\fR and
\&\f(CW\*(C`cas:proxyFailure\*(C'\fR server responses outlined in the \s-1CAS\s0 protocol
specification.
.PP
\fInew( code => \f(CI$code\fI, message => \f(CI$message\fI, doc => \f(CI$doc\fI )\fR
.IX Subsection "new( code => $code, message => $message, doc => $doc )"
.PP
\&\f(CW\*(C`new()\*(C'\fR creates an instance of an \f(CW\*(C`Authen::CAS::Client::Response::Failure\*(C'\fR
object.  \f(CW$code\fR is the failure code.  \f(CW$message\fR is the failure message.
\&\f(CW$doc\fR is the response document.
.PP
\fI\f(BIcode()\fI\fR
.IX Subsection "code()"
.PP
\&\f(CW\*(C`code()\*(C'\fR returns the failure code.
.PP
\fI\f(BImessage()\fI\fR
.IX Subsection "message()"
.PP
\&\f(CW\*(C`message()\*(C'\fR returns the failure message.
.SS "Authen::CAS::Client::Response::AuthFailure"
.IX Subsection "Authen::CAS::Client::Response::AuthFailure"
Authen::CAS::Client::Response::AuthFailure is a subclass of
\&\f(CW\*(C`Authen::CAS::Client::Response::Failure\*(C'\fR and is used when a
validation attempt fails.  When using the \s-1CAS\s0 v2.0 protocol,
\&\f(CW$code\fR, \f(CW$message\fR and \f(CW$doc\fR are set according to what is parsed
from the server response.  When using the \s-1CAS\s0 v1.0 protocol, \f(CW$code\fR
is set to \f(CW\*(AqV10_AUTH_FAILURE\*(Aq\fR, \f(CW$message\fR is set to the empty string
and \f(CW$doc\fR is set to the server's response content.
.PP
No additional methods are defined.
.SS "Authen::CAS::Client::Response::ProxyFailure"
.IX Subsection "Authen::CAS::Client::Response::ProxyFailure"
Authen::CAS::Client::Response::ProxyFailure is a subclass of
\&\f(CW\*(C`Authen::CAS::Client::Response::Failure\*(C'\fR and is used when a
\&\f(CW\*(C`cas:proxyFailure\*(C'\fR response is received from the \s-1CAS\s0 server
during a proxy attempt.  \f(CW$code\fR, \f(CW$message\fR and \f(CW$doc\fR are set
according to what is parsed from the server response.
.PP
No additional methods are defined.
.SS "Authen::CAS::Client::Response::Success"
.IX Subsection "Authen::CAS::Client::Response::Success"
\&\f(CW\*(C`Authen::CAS::Client::Response::Success\*(C'\fR is used as base class for other
success responses.  These correspond to the \f(CW\*(C`cas:authenticationSuccess\*(C'\fR and
\&\f(CW\*(C`cas:proxySuccess\*(C'\fR server responses.
.PP
\fInew( doc => \f(CI$doc\fI )\fR
.IX Subsection "new( doc => $doc )"
.PP
\&\f(CW\*(C`new()\*(C'\fR creates an instance of an \f(CW\*(C`Authen::CAS::Client::Response::Success\*(C'\fR
object.  \f(CW$doc\fR is the response document.
.SS "Authen::CAS::Client::Response::AuthSuccess"
.IX Subsection "Authen::CAS::Client::Response::AuthSuccess"
Authen::CAS::Client::Response::AuthSuccess is a subclass of
\&\f(CW\*(C`Authen::CAS::Client::Response::Success\*(C'\fR and is used when
validation succeeds.
.PP
\fInew( user => \f(CI$user\fI, iou => \f(CI$iou\fI, proxies => \e@proxies, doc => \f(CI$doc\fI )\fR
.IX Subsection "new( user => $user, iou => $iou, proxies => @proxies, doc => $doc )"
.PP
\&\f(CW\*(C`new()\*(C'\fR creates an instance of an \f(CW\*(C`Authen::CAS::Client::Response::AuthSuccess\*(C'\fR
object.  \f(CW$user\fR is the username received in the response.  \f(CW$iou\fR
is the proxy granting ticket \s-1IOU,\s0 if present.  \f(CW\*(C`\e@proxies\*(C'\fR is the
list of proxies used during validation, if present.  \f(CW$doc\fR is the
response document.
.PP
\fI\f(BIuser()\fI\fR
.IX Subsection "user()"
.PP
\&\f(CW\*(C`user()\*(C'\fR returns the user name that was contained in the server response.
.PP
\fI\f(BIiou()\fI\fR
.IX Subsection "iou()"
.PP
\&\f(CW\*(C`iou()\*(C'\fR returns the proxy granting ticket \s-1IOU,\s0 if it was present in the
server response.  Otherwise it is set to \f(CW\*(C`undef\*(C'\fR.
.PP
\fI\f(BIproxies()\fI\fR
.IX Subsection "proxies()"
.PP
\&\f(CW\*(C`proxies()\*(C'\fR returns the list of proxies present in the server response.  If
no proxies are found, an empty list is returned.  In scalar context an
array reference will be returned instead.
.SS "Authen::CAS::Client::Response::ProxySuccess"
.IX Subsection "Authen::CAS::Client::Response::ProxySuccess"
Authen::CAS::Client::Response::ProxySuccess is a subclass of
\&\f(CW\*(C`Authen::CAS::Client::Response::Success\*(C'\fR and is used when a
\&\f(CW\*(C`cas:proxySuccess\*(C'\fR response is received from the \s-1CAS\s0 server during
a proxy attempt.
.PP
\fInew( proxy_ticket => \f(CI$proxy_ticket\fI, doc => \f(CI$doc\fI )\fR
.IX Subsection "new( proxy_ticket => $proxy_ticket, doc => $doc )"
.PP
\&\f(CW\*(C`new()\*(C'\fR creates an instance of an \f(CW\*(C`Authen::CAS::Client::Response::ProxySuccess\*(C'\fR
object.  \f(CW$proxy_ticket\fR is the proxy ticket received in the response.
\&\f(CW$doc\fR is the response document.
.PP
\fI\f(BIproxy_ticket()\fI\fR
.IX Subsection "proxy_ticket()"
.PP
\&\f(CW\*(C`proxy_ticket()\*(C'\fR returns the proxy ticket that was contained in the
server response.
.SH "BUGS"
.IX Header "BUGS"
None are known at this time, but if you find one, please feel free to
submit a report to the author.
.SH "AUTHOR"
.IX Header "AUTHOR"
jason hord <pravus@cpan.org>
.SH "SEE ALSO"
.IX Header "SEE ALSO"
.IP "Authen::CAS::Client" 4
.IX Item "Authen::CAS::Client"
.SH "LICENSE"
.IX Header "LICENSE"
This software is information.
It is subject only to local laws of physics.