net.sf.ehcache.management.service.CacheManagerServiceV2 Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of management-ehcache-v2 Show documentation

A library defining the ehcache management resource services and resource entities, version 2

The newest version!

/*
 * All content copyright (c) 2003-2012 Terracotta, Inc., except as may otherwise be noted in a separate copyright
 * notice. All rights reserved.
 */

package net.sf.ehcache.management.service;

import net.sf.ehcache.management.resource.CacheManagerEntityV2;

import org.terracotta.management.ServiceExecutionException;
import org.terracotta.management.resource.ResponseEntityV2;

/**
 * An interface for service implementations providing operations on CacheManager objects.
 *
 * @author brandony
 */
public interface CacheManagerServiceV2 {

  /**
   * Update a cache manager represented by the submitted entity.
   *
   * @param cacheManagerName the name of the CacheManager to be updated
   * @param resource         the representation of the resource informing this update
   * @throws ServiceExecutionException if the update fails
   */
  void updateCacheManager(String cacheManagerName,
      CacheManagerEntityV2 resource) throws ServiceExecutionException;
  /**
   * Execute query against cache manager and returns results array
   * 
   * @param queryString
   * @return {@code ResponseEntityV2} containing {@code QueryResultsEntityV2} entities
   * @throws ServiceExecutionException
   */
  ResponseEntityV2 executeQuery(String cacheManagerName, String queryString) throws ServiceExecutionException;
}