com.axibase.tsd.client
Class MetaDataService

java.lang.Object
  com.axibase.tsd.client.MetaDataService

public class MetaDataService
extends Object

Provides high-level API to retrieve and update ATSD Metadata Objects (entities, entity groups, metrics).

Author:

Nikolay Malevanny.

Constructor Summary

MetaDataService()

MetaDataService(HttpClientManager httpClientManager)

Method Summary

boolean	addGroupEntities(String entityGroupName, Boolean createEntities, Entity... entities) Add specified entities to entity group.
boolean	createOrReplaceEntity(Entity entity)
boolean	createOrReplaceEntityGroup(EntityGroup entityGroup) Create an entity group with specified properties and tags or replace an existing entity group.
boolean	createOrReplaceMetric(Metric metric)
boolean	deleteAllGroupEntities(String entityGroupName) Delete all entities from entity group.
boolean	deleteEntity(Entity entity)
boolean	deleteEntityGroup(EntityGroup entityGroup)
boolean	deleteGroupEntities(String entityGroupName, Entity... entities) Delete entities from entity group.
boolean	deleteMetric(Metric metric)
boolean	replaceGroupEntities(String entityGroupName, Boolean createEntities, Entity... entities) Replace entities in the entity group with the specified collection.
List<Entity>	retrieveEntities(Boolean active, String expression, TagAppender tagAppender, Integer limit)
Entity	retrieveEntity(String entityName)
List<EntityAndTags>	retrieveEntityAndTags(String metricName, String entityName)
EntityGroup	retrieveEntityGroup(String entityGroupName)
List<EntityGroup>	retrieveEntityGroups()
List<Entity>	retrieveGroupEntities(String entityGroupName)
List<Entity>	retrieveGroupEntities(String entityGroupName, Boolean active, String expression, TagAppender tagAppender, Integer limit)
Metric	retrieveMetric(String metricName)
List<Metric>	retrieveMetrics(Boolean active, String expression, TagAppender tagAppender, Integer limit)
List<Metric>	retrieveMetrics(String entityName, Boolean active, String expression, TagAppender tagAppender, Integer limit)
Set<String>	retrievePropertyTypes(String entityName, Long startTime)
void	setHttpClientManager(HttpClientManager httpClientManager)
boolean	updateEntity(Entity entity)
boolean	updateEntityGroup(EntityGroup entityGroup) Update specified properties and tags for the given entity group.
boolean	updateMetric(Metric metric)

Methods inherited from class java.lang.Object

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

Constructor Detail

MetaDataService

public MetaDataService()

MetaDataService

public MetaDataService(HttpClientManager httpClientManager)

Method Detail

setHttpClientManager

public void setHttpClientManager(HttpClientManager httpClientManager)

retrieveMetrics

public List<Metric> retrieveMetrics(Boolean active,
                                    String expression,
                                    TagAppender tagAppender,
                                    Integer limit)
                             throws AtsdClientException,
                                    AtsdServerException

Parameters:

active - Filter metrics by lastInsertTime. If active = true, only metrics with positive lastInsertTime are included in the response.

expression - Specify EL expression.

tagAppender - Specify metric tags to be included in the response.

limit - Limit response to first N metrics, ordered by name.

Returns:

List of metrics.

Throws:

AtsdClientException

AtsdServerException

retrieveMetrics

public List<Metric> retrieveMetrics(String entityName,
                                    Boolean active,
                                    String expression,
                                    TagAppender tagAppender,
                                    Integer limit)
                             throws AtsdClientException,
                                    AtsdServerException

Parameters:

entityName - Entity name.

active - Filter metrics by lastInsertTime. If active = true, only metrics with positive lastInsertTime are included in the response.

expression - Specify EL expression.

tagAppender - Specify metric tags to be included in the response.

limit - Limit response to first N metrics, ordered by name.

Returns:

List of metrics.

Throws:

AtsdClientException

AtsdServerException

retrieveMetric

public Metric retrieveMetric(String metricName)
                      throws AtsdClientException,
                             AtsdServerException

Parameters:

metricName - Metric name.

Returns:

Metric.

Throws:

AtsdClientException

AtsdServerException

createOrReplaceMetric

public boolean createOrReplaceMetric(Metric metric)

updateMetric

public boolean updateMetric(Metric metric)

deleteMetric

public boolean deleteMetric(Metric metric)

retrieveEntities

public List<Entity> retrieveEntities(Boolean active,
                                     String expression,
                                     TagAppender tagAppender,
                                     Integer limit)
                              throws AtsdClientException,
                                     AtsdServerException

Parameters:

active - Filter entities by lastInsertTime. If active = true, only entities with positive lastInsertTime are included in the response.

expression - Specify EL expression.

tagAppender - Specify entity tags to be included in the response.

limit - Limit response to first N entities, ordered by name.

Returns:

List of entities.

Throws:

AtsdClientException

AtsdServerException

retrieveEntity

public Entity retrieveEntity(String entityName)
                      throws AtsdClientException,
                             AtsdServerException

Parameters:

entityName - Entity name.

Returns:

Entity

Throws:

AtsdClientException

AtsdServerException

retrievePropertyTypes

public Set<String> retrievePropertyTypes(String entityName,
                                         Long startTime)

Parameters:

entityName - entity name

startTime - to return only property types that have been collected after the specified time

Returns:

a set of property types for the entity.

createOrReplaceEntity

public boolean createOrReplaceEntity(Entity entity)

updateEntity

public boolean updateEntity(Entity entity)

deleteEntity

public boolean deleteEntity(Entity entity)

retrieveEntityAndTags

public List<EntityAndTags> retrieveEntityAndTags(String metricName,
                                                 String entityName)
                                          throws AtsdClientException,
                                                 AtsdServerException

Parameters:

metricName - Metric name.

entityName - Filter entities by entity name.

Returns:

List of entities and tags for metric.

Throws:

AtsdClientException

AtsdServerException

retrieveEntityGroups

public List<EntityGroup> retrieveEntityGroups()
                                       throws AtsdClientException,
                                              AtsdServerException

Returns:

List of entity groups.

Throws:

AtsdClientException

AtsdServerException

retrieveEntityGroup

public EntityGroup retrieveEntityGroup(String entityGroupName)
                                throws AtsdClientException,
                                       AtsdServerException

Parameters:

entityGroupName - Entity group name.

Returns:

List of entity groups.

Throws:

AtsdClientException

AtsdServerException

createOrReplaceEntityGroup

public boolean createOrReplaceEntityGroup(EntityGroup entityGroup)
                                   throws AtsdClientException,
                                          AtsdServerException

Create an entity group with specified properties and tags or replace an existing entity group.

This method creates a new entity group or replaces an existing entity group.

If only a subset of fields is provided for an existing entity group, the remaining properties and tags will be deleted.

Parameters:

entityGroup - the entity group to create or replace

Returns:

true if entity group is created or updated.

Throws:

AtsdClientException

AtsdServerException

updateEntityGroup

public boolean updateEntityGroup(EntityGroup entityGroup)
                          throws AtsdClientException,
                                 AtsdServerException

Update specified properties and tags for the given entity group.

This method updates specified properties and tags for an existing entity group.

Properties and tags that are not specified are left unchanged.

Parameters:

entityGroup - the entity group to update

Returns:

true if entity group is updated.

Throws:

AtsdClientException

AtsdServerException

deleteEntityGroup

public boolean deleteEntityGroup(EntityGroup entityGroup)
                          throws AtsdClientException,
                                 AtsdServerException

Throws:

AtsdClientException

AtsdServerException

retrieveGroupEntities

public List<Entity> retrieveGroupEntities(String entityGroupName,
                                          Boolean active,
                                          String expression,
                                          TagAppender tagAppender,
                                          Integer limit)
                                   throws AtsdClientException,
                                          AtsdServerException

Parameters:

entityGroupName - Entity group name.

active - Filter entities by lastInsertTime. If active = true, only entities with positive lastInsertTime are included in the response.

expression - Specify EL expression.

tagAppender - Specify entity tags to be included in the response.

Returns:

List of entities for an entity group.

Throws:

AtsdClientException

AtsdServerException

retrieveGroupEntities

public List<Entity> retrieveGroupEntities(String entityGroupName)
                                   throws AtsdClientException,
                                          AtsdServerException

Parameters:

entityGroupName - Entity group name.

Returns:

List of entities for an entity group.

Throws:

AtsdClientException

AtsdServerException

addGroupEntities

public boolean addGroupEntities(String entityGroupName,
                                Boolean createEntities,
                                Entity... entities)

Add specified entities to entity group.

Parameters:

entityGroupName - Entity group name.

createEntities - Automatically create new entities from the submitted list if such entities don't already exist.

entities - Entities to create.

Returns:

true if entities added.

Throws:

AtsdClientException - if there is any client problem

AtsdServerException - if there is any server problem

replaceGroupEntities

public boolean replaceGroupEntities(String entityGroupName,
                                    Boolean createEntities,
                                    Entity... entities)

Replace entities in the entity group with the specified collection. All existing entities that are not included in the collection will be removed. If the specified collection is empty, all entities are removed from the group (replace with empty collection).

Parameters:

entityGroupName - Entity group name.

createEntities - Automatically create new entities from the submitted list if such entities don't already exist.

entities - Entities to replace.

Returns:

true if entities replaced.

Throws:

AtsdClientException - if there is any client problem

AtsdServerException - if there is any server problem

deleteGroupEntities

public boolean deleteGroupEntities(String entityGroupName,
                                   Entity... entities)

Delete entities from entity group.

Parameters:

entityGroupName - Entity group name.

entities - Entities to replace. @return true if entities added.

Throws:

AtsdClientException - if there is any client problem

AtsdServerException - if there is any server problem

deleteAllGroupEntities

public boolean deleteAllGroupEntities(String entityGroupName)

Delete all entities from entity group.

Parameters:

entityGroupName - Entity group name.

Throws:

AtsdClientException - if there is any client problem

AtsdServerException - if there is any server problem