frostfs-sdk-java/README.md
Bruk Ori ff5b007780 [#XX] code cleanup
update README.md
Signed-off-by: Ori Bruk <o.bruk@yadro.com>
2024-07-23 19:30:07 +03:00

2.8 KiB

frostfs-sdk-java

Java implementation of FrostFS SDK

Prerequisites

Get the key for your wallet

  1. Get the address
cat <path_to_your_wallet> | jq .accounts[0].address | tr -d '"'
  1. Get the key
neo-go wallet export -w <path_to_your_wallet> -d <address_from_p1>

Example usage

Container

import info.FrostFS.sdk.dto.container.Container;
import info.FrostFS.sdk.dto.netmap.PlacementPolicy;
import info.FrostFS.sdk.dto.netmap.Replica;
import info.FrostFS.sdk.enums.BasicAcl;
import info.FrostFS.sdk.jdo.ClientSettings;
import info.FrostFS.sdk.services.FrostFSClient;

public class ContainerExample {

    public void example() {
        ClientSettings clientSettings = new ClientSettings(<your_key>, <your_host>);
        FrostFSClient frostFSClient = new FrostFSClient(clientSettings);

        // Create container
        var placementPolicy = new PlacementPolicy(true, new Replica[]{new Replica(1)});
        var containerId = frostFSClient.createContainer(new Container(BasicAcl.PUBLIC_RW, placementPolicy));

        // Get container
        var container = frostFSClient.getContainer(containerId);

        // List containers
        var containerIds = frostFSClient.listContainers();

        // Delete container
        frostFSClient.deleteContainer(containerId);
    }
}

Object

import info.FrostFS.sdk.enums.ObjectType;
import info.FrostFS.sdk.dto.container.ContainerId;
import info.FrostFS.sdk.dto.object.ObjectAttribute;
import info.FrostFS.sdk.dto.object.ObjectFilter;
import info.FrostFS.sdk.dto.object.ObjectHeader;
import info.FrostFS.sdk.jdo.PutObjectParameters;
import info.FrostFS.sdk.services.FrostFSClient;

import java.io.FileInputStream;
import java.io.IOException;

public class ObjectExample {

    public void example() {
        ClientSettings clientSettings = new ClientSettings(<your_key>, <your_host>);
        FrostFSClient frostFSClient = new FrostFSClient(clientSettings);

        // Put object
        info.FrostFS.sdk.dto.object.ObjectId objectId;
        try (FileInputStream fis = new FileInputStream("cat.jpg")) {
            var cat = new ObjectHeader(
                    containerId, ObjectType.REGULAR, new ObjectAttribute[]{new ObjectAttribute("Filename", "cat.jpg")}
            );

            var params = new PutObjectParameters(cat, fis);
            objectId = frostFSClient.putObject(params);
        } catch (IOException e) {
            throw new RuntimeException(e);
        }

        // Get object
        var obj = frostFSClient.getObject(containerId, objectId);

        // Get object header
        var objectHeader = frostFSClient.getObjectHead(containerId, objectId);

        // Search regular objects
        var objectIds = frostFSClient.searchObjects(containerId, ObjectFilter.RootFilter());
    }
}