forked from apereo/phpCAS
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathAbstract.php
More file actions
executable file
·108 lines (95 loc) · 3.51 KB
/
Abstract.php
File metadata and controls
executable file
·108 lines (95 loc) · 3.51 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
<?php
/**
* Licensed to Jasig under one or more contributor license
* agreements. See the NOTICE file distributed with this work for
* additional information regarding copyright ownership.
*
* Jasig licenses this file to you under the Apache License,
* Version 2.0 (the "License"); you may not use this file except in
* compliance with the License. You may obtain a copy of the License at:
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
/**
* This class implements common methods for ProxiedService implementations included
* with phpCAS.
*/
abstract class CAS_ProxiedService_Abstract
implements CAS_ProxiedService, CAS_ProxiedService_Testable
{
/**
* The proxy ticket that can be used when making service requests.
* @var string $_proxyTicket;
*/
private $_proxyTicket;
/**
* Register a proxy ticket with the Proxy that it can use when making requests.
*
* @param string $proxyTicket
* @return void
* @throws InvalidArgumentException If the $proxyTicket is invalid.
* @throws CAS_OutOfSequenceException If called after a proxy ticket has already been initialized/set.
*/
public function setProxyTicket ($proxyTicket) {
if (empty($proxyTicket))
throw new CAS_InvalidArgumentException("Trying to initialize with an empty proxy ticket.");
if (!empty($this->_proxyTicket))
throw new CAS_OutOfSequenceException('Already initialized, cannot change the proxy ticket.');
$this->_proxyTicket = $proxyTicket;
}
/**
* Answer the proxy ticket to be used when making requests.
*
* @return string
* @throws CAS_OutOfSequenceException If called before a proxy ticket has already been initialized/set.
*/
protected function getProxyTicket () {
if (empty($this->_proxyTicket))
throw new CAS_OutOfSequenceException('No proxy ticket yet. Call $this->initializeProxyTicket() to aquire the proxy ticket.');
return $this->_proxyTicket;
}
/**
* @var CAS_Client $_casClient;
*/
private $_casClient;
/**
* Use a particular CAS_Client->initializeProxiedService() rather than the
* static phpCAS::initializeProxiedService().
*
* This method should not be called in standard operation, but is needed for unit
* testing.
*
* @param CAS_Client $casClient
* @return void
* @throws CAS_OutOfSequenceException If called after a proxy ticket has already been initialized/set.
*/
public function setCasClient (CAS_Client $casClient) {
if (!empty($this->_proxyTicket))
throw new CAS_OutOfSequenceException('Already initialized, cannot change the CAS_Client.');
$this->_casClient = $casClient;
}
/**
* Fetch our proxy ticket.
*
* Descendent classes should call this method once their service URL is available
* to initialize their proxy ticket.
*
* @return void
* @throws CAS_OutOfSequenceException If called after a proxy ticket has already been initialized.
*/
protected function initializeProxyTicket() {
if (!empty($this->_proxyTicket))
throw new CAS_OutOfSequenceException('Already initialized, cannot initialize again.');
// Allow usage of a particular CAS_Client for unit testing.
if (empty($this->_casClient))
phpCAS::initializeProxiedService($this);
else
$this->_casClient->initializeProxiedService($this);
}
}