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.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 interface defines methods that clients should use for configuring, sending, 32*d10b5556SXylle * and receiving proxied HTTP requests. 33*d10b5556SXylle * 34*d10b5556SXylle * @class CAS_ProxiedService_Http 35*d10b5556SXylle * @category Authentication 36*d10b5556SXylle * @package PhpCAS 37*d10b5556SXylle * @author Adam Franco <afranco@middlebury.edu> 38*d10b5556SXylle * @license http://www.apache.org/licenses/LICENSE-2.0 Apache License 2.0 39*d10b5556SXylle * @link https://wiki.jasig.org/display/CASC/phpCAS 40*d10b5556SXylle */ 41*d10b5556SXylleinterface CAS_ProxiedService_Http 42*d10b5556SXylle{ 43*d10b5556SXylle 44*d10b5556SXylle /********************************************************* 45*d10b5556SXylle * Configure the Request 46*d10b5556SXylle *********************************************************/ 47*d10b5556SXylle 48*d10b5556SXylle /** 49*d10b5556SXylle * Set the URL of the Request 50*d10b5556SXylle * 51*d10b5556SXylle * @param string $url Url to set 52*d10b5556SXylle * 53*d10b5556SXylle * @return void 54*d10b5556SXylle * @throws CAS_OutOfSequenceException If called after the Request has been sent. 55*d10b5556SXylle */ 56*d10b5556SXylle public function setUrl ($url); 57*d10b5556SXylle 58*d10b5556SXylle /********************************************************* 59*d10b5556SXylle * 2. Send the Request 60*d10b5556SXylle *********************************************************/ 61*d10b5556SXylle 62*d10b5556SXylle /** 63*d10b5556SXylle * Perform the request. 64*d10b5556SXylle * 65*d10b5556SXylle * @return bool TRUE on success, FALSE on failure. 66*d10b5556SXylle * @throws CAS_OutOfSequenceException If called multiple times. 67*d10b5556SXylle */ 68*d10b5556SXylle public function send (); 69*d10b5556SXylle 70*d10b5556SXylle /********************************************************* 71*d10b5556SXylle * 3. Access the response 72*d10b5556SXylle *********************************************************/ 73*d10b5556SXylle 74*d10b5556SXylle /** 75*d10b5556SXylle * Answer the headers of the response. 76*d10b5556SXylle * 77*d10b5556SXylle * @return array An array of header strings. 78*d10b5556SXylle * @throws CAS_OutOfSequenceException If called before the Request has been sent. 79*d10b5556SXylle */ 80*d10b5556SXylle public function getResponseHeaders (); 81*d10b5556SXylle 82*d10b5556SXylle /** 83*d10b5556SXylle * Answer the body of response. 84*d10b5556SXylle * 85*d10b5556SXylle * @return string 86*d10b5556SXylle * @throws CAS_OutOfSequenceException If called before the Request has been sent. 87*d10b5556SXylle */ 88*d10b5556SXylle public function getResponseBody (); 89*d10b5556SXylle 90*d10b5556SXylle} 91*d10b5556SXylle?> 92