interface CredentialsInterface in Apigee Edge 8

Defines an interface for credentials classes.

@todo: move to \Drupal\apigee_edge\Connector namespace.

Hierarchy

• interface \Drupal\apigee_edge\CredentialsInterface

File

src/CredentialsInterface.php, line 31

Namespace

Drupal\apigee_edge

interface CredentialsInterface {

  /**
   * Gets the authentication object which instantiated by the key type.
   *
   * @return \Http\Message\Authentication
   *   The authentication object.
   */
  public function getAuthentication() : Authentication;

  /**
   * Gets the key entity which stores the API credentials.
   *
   * @return \Drupal\key\KeyInterface
   *   The key entity which stores the API credentials.
   */
  public function getKey() : KeyInterface;

  /**
   * Gets the key type of the key entity.
   *
   * @return \Drupal\apigee_edge\Plugin\EdgeKeyTypeInterface
   *   The key type of the key entity.
   */
  public function getKeyType() : EdgeKeyTypeInterface;

}

Members

Name	Modifiers	Type	Description	Overrides
CredentialsInterface::getAuthentication	public	function	Gets the authentication object which instantiated by the key type.	1
CredentialsInterface::getKey	public	function	Gets the key entity which stores the API credentials.	1
CredentialsInterface::getKeyType	public	function	Gets the key type of the key entity.	1