HotRodOperations.java

/*
 * JBoss, Home of Professional Open Source
 * Copyright 2010 Red Hat Inc. and/or its affiliates and other
 * contributors as indicated by the @author tags. All rights reserved.
 * See the copyright.txt in the distribution for a full listing of
 * individual contributors.
 *
 * This is free software; you can redistribute it and/or modify it
 * under the terms of the GNU Lesser General Public License as
 * published by the Free Software Foundation; either version 2.1 of
 * the License, or (at your option) any later version.
 *
 * This software 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. See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this software; if not, write to the Free
 * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
 * 02110-1301 USA, or see the FSF site: http://www.fsf.org.
 */
package org.infinispan.client.hotrod.impl.protocol;


import org.infinispan.client.hotrod.Flag;
import org.infinispan.client.hotrod.impl.BinaryVersionedValue;
import org.infinispan.client.hotrod.impl.VersionedOperationResponse;

import java.util.Map;

/**
 * Defines the Hot Rod operations as described in the protocol spec: http://community.jboss.org/wiki/HotRodProtocol
 *
 * @author Mircea.Markus@jboss.com
 * @since 4.1
 */
public interface HotRodOperations {

   byte[] get(byte[] key, Flag... flags);

   byte[] remove(byte[] key, Flag... flags);

   boolean containsKey(byte[] key, Flag... flags);

   /**
    * Returns null if the given key does not exist.
    */
   BinaryVersionedValue getWithVersion(byte[] key, Flag... flags);

   /**
    * @param lifespan number of seconds that a entry during which the entry is allowed to life.
    * If number of seconds is bigger than 30 days, this number of seconds is treated as UNIX time and so, represents
    * the number of seconds since 1/1/1970. If set to 0, lifespan is unlimited.
    * @param maxIdle Number of seconds that a entry can be idle before it's evicted from the cache. If 0, no max
    * @param flags
    */
   byte[] put(byte[] key, byte[] value, int lifespan, int maxIdle, Flag... flags);

   /**
    * @param lifespan same as in {@link #put(byte[],byte[],int,int,org.infinispan.client.hotrod.Flag...)}
    * @param maxIdle same as in {@link #put(byte[],byte[],int,int,org.infinispan.client.hotrod.Flag...)}
    * @param flags
    */
   byte[] putIfAbsent(byte[] key, byte[] value, int lifespan, int maxIdle, Flag... flags);

   /**
    * @param lifespan same as in {@link #put(byte[],byte[],int,int,org.infinispan.client.hotrod.Flag...)}
    * @param maxIdle same as in {@link #put(byte[],byte[],int,int,org.infinispan.client.hotrod.Flag...)}
    * @param flags
    */
   byte[] replace(byte[] key, byte[] value, int lifespan, int maxIdle, Flag... flags);

   /**
    * @param lifespan same as in {@link #put(byte[],byte[],int,int,org.infinispan.client.hotrod.Flag...)}
    * @param maxIdle same as in {@link #put(byte[],byte[],int,int,org.infinispan.client.hotrod.Flag...)}
    * @param flags
    */
   VersionedOperationResponse replaceIfUnmodified(byte[] key, byte[] value, int lifespan, int maxIdle, long version, Flag... flags);

   VersionedOperationResponse removeIfUnmodified(byte[] key, long version, Flag... flags);

   void clear(Flag... flags);

   Map<String, String> stats();

}