Skip navigation links
A B C D E F G H I L M N O P R S T U V W 

A

AccessKey - Class in com.om.mxs.client.japi.cred
Object representing an access key in MatrixStore system.
AccessKey() - Constructor for class com.om.mxs.client.japi.cred.AccessKey
 
AccessKeyBasedCredentials - Class in com.om.mxs.client.japi.cred
Authentication credentials based on an access key.
AccessOption - Enum in com.om.mxs.client.japi
This class specifies the options to open MatrixStore channels
addAuditEntry(AuditEntryDescription) - Method in class com.om.mxs.client.japi.Vault
Adds user audit information to a given vault.
and(AuditSearchTerm[]) - Static method in class com.om.mxs.client.japi.audit.AuditSearchTerm
Creates AND term from given terms.
AppCapability - Class in com.om.mxs.client.japi.iam
An individual application capability granted to an identity.
Attribute - Class in com.om.mxs.client.japi
This class encapsulates metadata attributes in MatrixStore objects.
Attribute(String, ByteBuffer, boolean) - Constructor for class com.om.mxs.client.japi.Attribute
Creates an attribute with binary value.
Attribute(String, ByteBuffer) - Constructor for class com.om.mxs.client.japi.Attribute
Creates an attribute with binary value.
Attribute(String, String, boolean) - Constructor for class com.om.mxs.client.japi.Attribute
Creates an attribute with a string value.
Attribute(String, String) - Constructor for class com.om.mxs.client.japi.Attribute
Creates an attribute with a string value.
Attribute(String, boolean, boolean) - Constructor for class com.om.mxs.client.japi.Attribute
Creates an attribute with a boolean value.
Attribute(String, boolean) - Constructor for class com.om.mxs.client.japi.Attribute
Creates an attribute with a boolean value.
Attribute(String, int, boolean) - Constructor for class com.om.mxs.client.japi.Attribute
Creates an attribute with an integer value.
Attribute(String, int) - Constructor for class com.om.mxs.client.japi.Attribute
Creates an attribute with an integer value.
Attribute(String, long, boolean) - Constructor for class com.om.mxs.client.japi.Attribute
Creates an attribute with a long value.
Attribute(String, long) - Constructor for class com.om.mxs.client.japi.Attribute
Creates an attribute with an long value.
Attribute(String, float, boolean) - Constructor for class com.om.mxs.client.japi.Attribute
Creates an attribute with a float value.
Attribute(String, float) - Constructor for class com.om.mxs.client.japi.Attribute
Creates an attribute with an long value.
AttributeView - Interface in com.om.mxs.client.japi
This interface defines the basic set of methods to access user-defined attributes.
AuditEntry - Interface in com.om.mxs.client.japi.audit
Represents an audit entry in MatrixStore cluster.
AuditSearchTerm - Class in com.om.mxs.client.japi.audit
Factory class creating AuditSearchTerm objects representing search terms.

B

build() - Method in class com.om.mxs.client.japi.iam.IdentityPrivileges.Builder
 
build() - Method in class com.om.mxs.client.japi.iam.Privilege.Builder
 
build() - Method in class com.om.mxs.client.japi.MatrixStoreBuilder
Builds an instance of a MatrixStore object.
build() - Method in class com.om.mxs.client.japi.MatrixStoreConnection.MatrixStoreConnectionBuilder
Create a new connection to the MatrixStore cluster using the details supplied to the builder.
builder() - Static method in class com.om.mxs.client.japi.iam.IdentityPrivileges
 
Builder() - Constructor for class com.om.mxs.client.japi.iam.Privilege.Builder
 
builder() - Static method in class com.om.mxs.client.japi.MatrixStore
 
builder() - Static method in class com.om.mxs.client.japi.MatrixStoreConnection
Produces a builder used to create a new connection.

C

cancel() - Method in interface com.om.mxs.client.japi.Cancellable
Cancel the current action
cancel() - Method in interface com.om.mxs.client.japi.MxsByteChannel
 
cancel() - Method in class com.om.mxs.client.japi.MxsInputStream
Cancel the current stream
cancel() - Method in class com.om.mxs.client.japi.MxsOutputStream
Cancel the current stream
Cancellable - Interface in com.om.mxs.client.japi
Cancellable interface.
canDelete() - Method in class com.om.mxs.client.japi.UserCapabilities
Tests whether the user can delete in the vault
canRead() - Method in class com.om.mxs.client.japi.UserCapabilities
Tests whether the user can read in the vault
canSearch() - Method in class com.om.mxs.client.japi.UserCapabilities
Tests whether the user can search in the vault
canUpdate() - Method in class com.om.mxs.client.japi.UserCapabilities
Tests whether the user can update in the vault
canUpdateMetadataForm() - Method in class com.om.mxs.client.japi.UserCapabilities
Tests whether the user can update metadata form in the vault
canWrite() - Method in class com.om.mxs.client.japi.UserCapabilities
Tests whether the user can write in the vault
changePassword(char[]) - Method in interface com.om.mxs.client.japi.IdentityManagement
Changes password for current user.
clear() - Method in class com.om.mxs.client.japi.cred.AccessKey
Clears the security-sensitive information in this AccessKey
clear() - Method in class com.om.mxs.client.japi.cred.AccessKeyBasedCredentials
 
clear() - Method in class com.om.mxs.client.japi.cred.Credentials
Erases sensitive information from this instance.
clear() - Method in class com.om.mxs.client.japi.cred.UsernamePasswordCredentials
 
close() - Method in class com.om.mxs.client.japi.MatrixStoreConnection
Closes the connection.
close() - Method in class com.om.mxs.client.japi.MxsInputStream
 
close() - Method in class com.om.mxs.client.japi.MxsOutputStream
 
closeConnection() - Method in class com.om.mxs.client.japi.MatrixStore
Logout and close MatrixStore connection used to create this instance.
ClusterAttributesView - Interface in com.om.mxs.client.japi.metadata
Provides access to cluster attributes.
clusterId() - Method in interface com.om.mxs.client.japi.metadata.ClusterAttributesView
Returns ID of the MatrixStore system
clusterName() - Method in interface com.om.mxs.client.japi.metadata.ClusterAttributesView
Returns non-null name of the MatrixStore system.
com.om.mxs.client.api - package com.om.mxs.client.api
 
com.om.mxs.client.japi - package com.om.mxs.client.japi
 
com.om.mxs.client.japi.audit - package com.om.mxs.client.japi.audit
 
com.om.mxs.client.japi.cred - package com.om.mxs.client.japi.cred
 
com.om.mxs.client.japi.iam - package com.om.mxs.client.japi.iam
 
com.om.mxs.client.japi.metadata - package com.om.mxs.client.japi.metadata
 
com.om.mxs.client.japi.vault - package com.om.mxs.client.japi.vault
 
ConnectionDetails - Interface in com.om.mxs.client.japi
This interface defines the access methods for user information containers
Constants - Class in com.om.mxs.client.japi
This class declares useful constants
Constants() - Constructor for class com.om.mxs.client.japi.Constants
 
contains(String, String, boolean) - Static method in class com.om.mxs.client.japi.audit.AuditSearchTerm
Creates a simple search term which requires that given key should contain a value which has the specified string.
CONTENT - Static variable in class com.om.mxs.client.japi.Constants
Content Search Keys
CONTENT_TYPE - Static variable in class com.om.mxs.client.japi.Constants
 
copy(Credentials) - Static method in class com.om.mxs.client.japi.cred.Credentials
Creates safe copy of a given credentials.
create(byte[], byte[]) - Static method in class com.om.mxs.client.japi.cred.AccessKey
Creates new AccessKey
create(String, char[]) - Static method in class com.om.mxs.client.japi.cred.AccessKey
Creates new AccessKey
create(char[], char[]) - Static method in class com.om.mxs.client.japi.cred.AccessKey
Creates new AccessKey
create(String, String) - Static method in class com.om.mxs.client.japi.cred.AccessKey
Creates new AccessKey
create(String, String) - Static method in class com.om.mxs.client.japi.iam.AppCapability
Create a new AppCapability object.
createANDTerm(SearchTerm[]) - Static method in class com.om.mxs.client.japi.SearchTerm
Creates a search term as an AND combination of search terms
createNOTTerm(SearchTerm) - Static method in class com.om.mxs.client.japi.SearchTerm
Creates a search term as the negation of another search term
createObject() - Method in class com.om.mxs.client.japi.Vault
Creates a new object without any data nor metadata.
createObject(Attribute[]) - Method in class com.om.mxs.client.japi.Vault
Creates a new object without any data, just metadata.
createORTerm(SearchTerm[]) - Static method in class com.om.mxs.client.japi.SearchTerm
Creates a search term as an OR combination of search terms
createSimpleTerm(String, ByteBuffer) - Static method in class com.om.mxs.client.japi.SearchTerm
Creates a simple key-value search term
createSimpleTerm(String, String) - Static method in class com.om.mxs.client.japi.SearchTerm
Creates a simple key-value search term
createSimpleTerm(String, boolean) - Static method in class com.om.mxs.client.japi.SearchTerm
Creates a simple key-value search term
createSimpleTerm(String, int) - Static method in class com.om.mxs.client.japi.SearchTerm
Creates a simple key-value search term
createSimpleTerm(String, long) - Static method in class com.om.mxs.client.japi.SearchTerm
Creates a simple key-value search term
createSimpleTerm(Attribute) - Static method in class com.om.mxs.client.japi.SearchTerm
Creates a simple key-value search term defined by an attribute instance
createTextAttribute(String, String) - Static method in class com.om.mxs.client.japi.Attribute
Creates a searchable textual attribute.
createTextAttribute(String, String, boolean) - Static method in class com.om.mxs.client.japi.Attribute
Creates a searchable/non-searchable textual attribute.
creationTime() - Method in interface com.om.mxs.client.japi.MXFSFileAttributes
Returns the creation date of this object
Credentials - Class in com.om.mxs.client.japi.cred
Abstract credentials used to authenticate user or a service.
currentUserInformation() - Method in interface com.om.mxs.client.japi.IdentityManagement
Returns information for authenticated user
currentUserVaultsPrivileges() - Method in interface com.om.mxs.client.japi.IdentityManagement
Returns effective vault privileges for the current (authenticated) user

D

delete(String) - Method in interface com.om.mxs.client.japi.AttributeView
Deletes a user-defined attribute.
delete() - Method in class com.om.mxs.client.japi.MxsObject
Deletes this object from MatrixStore
deleteForcefully() - Method in class com.om.mxs.client.japi.MxsObject
Deletes this object from MatrixStore bypassing the trashcan
dispose() - Method in class com.om.mxs.client.japi.MatrixStore
Disposes of this MatrixStore instance and logs out.
dispose() - Method in class com.om.mxs.client.japi.Vault
Disposes the resources used by this instance.

E

endsWith(String, String, boolean) - Static method in class com.om.mxs.client.japi.audit.AuditSearchTerm
Creates a simple search term which requires that given key should contain a value that ends with specified string.
EntityType - Enum in com.om.mxs.client.japi
Type of an entity e.g.
equals(Object) - Method in class com.om.mxs.client.japi.Attribute
 
equals(Object) - Method in class com.om.mxs.client.japi.iam.AppCapability
 
equals(Object) - Method in class com.om.mxs.client.japi.iam.Permission
 
exist() - Method in class com.om.mxs.client.japi.Vault
true if and only if this vault exists in MatrixStore
exists() - Method in class com.om.mxs.client.japi.MxsObject
Returns true if this object exists in MatrixStore server or it's only in memory in the client.

F

fileKey() - Method in interface com.om.mxs.client.japi.MXFSFileAttributes
Returns an unique identifier of this object.
flush() - Method in class com.om.mxs.client.japi.MxsOutputStream
 
forName(String) - Static method in class com.om.mxs.client.japi.iam.Permission
 

G

getAddresses() - Method in interface com.om.mxs.client.japi.ConnectionDetails
 
getAddresses() - Method in class com.om.mxs.client.japi.UserInfo
Deprecated.
Returns the list of ip addresses
getAppCapabilities(String) - Method in interface com.om.mxs.client.japi.IdentityManagement
Returns the application capabilities assigned to the current user for the application specified
getApplicationName() - Method in class com.om.mxs.client.japi.iam.AppCapability
 
getAttributes() - Method in class com.om.mxs.client.japi.Vault
Returns a VaultAttributes object you can use to discover storage capacity.
getAttributeView() - Method in class com.om.mxs.client.japi.MxsObject
Opens a typed view to this objects' metadata.
getCapabilityId() - Method in class com.om.mxs.client.japi.iam.AppCapability
 
getClient() - Method in class com.om.mxs.client.japi.MatrixStore.MatrixStoreContext
 
getClient() - Method in class com.om.mxs.client.japi.Vault
 
getClient() - Method in class com.om.mxs.client.japi.Vault.VaultInternalContext
 
getClusterAttributesView() - Method in class com.om.mxs.client.japi.MatrixStore
Returns a ClusterAttributesView object that can be used to discover information about the cluster such as name and Id.
getClusterId() - Method in interface com.om.mxs.client.japi.ConnectionDetails
 
getClusterId() - Method in class com.om.mxs.client.japi.UserInfo
Deprecated.
Returns the cluster unique identifier
getClusterTime() - Method in class com.om.mxs.client.japi.MatrixStore
Returns current time on the cluster (number of milliseconds since epoch UTC)
getConnection() - Method in class com.om.mxs.client.japi.MatrixStore
Returns object representing connection to a cluster or null if connection has been closed
getCredentialsAsBytes() - Method in class com.om.mxs.client.japi.cred.AccessKeyBasedCredentials
 
getCredentialsAsBytes() - Method in class com.om.mxs.client.japi.cred.Credentials
Returns credential part of this instance as an byte[].
getCredentialsAsBytes() - Method in class com.om.mxs.client.japi.cred.UsernamePasswordCredentials
 
getEntityId() - Method in interface com.om.mxs.client.japi.iam.Privilege
Returns Id of an entity for which these permissions are defined
getEntityId() - Method in class com.om.mxs.client.japi.iam.Privilege.Impl
 
getEntityType() - Method in interface com.om.mxs.client.japi.iam.Privilege
Returns type of an entity for which these permissions are defined
getEntityType() - Method in class com.om.mxs.client.japi.iam.Privilege.Impl
 
getErrorCode(IOException) - Static method in class com.om.mxs.client.japi.Vault
Extracts the API error code embedded in an exception if thrown by this Java API
getFullName() - Method in interface com.om.mxs.client.japi.iam.UserInformation
Full name of a user
getId() - Method in class com.om.mxs.client.japi.cred.AccessKey
Returns ID of this AccessKey
getId() - Method in class com.om.mxs.client.japi.cred.AccessKeyBasedCredentials
Returns ID part of a backing AccessKey.
getId() - Method in interface com.om.mxs.client.japi.iam.UserInformation
Returns ID of the user
getId() - Method in class com.om.mxs.client.japi.MxsObject
Returns this object id
getId() - Method in class com.om.mxs.client.japi.Vault
Returns the unique identifier of the vault it is connected to
getId() - Method in interface com.om.mxs.client.japi.vault.VaultInfo
 
getIdentity() - Method in class com.om.mxs.client.japi.iam.IdentityPrivileges
Identity associated with the privileges returned in this object.
getIdentityId() - Method in class com.om.mxs.client.japi.iam.IdentityPrivileges
Id of the identity (user, group).
getIdentityManagement() - Method in class com.om.mxs.client.japi.MatrixStore
Returns an IdentityManagement service that can be used to discover the current user's privileges, user information and change their password.
getKey() - Method in class com.om.mxs.client.japi.Attribute
Returns this attribute key
getLogin() - Method in class com.om.mxs.client.japi.cred.UsernamePasswordCredentials
Returns user name (login) of a user.
getMXFSFileAttributeView() - Method in class com.om.mxs.client.japi.MxsObject
Opens a typed view to this objects' metadata.
getName() - Method in interface com.om.mxs.client.japi.MXFSFileAttributes
Returns the file name if this object is an MXFS object
getName() - Method in interface com.om.mxs.client.japi.vault.VaultInfo
 
getObject(String) - Method in class com.om.mxs.client.japi.Vault
Returns a reference to a MatrixStore object.
getParent() - Method in interface com.om.mxs.client.japi.MXFSFileAttributes
Returns the parent object id if this object is an MXFS object
getPassword() - Method in interface com.om.mxs.client.japi.ConnectionDetails
 
getPassword() - Method in class com.om.mxs.client.japi.cred.UsernamePasswordCredentials
Returns name of a Space.
getPassword() - Method in class com.om.mxs.client.japi.UserInfo
Deprecated.
Returns the user password
getPermissions() - Method in interface com.om.mxs.client.japi.iam.Privilege
Returns non-null, immutable set of permissions associated with an entity.
getPermissions() - Method in class com.om.mxs.client.japi.iam.Privilege.Impl
 
getPrincipal() - Method in class com.om.mxs.client.japi.cred.AccessKeyBasedCredentials
 
getPrincipal() - Method in class com.om.mxs.client.japi.cred.Credentials
Returns principal part of this instance as a String representation.
getPrincipal() - Method in class com.om.mxs.client.japi.cred.UsernamePasswordCredentials
 
getPrincipalAsBytes() - Method in class com.om.mxs.client.japi.cred.AccessKeyBasedCredentials
 
getPrincipalAsBytes() - Method in class com.om.mxs.client.japi.cred.Credentials
Returns principal part of this instance as a byte[].
getPrincipalAsBytes() - Method in class com.om.mxs.client.japi.cred.UsernamePasswordCredentials
 
getPrivileges() - Method in class com.om.mxs.client.japi.iam.IdentityPrivileges
An array of Privileges.
getProps() - Method in interface com.om.mxs.client.japi.audit.AuditEntry
Returns unmodifiable map with key-value pairs, properties of the audit entry
getProtocol() - Method in interface com.om.mxs.client.japi.ConnectionDetails
 
getProtocol() - Method in class com.om.mxs.client.japi.UserInfo
Deprecated.
Returns the communication protocol to be used by this user
getSecret() - Method in class com.om.mxs.client.japi.cred.AccessKey
Returns String representation of the secret for this AccessKey
getSecret() - Method in class com.om.mxs.client.japi.cred.AccessKeyBasedCredentials
Returns secret part of a backing AccessKey.
getSecretAsBytes() - Method in class com.om.mxs.client.japi.cred.AccessKey
Returns byte representation of the secret for this AccessKey
getSpaceId() - Method in interface com.om.mxs.client.japi.iam.UserInformation
ID of a space to which user belongs to.
getSpaceName() - Method in class com.om.mxs.client.japi.cred.UsernamePasswordCredentials
Returns name of a Space used by this Credentials.
getTimestamp() - Method in interface com.om.mxs.client.japi.audit.AuditEntry
Returns an epoch of this audit entry.
getUid() - Method in interface com.om.mxs.client.japi.audit.AuditEntry
Returns unique Id of the audit entry.
getUser() - Method in interface com.om.mxs.client.japi.ConnectionDetails
 
getUser() - Method in class com.om.mxs.client.japi.UserInfo
Deprecated.
Returns the user unique identifier
getUserCapabilities() - Method in class com.om.mxs.client.japi.Vault
Returns the user capabilities of this vault
getValue() - Method in class com.om.mxs.client.japi.Attribute
Returns this attribute value wrapped in an object.
getValue(Object) - Method in class com.om.mxs.client.japi.Attribute
Returns this attribute value based on a default value type.
getVault() - Method in interface com.om.mxs.client.japi.ConnectionDetails
 
getVault() - Method in class com.om.mxs.client.japi.MxsObject
Returns a reference to the vault this object belongs to.
getVault() - Method in class com.om.mxs.client.japi.UserInfo
Deprecated.
Returns the vault unique identifier

H

hashCode() - Method in class com.om.mxs.client.japi.Attribute
 
hashCode() - Method in class com.om.mxs.client.japi.iam.AppCapability
 
hashCode() - Method in class com.om.mxs.client.japi.iam.Permission
 
hasPermission(Permission) - Method in interface com.om.mxs.client.japi.iam.Privilege
Returns true if this privilege contains specified permission, otherwise false.
hasPermission(Permission) - Method in class com.om.mxs.client.japi.iam.Privilege.Impl
 
hasPermissionOn(String, Permission) - Method in class com.om.mxs.client.japi.iam.IdentityPrivileges
 
hasReplicaCopy() - Method in class com.om.mxs.client.japi.MxsObject
Checks if the object has a copy on replica vault
HTML - Static variable in class com.om.mxs.client.japi.Constants
 

I

IdentityManagement - Interface in com.om.mxs.client.japi
Provides information about users and permissions.
IdentityPrivileges - Class in com.om.mxs.client.japi.iam
Represents privileges of an identity (user, group).
IdentityPrivileges() - Constructor for class com.om.mxs.client.japi.iam.IdentityPrivileges
 
IdentityPrivileges.Builder - Class in com.om.mxs.client.japi.iam
 
Impl() - Constructor for class com.om.mxs.client.japi.iam.Privilege.Impl
 
isDirectory() - Method in interface com.om.mxs.client.japi.MXFSFileAttributes
Returns true if this object is an MXFS directory
isEqual(String, String, boolean) - Static method in class com.om.mxs.client.japi.audit.AuditSearchTerm
Creates a simple search term which requires that given key should equal specified value.
isIndexed() - Method in class com.om.mxs.client.japi.MxsObject
Returns true if the object has been indexed.
isMarkedReducibleToSingleInstance() - Method in class com.om.mxs.client.japi.MxsObject
Check if the object has been marked as 'reducible to single instance'
isOnline() - Method in class com.om.mxs.client.japi.MxsObject
Returns true if the object is online.
isOther() - Method in interface com.om.mxs.client.japi.MXFSFileAttributes
Returns true if this object not an MXFS or DropSpot object
isRegularFile() - Method in interface com.om.mxs.client.japi.MXFSFileAttributes
Returns true if this object is an MXFS file
isSymbolicLink() - Method in interface com.om.mxs.client.japi.MXFSFileAttributes
Returns true if this object is an MXFS symbolic link
iterator(int) - Method in interface com.om.mxs.client.japi.ObjectAttributeView
Returns an iterator to the user-defined attributes defined for the object this view relates to.
iterator() - Method in interface com.om.mxs.client.japi.ObjectAttributeView
Returns an iterator to the user-defined attributes defined for the object this view relates to.

L

lastAccessTime() - Method in interface com.om.mxs.client.japi.MXFSFileAttributes
Returns the last access time if available
lastModifiedTime() - Method in interface com.om.mxs.client.japi.MXFSFileAttributes
Returns the last modified time
list() - Method in interface com.om.mxs.client.japi.AttributeView
Returns a list containing the names of the user-defined attributes.
listVaults() - Method in class com.om.mxs.client.japi.MatrixStore
Returns an Iterator of VaultInfo objects, one for each vault in the space.

M

makeOffline(String) - Method in class com.om.mxs.client.japi.MxsObject
Makes an object offline.
makeOnline() - Method in class com.om.mxs.client.japi.MxsObject
Makes an object online.
mark(int) - Method in class com.om.mxs.client.japi.MxsInputStream
 
markReducibleToSingleInstance() - Method in class com.om.mxs.client.japi.MxsObject
Attempt to mark the object as 'reducible to single instance'
markSupported() - Method in class com.om.mxs.client.japi.MxsInputStream
 
MatrixStore - Class in com.om.mxs.client.japi
This class is the entry point for any operation on a MatrixStore server.
MatrixStore() - Constructor for class com.om.mxs.client.japi.MatrixStore
Deprecated.
MatrixStore.MatrixStoreContext - Class in com.om.mxs.client.japi
 
MatrixStoreBuilder - Class in com.om.mxs.client.japi
Helper builder class to instantiate MatrixStore object.
MatrixStoreConnection - Class in com.om.mxs.client.japi
A network connection resource required to communicate with a single MatrixStore Cluster.
MatrixStoreConnection.MatrixStoreConnectionBuilder - Class in com.om.mxs.client.japi
Builder for creating new instances of MatrixStoreConnection.
MSWORD - Static variable in class com.om.mxs.client.japi.Constants
 
MXFSFileAttributes - Interface in com.om.mxs.client.japi
This interface defines MXFS or filesystem-like information related to an object.
MXFSFileAttributeView - Interface in com.om.mxs.client.japi
This interface defines a view to MatrixStore object attributes related to MXFS or filesystem-like attributes, e.g.
MxsByteChannel - Interface in com.om.mxs.client.japi
MxsByteChannel interface for JAPI A simple ByteChannel with cancel() option
MXSERR_AMBERSTATUS - Static variable in interface com.om.mxs.client.api.MxsErrors
Careful, the server entered in amber status
MXSERR_BADTRANSMISSION - Static variable in interface com.om.mxs.client.api.MxsErrors
Bad transmission
MXSERR_CHECKSUMERROR - Static variable in interface com.om.mxs.client.api.MxsErrors
Checksum mismatch between server and client
MXSERR_CLIENT - Static variable in interface com.om.mxs.client.api.MxsErrors
client errors base
MXSERR_CLOSEDOBJECT - Static variable in interface com.om.mxs.client.api.MxsErrors
Accessing an already closed object
MXSERR_CONNECTIONBROKEN - Static variable in interface com.om.mxs.client.api.MxsErrors
Connection broken
MXSERR_ENTITYNOTFOUND - Static variable in interface com.om.mxs.client.api.MxsErrors
Entity not found
MXSERR_EOF - Static variable in interface com.om.mxs.client.api.MxsErrors
End of object data reached
MXSERR_EXISTINGATTRIBUTE - Static variable in interface com.om.mxs.client.api.MxsErrors
Attribute already existing
MXSERR_EXISTINGOBJECT - Static variable in interface com.om.mxs.client.api.MxsErrors
Entity already existing (vault, user, etc..)
MXSERR_FILESYS - Static variable in interface com.om.mxs.client.api.MxsErrors
File system error
MXSERR_INVALIDATTRIBUTE - Static variable in interface com.om.mxs.client.api.MxsErrors
Invalid attribute, it does not exist
MXSERR_INVALIDCLUSTER - Static variable in interface com.om.mxs.client.api.MxsErrors
Invalid cluster id
MXSERR_INVALIDOBJECT - Static variable in interface com.om.mxs.client.api.MxsErrors
Invalid object, it does not exist
MXSERR_INVALIDOPERATION - Static variable in interface com.om.mxs.client.api.MxsErrors
Invalid operation
MXSERR_INVALIDPARAMETER - Static variable in interface com.om.mxs.client.api.MxsErrors
Invalid parameter
MXSERR_INVALIDREFERENCE - Static variable in interface com.om.mxs.client.api.MxsErrors
Invalid mxsapi object reference
MXSERR_INVALIDUSER - Static variable in interface com.om.mxs.client.api.MxsErrors
Invalid user
MXSERR_INVALIDVAULT - Static variable in interface com.om.mxs.client.api.MxsErrors
Invalid vault
MXSERR_MXSQUOTAEXCEEDED - Static variable in interface com.om.mxs.client.api.MxsErrors
MatrixStore quota exceeded
MXSERR_NETWORK - Static variable in interface com.om.mxs.client.api.MxsErrors
network errors base
MXSERR_NOERR - Static variable in interface com.om.mxs.client.api.MxsErrors
no error code
MXSERR_NOMEM - Static variable in interface com.om.mxs.client.api.MxsErrors
Not enough memory buffer space
MXSERR_NOSUCHELEMENT - Static variable in interface com.om.mxs.client.api.MxsErrors
Iteration has no more elements
MXSERR_NOTSECGUARD - Static variable in interface com.om.mxs.client.api.MxsErrors
Security guard is running on another node
MXSERR_OBJECTINRETENTION - Static variable in interface com.om.mxs.client.api.MxsErrors
Could not delete object, retention period not expired
MXSERR_OBJECTOFFLINE - Static variable in interface com.om.mxs.client.api.MxsErrors
Object is offline
MXSERR_OBJECTONLINE - Static variable in interface com.om.mxs.client.api.MxsErrors
Object is online
MXSERR_OPERATIONNOTALLOWED - Static variable in interface com.om.mxs.client.api.MxsErrors
Operation not allowed for the current user
MXSERR_OPERATIONNOTSUPPORTED - Static variable in interface com.om.mxs.client.api.MxsErrors
Operation not supported
MXSERR_OUTOFMEMORY - Static variable in interface com.om.mxs.client.api.MxsErrors
Client out of memory
MXSERR_QUOTAEXCEEDED - Static variable in interface com.om.mxs.client.api.MxsErrors
Vault quota exceeded
MXSERR_REDSTATUS - Static variable in interface com.om.mxs.client.api.MxsErrors
Careful, the server entered in red status
MXSERR_SERVER - Static variable in interface com.om.mxs.client.api.MxsErrors
server errors base
MXSERR_SERVERBUSY - Static variable in interface com.om.mxs.client.api.MxsErrors
Server too busy to answer
MXSERR_TOMBSTONE - Static variable in interface com.om.mxs.client.api.MxsErrors
Could not access object, it is a tombstone
MXSERR_TYPEMISMATCH - Static variable in interface com.om.mxs.client.api.MxsErrors
Expected type different from real type
MXSERR_UNABLETOLOCKOBJECT - Static variable in interface com.om.mxs.client.api.MxsErrors
Unable to lock object
MXSERR_UNEXPECTEDRESULT - Static variable in interface com.om.mxs.client.api.MxsErrors
Unexpected result from the server
MXSERR_UNKNOWN - Static variable in interface com.om.mxs.client.api.MxsErrors
Unknown error in the server
MXSERR_UNKNOWNNODE - Static variable in interface com.om.mxs.client.api.MxsErrors
Could not contact the given server
MxsErrors - Interface in com.om.mxs.client.api
This interface provides the definition of all error codes that can be returned by the MatrixStore API in the form of MxsException's.
MxsInputStream - Class in com.om.mxs.client.japi
Abstract class to be used as InputStream interface for JAPI A simple InputStream with a cancel option
MxsInputStream() - Constructor for class com.om.mxs.client.japi.MxsInputStream
 
MxsObject - Class in com.om.mxs.client.japi
Access class to MatrixStore objects.
MxsOutputStream - Class in com.om.mxs.client.japi
Abstract class to be used as OutputStream interface for JAPI A simple OutputStream with a cancel option
MxsOutputStream() - Constructor for class com.om.mxs.client.japi.MxsOutputStream
 

N

name() - Method in interface com.om.mxs.client.japi.AttributeView
Returns the name of this attribute view.
name() - Method in class com.om.mxs.client.japi.iam.Permission
 
name() - Method in interface com.om.mxs.client.japi.MXFSFileAttributeView
Returns the name of this attribute view.
newAccessKeyCredentials(AccessKey) - Static method in class com.om.mxs.client.japi.cred.Credentials
Creates new authentication Credentials using provided AccessKey.
newAccessKeyCredentials(String, String) - Static method in class com.om.mxs.client.japi.cred.Credentials
Creates new authentication Credentials from provided ID and a secret of an AccessKey.
newAccessKeyCredentials(char[], char[]) - Static method in class com.om.mxs.client.japi.cred.Credentials
Creates new authentication Credentials from provided ID and a secret of an AccessKey.
newInputStream() - Method in class com.om.mxs.client.japi.MxsObject
Creates an input stream from this object's data
newInputStream(int) - Method in class com.om.mxs.client.japi.MxsObject
Creates an input stream from this object's data, using the specified chunk size (in mb)
newObjectChannel(AccessOption) - Method in class com.om.mxs.client.japi.MxsObject
Creates a channel to this object's data
newObjectChannel(AccessOption, int) - Method in class com.om.mxs.client.japi.MxsObject
Creates a channel to this object's data, with the given chunk size to read (in mb)
newOutputStream() - Method in class com.om.mxs.client.japi.MxsObject
Creates an output stream to this object's data
newSeekableObjectChannel(Set<AccessOption>) - Method in class com.om.mxs.client.japi.MxsObject
Creates a random access channel to this object's data
newSeekableObjectChannel(Set<AccessOption>, int) - Method in class com.om.mxs.client.japi.MxsObject
Creates a random access channel to this object's data If only option READ is supplied, then stream with given chunk size is created
newSpacenameUsernamePasswordCredentials(String, String, String) - Static method in class com.om.mxs.client.japi.cred.Credentials
Creates new authentication Credentials from a given user details: Space name, login and a password of a user.
newSpacenameUsernamePasswordCredentials(String, String, char[]) - Static method in class com.om.mxs.client.japi.cred.Credentials
Creates new authentication Credentials from a given user details: Space name, login and a password of a user.
newUsernamePasswordCredentials(String, String) - Static method in class com.om.mxs.client.japi.cred.Credentials
Creates new authentication Credentials using an empty String as a Space name, provided user's login and a password.
newUsernamePasswordCredentials(String, char[]) - Static method in class com.om.mxs.client.japi.cred.Credentials
Creates new authentication Credentials using an empty String as a Space name, provided user's login and a password.
not(AuditSearchTerm) - Static method in class com.om.mxs.client.japi.audit.AuditSearchTerm
Creates negation from given term.

O

ObjectAttributeView - Interface in com.om.mxs.client.japi
This interface defines a view to MatrixStore user-defined object attributes.
ObjectTypedAttributeView - Interface in com.om.mxs.client.japi
This interface defines a typed-protected view to MatrixStore user-defined object attributes.
online() - Method in class com.om.mxs.client.japi.Vault
Tests whether the connection to MatrixStore can be established.
openVault(UserInfo) - Static method in class com.om.mxs.client.japi.MatrixStore
Deprecated.
openVault(String) - Method in class com.om.mxs.client.japi.MatrixStore
Provides access to a vault with a given ID.
or(AuditSearchTerm[]) - Static method in class com.om.mxs.client.japi.audit.AuditSearchTerm
Creates OR term from given terms.

P

PDF - Static variable in class com.om.mxs.client.japi.Constants
 
Permission - Class in com.om.mxs.client.japi.iam
Represents a single permission of a user or a group.
permissionsForEntity(String) - Method in class com.om.mxs.client.japi.iam.IdentityPrivileges
 
position() - Method in interface com.om.mxs.client.japi.SeekableByteChannel
Returns this channel's position
position(long) - Method in interface com.om.mxs.client.japi.SeekableByteChannel
Sets this channel's position.
Privilege - Interface in com.om.mxs.client.japi.iam
Represents a set of permissions on a specific entity e.g.
Privilege.Builder - Class in com.om.mxs.client.japi.iam
 
Privilege.Impl - Class in com.om.mxs.client.japi.iam
 

R

read(String, ByteBuffer) - Method in interface com.om.mxs.client.japi.AttributeView
Read the value of a user-defined attribute into a buffer.
read() - Method in class com.om.mxs.client.japi.MxsInputStream
 
read(byte[]) - Method in class com.om.mxs.client.japi.MxsInputStream
 
read(byte[], int, int) - Method in class com.om.mxs.client.japi.MxsInputStream
 
readAttributes() - Method in interface com.om.mxs.client.japi.MXFSFileAttributeView
Reads the basic MXFS file attributes as a bulk operation
readBoolean(String) - Method in interface com.om.mxs.client.japi.ObjectTypedAttributeView
Reads a boolean attribute value
readFloat(String) - Method in interface com.om.mxs.client.japi.ObjectTypedAttributeView
Reads a long attribute value
readInt(String) - Method in interface com.om.mxs.client.japi.ObjectTypedAttributeView
Reads a integer attribute value
readLong(String) - Method in interface com.om.mxs.client.japi.ObjectTypedAttributeView
Reads a long attribute value
readString(String) - Method in interface com.om.mxs.client.japi.ObjectTypedAttributeView
Reads a string attribute value
readText(String) - Method in interface com.om.mxs.client.japi.ObjectTypedAttributeView
Read a String representation of a textual value
reset() - Method in class com.om.mxs.client.japi.MxsInputStream
 
retrieveAccessKey(String) - Method in interface com.om.mxs.client.japi.IdentityManagement
Returns AccessKey associated with a given AccessKey ID.
RTF - Static variable in class com.om.mxs.client.japi.Constants
 

S

searchAudits(long) - Method in class com.om.mxs.client.japi.Vault
Searches vault for all audit entries for which creation time is newer or equal to given fromMs timestamp.
searchAudits(long, long) - Method in class com.om.mxs.client.japi.Vault
Searches vault for all audit entries for which creation time is newer or equal to given fromMs timestamp and lower than toMs timestamp.
searchAudits(long, AuditSearchTerm) - Method in class com.om.mxs.client.japi.Vault
Searches vault for all audit entries for which creation time is newer or equal to given fromMs timestamp.
searchAudits(long, long, AuditSearchTerm) - Method in class com.om.mxs.client.japi.Vault
Searches vault for all audit entries for which creation time is newer or equal to given fromMs timestamp and lower than toMs timestamp.
searchObjects(SearchTerm, int) - Method in class com.om.mxs.client.japi.Vault
Searches for objects matching a metadata search term.
searchObjects(Attribute, int) - Method in class com.om.mxs.client.japi.Vault
Searches for objects containing a specific metadata attribute.
searchObjectsIterator(SearchTerm, int) - Method in class com.om.mxs.client.japi.Vault
Searches for objects matching a metadata search term.
searchObjectsIterator(Attribute, int) - Method in class com.om.mxs.client.japi.Vault
Searches for objects containing a specific metadata attribute.
SearchTerm - Class in com.om.mxs.client.japi
This class contains factory methods to create search terms to find MatrixStore objects.
SeekableByteChannel - Interface in com.om.mxs.client.japi
This interface defines a seekable channel.
set(int) - Method in interface com.om.mxs.client.japi.ObjectAttributeView
Returns the set of user-defined attributes defined for the object this view relates to.
set() - Method in interface com.om.mxs.client.japi.ObjectAttributeView
Returns the set of user-defined attributes defined for the object this view relates to.
setEntityId(String) - Method in class com.om.mxs.client.japi.iam.Privilege.Builder
 
setEntityType(EntityType) - Method in class com.om.mxs.client.japi.iam.Privilege.Builder
 
setEntityType(int) - Method in class com.om.mxs.client.japi.iam.Privilege.Builder
 
setPrivileges(Set<Permission>) - Method in class com.om.mxs.client.japi.iam.Privilege.Builder
 
setSearchableInContentDB(boolean) - Method in class com.om.mxs.client.japi.Attribute
Marks attribute as searchable/non-searchable in cluster's content DB.
size(String) - Method in interface com.om.mxs.client.japi.AttributeView
Returns the size of the value of a user-defined attribute.
size() - Method in interface com.om.mxs.client.japi.MXFSFileAttributes
Returns the size of this object
size() - Method in interface com.om.mxs.client.japi.SeekableByteChannel
Returns the current size of entity to which this channel is connected.
skip(long) - Method in class com.om.mxs.client.japi.MxsInputStream
 
startsWith(String, String, boolean) - Static method in class com.om.mxs.client.japi.audit.AuditSearchTerm
Creates a simple search term which requires that given key should contain a value that starts with specified string.
submitMakeOnline() - Method in class com.om.mxs.client.japi.MxsObject
Initiates asynchronous operation of restoring this object to online state.

T

TEXT - Static variable in class com.om.mxs.client.japi.Constants
Content Search Types
toString() - Method in class com.om.mxs.client.japi.iam.AppCapability
 
toString() - Method in class com.om.mxs.client.japi.iam.Permission
 
toString() - Method in class com.om.mxs.client.japi.iam.Privilege.Impl
 
toString() - Method in class com.om.mxs.client.japi.UserCapabilities
Returns the string representation of the user capabilities with the following format:
totalSpace() - Method in interface com.om.mxs.client.japi.metadata.VaultAttributes
 
truncate(long) - Method in interface com.om.mxs.client.japi.SeekableByteChannel
Truncates the entity, to which this channel is connected, to the given size.
typeForIntValue(int) - Static method in enum com.om.mxs.client.japi.EntityType
 

U

unallocatedSpace() - Method in interface com.om.mxs.client.japi.metadata.VaultAttributes
 
usableSpace() - Method in interface com.om.mxs.client.japi.metadata.VaultAttributes
 
UserCapabilities - Class in com.om.mxs.client.japi
Represents capabilities of a user
UserInfo - Class in com.om.mxs.client.japi
Deprecated.
As of MatrixStore 4.0. Use Credentials instead for username or access key and MatrixStoreConnection for cluster addresses. See MatrixStore doc for usage example.
UserInfo(String, String, String, String, String) - Constructor for class com.om.mxs.client.japi.UserInfo
Deprecated.
Initialises a new instance of this class
UserInfo(String, String, String, String, String, String) - Constructor for class com.om.mxs.client.japi.UserInfo
Deprecated.
Initialises a new instance of this class
UserInfo(String[], String, String, String, String, String) - Constructor for class com.om.mxs.client.japi.UserInfo
Deprecated.
Initialises a new instance of this class
UserInformation - Interface in com.om.mxs.client.japi.iam
User information.
UsernamePasswordCredentials - Class in com.om.mxs.client.japi.cred
Authentication credentials based on username (login) and a password.

V

valueAsInt() - Method in enum com.om.mxs.client.japi.EntityType
Returns int value for this type.
valueOf(String) - Static method in enum com.om.mxs.client.japi.AccessOption
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.om.mxs.client.japi.EntityType
Returns the enum constant of this type with the specified name.
values() - Static method in enum com.om.mxs.client.japi.AccessOption
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.om.mxs.client.japi.EntityType
Returns an array containing the constants of this enum type, in the order they are declared.
Vault - Class in com.om.mxs.client.japi
This class represents a connection to a MatrixStore Vault.
Vault.VaultInternalContext - Class in com.om.mxs.client.japi
Internal purposes only
VaultAttributes - Interface in com.om.mxs.client.japi.metadata
Reveals information related to vault storage capacity.
VaultInfo - Interface in com.om.mxs.client.japi.vault
Basic descriptive information about a vault.

W

withClusterId(String) - Method in class com.om.mxs.client.japi.MatrixStoreConnection.MatrixStoreConnectionBuilder
Id of the cluster you are connecting to.
withConnection(MatrixStoreConnection) - Method in class com.om.mxs.client.japi.MatrixStoreBuilder
Connection to use for the life time of the MatrixStore instance.
withCredentials(Credentials) - Method in class com.om.mxs.client.japi.MatrixStoreBuilder
Must be one of either UsernamePasswordCredentials, where user login and password are given, or AccessKeyBasedCredentials, where a user's access key id and secret is used.
withHosts(String[]) - Method in class com.om.mxs.client.japi.MatrixStoreConnection.MatrixStoreConnectionBuilder
Host addresses of the cluster you are connecting to.
withIdentity(Identity) - Method in class com.om.mxs.client.japi.iam.IdentityPrivileges.Builder
 
withIdentity(IdentityType, String) - Method in class com.om.mxs.client.japi.iam.IdentityPrivileges.Builder
 
withPrivileges(Privilege[]) - Method in class com.om.mxs.client.japi.iam.IdentityPrivileges.Builder
 
withProtocolName(String) - Method in class com.om.mxs.client.japi.MatrixStoreConnection.MatrixStoreConnectionBuilder
A specific RPC protocol to use with this connection.
write(String, ByteBuffer) - Method in interface com.om.mxs.client.japi.AttributeView
Writes the value of a user-defined attribute from a buffer.
write(byte[]) - Method in class com.om.mxs.client.japi.MxsOutputStream
 
write(byte[], int, int) - Method in class com.om.mxs.client.japi.MxsOutputStream
 
write(int) - Method in class com.om.mxs.client.japi.MxsOutputStream
 
write(String, ByteBuffer, boolean) - Method in interface com.om.mxs.client.japi.ObjectAttributeView
Writes the value of a user-defined attribute from a buffer.
write(String, ByteBuffer, boolean, boolean) - Method in interface com.om.mxs.client.japi.ObjectAttributeView
See description for int write(String name, ByteBuffer src, boolean searchable)
writeAllAttributes(Collection<Attribute>) - Method in interface com.om.mxs.client.japi.ObjectTypedAttributeView
Write all given attributes.
writeAttribute(Attribute) - Method in interface com.om.mxs.client.japi.ObjectTypedAttributeView
Write the given attribute.
writeBoolean(String, boolean) - Method in interface com.om.mxs.client.japi.ObjectTypedAttributeView
Writes a boolean valued metadata attribute
writeBoolean(String, boolean, boolean) - Method in interface com.om.mxs.client.japi.ObjectTypedAttributeView
Writes a boolean valued metadata attribute
writeBoolean(String, boolean, boolean, boolean) - Method in interface com.om.mxs.client.japi.ObjectTypedAttributeView
Writes a boolean valued metadata attribute
writeFloat(String, float) - Method in interface com.om.mxs.client.japi.ObjectTypedAttributeView
Writes a float valued metadata attribute
writeFloat(String, float, boolean) - Method in interface com.om.mxs.client.japi.ObjectTypedAttributeView
Writes a float valued metadata attribute
writeFloat(String, float, boolean, boolean) - Method in interface com.om.mxs.client.japi.ObjectTypedAttributeView
Writes a float valued metadata attribute
writeInt(String, int) - Method in interface com.om.mxs.client.japi.ObjectTypedAttributeView
Writes a integer valued metadata attribute
writeInt(String, int, boolean) - Method in interface com.om.mxs.client.japi.ObjectTypedAttributeView
Writes a integer valued metadata attribute
writeInt(String, int, boolean, boolean) - Method in interface com.om.mxs.client.japi.ObjectTypedAttributeView
Writes a integer valued metadata attribute
writeLong(String, long) - Method in interface com.om.mxs.client.japi.ObjectTypedAttributeView
Writes a long valued metadata attribute
writeLong(String, long, boolean) - Method in interface com.om.mxs.client.japi.ObjectTypedAttributeView
Writes a long valued metadata attribute
writeLong(String, long, boolean, boolean) - Method in interface com.om.mxs.client.japi.ObjectTypedAttributeView
Writes a long valued metadata attribute
writeString(String, String) - Method in interface com.om.mxs.client.japi.ObjectTypedAttributeView
Writes a string valued metadata attribute.
writeString(String, String, boolean) - Method in interface com.om.mxs.client.japi.ObjectTypedAttributeView
Writes a string valued metadata attribute.
writeString(String, String, boolean, boolean) - Method in interface com.om.mxs.client.japi.ObjectTypedAttributeView
Writes a string valued metadata attribute.
writeText(String, String) - Method in interface com.om.mxs.client.japi.ObjectTypedAttributeView
Write metadata as textual value.
writeText(String, String, boolean, boolean) - Method in interface com.om.mxs.client.japi.ObjectTypedAttributeView
Write metadata as textual value.
A B C D E F G H I L M N O P R S T U V W 
Skip navigation links