Com::Vmware::Vapi::Metadata::Authentication::Component Class Reference

Inheritance diagram for Com::Vmware::Vapi::Metadata::Authentication::Component:

Avaliable Methods
public method	get ()
public method	fingerprint ()
public method	new ()
public method	list ()

Detailed Description

The Com::Vmware::Vapi::Metadata::Authentication::Component interface provides methods to retrieve authentication information of a component element.

A component element is said to contain authentication information if any one of package elements contained in it has authentication information.

Constant String::RESOURCE_TYPE # Resource type for component.

Member Function Documentation

public method Com::Vmware::Vapi::Metadata::Authentication::Component::fingerprint

(

)

Retrieves the fingerprint computed from the authentication metadata of the component element corresponding to component_id .

The fingerprint provides clients an efficient way to check if the metadata for a particular component has been modified on the server. The client can do this by comparing the result of this operation with the fingerprint returned in the result of :func:Com::Vmware::Vapi::Metadata::Authentication::Component.get .

Parameters

component_id

[REQUIRED] Identifier of the component element. The value must be an identifier for the resource type getQualifiedName(com.vmware.vapi.component). . The value must be str.

Return values

The	fingerprint computed from the authentication metadata of the component. The return type will be String

Exceptions

Com::Vmware::Vapi::Std::Errors::NotFound

if the component element associated with component_id does not have any authentication information.

Code:

public method Com::Vmware::Vapi::Metadata::Authentication::Component::get

(

)

Retrieves authentication information about the component element corresponding to component_id .

The class Com::Vmware::Vapi::Metadata::Authentication::ComponentData contains the authentication information about the component element and it's fingerprint. It contains information about all the package elements that belong to this component element.

Parameters

component_id

[REQUIRED] Identifier of the component element. The value must be an identifier for the resource type getQualifiedName(com.vmware.vapi.component). . The value must be str.

Return values

The	class Com::Vmware::Vapi::Metadata::Authentication::ComponentData instance that corresponds to component_id The return type will be Com::Vmware::Vapi::Metadata::Authentication::ComponentData

Exceptions

Com::Vmware::Vapi::Std::Errors::NotFound

if the component element associated with component_id does not have any authentication information.

Code:

public method Com::Vmware::Vapi::Metadata::Authentication::Component::list

(

)

Returns the identifiers for the component elements that have authentication information.

Return values

The	list of identifiers for the component elements that have authentication information. The value will be an identifier for the resource type getQualifiedName(com.vmware.vapi.component). The return type will be Array of str

Code:

public method Com::Vmware::Vapi::Metadata::Authentication::Component::new

(

)

Constructor to initialize the object

Parameters

api_provider	- protocol connection to use with stubs created by this factory
StubConfig	- Stub's additional configuration

Return values

Blessed

object

Code:

---

The documentation for this class was generated from the following file:

• Com/Vmware/Vapi/Metadata/Authentication/Component.pm