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/Request/MultiRequestInterface.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 a class library for performing multiple web requests 32*d10b5556SXylle * in batches. Implementations of this interface may perform requests serially 33*d10b5556SXylle * or in parallel. 34*d10b5556SXylle * 35*d10b5556SXylle * @class CAS_Request_MultiRequestInterface 36*d10b5556SXylle * @category Authentication 37*d10b5556SXylle * @package PhpCAS 38*d10b5556SXylle * @author Adam Franco <afranco@middlebury.edu> 39*d10b5556SXylle * @license http://www.apache.org/licenses/LICENSE-2.0 Apache License 2.0 40*d10b5556SXylle * @link https://wiki.jasig.org/display/CASC/phpCAS 41*d10b5556SXylle */ 42*d10b5556SXylleinterface CAS_Request_MultiRequestInterface 43*d10b5556SXylle{ 44*d10b5556SXylle 45*d10b5556SXylle /********************************************************* 46*d10b5556SXylle * Add Requests 47*d10b5556SXylle *********************************************************/ 48*d10b5556SXylle 49*d10b5556SXylle /** 50*d10b5556SXylle * Add a new Request to this batch. 51*d10b5556SXylle * Note, implementations will likely restrict requests to their own concrete 52*d10b5556SXylle * class hierarchy. 53*d10b5556SXylle * 54*d10b5556SXylle * @param CAS_Request_RequestInterface $request request interface 55*d10b5556SXylle * 56*d10b5556SXylle * @return void 57*d10b5556SXylle * @throws CAS_OutOfSequenceException If called after the Request has been 58*d10b5556SXylle * sent. 59*d10b5556SXylle * @throws CAS_InvalidArgumentException If passed a Request of the wrong 60*d10b5556SXylle * implmentation. 61*d10b5556SXylle */ 62*d10b5556SXylle public function addRequest (CAS_Request_RequestInterface $request); 63*d10b5556SXylle 64*d10b5556SXylle /** 65*d10b5556SXylle * Retrieve the number of requests added to this batch. 66*d10b5556SXylle * 67*d10b5556SXylle * @return int number of request elements 68*d10b5556SXylle */ 69*d10b5556SXylle public function getNumRequests (); 70*d10b5556SXylle 71*d10b5556SXylle /********************************************************* 72*d10b5556SXylle * 2. Send the Request 73*d10b5556SXylle *********************************************************/ 74*d10b5556SXylle 75*d10b5556SXylle /** 76*d10b5556SXylle * Perform the request. After sending, all requests will have their 77*d10b5556SXylle * responses poulated. 78*d10b5556SXylle * 79*d10b5556SXylle * @return bool TRUE on success, FALSE on failure. 80*d10b5556SXylle * @throws CAS_OutOfSequenceException If called multiple times. 81*d10b5556SXylle */ 82*d10b5556SXylle public function send (); 83*d10b5556SXylle} 84