Index (s3-ninja 2.7 API)

A B C D E G H I L M N O S U V

A

api(WebContext) - Method in class ninja.NinjaController: Handles requests to /ui/api
APILog - Class in ninja: Contains a log of the latest API calls The entries are stored in memory and will be lost during server restarts.
APILog() - Constructor for class ninja.APILog
APILog.Entry - Class in ninja: Represents a log entry.
APILog.Result - Enum in ninja: Used to describe if a call was successful or why if failed.
Aws4HashCalculator - Class in ninja: Hash calculator for AWS signature v4 calculation
Aws4HashCalculator() - Constructor for class ninja.Aws4HashCalculator
AWS_AUTH4_PATTERN - Static variable in class ninja.Aws4HashCalculator
AWS_AUTH_PATTERN - Static variable in class ninja.AwsHashCalculator
AwsHashCalculator - Class in ninja: Class in charge of generating the appropriate hash for the given request and path prefix by delegating the computation to either Aws4HashCalculator or AwsLegacyHashCalculator depending of whether or not Aws4HashCalculator supports the request or not
AwsHashCalculator() - Constructor for class ninja.AwsHashCalculator
AwsLegacyHashCalculator - Class in ninja: Hash calculator for legacy AWS signature calculation
AwsLegacyHashCalculator() - Constructor for class ninja.AwsLegacyHashCalculator

B

Bucket - Class in ninja: Represents a bucket.
Bucket(File) - Constructor for class ninja.Bucket: Creates a new bucket based on the given directory.
bucket(WebContext, String) - Method in class ninja.NinjaController: Handles requests to /ui/[bucketName] This will list the contents of the bucket.
bucket(WebContext, String) - Method in class ninja.S3Controller: Dispatching method handling bucket specific calls without content (HEAD and DELETE)
bucket(WebContext, String, InputStreamHandler) - Method in class ninja.S3Controller: Dispatching method handling bucket specific calls with content (PUT)

C

collectExtensionNames(Consumer<Tuple<String, Class<?>>>) - Method in class ninja.NinjaExtension
collectExtensionValues(Consumer<Tuple<String, Object>>) - Method in class ninja.NinjaExtension
computeHash(WebContext) - Method in class ninja.Aws4HashCalculator: Computes the authentication hash as specified by the AWS SDK for verification purposes.
computeHash(WebContext, String) - Method in class ninja.AwsHashCalculator: Computes the authentication hash as specified by the AWS SDK for verification purposes.
computeHash(WebContext, String) - Method in class ninja.AwsLegacyHashCalculator: Computes the authentication hash as specified by the AWS SDK for verification purposes.
create() - Method in class ninja.Bucket: Creates the bucket.

D

delete() - Method in class ninja.Bucket: Deletes the bucket and all of its contents.
delete() - Method in class ninja.StoredObject: Deletes the object
deleteBucket(WebContext, String) - Method in class ninja.NinjaController: Handles requests to /ui/[bucketName]/delete This will delete the given bucket and list the remaining.
deleteObject(WebContext, String, String) - Method in class ninja.NinjaController: Handles requests to /ui/[bucketName]/[object]/delete This will delete the given object and list the remaining.

E

Entry(String, String, String, String) - Constructor for class ninja.APILog.Entry: Creates a new log entry.
exists() - Method in class ninja.Bucket: Determines if the bucket exists.
exists() - Method in class ninja.StoredObject: Determins if the object exists

G

getAwsAccessKey() - Method in class ninja.Storage: Returns the used AWS access key.
getAwsSecretKey() - Method in class ninja.Storage: Returns the AWS secret key used to verify hashes.
getBaseDir() - Method in class ninja.Storage
getBasePath() - Method in class ninja.Storage: Returns the base directory as string.
getBucket(String) - Method in class ninja.Storage: Returns a bucket with the given name
getBuckets() - Method in class ninja.Storage: Enumerates all known buckets.
getCSS() - Method in class ninja.APILog.Entry: Helper method which returns a bootstrap css class based on the result of the call
getDescription() - Method in class ninja.APILog.Entry: Returns a description of the call
getDuration() - Method in class ninja.APILog.Entry: Returns the duration of the call
getEntries(int, int) - Method in class ninja.APILog: Returns a sublist of the stored entries, starting at start returning at most count items.
getFile() - Method in class ninja.Bucket: Returns the underlying directory as File.
getFile() - Method in class ninja.StoredObject: Returns the underlying file
getFunction() - Method in class ninja.APILog.Entry: Returns the method or function which was called.
getLastModified() - Method in class ninja.StoredObject: Returns the last modified date of the object
getLastModifiedInstant() - Method in class ninja.StoredObject
getName() - Method in class ninja.Bucket: Returns the name of the bucket.
getName() - Method in class ninja.StoredObject: Returns the name of the object.
getObject(String) - Method in class ninja.Bucket: Returns the child object with the given id.
getObjects() - Method in class ninja.Bucket: Returns a list of all stored objects
getProperties() - Method in class ninja.StoredObject: Returns all properties stored along with the object.
getPropertiesFile() - Method in class ninja.StoredObject: Returns the file used to store the properties and meta headers.
getResult() - Method in class ninja.APILog.Entry: Returns the outcome (one of Result.name()) of the call
getSize() - Method in class ninja.StoredObject: Returns the size of the object.
getTod() - Method in class ninja.APILog.Entry: Returns a timestamp of the call

H

HTTP_HEADER_NAME_ETAG - Static variable in class ninja.S3Controller

I

index(WebContext) - Method in class ninja.NinjaController: Handles requests to /
isAutocreateBuckets() - Method in class ninja.Storage: Determines if buckets should be automatically created.
ISO_INSTANT - Static variable in class ninja.S3Controller
isPrivate() - Method in class ninja.Bucket: Determines if the bucket is private or public accessible

L

license(WebContext) - Method in class ninja.NinjaController: Handles requests to /ui/license
listBuckets(WebContext) - Method in class ninja.S3Controller: GET a list of all buckets
log(String, String, APILog.Result, Watch) - Method in class ninja.APILog: Creates a new log entry.
log(WebContext) - Method in class ninja.NinjaController: Handles requests to /ui/log
LOG - Static variable in class ninja.Storage

M

makePrivate() - Method in class ninja.Bucket: Marks the bucket as private accessible.
makePrivate(WebContext, String) - Method in class ninja.NinjaController: Handles requests to /ui/[bucketName]/makePrivate This will make the given bucket private and list its contents.
makePublic() - Method in class ninja.Bucket: Marks the bucket as public accessible.
makePublic(WebContext, String) - Method in class ninja.NinjaController: Handles requests to /ui/[bucketName]/makePublic This will make the given bucket public and list its contents.

N

ninja - package ninja: Contains the implementation of S3 ninja
NinjaController - Class in ninja: Takes care of the "management ui".
NinjaController() - Constructor for class ninja.NinjaController
NinjaExtension - Class in ninja: Provides additional variables to the Rythm-Context.
NinjaExtension() - Constructor for class ninja.NinjaExtension

O

object(WebContext, String, String) - Method in class ninja.NinjaController: Handles requests to /ui/[bucketName]/[object] This will start a download of the requested object.
object(WebContext, String, String, List<String>) - Method in class ninja.S3Controller: Dispatching method handling all object specific calls.
object(WebContext, String, String, List<String>, InputStreamHandler) - Method in class ninja.S3Controller: Dispatching method handling all object specific calls.
onError(WebContext, HandledException) - Method in class ninja.NinjaController
onError(WebContext, HandledException) - Method in class ninja.S3Controller
outputObjects(XMLStructuredOutput, int, String, String) - Method in class ninja.Bucket: Returns a list of at most the provided number of stored objects

S

S3Controller - Class in ninja: Handles calls to the S3 API.
S3Controller() - Constructor for class ninja.S3Controller
Storage - Class in ninja: Storage service which takes care of organizing buckets on disk.
Storage() - Constructor for class ninja.Storage
StoredObject - Class in ninja: Represents a stored object.
StoredObject(File) - Constructor for class ninja.StoredObject: Creates a new StoredObject based on a file.
storeProperties(Map<String, String>) - Method in class ninja.StoredObject: Stores the given meta infos for the stored object.
supports(WebContext) - Method in class ninja.Aws4HashCalculator: Determines if the given request contains an AWS4 auth token.

U

uploadFile(WebContext, String) - Method in class ninja.NinjaController: Handles manual object uploads

V

valueOf(String) - Static method in enum ninja.APILog.Result: Returns the enum constant of this type with the specified name.
values() - Static method in enum ninja.APILog.Result: Returns an array containing the constants of this enum type, in the order they are declared.

A B C D E G H I L M N O S U V