interface SDKConnectorInterface in Apigee Edge 8

Defines an interface for SDK controller classes.

Hierarchy

• interface \Drupal\apigee_edge\SDKConnectorInterface

20 files declare their use of SDKConnectorInterface

ApiProductController.php in src/Entity/Controller/ApiProductController.php

AppAnalyticsFormBase.php in src/Form/AppAnalyticsFormBase.php

AppAnalyticsSettingsForm.php in src/Form/AppAnalyticsSettingsForm.php

AppByOwnerController.php in src/Entity/Controller/AppByOwnerController.php

AppController.php in src/Entity/Controller/AppController.php

... See full list

File

src/SDKConnectorInterface.php, line 29

Namespace

Drupal\apigee_edge

interface SDKConnectorInterface {

  /**
   * Gets the organization.
   *
   * @return string
   *   The organization.
   */
  public function getOrganization() : string;

  /**
   * Returns the http client.
   *
   * @return \Apigee\Edge\ClientInterface
   *   The http client.
   */
  public function getClient() : ClientInterface;

  /**
   * Test connection with the Edge Management Server.
   *
   * @param \Drupal\key\KeyInterface|null $key
   *   Key entity to check connection with Edge,
   *   if NULL, then use the stored key.
   *
   * @throws \Exception
   */
  public function testConnection(KeyInterface $key = NULL);

  /**
   * Returns a pre-configured API client with the provided credentials.
   *
   * @param \Http\Message\Authentication $authentication
   *   Authentication.
   * @param null|string $endpoint
   *   API endpoint, default is https://api.enterprise.apigee.com/v1.
   * @param array $options
   *   Client configuration option.
   *
   * @return \Apigee\Edge\ClientInterface
   *   Configured API client.
   */
  public function buildClient(Authentication $authentication, ?string $endpoint = NULL, array $options = []) : ClientInterface;

}

Members

Name	Modifiers	Type	Description	Overrides
SDKConnectorInterface::buildClient	public	function	Returns a pre-configured API client with the provided credentials.	1
SDKConnectorInterface::getClient	public	function	Returns the http client.	1
SDKConnectorInterface::getOrganization	public	function	Gets the organization.	1
SDKConnectorInterface::testConnection	public	function	Test connection with the Edge Management Server.	1