Package com.vmware.vapi.metadata.metamodel

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

See: Description

Interface Summary

Interface	Description
Component	The Component interface providers methods to retrieve metamodel information of a component element.
ComponentTypes	Defines the data types of the Component API service.
Enumeration	The Enumeration interface provides methods to retrieve metamodel information about an enumeration element in the interface definition language.
EnumerationTypes	Defines the data types of the Enumeration API service.
MetadataIdentifier	The MetadataIdentifier interface provides string constants that can be used as identifiers for the metadata elements.
MetadataIdentifierTypes	Defines the data types of the MetadataIdentifier API service.
Package	The Package interface provides methods to retrieve metamodel information about a package element in the interface definition language.
PackageTypes	Defines the data types of the Package API service.
Resource	The Resource interface provides methods to retrieve information about resource types.
ResourceTypes	Defines the data types of the Resource API service.
Service	The Service interface provides methods to retrieve metamodel information about a service element in the interface definition language.
ServiceTypes	Defines the data types of the Service API service.
Structure	The Structure interface providers methods to retrieve metamodel information about a structure element in the interface definition language.
StructureTypes	Defines the data types of the Structure API service.

Class Summary

Class	Description
ComponentData	The ComponentData class contains the metamodel metadata information of a component element along with its fingerprint.
ComponentData.Builder	Builder class for ComponentData.
ComponentDefinitions	Defines the type descriptors for the Component API service.
ComponentInfo	The ComponentInfo class contains metamodel metadata information about a component element.
ComponentInfo.Builder	Builder class for ComponentInfo.
ComponentStub	Remote stub implementation of the Component API service.
ConstantInfo	The ConstantInfo class contains metamodel information of the constant elements.
ConstantInfo.Builder	Builder class for ConstantInfo.
ConstantValue	The ConstantValue class contains the metamodel information of the constant element.
ConstantValue.Builder	Builder class for ConstantValue.
ConstantValue.Category	The Category enumeration class defines enumeration constants for the valid kinds of values.
ElementMap	The ElementMap class contains the metadata elements.
ElementMap.Builder	Builder class for ElementMap.
ElementValue	The ElementValue class describes the value of the metadata element.
ElementValue.Builder	Builder class for ElementValue.
ElementValue.Type	The Type enumeration class defines the valid types for values in metadata elements.
EnumerationDefinitions	Defines the type descriptors for the Enumeration API service.
EnumerationInfo	The EnumerationInfo class contains the metamodel information of an enumeration element.
EnumerationInfo.Builder	Builder class for EnumerationInfo.
EnumerationStub	Remote stub implementation of the Enumeration API service.
EnumerationValueInfo	The EnumerationValueInfo class describes the enumeration constant in the enumeration class.
EnumerationValueInfo.Builder	Builder class for EnumerationValueInfo.
ErrorInfo	The ErrorInfo class contains the metadata information about the error elements contained in an operation element.
ErrorInfo.Builder	Builder class for ErrorInfo.
FieldInfo	The FieldInfo class contains metamodel information of a field element contained in a structure element.
FieldInfo.Builder	Builder class for FieldInfo.
GenericInstantiation	The GenericInstantiation class describes the type information of a typed element when the type is an instantiation of one of the generic types provided by the infrastructure.
GenericInstantiation.Builder	Builder class for GenericInstantiation.
GenericInstantiation.GenericType	The GenericType enumeration class provides enumeration constants for each of the generic types provided by the infrastructure.
MetadataIdentifierDefinitions	Defines the type descriptors for the MetadataIdentifier API service.
MetadataIdentifierStub	Remote stub implementation of the MetadataIdentifier API service.
MetamodelFactory	MetamodelFactory is responsible for creating instances of services contained inside the com.vmware.vapi.metadata.metamodel package and also has the subpackages reference to access respective subpackage services.
OperationInfo	The OperationInfo class contains metamodel information of an operation element.
OperationInfo.Builder	Builder class for OperationInfo.
OperationResultInfo	The OperationResultInfo class contains the metamodel information of an operation result element.
OperationResultInfo.Builder	Builder class for OperationResultInfo.
PackageDefinitions	Defines the type descriptors for the Package API service.
PackageInfo	The PackageInfo class contains the metamodel information of all the service elements, structure elements and enumeration elements contained in the package element.
PackageInfo.Builder	Builder class for PackageInfo.
PackageStub	Remote stub implementation of the Package API service.
PrimitiveValue	The PrimitiveValue class contains value of the constant element.
PrimitiveValue.Builder	Builder class for PrimitiveValue.
PrimitiveValue.Type	The Type enumeration class defines the valid types for values in constant elements.
ResourceDefinitions	Defines the type descriptors for the Resource API service.
ResourceStub	Remote stub implementation of the Resource API service.
ServiceDefinitions	Defines the type descriptors for the Service API service.
ServiceInfo	The ServiceInfo class contains the metamodel information of all the operation elements, structure elements and enumeration elements containted in a service element.
ServiceInfo.Builder	Builder class for ServiceInfo.
ServiceStub	Remote stub implementation of the Service API service.
StructDefinitions	Defines the type descriptors for the top-level types in com.vmware.vapi.metadata.metamodel package.
StructureDefinitions	Defines the type descriptors for the Structure API service.
StructureInfo	The StructureInfo class contains the metamodel information of all the field elements, constant elements and enumeration elements contained in the structure element.
StructureInfo.Builder	Builder class for StructureInfo.
StructureInfo.Type	The Type enumeration class defines the kind of this structure element.
StructureStub	Remote stub implementation of the Structure API service.
Type	The Type class describes the type information of a typed element in the interface definiton language.
Type.Builder	Builder class for Type.
Type.BuiltinType	The BuiltinType enumeration class provides enumeration constant for each of the built-in types present in the interface definition language type system.
Type.Category	The Category enumeration class provides enumeration constant for each category of the type.
UserDefinedType	The UserDefinedType class contains the metamodel type information of a typed element whose type is a user defined named type.
UserDefinedType.Builder	Builder class for UserDefinedType.

Enum Summary

Enum	Description
ConstantValue.Category.Values	Native Java enum representing this enumeration class.
ElementValue.Type.Values	Native Java enum representing this enumeration class.
GenericInstantiation.GenericType.Values	Native Java enum representing this enumeration class.
PrimitiveValue.Type.Values	Native Java enum representing this enumeration class.
StructureInfo.Type.Values	Native Java enum representing this enumeration class.
Type.BuiltinType.Values	Native Java enum representing this enumeration class.
Type.Category.Values	Native Java enum representing this enumeration class.

Package com.vmware.vapi.metadata.metamodel Description

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.