This class implements common methods for ProxiedService implementations included with phpCAS. More...

Inheritance diagram for CAS_ProxiedService_Http_Abstract:

Collaboration diagram for CAS_ProxiedService_Http_Abstract:

Public Member Functions
	__construct (CAS_Request_RequestInterface $requestHandler, CAS_CookieJar $cookieJar)
	Constructor. More...

	getServiceUrl ()
	Answer a service identifier (URL) for whom we should fetch a proxy ticket. More...

	setUrl ($url)
	Set the URL of the Request. More...

	send ()
	Perform the request. More...

	getResponseHeaders ()
	Answer the headers of the response. More...

	getResponseStatusCode ()
	Answer HTTP status code of the response. More...

	getResponseBody ()
	Answer the body of response. More...

	getCookies ()
	Answer the cookies from the response. More...

Public Member Functions inherited from CAS_ProxiedService_Abstract
	setProxyTicket ($proxyTicket)
	Register a proxy ticket with the Proxy that it can use when making requests. More...

	setCasClient (CAS_Client $casClient)
	Use a particular CAS_Client->initializeProxiedService() rather than the static phpCAS::initializeProxiedService(). More...

Public Member Functions inherited from CAS_ProxiedService
	getServiceUrl ()
	Answer a service identifier (URL) for whom we should fetch a proxy ticket. More...

	setProxyTicket ($proxyTicket)
	Register a proxy ticket with the ProxiedService that it can use when making requests. More...

Public Member Functions inherited from CAS_ProxiedService_Http
	setUrl ($url)
	Set the URL of the Request. More...

	send ()
	Perform the request. More...

	getResponseHeaders ()
	Answer the headers of the response. More...

	getResponseBody ()
	Answer the body of response. More...

Protected Member Functions
	makeRequest ($url)
	Build and perform a request, following redirects. More...

	populateRequest (CAS_Request_RequestInterface $request)
	Add any other parts of the request needed by concrete classes. More...

	getRedirectUrl (array $responseHeaders)
	Answer a redirect URL if a redirect header is found, otherwise null. More...

	hasBeenSent ()
	Answer true if our request has been sent yet. More...

Protected Member Functions inherited from CAS_ProxiedService_Abstract
	getProxyTicket ()
	Answer the proxy ticket to be used when making requests. More...

	initializeProxyTicket ()
	Fetch our proxy ticket. More...

Protected Attributes
	$requestHandler
	The HTTP request mechanism talking to the target service. More...

Private Attributes
	$_cookieJar
	The storage mechanism for cookies set by the target service. More...

	$_url
	The target service url. More...

	$_numRequests = 0
	Indicator of the number of requests (including redirects performed. More...

	$_responseHeaders = array()
	The response headers. More...

	$_responseStatusCode = ''
	The response status code. More...

	$_responseBody = ''
	The response headers. More...

Detailed Description

This class implements common methods for ProxiedService implementations included with phpCAS.

Definition at line 41 of file Abstract.php.

Constructor & Destructor Documentation

◆ __construct()

CAS_ProxiedService_Http_Abstract::__construct	(	CAS_Request_RequestInterface	$requestHandler,
		CAS_CookieJar	$cookieJar
	)

Constructor.

Parameters

CAS_Request_RequestInterface	$requestHandler	request handler object
CAS_CookieJar	$cookieJar	cookieJar object

Returns: void

Definition at line 66 of file Abstract.php.

References $requestHandler.

       {
         $this->requestHandler = $requestHandler;
         $this->_cookieJar = $cookieJar;
     }

Member Function Documentation

◆ getCookies()

CAS_ProxiedService_Http_Abstract::getCookies ( )

Answer the cookies from the response.

This may include cookies set during redirect responses.

Returns: array An array containing cookies. E.g. array('name' => 'val');

Definition at line 354 of file Abstract.php.

     {
         return $this->_cookieJar->getCookies($this->getServiceUrl());
     }

◆ getRedirectUrl()

CAS_ProxiedService_Http_Abstract::getRedirectUrl ( array $responseHeaders )

protected

Answer a redirect URL if a redirect header is found, otherwise null.

Parameters

array $responseHeaders response header to extract a redirect from

Returns: string or null

Definition at line 271 of file Abstract.php.

     {
         // Check for the redirect after authentication
         foreach ($responseHeaders as $header) {
             if ( preg_match('/^(Location:|URI:)\s*([^\s]+.*)$/', $header, $matches)
             ) {
                 return trim(array_pop($matches));
             }
         }
         return null;
     }

◆ getResponseBody()

CAS_ProxiedService_Http_Abstract::getResponseBody ( )

Answer the body of response.

Returns: string

Exceptions

CAS_OutOfSequenceException If called before the Request has been sent.

Definition at line 337 of file Abstract.php.

     {
         if (!$this->hasBeenSent()) {
             throw new CAS_OutOfSequenceException(
                 'Cannot access response, request not sent yet.'
             );
         }
 
         return $this->_responseBody;
     }

◆ getResponseHeaders()

CAS_ProxiedService_Http_Abstract::getResponseHeaders ( )

Answer the headers of the response.

Returns: array An array of header strings.

Exceptions

CAS_OutOfSequenceException If called before the Request has been sent.

Definition at line 303 of file Abstract.php.

     {
         if (!$this->hasBeenSent()) {
             throw new CAS_OutOfSequenceException(
                 'Cannot access response, request not sent yet.'
             );
         }
 
         return $this->_responseHeaders;
     }

◆ getResponseStatusCode()

CAS_ProxiedService_Http_Abstract::getResponseStatusCode ( )

Answer HTTP status code of the response.

Returns: int

Exceptions

CAS_OutOfSequenceException If called before the Request has been sent.

Definition at line 320 of file Abstract.php.

     {
         if (!$this->hasBeenSent()) {
             throw new CAS_OutOfSequenceException(
                 'Cannot access response, request not sent yet.'
             );
         }
 
         return $this->_responseStatusCode;
     }

◆ getServiceUrl()

CAS_ProxiedService_Http_Abstract::getServiceUrl ( )

Answer a service identifier (URL) for whom we should fetch a proxy ticket.

Returns: string

Exceptions

Exception If no service url is available.

Definition at line 85 of file Abstract.php.

References $_url.

Referenced by send().

     {
         if (empty($this->_url)) {
             throw new CAS_ProxiedService_Exception(
                 'No URL set via ' . get_class($this) . '->setUrl($url).'
             );
         }
 
         return $this->_url;
     }

Here is the caller graph for this function:

◆ hasBeenSent()

CAS_ProxiedService_Http_Abstract::hasBeenSent ( )

protected

Answer true if our request has been sent yet.

Returns: bool

Definition at line 292 of file Abstract.php.

Referenced by send(), CAS_ProxiedService_Http_Post\setBody(), CAS_ProxiedService_Http_Post\setContentType(), and setUrl().

     {
         return ($this->_numRequests > 0);
     }

Here is the caller graph for this function:

◆ makeRequest()

CAS_ProxiedService_Http_Abstract::makeRequest ( $url )

protected

Build and perform a request, following redirects.

Parameters

string $url url for the request

Returns: void

Exceptions

CAS_ProxyTicketException	If there is a proxy-ticket failure. The code of the Exception will be one of: PHPCAS_SERVICE_PT_NO_SERVER_RESPONSE PHPCAS_SERVICE_PT_BAD_SERVER_RESPONSE PHPCAS_SERVICE_PT_FAILURE
CAS_ProxiedService_Exception	If there is a failure sending the request to the target service.

Definition at line 208 of file Abstract.php.

References $requestHandler, $url, populateRequest(), and phpCAS\trace().

Referenced by send().

     {
         // Verify that we are not in a redirect loop
         $this->_numRequests++;
         if ($this->_numRequests > 4) {
             $message = 'Exceeded the maximum number of redirects (3) in proxied service request.';
             phpCAS::trace($message);
             throw new CAS_ProxiedService_Exception($message);
         }
 
         // Create a new request.
         $request = clone $this->requestHandler;
         $request->setUrl($url);
 
         // Add any cookies to the request.
         $request->addCookies($this->_cookieJar->getCookies($url));
 
         // Add any other parts of the request needed by concrete classes
         $this->populateRequest($request);
 
         // Perform the request.
         phpCAS::trace('Performing proxied service request to \'' . $url . '\'');
         if (!$request->send()) {
             $message = 'Could not perform proxied service request to URL`'
             . $url . '\'. ' . $request->getErrorMessage();
             phpCAS::trace($message);
             throw new CAS_ProxiedService_Exception($message);
         }
 
         // Store any cookies from the response;
         $this->_cookieJar->storeCookies($url, $request->getResponseHeaders());
 
         // Follow any redirects
         if ($redirectUrl = $this->getRedirectUrl($request->getResponseHeaders())
         ) {
             phpCAS::trace('Found redirect:' . $redirectUrl);
             $this->makeRequest($redirectUrl);
         } else {
 
             $this->_responseHeaders = $request->getResponseHeaders();
             $this->_responseBody = $request->getResponseBody();
             $this->_responseStatusCode = $request->getResponseStatusCode();
         }
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ populateRequest()

CAS_ProxiedService_Http_Abstract::populateRequest ( CAS_Request_RequestInterface $request )

abstractprotected

Add any other parts of the request needed by concrete classes.

Parameters

CAS_Request_RequestInterface $request request interface object

Returns: void

Referenced by makeRequest().

Here is the caller graph for this function:

◆ send()

CAS_ProxiedService_Http_Abstract::send ( )

Perform the request.

Returns: void

Exceptions

CAS_OutOfSequenceException	If called multiple times.
CAS_ProxyTicketException	If there is a proxy-ticket failure. The code of the Exception will be one of: PHPCAS_SERVICE_PT_NO_SERVER_RESPONSE PHPCAS_SERVICE_PT_BAD_SERVER_RESPONSE PHPCAS_SERVICE_PT_FAILURE
CAS_ProxiedService_Exception	If there is a failure sending the request to the target service.

Definition at line 139 of file Abstract.php.

References $url, CAS_ProxiedService_Abstract\getProxyTicket(), getServiceUrl(), hasBeenSent(), CAS_ProxiedService_Abstract\initializeProxyTicket(), makeRequest(), phpCAS\traceBegin(), and phpCAS\traceEnd().

     {
         if ($this->hasBeenSent()) {
             throw new CAS_OutOfSequenceException(
                 'Cannot send, request already sent.'
             );
         }
 
         phpCAS::traceBegin();
 
         // Get our proxy ticket and append it to our URL.
         $this->initializeProxyTicket();
         $url = $this->getServiceUrl();
         if (strstr($url, '?') === false) {
             $url = $url . '?ticket=' . $this->getProxyTicket();
         } else {
             $url = $url . '&ticket=' . $this->getProxyTicket();
         }
 
         try {
             $this->makeRequest($url);
         } catch (Exception $e) {
             phpCAS::traceEnd();
             throw $e;
         }
     }

Here is the call graph for this function:

◆ setUrl()

CAS_ProxiedService_Http_Abstract::setUrl ( $url )

Set the URL of the Request.

Parameters

string $url url to set

Returns: void

Exceptions

CAS_OutOfSequenceException If called after the Request has been sent.

Definition at line 108 of file Abstract.php.

References $url, and hasBeenSent().

     {
         if ($this->hasBeenSent()) {
             throw new CAS_OutOfSequenceException(
                 'Cannot set the URL, request already sent.'
             );
         }
         if (!is_string($url)) {
             throw new CAS_InvalidArgumentException('$url must be a string.');
         }
 
         $this->_url = $url;
     }

Here is the call graph for this function:

Field Documentation

◆ $_cookieJar

CAS_CookieJar CAS_ProxiedService_Http_Abstract::$_cookieJar

private

The storage mechanism for cookies set by the target service.

Definition at line 56 of file Abstract.php.

◆ $_numRequests

int CAS_ProxiedService_Http_Abstract::$_numRequests = 0

private

Indicator of the number of requests (including redirects performed.

Definition at line 171 of file Abstract.php.

◆ $_responseBody

string CAS_ProxiedService_Http_Abstract::$_responseBody = ''

private

The response headers.

Definition at line 192 of file Abstract.php.

◆ $_responseHeaders

array CAS_ProxiedService_Http_Abstract::$_responseHeaders = array()

private

The response headers.

Definition at line 178 of file Abstract.php.

◆ $_responseStatusCode

string CAS_ProxiedService_Http_Abstract::$_responseStatusCode = ''

private

The response status code.

Definition at line 185 of file Abstract.php.

◆ $_url

string CAS_ProxiedService_Http_Abstract::$_url

private

The target service url.

Definition at line 77 of file Abstract.php.

Referenced by getServiceUrl().

◆ $requestHandler

CAS_Request_RequestInterface CAS_ProxiedService_Http_Abstract::$requestHandler

protected

The HTTP request mechanism talking to the target service.

Definition at line 49 of file Abstract.php.

Referenced by __construct(), and makeRequest().

The documentation for this class was generated from the following file:

Services/CAS/lib/CAS/ProxiedService/Http/Abstract.php

Public Member Functions

Protected Member Functions

Protected Attributes

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ getCookies()

◆ getRedirectUrl()

◆ getResponseBody()

◆ getResponseHeaders()

◆ getResponseStatusCode()

◆ getServiceUrl()

◆ hasBeenSent()

◆ makeRequest()

◆ populateRequest()

◆ send()

◆ setUrl()

Field Documentation

◆ $_cookieJar

◆ $_numRequests

◆ $_responseBody

◆ $_responseHeaders

◆ $_responseStatusCode

◆ $_url

◆ $requestHandler