@NoImplement public interface MetadataService
MetadataProvider
and EntityMetadataProvider
components in the
application and the MetadataKey
of the MetadataKeyProvider
components, using it's Location
It also
provides access to the MetadataKey
associated to a configuration through the operations and sources that belong to that
configuration.Modifier and Type | Field and Description |
---|---|
static String |
METADATA_SERVICE_KEY
Key under which the
MetadataService can be found in the Registry |
Modifier and Type | Method and Description |
---|---|
void |
disposeCache(String id)
Removes the
MetadataCache with the specified id. |
MetadataResult<MetadataKeysContainer> |
getEntityKeys(Location location)
Returns the list of entity types that can be queried in an
EntityMetadataProvider component identified by the
Location . |
MetadataResult<TypeMetadataDescriptor> |
getEntityMetadata(Location location,
MetadataKey key)
Resolves an entity
TypeMetadataDescriptor for the EntityMetadataProvider component identified by the
Location . |
MetadataResult<MetadataKeysContainer> |
getMetadataKeys(Location location)
Returns the list of types that can be described by the
TypeKeysResolver associated to the MetadataKeyProvider
Component identified by the Location . |
MetadataResult<ComponentMetadataDescriptor<OperationModel>> |
getOperationMetadata(Location location)
Resolves the
ComponentMetadataDescriptor for the MetadataProvider Component identified by the
Location using only the static types of its parameters, attributes and output. |
MetadataResult<ComponentMetadataDescriptor<OperationModel>> |
getOperationMetadata(Location location,
MetadataKey key)
Resolves the
ComponentMetadataDescriptor for the MetadataProvider Component identified by the
Location using both static and dynamic resolving of the parameters, attributes and output types. |
MetadataResult<ComponentMetadataDescriptor<SourceModel>> |
getSourceMetadata(Location location)
Resolves the
ComponentMetadataDescriptor for the MetadataProvider Component identified by the
Location using only the static types of its parameters, attributes and output. |
MetadataResult<ComponentMetadataDescriptor<SourceModel>> |
getSourceMetadata(Location location,
MetadataKey key)
Resolves the
ComponentMetadataDescriptor for the MetadataProvider Component identified by the
Location using both static and dynamic resolving of the parameters, attributes and output types. |
static final String METADATA_SERVICE_KEY
MetadataService
can be found in the Registry
MetadataResult<MetadataKeysContainer> getMetadataKeys(Location location)
TypeKeysResolver
associated to the MetadataKeyProvider
Component identified by the Location
.location
- the location of the MetadataKeyProvider
component to query for its available keysMetadataResult
if the keys are successfully resolved Failure MetadataResult
if there is an
error while resolving the keysMetadataResult<ComponentMetadataDescriptor<OperationModel>> getOperationMetadata(Location location)
ComponentMetadataDescriptor
for the MetadataProvider
Component identified by the
Location
using only the static types of its parameters, attributes and output.location
- the location of the MetadataProvider
component to type dynamicallyComponentMetadataDescriptor
with the static Metadata representation of the Component. Successful
MetadataResult
if the Metadata is successfully retrieved Failure MetadataResult
when the Metadata
retrieval of any element fails for any reasonMetadataResult<ComponentMetadataDescriptor<OperationModel>> getOperationMetadata(Location location, MetadataKey key)
ComponentMetadataDescriptor
for the MetadataProvider
Component identified by the
Location
using both static and dynamic resolving of the parameters, attributes and output types.
If the component has a InputTypeResolver
or OutputTypeResolver
associated that can be used to resolve the
dynamic MetadataType
for the Content or Output, then the ComponentMetadataDescriptor
will contain those
dynamic types instead of the static types declaration.
When neither Content nor Output have dynamic types, then invoking this method is the same as invoking
this#getOperationMetadata
location
- the location of the MetadataProvider
component to type dynamicallykey
- MetadataKey
of the type which's structure has to be resolved, used both for input and output typesMetadataResult
of ComponentMetadataDescriptor
type with Successful MetadataResult
if the
Metadata is successfully retrieved and a Failed MetadataResult
when the Metadata retrieval of any element
fails for any reasonMetadataResult<ComponentMetadataDescriptor<SourceModel>> getSourceMetadata(Location location)
ComponentMetadataDescriptor
for the MetadataProvider
Component identified by the
Location
using only the static types of its parameters, attributes and output.location
- the location of the MetadataProvider
component to type dynamicallyComponentMetadataDescriptor
with the static Metadata representation of the Component. Successful
MetadataResult
if the Metadata is successfully retrieved Failure MetadataResult
when the Metadata
retrieval of any element fails for any reasonMetadataResult<ComponentMetadataDescriptor<SourceModel>> getSourceMetadata(Location location, MetadataKey key)
ComponentMetadataDescriptor
for the MetadataProvider
Component identified by the
Location
using both static and dynamic resolving of the parameters, attributes and output types.
If the component has a InputTypeResolver
or OutputTypeResolver
associated that can be used to resolve the
dynamic MetadataType
for the Content or Output, then the ComponentMetadataDescriptor
will contain those
dynamic types instead of the static types declaration.
When neither Content nor Output have dynamic types, then invoking this method is the same as invoking
this#getOperationMetadata
location
- the location of the MetadataProvider
component to type dynamicallykey
- MetadataKey
of the type which's structure has to be resolved, used both for input and output typesMetadataResult
of ComponentMetadataDescriptor
type with Successful MetadataResult
if the
Metadata is successfully retrieved and a Failed MetadataResult
when the Metadata retrieval of any element
fails for any reasonvoid disposeCache(String id)
MetadataCache
with the specified id.id
- the id of the cache to be removedMetadataResult<MetadataKeysContainer> getEntityKeys(Location location)
EntityMetadataProvider
component identified by the
Location
.location
- the location of the EntityMetadataProvider
component to query for its available keysMetadataResult
if the keys are successfully resolved Failure MetadataResult
if there is an
error while resolving the entity keysMetadataResult<TypeMetadataDescriptor> getEntityMetadata(Location location, MetadataKey key)
TypeMetadataDescriptor
for the EntityMetadataProvider
component identified by the
Location
.location
- the location of the EntityMetadataProvider
component to query for its available keyskey
- MetadataKey
representing an entity of the type which's structure has to be resolvedMetadataResult
of TypeMetadataDescriptor
type with a successful MetadataResult
if the
metadata is successfully retrieved and a failed MetadataResult
when the metadata retrieval of the entity had
a problem.Copyright © 2018. All rights reserved.