xref: /plugin/authssocas/vendor/apereo/phpcas/source/CAS/ProxiedService/Http/Get.php (revision d10b5556242e78d8a430c323b91984ec16415a46)
1*d10b5556SXylle<?php
2*d10b5556SXylle
3*d10b5556SXylle/**
4*d10b5556SXylle * Licensed to Jasig under one or more contributor license
5*d10b5556SXylle * agreements. See the NOTICE file distributed with this work for
6*d10b5556SXylle * additional information regarding copyright ownership.
7*d10b5556SXylle *
8*d10b5556SXylle * Jasig licenses this file to you under the Apache License,
9*d10b5556SXylle * Version 2.0 (the "License"); you may not use this file except in
10*d10b5556SXylle * compliance with the License. You may obtain a copy of the License at:
11*d10b5556SXylle *
12*d10b5556SXylle * http://www.apache.org/licenses/LICENSE-2.0
13*d10b5556SXylle *
14*d10b5556SXylle * Unless required by applicable law or agreed to in writing, software
15*d10b5556SXylle * distributed under the License is distributed on an "AS IS" BASIS,
16*d10b5556SXylle * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
17*d10b5556SXylle * See the License for the specific language governing permissions and
18*d10b5556SXylle * limitations under the License.
19*d10b5556SXylle *
20*d10b5556SXylle * PHP Version 7
21*d10b5556SXylle *
22*d10b5556SXylle * @file     CAS/ProxiedService/Http/Get.php
23*d10b5556SXylle * @category Authentication
24*d10b5556SXylle * @package  PhpCAS
25*d10b5556SXylle * @author   Adam Franco <afranco@middlebury.edu>
26*d10b5556SXylle * @license  http://www.apache.org/licenses/LICENSE-2.0  Apache License 2.0
27*d10b5556SXylle * @link     https://wiki.jasig.org/display/CASC/phpCAS
28*d10b5556SXylle */
29*d10b5556SXylle
30*d10b5556SXylle/**
31*d10b5556SXylle * This class is used to make proxied service requests via the HTTP GET method.
32*d10b5556SXylle *
33*d10b5556SXylle * Usage Example:
34*d10b5556SXylle *
35*d10b5556SXylle *	try {
36*d10b5556SXylle *		$service = phpCAS::getProxiedService(PHPCAS_PROXIED_SERVICE_HTTP_GET);
37*d10b5556SXylle *		$service->setUrl('http://www.example.com/path/');
38*d10b5556SXylle *		$service->send();
39*d10b5556SXylle *		if ($service->getResponseStatusCode() == 200)
40*d10b5556SXylle *			return $service->getResponseBody();
41*d10b5556SXylle *		else
42*d10b5556SXylle *			// The service responded with an error code 404, 500, etc.
43*d10b5556SXylle *			throw new Exception('The service responded with an error.');
44*d10b5556SXylle *
45*d10b5556SXylle * 	} catch (CAS_ProxyTicketException $e) {
46*d10b5556SXylle *	    if ($e->getCode() == PHPCAS_SERVICE_PT_FAILURE)
47*d10b5556SXylle *			return "Your login has timed out. You need to log in again.";
48*d10b5556SXylle *		else
49*d10b5556SXylle *			// Other proxy ticket errors are from bad request format
50*d10b5556SXylle *          // (shouldn't happen) or CAS server failure (unlikely)
51*d10b5556SXylle *          // so lets just stop if we hit those.
52*d10b5556SXylle *			throw $e;
53*d10b5556SXylle *	} catch (CAS_ProxiedService_Exception $e) {
54*d10b5556SXylle *		// Something prevented the service request from being sent or received.
55*d10b5556SXylle *		// We didn't even get a valid error response (404, 500, etc), so this
56*d10b5556SXylle *		// might be caused by a network error or a DNS resolution failure.
57*d10b5556SXylle *		// We could handle it in some way, but for now we will just stop.
58*d10b5556SXylle *		throw $e;
59*d10b5556SXylle *	}
60*d10b5556SXylle *
61*d10b5556SXylle * @class    CAS_ProxiedService_Http_Get
62*d10b5556SXylle * @category Authentication
63*d10b5556SXylle * @package  PhpCAS
64*d10b5556SXylle * @author   Adam Franco <afranco@middlebury.edu>
65*d10b5556SXylle * @license  http://www.apache.org/licenses/LICENSE-2.0  Apache License 2.0
66*d10b5556SXylle * @link     https://wiki.jasig.org/display/CASC/phpCAS
67*d10b5556SXylle */
68*d10b5556SXylleclass CAS_ProxiedService_Http_Get
69*d10b5556SXylleextends CAS_ProxiedService_Http_Abstract
70*d10b5556SXylle{
71*d10b5556SXylle
72*d10b5556SXylle    /**
73*d10b5556SXylle     * Add any other parts of the request needed by concrete classes
74*d10b5556SXylle     *
75*d10b5556SXylle     * @param CAS_Request_RequestInterface $request request interface
76*d10b5556SXylle     *
77*d10b5556SXylle     * @return void
78*d10b5556SXylle     */
79*d10b5556SXylle    protected function populateRequest (CAS_Request_RequestInterface $request)
80*d10b5556SXylle    {
81*d10b5556SXylle        // do nothing, since the URL has already been sent and that is our
82*d10b5556SXylle        // only data.
83*d10b5556SXylle    }
84*d10b5556SXylle}
85*d10b5556SXylle?>
86