com.vmware.vapi.metadata

Class MetadataFactory

java.lang.Object

com.vmware.vapi.metadata.MetadataFactory

public class MetadataFactory
extends java.lang.Object

MetadataFactory is responsible for creating instances of services contained inside the com.vmware.vapi.metadata package and also has the subpackages reference to access respective subpackage services.

Method Summary

Methods

Modifier and Type	Method and Description
AuthenticationFactory	authentication() The com.vmware.vapi.metadata.authentication package provides interfaces that expose authentication information for operation elements across all the service elements.
CliFactory	cli() The com.vmware.vapi.metadata.cli package provides interfaces that expose all the information required to display namespace or command help, execute a command and display it's result.
static MetadataFactory	getFactory(StubFactory stubFactory, StubConfiguration stubConfig) Creates the new instance of this class with provided configuration
MetamodelFactory	metamodel() The com.vmware.vapi.metadata.metamodel package provides interfaces that expose all the information present in the interface definition language (IDL) specification.
PrivilegeFactory	privilege() The com.vmware.vapi.metadata.privilege package provides interfaces that expose privilege information for operation elements across all the service elements.
void	updateStubConfiguration(StubFactory stubFactory, StubConfiguration stubConfig)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

getFactory

public static MetadataFactory getFactory(StubFactory stubFactory,
                         StubConfiguration stubConfig)

Creates the new instance of this class with provided configuration

Parameters:

stubFactory - StubFactory instance is responsible for creating stubs

stubConfig - StubConfiguration instance is required to authenticate the request

Returns:

MetadataFactory factory instance

authentication

public AuthenticationFactory authentication()

The com.vmware.vapi.metadata.authentication package provides interfaces that expose authentication information for operation elements across all the service elements.

To calculate the effective authentication information for an operation element, you should first see if there is an authentication scheme specified for the operation element. If it is not specified, then authentication scheme for the service element that contains this operation element is used. If it is not specified for the service element as well, then the authentication scheme for the package element that contains this service element is used.

cli

public CliFactory cli()

The com.vmware.vapi.metadata.cli package provides interfaces that expose all the information required to display namespace or command help, execute a command and display it's result.

metamodel

public MetamodelFactory metamodel()

The com.vmware.vapi.metadata.metamodel package provides interfaces that expose all the information present in the interface definition language (IDL) specification.

Metamodel metadata is organized into an hierarchy of elements. The main elements are:

• Enumeration: An enumeration element that has a list of enumeration value elements.
• Constant: A constant element has a name and a value.
• Structure: A structure element can have field elements, constant elements and enumeration elements.
• Operation: An operation has a list of parameter elements, result element and error elements.
• Service: A service is a collection of operation elements, structure elements, enumerated elements and constant elements.
• Package: A package is a collection of service elements, structure elements and enumeration elements.
• Component: A component is a collection of package elements.

The com.vmware.vapi.metadata.metamodel package has interfaces that enables two styles of client applications:

• A client can retrieve the exact pieces of information it requires using the various granularities the API supports (that is com.vmware.vapi.metadata.metamodel.ComponentProvider, com.vmware.vapi.metadata.metamodel.PackageProvider, com.vmware.vapi.metadata.metamodel.ServiceProvider, com.vmware.vapi.metadata.metamodel.StructureProvider, com.vmware.vapi.metadata.metamodel.EnumerationProvider and com.vmware.vapi.metadata.metamodel.service.OperationProvider). In this case, it doesn't cache any information locally and always invokes methods to get the metamodel information it requires.
• A client can retrieve all the metamodel information in fewer method invocations using the com.vmware.vapi.metadata.metamodel.ComponentProvider interface and cache the output locally. It can then poll on the fingerprint information exposed by the com.vmware.vapi.metadata.metamodel.ComponentProvider interface to monitor changes in API definition.

privilege

public PrivilegeFactory privilege()

The com.vmware.vapi.metadata.privilege package provides interfaces that expose privilege information for operation elements across all the service elements.

An entity has a unique identifier and a resource type. An entity can either be present in one of the parameter elements or if a parameter is a structure element, it could also be present in one of the field elements.

Privileges can be assigned to either operation elements or entities used in the operation element. A list of privileges can also be applied on a package element. This list of privileges would be used as a default for all the operation elements and the entities that do not have any defined privileges.

updateStubConfiguration

public void updateStubConfiguration(StubFactory stubFactory,
                           StubConfiguration stubConfig)