xref: /plugin/authssocas/vendor/apereo/phpcas/source/CAS/ProxiedService.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.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 allow proxy-authenticated service handlers
32*d10b5556SXylle * to interact with phpCAS.
33*d10b5556SXylle *
34*d10b5556SXylle * Proxy service handlers must implement this interface as well as call
35*d10b5556SXylle * phpCAS::initializeProxiedService($this) at some point in their implementation.
36*d10b5556SXylle *
37*d10b5556SXylle * While not required, proxy-authenticated service handlers are encouraged to
38*d10b5556SXylle * implement the CAS_ProxiedService_Testable interface to facilitate unit testing.
39*d10b5556SXylle *
40*d10b5556SXylle * @class    CAS_ProxiedService
41*d10b5556SXylle * @category Authentication
42*d10b5556SXylle * @package  PhpCAS
43*d10b5556SXylle * @author   Adam Franco <afranco@middlebury.edu>
44*d10b5556SXylle * @license  http://www.apache.org/licenses/LICENSE-2.0  Apache License 2.0
45*d10b5556SXylle * @link     https://wiki.jasig.org/display/CASC/phpCAS
46*d10b5556SXylle */
47*d10b5556SXylleinterface CAS_ProxiedService
48*d10b5556SXylle{
49*d10b5556SXylle
50*d10b5556SXylle    /**
51*d10b5556SXylle     * Answer a service identifier (URL) for whom we should fetch a proxy ticket.
52*d10b5556SXylle     *
53*d10b5556SXylle     * @return string
54*d10b5556SXylle     * @throws Exception If no service url is available.
55*d10b5556SXylle     */
56*d10b5556SXylle    public function getServiceUrl ();
57*d10b5556SXylle
58*d10b5556SXylle    /**
59*d10b5556SXylle     * Register a proxy ticket with the ProxiedService that it can use when
60*d10b5556SXylle     * making requests.
61*d10b5556SXylle     *
62*d10b5556SXylle     * @param string $proxyTicket Proxy ticket string
63*d10b5556SXylle     *
64*d10b5556SXylle     * @return void
65*d10b5556SXylle     * @throws InvalidArgumentException If the $proxyTicket is invalid.
66*d10b5556SXylle     * @throws CAS_OutOfSequenceException If called after a proxy ticket has
67*d10b5556SXylle     * already been initialized/set.
68*d10b5556SXylle     */
69*d10b5556SXylle    public function setProxyTicket ($proxyTicket);
70*d10b5556SXylle
71*d10b5556SXylle}
72*d10b5556SXylle?>
73