Cmd (k2hdkc 1.1.7 API)

All Known Implementing Classes:: AddSubkeyCmd, CasGetCmd, CasIncDecCmd, CasInitCmd, CasSetCmd, ClearSubkeysCmd, GetAttrsCmd, GetCmd, GetSubkeysCmd, KeyQueueAddCmd, KeyQueueRemoveCmd, QueueAddCmd, QueueRemoveCmd, RemoveCmd, RemoveSubkeyCmd, RenameCmd, SetAllCmd, SetCmd, SetSubkeysCmd

public interface Cmd<T>

Represents an operation of a k2hdkc cluster. Each of a k2hdkc Command class implements the execute method. The execute(ax.antpick.k2hdkc.Session) method accepts a Session argument and returns a Result instance.

This interface is currently a package-private interface because I think it's hard for implementators to use the k2hdkc C functions very well. I will move this interface to a public one if I could think it is much easier to use them.

Here is a pseudo code implements the interface:

 public class ExampleCmd extends CmdBase implements Cmd {
   private final String key;
   public SampleCmd(String key) {
     this.key = key;
   }
   @Override
   public Optional Optional<Result<T>> execute(Session session) throws IOException {

     // get value from cluster.
     String rval = null;
     String password = null;
     PointerByReference ppval = new PointerByReference();
     // Call the k2hdkc C function
     boolean isSuccess = INSTANCE.k2hdkc_pm_get_str_value_wp(session.getHandle(), this.key, password, ppval);

      Result<T> result = Result.of(SampleCmd.class.getSimpleName(), isSuccess, (T)Boolean.valueOf(isSuccess), 0, 0);
     return Optional.of(result);
   }
 }

Or, you can implement the interface as a Functional interface. Supposing the interface is a public, you could write this:

 try (
   Cluster c = Cluster.of("slave.ini");
   Session s = Session.of(); ) {
   Cmd<Session, Optional<Result<T>>> cmd = s -> {
     try {
       K2hdkcLibrary INSTANCE = Session.getLibrary(); // can throws IOException
       boolean b = INSTANCE.k2hdkc_pm_set_str_value_wa(s.getHandle(), "key", "value", false, null, null);
        Result<T> rb = Result.of("set", b, (T)Boolean.valueOf(b), 0, 0);
       return Optional.of(rb);
     } catch (IOException ex) {
       return Optional.empty();
     }
  };
   System.out.println(cmd.execute(s));
 } catch (IOException ex) {
   System.err.println(ex.getMessage());
 }

Author:: Hirotaka Wakabayashi

Nested Class Summary

Nested Classes
Modifier and Type Interface and Description

static class Cmd.DataType
DataType of data in CAS operation

Nested Classes
Modifier and Type	Interface and Description
`static class`	`Cmd.DataType` DataType of data in CAS operation

Field Summary

Fields
Modifier and Type	Field and Description
`static boolean`	`DEFAULT_CHECK_PARENT_ATTRS` Default checkParentAttrs is `true`.
`static long`	`DEFAULT_EXPIRATION_DURATION` Default data expiration duration is `0`.
`static boolean`	`DEFAULT_IS_CHECK_PARENT_ATTRS` Default clear all subkeys is `false`.
`static boolean`	`DEFAULT_IS_CLEAR_SUBKEYS` Default clear all subkeys is `false`.
`static boolean`	`DEFAULT_IS_FIFO` Default isFifo is `true`.
`static boolean`	`DEFAULT_IS_INCREMENT` Default isIncrement is `true`.
`static boolean`	`DEFAULT_NEED_RETURN_VALUE` Default isReturnValue is `true`.
`static String`	`DEFAULT_PARENT_KEY` Default parent string is `null`.
`static String`	`DEFAULT_PASS` Default passphrase string is `null`.
`static int`	`DEFAULT_REMOVE_ELEMENT_SIZE` Default pass is null.
`static boolean`	`DEFAULT_REMOVE_RECURSIVELY` Default removing subkeys recursively is `false`.
`static String[]`	`DEFAULT_SUBKEYS` Default clear all subkeys is `false`.

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method and Description
`static int`	`bytesToInt(byte[] b)` Packs a byte array to integer.
`<T> Optional<Result<T>>`	`execute(Session session)` Executes a command and return a result.
`static int`	`getValusAsInt(byte[] value)` Returns a value as a integer value.

- Field Detail
  - DEFAULT_REMOVE_RECURSIVELY
```
static final boolean DEFAULT_REMOVE_RECURSIVELY
```
    Default removing subkeys recursively is false.
    
    See Also:
    
    Constant Field Values
  - DEFAULT_IS_CLEAR_SUBKEYS
```
static final boolean DEFAULT_IS_CLEAR_SUBKEYS
```
    Default clear all subkeys is false.
    
    See Also:
    
    Constant Field Values
  - DEFAULT_SUBKEYS
```
static final String[] DEFAULT_SUBKEYS
```
    Default clear all subkeys is false.
  - DEFAULT_PARENT_KEY
```
static final String DEFAULT_PARENT_KEY
```
    Default parent string is null.
  - DEFAULT_IS_CHECK_PARENT_ATTRS
```
static final boolean DEFAULT_IS_CHECK_PARENT_ATTRS
```
    Default clear all subkeys is false.
    
    See Also:
    
    Constant Field Values
  - DEFAULT_REMOVE_ELEMENT_SIZE
```
static final int DEFAULT_REMOVE_ELEMENT_SIZE
```
    Default pass is null.
    
    See Also:
    
    Constant Field Values
  - DEFAULT_NEED_RETURN_VALUE
```
static final boolean DEFAULT_NEED_RETURN_VALUE
```
    Default isReturnValue is true.
    
    See Also:
    
    Constant Field Values
  - DEFAULT_IS_FIFO
```
static final boolean DEFAULT_IS_FIFO
```
    Default isFifo is true.
    
    See Also:
    
    Constant Field Values
  - DEFAULT_CHECK_PARENT_ATTRS
```
static final boolean DEFAULT_CHECK_PARENT_ATTRS
```
    Default checkParentAttrs is true.
    
    See Also:
    
    Constant Field Values
  - DEFAULT_IS_INCREMENT
```
static final boolean DEFAULT_IS_INCREMENT
```
    Default isIncrement is true.
    
    See Also:
    
    Constant Field Values
  - DEFAULT_PASS
```
static final String DEFAULT_PASS
```
    Default passphrase string is null.
  - DEFAULT_EXPIRATION_DURATION
```
static final long DEFAULT_EXPIRATION_DURATION
```
    Default data expiration duration is 0.
    
    See Also:
    
    Constant Field Values
- Method Detail
  - execute
```
<T> Optional<Result<T>> execute(Session session)
                         throws IOException
```
    Executes a command and return a result.
    
    Parameters:
    
    session - a Session instance.
    
    Returns:
    
    a Optional instance.
    
    Throws:
    
    IOException - if the native C library file can't be open.
  - bytesToInt
```
static int bytesToInt(byte[] b)
```
    Packs a byte array to integer. People who use the CAS command family can use this helper function(implicitly public method).
    
    Parameters:
    
    b - a byte array
    
    Returns:
    
    a interger variable
  - getValusAsInt
```
static int getValusAsInt(byte[] value)
```
    Returns a value as a integer value.
    
    Parameters:
    
    value - a byte array
    
    Returns:
    
    a value in integer
    
    Throws:
    
    IllegalStateException - this.value is not valid integer.

Interface Cmd<T>

Nested Class Summary

Field Summary

Method Summary

Field Detail

DEFAULT_REMOVE_RECURSIVELY

DEFAULT_IS_CLEAR_SUBKEYS

DEFAULT_SUBKEYS

DEFAULT_PARENT_KEY

DEFAULT_IS_CHECK_PARENT_ATTRS

DEFAULT_REMOVE_ELEMENT_SIZE

DEFAULT_NEED_RETURN_VALUE

DEFAULT_IS_FIFO

DEFAULT_CHECK_PARENT_ATTRS

DEFAULT_IS_INCREMENT

DEFAULT_PASS

DEFAULT_EXPIRATION_DURATION

Method Detail

execute

bytesToInt

getValusAsInt