io.storj

Class Access

java.lang.Object

io.storj.Access

public class Access
extends java.lang.Object

Represents all credentials you need to access data on the Storj network:

• Satellite address in the form of "host:port"
• ApiKey to access the satellite
• Encryption access for accessing the encrypted content

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.String	serializedAccess

Method Summary

Modifier and Type	Method and Description
void	overrideEncryptionKey(java.lang.String bucket, java.lang.String prefix, EncryptionKey encryptionKey) Overrides the root encryption key for the prefix in bucket with encryptionKey.
static Access	parse(java.lang.String serialized) Parses a base58-encoded String to an Access.
java.lang.String	serialize() Serializes this Access to base58-encoded String.
Access	share(Permission permission, SharePrefix... prefixes) Creates a new access grant with specific permissions.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

serializedAccess

protected java.lang.String serializedAccess

Method Detail

serialize

public java.lang.String serialize()
                           throws StorjException

Serializes this Access to base58-encoded String.

Returns:

a String with serialized Access Grant

Throws:

StorjException - in case of error

parse

public static Access parse(java.lang.String serialized)
                    throws StorjException

Parses a base58-encoded String to an Access.

Parameters:

serialized - a base58-encoded String

Returns:

the parsed Access Grant

Throws:

StorjException - in case of error

share

public Access share(Permission permission,
                    SharePrefix... prefixes)
             throws StorjException

Creates a new access grant with specific permissions.

Access grants can only have their existing permissions restricted, and the resulting access grant will only allow for the intersection of all previous Share calls in the access grant construction chain.

Prefixes, if provided, restrict the access grant (and internal encryption information) to only contain enough information to allow access to just those prefixes.

Parameters:

permission - the permission

prefixes - list of prefixes to restrict access

Returns:

shared access grant

Throws:

StorjException - if an error occurs during the sharing

overrideEncryptionKey

public void overrideEncryptionKey(java.lang.String bucket,
                                  java.lang.String prefix,
                                  EncryptionKey encryptionKey)
                           throws StorjException

Overrides the root encryption key for the prefix in bucket with encryptionKey.

This function is useful for overriding the encryption key in user-specific access grants when implementing multitenancy in a single app bucket.

Parameters:

bucket - the bucket name

prefix - the prefix

encryptionKey - new encryption key

Throws:

StorjException - in case of error