net.sf.ehcache.management.resource.services.CacheConfigsResourceService Maven / Gradle / Ivy

Go to download

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

A library defining the ehcache management resource service interfaces and resource entities.

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.resource.services;

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

import java.util.Collection;

import javax.ws.rs.Consumes;
import javax.ws.rs.GET;
import javax.ws.rs.Produces;
import javax.ws.rs.core.Context;
import javax.ws.rs.core.MediaType;
import javax.ws.rs.core.UriInfo;

/**
 * @author brandony
 */
public interface CacheConfigsResourceService {
  /**
   * Get a {@code Collection} of {@link net.sf.ehcache.management.resource.CacheConfigEntity} objects representing the
   * cache manager configuration information provided by the associated monitorable entity's agent given the request path.
   *
   *
   * @param {@link UriInfo} for this resource request
   * @return a collection of CacheConfigEntity objects.
   * {@link net.sf.ehcache.management.resource.CacheConfigEntity} objects
   */
  @GET
  @Produces(MediaType.APPLICATION_JSON)
  public Collection getCacheConfigs(@Context UriInfo info);

  /**
   * Get a {@code Collection} of {@link net.sf.ehcache.management.resource.CacheConfigEntity} objects representing the
   * cache manager configuration information provided by the associated monitorable entity's agent given the request path.
   *
   *
   * @param {@link UriInfo} for this resource request
   * @return a collection of CacheConfigEntity objects.
   * {@link net.sf.ehcache.management.resource.CacheConfigEntity} objects
   */
  @Deprecated
  @GET
  @Consumes(MediaType.APPLICATION_XML)
  @Produces(MediaType.APPLICATION_XML)
  public Collection getXMLCacheConfigs(@Context UriInfo info);
}