io.baratine.keyvalue.Store Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of api Show documentation

A reactive Java web server.

There is a newer version: 1.0.1

/*
 * Copyright (c) 1998-2015 Caucho Technology -- all rights reserved
 *
 * This file is part of Baratine(TM)(TM)
 *
 * Each copy or derived work must preserve the copyright notice and this
 * notice unmodified.
 *
 * Baratine is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 *
 * Baratine is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE, or any warranty
 * of NON-INFRINGEMENT.  See the GNU General Public License for more
 * details.
 *
 * You should have received a copy of the GNU General Public License
 * along with Baratine; if not, write to the
 *
 *   Free Software Foundation, Inc.
 *   59 Temple Place, Suite 330
 *   Boston, MA 02111-1307  USA
 */

package io.baratine.keyvalue;

import io.baratine.service.Result;



/**
 * Simple Key/Value store integrated with Baratine's pod system.
 * 
 * For distributed pods, the hashing of the store key is consistent with
 * the hashing of URLs. Baratine will hash both "pod:///my-service/14" and
 * the Store key "/my-service/14" to the same pod node.
 * 
 * Because the key is stored on the owning service node, gets and puts will
 * be local operations, and therefore faster.
 * 
 * 
 * @Inject @Lookup("store:///")
 * Store _db;
 * 
 * 
 * Or programmatically,
 *
 * 
 * _db = serviceManager.lookup("store:///").as(Store.class);
 * 
 * 
 * The special "local" pod is local to the current machine, allowing for
 * local caching.
 * 
 * @Inject @Lookup("store://local/my-service")
 * Store _db;
 * 
 * 
 * The lookup for a Store creates a prefix for get/put.
 */
public interface Store
{
  void lookup(String path, Result> result);
  
  void get(String key, Result value);

  void put(String key, V value);
  void put(String key, V value, Result result);

  void remove(String key);
  void remove(String key, Result result);
}