Class CAS_ProxiedService_Http_Abstract

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

CAS_ProxiedService_Abstract implements CAS_ProxiedService, CAS_ProxiedService_Testable

CAS_ProxiedService_Http_Abstract implements CAS_ProxiedService_Http

Direct known subclasses

CAS_ProxiedService_Http_Get, CAS_ProxiedService_Http_Post

Abstract
Package: PhpCAS
Category: Authentication
License: Apache License 2.0
Author: Adam Franco afranco@middlebury.edu
Link: https://wiki.jasig.org/display/CASC/phpCAS
Class: CAS_ProxiedService_Http_Abstract
Located at shared/cas/source/CAS/ProxiedService/Http/Abstract.php

Methods summary
`public`	# `__construct( CAS_Request_RequestInterface $requestHandler, CAS_CookieJar $cookieJar )` Constructor. Constructor. Parameters `$requestHandler` request handler object `$cookieJar` cookieJar object
`public string`	# `getServiceUrl( )` Answer a service identifier (URL) for whom we should fetch a proxy ticket. Answer a service identifier (URL) for whom we should fetch a proxy ticket. Returns string Throws Exception If no service url is available.
`public`	# `setUrl( string $url )` Set the URL of the Request Set the URL of the Request Parameters `$url` url to set Throws `CAS_OutOfSequenceException` If called after the Request has been sent. Implementation of `CAS_ProxiedService_Http::setUrl()`
`public`	# `send( )` Perform the request. Perform the request. Throws `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. Implementation of `CAS_ProxiedService_Http::send()`
`protected`	# `makeRequest( string $url )` Build and perform a request, following redirects Build and perform a request, following redirects Parameters `$url` url for the request Throws `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.
`abstract protected`	# `populateRequest( CAS_Request_RequestInterface $request )` Add any other parts of the request needed by concrete classes Add any other parts of the request needed by concrete classes Parameters `$request` request interface object
`protected string`	# `getRedirectUrl( array $responseHeaders )` Answer a redirect URL if a redirect header is found, otherwise null. Answer a redirect URL if a redirect header is found, otherwise null. Parameters `$responseHeaders` response header to extract a redirect from Returns string or null
`protected boolean`	# `hasBeenSent( )` Answer true if our request has been sent yet. Answer true if our request has been sent yet. Returns boolean
`public array`	# `getResponseHeaders( )` Answer the headers of the response. Answer the headers of the response. Returns array An array of header strings. Throws `CAS_OutOfSequenceException` If called before the Request has been sent. Implementation of `CAS_ProxiedService_Http::getResponseHeaders()`
`public integer`	# `getResponseStatusCode( )` Answer HTTP status code of the response Answer HTTP status code of the response Returns integer Throws `CAS_OutOfSequenceException` If called before the Request has been sent.
`public string`	# `getResponseBody( )` Answer the body of response. Answer the body of response. Returns string Throws `CAS_OutOfSequenceException` If called before the Request has been sent. Implementation of `CAS_ProxiedService_Http::getResponseBody()`
`public array`	# `getCookies( )` Answer the cookies from the response. This may include cookies set during redirect responses. 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');

Methods inherited from CAS_ProxiedService_Abstract
`getProxyTicket(), initializeProxyTicket(), setCasClient(), setProxyTicket()`

Properties summary
`protected CAS_Request_RequestInterface`	`$requestHandler` The HTTP request mechanism talking to the target service. The HTTP request mechanism talking to the target service.	#
`private CAS_CookieJar`	`$_cookieJar` The storage mechanism for cookies set by the target service. The storage mechanism for cookies set by the target service.	#
`private string`	`$_url` The target service url. The target service url.	#
`private integer`	`$_numRequests` Indicator of the number of requests (including redirects performed. Indicator of the number of requests (including redirects performed.	# `0`
`private array`	`$_responseHeaders` The response headers. The response headers.	# `array()`
`private string`	`$_responseStatusCode` The response status code. The response status code.	# `''`
`private string`	`$_responseBody` The response headers. The response headers.	# `''`

class-CAS_ProxiedService_Http_Abstract

Namespaces

Classes

Interfaces

Exceptions

Functions

Class CAS_ProxiedService_Http_Abstract

Direct known subclasses

Parameters

Returns

Throws

Parameters

Throws

Implementation of

Throws

Implementation of

Parameters

Throws

Parameters

Parameters

Returns

Returns

Returns

Throws

Implementation of

Returns

Throws

Returns

Throws

Implementation of

Returns