Service/DeveloperGarden/SecurityTokenServer.php
LICENSE
This source file is subject to the new BSD license that is bundled with this package in the file LICENSE.txt. It is also available through the world-wide-web at this URL: http://framework.zend.com/license/new-bsd If you did not receive a copy of the license and are unable to obtain it through the world-wide-web, please send an email to license@zend.com so we can send you a copy immediately.
- Category
- Zend
- Copyright
- Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)
- License
- New BSD License
- Package
- Zend_Service
- Subpackage
- DeveloperGarden
- Version
- $Id: SecurityTokenServer.php 24593 2012-01-05 20:35:02Z matthew $
\Zend_Service_DeveloperGarden_SecurityTokenServer
- Parent(s)
- \Zend_Service_DeveloperGarden_Client_ClientAbstract
- Author
- Marco Kaiser
- Category
- Zend
- Copyright
- Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)
- License
- New BSD License
Constants
ENV_PRODUCTION
= 1
ENV_SANDBOX
= 2
PARTICIPANT_MUTE_OFF
= 0
PARTICIPANT_MUTE_ON
= 1
PARTICIPANT_RECALL
= 2Properties

array $_classMap = array('SecurityTokenResponse' => 'Zend_Service_DeveloperGarden_Response_SecurityTokenServer_SecurityTokenResponse', 'getTokensResponse' => 'Zend_Service_DeveloperGarden_Response_SecurityTokenServer_GetTokensResponse')array('SecurityTokenResponse' => 'Zend_Service_DeveloperGarden_Response_SecurityTokenServer_SecurityTokenResponse', 'getTokensResponse' => 'Zend_Service_DeveloperGarden_Response_SecurityTokenServer_GetTokensResponse')Details- Type
- array

int $_consts = nullnullDetails- Type
- int
- Inherited_from
- \Zend_Service_DeveloperGarden_Client_ClientAbstract::$$_consts

\Zend_Service_DeveloperGarden_Credential $_credential = nullnullDetails
array $_options = array()array()Details- Type
- array
- Inherited_from
- \Zend_Service_DeveloperGarden_Client_ClientAbstract::$$_options

string $_serviceAuthId = 'https://odg.t-online.de''https://odg.t-online.de'Details- Type
- string
- Inherited_from
- \Zend_Service_DeveloperGarden_Client_ClientAbstract::$$_serviceAuthId

int $_serviceEnvironment = \Zend_Service_DeveloperGarden_Client_ClientAbstract::ENV_PRODUCTION\Zend_Service_DeveloperGarden_Client_ClientAbstract::ENV_PRODUCTIONDetails- Type
- int
- Inherited_from
- \Zend_Service_DeveloperGarden_Client_ClientAbstract::$$_serviceEnvironment

\Zend_Soap_Client $_soapClient = nullnullDetails
boolean $_useLocalWsdl = truetrueDetails- Type
- boolean
- Inherited_from
- \Zend_Service_DeveloperGarden_Client_ClientAbstract::$$_useLocalWsdl

string $_wsdlFile = 'https://sts.idm.telekom.com/TokenService?wsdl''https://sts.idm.telekom.com/TokenService?wsdl'Details- Type
- string
Methods

__construct(array $options = array()) : voidconstructor
Inherited from: \Zend_Service_DeveloperGarden_Client_ClientAbstract::__construct()| Name | Type | Description |
|---|---|---|
| $options | array | Associative array of options |

_buildConstArray() : nullhelper method to create const arrays
Inherited from: \Zend_Service_DeveloperGarden_Client_ClientAbstract::_buildConstArray()| Type | Description |
|---|---|
| null |

checkEnvironment(int $environment) : voidchecks if the given environemnt is valid otherwise it @throws Zend_Service_DeveloperGarden_Client_Exception
Inherited from: \Zend_Service_DeveloperGarden_Client_ClientAbstract::checkEnvironment()| Name | Type | Description |
|---|---|---|
| $environment | int |
| Exception | Description |
|---|---|
| \Zend_Service_DeveloperGarden_Client_Exception |

checkParticipantAction(int $action) : voidchecks if the given action is valid otherwise it @throws Zend_Service_DeveloperGarden_Exception
Inherited from: \Zend_Service_DeveloperGarden_Client_ClientAbstract::checkParticipantAction()| Name | Type | Description |
|---|---|---|
| $action | int |
| Exception | Description |
|---|---|
| \Zend_Service_DeveloperGarden_Client_Exception |

getClientOptions() : arrayreturns an array with configured options for this client
Inherited from: \Zend_Service_DeveloperGarden_Client_ClientAbstract::getClientOptions()| Type | Description |
|---|---|
| array |

getCredential() : \Zend_Service_DeveloperGarden_Credentialreturns the internal credential object
Inherited from: \Zend_Service_DeveloperGarden_Client_ClientAbstract::getCredential()| Type | Description |
|---|---|
| \Zend_Service_DeveloperGarden_Credential |

getEnvironment() : intreturns the current configured environemnt
Inherited from: \Zend_Service_DeveloperGarden_Client_ClientAbstract::getEnvironment()| Type | Description |
|---|---|
| int |

getEnvironments() : arrayreturns an array of all available environments
Inherited from: \Zend_Service_DeveloperGarden_Client_ClientAbstract::getEnvironments()| Type | Description |
|---|---|
| array |

getLoginToken() : \Zend_Service_DeveloperGarden_Response_SecurityTokenServer_SecurityTokenResponsedoes the login and return the specific response
| Type | Description |
|---|---|
| \Zend_Service_DeveloperGarden_Response_SecurityTokenServer_SecurityTokenResponse |

getOption(string $name) : mixedget an option value from the internal options object
Inherited from: \Zend_Service_DeveloperGarden_Client_ClientAbstract::getOption()| Name | Type | Description |
|---|---|---|
| $name | string |
| Type | Description |
|---|---|
| mixed |

getParticipantActions() : arrayreturns an array of all available environments
Inherited from: \Zend_Service_DeveloperGarden_Client_ClientAbstract::getParticipantActions()| Type | Description |
|---|---|
| array |

getSoapClient() : \Zend_Service_DeveloperGarden_Client_Soapreturns the internal soap client if not allready exists we create an instance of Zend_Soap_Client
Inherited from: \Zend_Service_DeveloperGarden_Client_ClientAbstract::getSoapClient()| Type | Description |
|---|---|
| \Zend_Service_DeveloperGarden_Client_Soap |
- Final

getTokens() : \Zend_Service_DeveloperGarden_Response_SecurityTokenServer_GetTokensResponsereturns the fetched token from token server
| Type | Description |
|---|---|
| \Zend_Service_DeveloperGarden_Response_SecurityTokenServer_GetTokensResponse |

getWsdl() : stringreturns the wsdl file path, a uri or the local path
Inherited from: \Zend_Service_DeveloperGarden_Client_ClientAbstract::getWsdl()| Type | Description |
|---|---|
| string |

setEnvironment(int $environment) : \Zend_Service_DeveloperGarden_Client_ClientAbstractsets new environment
Inherited from: \Zend_Service_DeveloperGarden_Client_ClientAbstract::setEnvironment()| Name | Type | Description |
|---|---|---|
| $environment | int |
| Type | Description |
|---|---|
| \Zend_Service_DeveloperGarden_Client_ClientAbstract |

setLocalWsdl(string $wsdlFile = null) : \Zend_Service_DeveloperGarden_Client_ClientAbstractsets a new local wsdl file
Inherited from: \Zend_Service_DeveloperGarden_Client_ClientAbstract::setLocalWsdl()| Name | Type | Description |
|---|---|---|
| $wsdlFile | string |
| Type | Description |
|---|---|
| \Zend_Service_DeveloperGarden_Client_ClientAbstract |

setOption(string $name, mixed $value) : \Zend_Service_DeveloperGarden_Client_ClientAbstractSet an option
Inherited from: \Zend_Service_DeveloperGarden_Client_ClientAbstract::setOption()| Name | Type | Description |
|---|---|---|
| $name | string | |
| $value | mixed |
| Type | Description |
|---|---|
| \Zend_Service_DeveloperGarden_Client_ClientAbstract |
| Exception | Description |
|---|---|
| \Zend_Service_DeveloperGarden_Client_Exception |

setUseLocalWsdl(\boolen $use = true) : \Zend_Service_DeveloperGarden_Client_ClientAbstractswitch to the local wsdl file usage
Inherited from: \Zend_Service_DeveloperGarden_Client_ClientAbstract::setUseLocalWsdl()| Name | Type | Description |
|---|---|---|
| $use | \boolen |
| Type | Description |
|---|---|
| \Zend_Service_DeveloperGarden_Client_ClientAbstract |

setWsdl(string $wsdlFile = null) : \Zend_Service_DeveloperGarden_Client_ClientAbstractsets a new wsdl file
Inherited from: \Zend_Service_DeveloperGarden_Client_ClientAbstract::setWsdl()| Name | Type | Description |
|---|---|---|
| $wsdlFile | string |
| Type | Description |
|---|---|
| \Zend_Service_DeveloperGarden_Client_ClientAbstract |