CommonGateway\CoreBundle\Service\CallService
Service to call external sources.
This service provides a guzzle wrapper to work with sources in the common gateway.
Methods
| Name | Description |
|---|---|
| __construct | The constructor sets al needed variables. |
| call | Calls a source according to given configuration. |
| decodeResponse | Decodes a response based on the source it belongs to. |
| getAllResults | Fetches all pages for a source and merges the result arrays to one array. |
| getCertificate | Writes the certificate and ssl keys to disk, returns the filenames. |
| removeFiles | Removes certificates and private keys from disk if they are not necessary anymore. |
CallService::__construct
Description
public __construct (\AuthenticationService $authenticationService, \EntityManagerInterface $entityManager, \FileService $fileService, \MappingService $mappingService, \SessionInterface $session, \LoggerInterface $callLogger)
The constructor sets al needed variables.
Parameters
(\AuthenticationService) $authenticationService: The authentication service(\EntityManagerInterface) $entityManager: The entity manager(\FileService) $fileService: The file service(\MappingService) $mappingService: The mapping service(\SessionInterface) $session: The current session.(\LoggerInterface) $callLogger: The logger for the call channel.
Return Values
void
CallService::call
Description
public call (\Source $source, string $endpoint, string $method, array $config, bool $asynchronous, bool $createCertificates)
Calls a source according to given configuration.
Parameters
(\Source) $source: The source to call.(string) $endpoint: The endpoint on the source to call.(string) $method: The method on which to call the source.(array) $config: The additional configuration to call the source.(bool) $asynchronous: Whether or not to call the source asynchronously.(bool) $createCertificates: Whether or not to create certificates for this source.
Return Values
\Response
Throws Exceptions
\Exception
CallService::decodeResponse
Description
public decodeResponse (\Source $source, \Response $response)
Decodes a response based on the source it belongs to.
Parameters
(\Source) $source: The source that has been called(\Response) $response: The response to decode
Return Values
array
The decoded response
Throws Exceptions
\Exception
Thrown if the response does not fit any supported content type
CallService::getAllResults
Description
public getAllResults (\Source $source, string $endpoint, array $config)
Fetches all pages for a source and merges the result arrays to one array.
Parameters
(\Source) $source: The source to call(string) $endpoint: The endpoint on the source to call(array) $config: The additional configuration to call the source
Return Values
array
The array of results
CallService::getCertificate
Description
public getCertificate (array $config)
Writes the certificate and ssl keys to disk, returns the filenames.
Parameters
(array) $config: The configuration as stored in the source
Return Values
void
CallService::removeFiles
Description
public removeFiles (array $config)
Removes certificates and private keys from disk if they are not necessary anymore.
Parameters
(array) $config: The configuration with filenames
Return Values
void