CAS_ProxiedService Class Reference

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

Inheritance diagram for CAS_ProxiedService:

Collaboration diagram for CAS_ProxiedService:

Public Member Functions
	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...

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 47 of file ProxiedService.php.

Member Function Documentation

getServiceUrl()

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().

Here is the caller graph for this function:

setProxyTicket()

CAS_ProxiedService::setProxyTicket

(

$proxyTicket

)

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

Parameters

string

$proxyTicket

Proxy ticket string

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().

Here is the caller graph for this function:

---

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

• Services/CAS/lib/CAS/ProxiedService.php