class ClientAuthorization in Entity Share 8.3

Defines an Entity Share Client authorization annotation object.

The Entity Share Client must be authorized to pull entities from the Entity Share Server offering the content. Such authorization could be by authenticating as an authorized user or it could be by presenting some previously created proof of authorization, such as an OAuth2 token.

Hierarchy

• class \Drupal\Component\Annotation\Plugin implements AnnotationInterface
  • class \Drupal\entity_share_client\Annotation\ClientAuthorization

See also

\Drupal\entity_share_client\ClientAuthorization\ClientAuthorizationManager

Plugin API

4 classes are annotated with ClientAuthorization

Anonymous in modules/entity_share_client/src/Plugin/ClientAuthorization/Anonymous.php

Provides Anonymous authorization.

BasicAuth in modules/entity_share_client/src/Plugin/ClientAuthorization/BasicAuth.php

Provides Basic Auth based client authorization.

Header in modules/entity_share_client/src/Plugin/ClientAuthorization/Header.php

Provides Header based client authorization.

Oauth in modules/entity_share_client/src/Plugin/ClientAuthorization/Oauth.php

Provides Oauth2 based client authorization.

File

modules/entity_share_client/src/Annotation/ClientAuthorization.php, line 22

Namespace

Drupal\entity_share_client\Annotation

class ClientAuthorization extends Plugin {

  /**
   * The plugin ID.
   *
   * A machine name for the authorization type provided by this plugin.
   *
   * @var string
   */
  public $id;

  /**
   * A human readable name for the authorization type provided by this plugin.
   *
   * @var \Drupal\Core\Annotation\Translation
   *
   * @ingroup plugin_translatable
   */
  public $label;

}

Members

Name	Modifiers	Type	Description	Overrides
ClientAuthorization::$id	public	property	The plugin ID.
ClientAuthorization::$label	public	property	A human readable name for the authorization type provided by this plugin.
Plugin::$definition	protected	property	The plugin definition read from the class annotation.	1
Plugin::get	public	function	Gets the value of an annotation. Overrides AnnotationInterface::get	5
Plugin::getClass	public	function	Gets the class of the annotated class. Overrides AnnotationInterface::getClass
Plugin::getId	public	function	Gets the unique ID for this annotated class. Overrides AnnotationInterface::getId
Plugin::getProvider	public	function	Gets the name of the provider of the annotated class. Overrides AnnotationInterface::getProvider
Plugin::parse	protected	function	Parses an annotation into its definition.
Plugin::setClass	public	function	Sets the class of the annotated class. Overrides AnnotationInterface::setClass
Plugin::setProvider	public	function	Sets the name of the provider of the annotated class. Overrides AnnotationInterface::setProvider
Plugin::__construct	public	function	Constructs a Plugin object.	2