|
vSphere Client SDK API Documentation : version 5.5.0.1300321 | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface DataServiceExtensionRegistry
Registration interface for data adapters and providers.
Method Summary | |
---|---|
void |
registerDataAdapter(DataProviderAdapter adapter,
String[] types)
Registers a DataProviderAdapter with the Data Services Framework registry. |
void |
registerDataAdapter(PropertyProviderAdapter provider,
TypeInfo[] types)
Registers a PropertyProviderAdapter with the Data Services Framework registry. |
void |
registerObjectRefTypeAdapter(ResourceObjectReferenceAdapter adapter,
Class<?> type,
String uidPrefix)
Registers an adapter for the given object reference class (e.g., URI). |
void |
unregisterDataAdapter(DataProviderAdapter adapter)
Removes the specified adapter from the registry. |
void |
unregisterDataAdapter(PropertyProviderAdapter provider)
Removes the specified property provider from the registry. |
void |
unregisterObjectRefTypeAdapter(Class<?> type)
Removes the object reference type adapter for the given reference class type and uidPrefix. |
Method Detail |
---|
void registerDataAdapter(DataProviderAdapter adapter, String[] types)
DataProviderAdapter
with the Data Services Framework registry.
The adapter will be called for all queries whose constraint has a type that matches one of those specified during registration.
When using Spring/OSGI the adapter's registration is done automatically at the
time the bundle is loaded if it is registered as an osgi-service under the
DataProviderAdapter
interface, like this:
<bean name="myDataProviderAdapter" class="com.abc.data.MyDataProviderAdapter"/> <osgi:service ref="myDataProviderAdapter" interface="com.vmware.vise.data.query.DataProviderAdapter"/>
adapter
- : The data adapter.types
- : The types which the adapter will adapt.void unregisterDataAdapter(DataProviderAdapter adapter)
When using Spring/OSGI the adapter is automatically unregistered when the its bundle is unloaded.
adapter
- : The adapter to unregister.void registerDataAdapter(PropertyProviderAdapter provider, TypeInfo[] types)
PropertyProviderAdapter
with the Data Services Framework registry.
The adapter will be called for all queries targeting type-properties tuples which are specified during registration.
When using Spring/OSGI the adapter's registration is done automatically at the
time the bundle is loaded if it is registered as an osgi-service under the
PropertyProviderAdapter
interface, like this:
<bean name="myPropertyProviderAdapter" class="com.abc.data.MyPropertyProviderAdapter"/> <osgi:service ref="myPropertyProviderAdapter" interface="com.vmware.vise.data.query.PropertyProviderAdapter"/>
provider
- : The property providertypes
- : The type-properties tuples that will be provided.void unregisterDataAdapter(PropertyProviderAdapter provider)
When using Spring/OSGI the adapter is automatically unregistered when the its bundle is unloaded.
provider
- : The property providervoid registerObjectRefTypeAdapter(ResourceObjectReferenceAdapter adapter, Class<?> type, String uidPrefix)
The adapter will provide additional property info required to handle the type.
type
- The reference class type to register with the object reference type
adapter.uidPrefix
- The uidPrefix to register with the object reference type adapter.adapter
- The object reference type adapter.
IllegalArgumentException
- if any of the params are null; if reference class
type is java.lang.Object.class; if the uidPrefix is an empty string; if there is
an ObjectRefTypeAdapter already registered for either the type or uidPrefix.void unregisterObjectRefTypeAdapter(Class<?> type)
type
- The reference class type to unregister with the object reference type
adapter.uidPrefix
- The uidPrefix to unregister with the object reference type adapter.
IllegalArgumentException
- if any of the params are null.
|
vSphere Client SDK API Documentation : version 5.5.0.1300321 | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |