Public Member Functions

CAS_ProxiedService Interface Reference

Inheritance diagram for CAS_ProxiedService:
CAS_ProxiedService_Abstract CAS_ProxiedService_Http_Abstract CAS_ProxiedService_Imap CAS_ProxiedService_Http_Get CAS_ProxiedService_Http_Post

List of all members.

Public Member Functions

 getServiceUrl ()
 setProxyTicket ($proxyTicket)

Detailed Description

This interface defines methods that allow proxy-authenticated service handlers to interact with phpCAS.

Proxy service handlers must implement this interface as well as call phpCAS::initializeProxiedService($this) at some point in their implementation.

While not required, proxy-authenticated service handlers are encouraged to implement the CAS_ProxiedService_Testable interface to facilitate unit testing.

Definition at line 41 of file ProxiedService.php.


Member Function Documentation

CAS_ProxiedService::getServiceUrl (  ) 

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

Returns:
string
Exceptions:
Exception If no service url is available.

Referenced by CAS_Client::initializeProxiedService().

CAS_ProxiedService::setProxyTicket ( proxyTicket  ) 

Register a proxy ticket with the ProxiedService that it can use when making requests.

Parameters:
string $proxyTicket
Returns:
void
Exceptions:
InvalidArgumentException If the $proxyTicket is invalid.
CAS_OutOfSequenceException If called after a proxy ticket has already been initialized/set.

Referenced by CAS_Client::initializeProxiedService().