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

A

abortAndPause() - Method in interface org.apache.jackrabbit.oak.api.jmx.IndexStatsMBean

ACCESS - Static variable in exception org.apache.jackrabbit.oak.api.CommitFailedException

Type name for access violation (i.e.

ACCESS_CONTROL - Static variable in exception org.apache.jackrabbit.oak.api.CommitFailedException

Type name for access control violation errors.

addChild(String) - Method in interface org.apache.jackrabbit.oak.api.Tree

Add a child with the given name.

asRepositoryException() - Method in exception org.apache.jackrabbit.oak.api.CommitFailedException

Wraps the given CommitFailedException instance using the appropriate RepositoryException subclass based on the type of the given exception.

asRepositoryException(String) - Method in exception org.apache.jackrabbit.oak.api.CommitFailedException

Wraps the given CommitFailedException instance using the appropriate RepositoryException subclass based on the type of the given exception.

AuthInfo - Interface in org.apache.jackrabbit.oak.api

AuthInfo instances provide access to information related to authentication and authorization of a given content session.

B

BINARIES - Static variable in class org.apache.jackrabbit.oak.api.Type

Map Iterable<Blob> to array of PropertyType.BINARY

BINARY - Static variable in class org.apache.jackrabbit.oak.api.Type

Map Blob to PropertyType.BINARY

Blob - Interface in org.apache.jackrabbit.oak.api

Immutable representation of a binary value of finite length.

BOOLEAN - Static variable in class org.apache.jackrabbit.oak.api.Type

Map Boolean to PropertyType.BOOLEAN

BOOLEANS - Static variable in class org.apache.jackrabbit.oak.api.Type

Map Iterable<Boolean> to array of PropertyType.BOOLEAN

C

cacheInfoAsString() - Method in interface org.apache.jackrabbit.oak.api.jmx.CacheStatsMBean

Gathers the stats of the cache for logging.

cacheInfoAsString() - Method in interface org.apache.jackrabbit.oak.api.jmx.PersistentCacheStatsMBean

CacheStatsMBean - Interface in org.apache.jackrabbit.oak.api.jmx

cancelRevisionGC() - Method in interface org.apache.jackrabbit.oak.api.jmx.RepositoryManagementMBean

Cancel a running revision garbage collection operation.

cancelRevisionGCForRole(String) - Method in interface org.apache.jackrabbit.oak.api.jmx.RepositoryManagementMBean

Cancel a running revision garbage collection operation for a given role.

checkpoint(long) - Method in interface org.apache.jackrabbit.oak.api.jmx.FileStoreBackupRestoreMBean

Deprecated.

Use CheckpointMBean instead

checkpoint(long) - Method in interface org.apache.jackrabbit.oak.api.jmx.RepositoryManagementMBean

Deprecated.

Use CheckpointMBean instead

CheckpointMBean - Interface in org.apache.jackrabbit.oak.api.jmx

MBean for managing org.apache.jackrabbit.oak.spi.state.NodeStore#checkpoint checkpoints.

commit(Map<String, Object>) - Method in interface org.apache.jackrabbit.oak.api.Root

Atomically persists all changes made to the tree attached to this root.

commit() - Method in interface org.apache.jackrabbit.oak.api.Root

Atomically persists all changes made to the tree attached to this root.

COMMIT_PATH - Static variable in interface org.apache.jackrabbit.oak.api.Root

Name of the entry of the commit path in the info map in Root.commit(java.util.Map)

CommitFailedException - Exception in org.apache.jackrabbit.oak.api

Main exception thrown by methods defined on the ContentSession interface indicating that committing a given set of changes failed.

CommitFailedException(String, String, int, String, Throwable) - Constructor for exception org.apache.jackrabbit.oak.api.CommitFailedException

CommitFailedException(String, int, String, Throwable) - Constructor for exception org.apache.jackrabbit.oak.api.CommitFailedException

CommitFailedException(String, int, String) - Constructor for exception org.apache.jackrabbit.oak.api.CommitFailedException

compareTo(Type<?>) - Method in class org.apache.jackrabbit.oak.api.Type

ConsolidatedCacheStatsMBean - Interface in org.apache.jackrabbit.oak.api.jmx

ConsolidatedDataStoreCacheStatsMBean - Interface in org.apache.jackrabbit.oak.api.jmx

CONSTRAINT - Static variable in exception org.apache.jackrabbit.oak.api.CommitFailedException

Type name for constraint violation errors.

ContentRepository - Interface in org.apache.jackrabbit.oak.api

Oak content repository.

ContentSession - Interface in org.apache.jackrabbit.oak.api

Authentication session for accessing a content repository.

CopyOnWriteStoreMBean - Interface in org.apache.jackrabbit.oak.api.jmx

MBean for managing the copy-on-write node store

count() - Method in interface org.apache.jackrabbit.oak.api.PropertyState

The number of values of this property.

count() - Method in interface org.apache.jackrabbit.oak.api.PropertyValue

The number of values of this object.

createBlob(InputStream) - Method in interface org.apache.jackrabbit.oak.api.Root

Reads (and closes) the given stream and returns a Blob that contains that binary.

createCheckpoint(long) - Method in interface org.apache.jackrabbit.oak.api.jmx.CheckpointMBean

Create a new checkpoint with the given lifetime.

D

DATE - Static variable in class org.apache.jackrabbit.oak.api.Type

Map String to PropertyType.DATE

DATES - Static variable in class org.apache.jackrabbit.oak.api.Type

Map Iterable<String> to array of PropertyType.DATE

DECIMAL - Static variable in class org.apache.jackrabbit.oak.api.Type

Map BigDecimal to PropertyType.DECIMAL

DECIMALS - Static variable in class org.apache.jackrabbit.oak.api.Type

Map Iterable<BigDecimal> to array of PropertyType.DECIMAL

Description - Annotation Type in org.apache.jackrabbit.oak.api.jmx

Produces a description that will be used by JMX metadata.

Descriptors - Interface in org.apache.jackrabbit.oak.api

Repository descriptors interface that is used to support providing the repository descriptors of Repository

disableCopyOnWrite() - Method in interface org.apache.jackrabbit.oak.api.jmx.CopyOnWriteStoreMBean

Disables the temporary store and switched the repository back to the "normal" mode.

DOUBLE - Static variable in class org.apache.jackrabbit.oak.api.Type

Map Double to PropertyType.DOUBLE

DOUBLES - Static variable in class org.apache.jackrabbit.oak.api.Type

Map Iterable<Double> to array of PropertyType.DOUBLE

E

EMPTY - Static variable in interface org.apache.jackrabbit.oak.api.AuthInfo

EMPTY_ARRAY - Static variable in interface org.apache.jackrabbit.oak.api.Tree

Empty array of trees.

enableCopyOnWrite() - Method in interface org.apache.jackrabbit.oak.api.jmx.CopyOnWriteStoreMBean

Enabled the temporary, copy-on-write store

equals(Object) - Method in class org.apache.jackrabbit.oak.api.Type

estimateCurrentWeight() - Method in interface org.apache.jackrabbit.oak.api.jmx.CacheStatsMBean

Total weight of the complete cache.

executeQuery(String, String, long, long, Map<String, ? extends PropertyValue>, Map<String, String>) - Method in interface org.apache.jackrabbit.oak.api.QueryEngine

Execute a query and get the result.

executeQuery(String, String, Map<String, ? extends PropertyValue>, Map<String, String>) - Method in interface org.apache.jackrabbit.oak.api.QueryEngine

Execute a query and get the result.

exists() - Method in interface org.apache.jackrabbit.oak.api.Tree

Determine whether this tree has been removed or does not exist otherwise (e.g.

F

FileStoreBackupRestoreMBean - Interface in org.apache.jackrabbit.oak.api.jmx

MBean for backing up and restoring a NodeStore.

fromString(String) - Static method in class org.apache.jackrabbit.oak.api.Type

Returns the Type with the given string representation.

fromTag(int, boolean) - Static method in class org.apache.jackrabbit.oak.api.Type

Corresponding Type for a given type tag and array flag.

G

getArrayType() - Method in class org.apache.jackrabbit.oak.api.Type

Determine the array type which has this type as base type

getAttribute(String) - Method in interface org.apache.jackrabbit.oak.api.AuthInfo

Returns the attribute with the given name or null if no attribute with that attributeName exists.

getAttributeNames() - Method in interface org.apache.jackrabbit.oak.api.AuthInfo

Returns the attribute names associated with this instance.

getAuthInfo() - Method in interface org.apache.jackrabbit.oak.api.ContentSession

This methods provides access to information related to authentication and authorization of this content session.

getAuthInfo() - Method in interface org.apache.jackrabbit.oak.api.jmx.SessionMBean

getAverageLoadPenalty() - Method in interface org.apache.jackrabbit.oak.api.jmx.CacheStatsMBean

Returns the average time spent loading new values.

getBackupStatus() - Method in interface org.apache.jackrabbit.oak.api.jmx.FileStoreBackupRestoreMBean

Backup status

getBackupStatus() - Method in interface org.apache.jackrabbit.oak.api.jmx.RepositoryManagementMBean

Backup status

getBaseType() - Method in class org.apache.jackrabbit.oak.api.Type

Determine the base type of array types

getBindVariableNames(String, String, Map<String, String>) - Method in interface org.apache.jackrabbit.oak.api.QueryEngine

Parse the query (check if it's valid) and get the list of bind variable names.

getBlob(String) - Method in interface org.apache.jackrabbit.oak.api.Root

Get a blob by its reference.

getBroadcastRecvRateHistory() - Method in interface org.apache.jackrabbit.oak.api.jmx.PersistentCacheStatsMBean

getCacheStats() - Method in interface org.apache.jackrabbit.oak.api.jmx.ConsolidatedCacheStatsMBean

getCacheStats() - Method in interface org.apache.jackrabbit.oak.api.jmx.ConsolidatedDataStoreCacheStatsMBean

getChild(String) - Method in interface org.apache.jackrabbit.oak.api.Tree

Get a possibly non existing child of this Tree.

getChildren() - Method in interface org.apache.jackrabbit.oak.api.Tree

All accessible children of this Tree instance.

getChildrenCount(long) - Method in interface org.apache.jackrabbit.oak.api.Tree

Determine the number of children of this Tree instance taking access restrictions into account.

getCode() - Method in exception org.apache.jackrabbit.oak.api.CommitFailedException

Returns the type-specific error code of this exception.

getColumnNames() - Method in interface org.apache.jackrabbit.oak.api.Result

Get the list of column names.

getColumnSelectorNames() - Method in interface org.apache.jackrabbit.oak.api.Result

Get the distinct selector names of all columns.

getConsecutiveFailedExecutions() - Method in interface org.apache.jackrabbit.oak.api.jmx.IndexStatsMBean

getConsolidatedExecutionStats() - Method in interface org.apache.jackrabbit.oak.api.jmx.IndexStatsMBean

Returns the consolidated execution stats since last reset

getContentIdentity() - Method in interface org.apache.jackrabbit.oak.api.Blob

A unique identifier of the content of this value.

getContentSession() - Method in interface org.apache.jackrabbit.oak.api.Root

Get the ContentSession from which this root was acquired

getDataStoreGCStatus() - Method in interface org.apache.jackrabbit.oak.api.jmx.RepositoryManagementMBean

Data store garbage collection status

getDescriptors() - Method in interface org.apache.jackrabbit.oak.api.ContentRepository

Returns the repository descriptors which contain all or a subset of the descriptors defined in Repository.

getDone() - Method in interface org.apache.jackrabbit.oak.api.jmx.IndexStatsMBean

getElementCount() - Method in interface org.apache.jackrabbit.oak.api.jmx.CacheStatsMBean

Get the number of elements/objects in the cache.

getEvictionCount() - Method in interface org.apache.jackrabbit.oak.api.jmx.CacheStatsMBean

Returns the number of times an entry has been evicted.

getExecutionCount() - Method in interface org.apache.jackrabbit.oak.api.jmx.IndexStatsMBean

Returns the number of executions as a org.apache.jackrabbit.api.stats.TimeSeries.

getExecutionTime() - Method in interface org.apache.jackrabbit.oak.api.jmx.IndexStatsMBean

Deprecated.

getFailingIndexStats() - Method in interface org.apache.jackrabbit.oak.api.jmx.IndexStatsMBean

getFailingSince() - Method in interface org.apache.jackrabbit.oak.api.jmx.IndexStatsMBean

getFailTraversal() - Method in interface org.apache.jackrabbit.oak.api.jmx.QueryEngineSettingsMBean

Whether queries that don't use an index will fail (throw an exception).

getHitCount() - Method in interface org.apache.jackrabbit.oak.api.jmx.CacheStatsMBean

Returns the number of times com.google.common.cache.Cache lookup methods have returned a cached value.

getHitPercentageHistory() - Method in interface org.apache.jackrabbit.oak.api.jmx.PersistentCacheStatsMBean

getHitRate() - Method in interface org.apache.jackrabbit.oak.api.jmx.CacheStatsMBean

Returns the ratio of cache requests which were hits.

getHitRateHistory() - Method in interface org.apache.jackrabbit.oak.api.jmx.PersistentCacheStatsMBean

getIndexedNodesCount() - Method in interface org.apache.jackrabbit.oak.api.jmx.IndexStatsMBean

Returns the number of indexed nodes as a org.apache.jackrabbit.api.stats.TimeSeries.

getInitStackTrace() - Method in interface org.apache.jackrabbit.oak.api.jmx.SessionMBean

getInvalidateAllRateHistory() - Method in interface org.apache.jackrabbit.oak.api.jmx.PersistentCacheStatsMBean

getInvalidateOneRateHistory() - Method in interface org.apache.jackrabbit.oak.api.jmx.PersistentCacheStatsMBean

getKeys() - Method in interface org.apache.jackrabbit.oak.api.Descriptors

Returns a string array holding all descriptor keys available for this implementation, both the standard descriptors defined by the string constants in this interface and any implementation-specific descriptors.

getLastFailedSave() - Method in interface org.apache.jackrabbit.oak.api.jmx.SessionMBean

getLastIndexedTime() - Method in interface org.apache.jackrabbit.oak.api.jmx.IndexStatsMBean

getLastReadAccess() - Method in interface org.apache.jackrabbit.oak.api.jmx.SessionMBean

getLastRefresh() - Method in interface org.apache.jackrabbit.oak.api.jmx.SessionMBean

getLastSave() - Method in interface org.apache.jackrabbit.oak.api.jmx.SessionMBean

getLastWriteAccess() - Method in interface org.apache.jackrabbit.oak.api.jmx.SessionMBean

getLatestError() - Method in interface org.apache.jackrabbit.oak.api.jmx.IndexStatsMBean

getLatestErrorTime() - Method in interface org.apache.jackrabbit.oak.api.jmx.IndexStatsMBean

getLatestRoot() - Method in interface org.apache.jackrabbit.oak.api.ContentSession

The current head root as seen by this content session.

getLimitInMemory() - Method in interface org.apache.jackrabbit.oak.api.jmx.QueryEngineSettingsMBean

Get the limit on how many nodes a query may read at most into memory, for "order by" and "distinct" queries.

getLimitReads() - Method in interface org.apache.jackrabbit.oak.api.jmx.QueryEngineSettingsMBean

Get the limit on how many nodes a query may read at most (raw read operations, including skipped nodes).

getLoadCount() - Method in interface org.apache.jackrabbit.oak.api.jmx.CacheStatsMBean

Returns the total number of times that com.google.common.cache.Cache lookup methods attempted to load new values.

getLoadExceptionCount() - Method in interface org.apache.jackrabbit.oak.api.jmx.CacheStatsMBean

Returns the number of times com.google.common.cache.Cache lookup methods threw an exception while loading a new value.

getLoadExceptionRate() - Method in interface org.apache.jackrabbit.oak.api.jmx.CacheStatsMBean

Returns the ratio of cache loading attempts which threw exceptions.

getLoadExceptionRateHistory() - Method in interface org.apache.jackrabbit.oak.api.jmx.PersistentCacheStatsMBean

getLoadRateHistory() - Method in interface org.apache.jackrabbit.oak.api.jmx.PersistentCacheStatsMBean

getLoadSuccessCount() - Method in interface org.apache.jackrabbit.oak.api.jmx.CacheStatsMBean

Returns the number of times com.google.common.cache.Cache lookup methods have successfully loaded a new value.

getLoginTimeStamp() - Method in interface org.apache.jackrabbit.oak.api.jmx.SessionMBean

getMaxTotalWeight() - Method in interface org.apache.jackrabbit.oak.api.jmx.CacheStatsMBean

The maximum weight of entries the cache may contain.

getMissCount() - Method in interface org.apache.jackrabbit.oak.api.jmx.CacheStatsMBean

Returns the number of times com.google.common.cache.Cache lookup methods have returned an uncached (newly loaded) value, or null.

getMissRate() - Method in interface org.apache.jackrabbit.oak.api.jmx.CacheStatsMBean

Returns the ratio of cache requests which were misses.

getName() - Method in interface org.apache.jackrabbit.oak.api.jmx.CacheStatsMBean

getName() - Method in interface org.apache.jackrabbit.oak.api.jmx.IndexStatsMBean

Name of the async indexing lane

getName() - Method in interface org.apache.jackrabbit.oak.api.PropertyState

getName() - Method in interface org.apache.jackrabbit.oak.api.Tree

getNewStream() - Method in interface org.apache.jackrabbit.oak.api.Blob

Returns a new stream for this blob.

getNodesReadCount() - Method in interface org.apache.jackrabbit.oak.api.jmx.IndexStatsMBean

Returns the number of which have been read so far.

getObservationEventAverage() - Method in interface org.apache.jackrabbit.oak.api.jmx.RepositoryStatsMBean

See org.apache.jackrabbit.api.stats.RepositoryStatistics.Type#OBSERVATION_EVENT_AVERAGE

getObservationEventCount() - Method in interface org.apache.jackrabbit.oak.api.jmx.RepositoryStatsMBean

See org.apache.jackrabbit.api.stats.RepositoryStatistics.Type#OBSERVATION_EVENT_COUNTER

getObservationEventDuration() - Method in interface org.apache.jackrabbit.oak.api.jmx.RepositoryStatsMBean

See org.apache.jackrabbit.api.stats.RepositoryStatistics.Type#OBSERVATION_EVENT_DURATION

getObservationQueueMaxLength() - Method in interface org.apache.jackrabbit.oak.api.jmx.RepositoryStatsMBean

Maximum length of observation queue in the respective time period.

getOldestCheckpointCreationDate() - Method in interface org.apache.jackrabbit.oak.api.jmx.CheckpointMBean

getOldestCheckpointCreationTimestamp() - Method in interface org.apache.jackrabbit.oak.api.jmx.CheckpointMBean

getParent() - Method in interface org.apache.jackrabbit.oak.api.Tree

getPath() - Method in interface org.apache.jackrabbit.oak.api.ResultRow

The path, assuming there is only one selector.

getPath(String) - Method in interface org.apache.jackrabbit.oak.api.ResultRow

The path for the given selector name.

getPath() - Method in interface org.apache.jackrabbit.oak.api.Tree

getPrincipals() - Method in interface org.apache.jackrabbit.oak.api.AuthInfo

Returns the set of principals associated with this AuthInfo instance.

getProcessedCheckpoint() - Method in interface org.apache.jackrabbit.oak.api.jmx.IndexStatsMBean

Returns the processed checkpoint used by the async indexer.

getProperties() - Method in interface org.apache.jackrabbit.oak.api.Tree

All accessible property states.

getProperty(String) - Method in interface org.apache.jackrabbit.oak.api.Tree

Get a property state

getPropertyCount() - Method in interface org.apache.jackrabbit.oak.api.Tree

Determine the number of properties accessible to the current content session.

getPropertyIndexAsyncReindexStatus() - Method in interface org.apache.jackrabbit.oak.api.jmx.RepositoryManagementMBean

Asynchronous Property Index reindexing status

getPropertyStatus(String) - Method in interface org.apache.jackrabbit.oak.api.Tree

Get the Status of a property state or null.

getPutRateHistory() - Method in interface org.apache.jackrabbit.oak.api.jmx.PersistentCacheStatsMBean

getPutRejectedAlreadyPersistedRateHistory() - Method in interface org.apache.jackrabbit.oak.api.jmx.PersistentCacheStatsMBean

getPutRejectedAsCachedInSecRateHistory() - Method in interface org.apache.jackrabbit.oak.api.jmx.PersistentCacheStatsMBean

getPutRejectedEntryNotUsedRateHistory() - Method in interface org.apache.jackrabbit.oak.api.jmx.PersistentCacheStatsMBean

getPutRejectedQueueFullRateHistory() - Method in interface org.apache.jackrabbit.oak.api.jmx.PersistentCacheStatsMBean

getQueryAverage() - Method in interface org.apache.jackrabbit.oak.api.jmx.RepositoryStatsMBean

See org.apache.jackrabbit.api.stats.RepositoryStatistics.Type#QUERY_AVERAGE

getQueryCount() - Method in interface org.apache.jackrabbit.oak.api.jmx.RepositoryStatsMBean

See org.apache.jackrabbit.api.stats.RepositoryStatistics.Type#QUERY_COUNT

getQueryDuration() - Method in interface org.apache.jackrabbit.oak.api.jmx.RepositoryStatsMBean

See org.apache.jackrabbit.api.stats.RepositoryStatistics.Type#QUERY_DURATION

getQueryEngine() - Method in interface org.apache.jackrabbit.oak.api.Root

Get the query engine.

getReadCount() - Method in interface org.apache.jackrabbit.oak.api.jmx.SessionMBean

getReadRate() - Method in interface org.apache.jackrabbit.oak.api.jmx.SessionMBean

getReference() - Method in interface org.apache.jackrabbit.oak.api.Blob

Returns a secure reference to this blob, or null if such a reference is not available.

getReferenceCheckpoint() - Method in interface org.apache.jackrabbit.oak.api.jmx.IndexStatsMBean

Returns the current reference checkpoint used by the async indexer

getRefreshCount() - Method in interface org.apache.jackrabbit.oak.api.jmx.SessionMBean

getRefreshPending() - Method in interface org.apache.jackrabbit.oak.api.jmx.SessionMBean

getRefreshRate() - Method in interface org.apache.jackrabbit.oak.api.jmx.SessionMBean

getRefreshStrategy() - Method in interface org.apache.jackrabbit.oak.api.jmx.SessionMBean

getRequestCount() - Method in interface org.apache.jackrabbit.oak.api.jmx.CacheStatsMBean

Returns the number of times com.google.common.cache.Cache lookup methods have returned either a cached or uncached value.

getRequestRateHistory() - Method in interface org.apache.jackrabbit.oak.api.jmx.PersistentCacheStatsMBean

getRestoreStatus() - Method in interface org.apache.jackrabbit.oak.api.jmx.FileStoreBackupRestoreMBean

Restore status

getRestoreStatus() - Method in interface org.apache.jackrabbit.oak.api.jmx.RepositoryManagementMBean

Restore status

getRevisionGCStatus() - Method in interface org.apache.jackrabbit.oak.api.jmx.RepositoryManagementMBean

Revision garbage collection status

getRevisionGCStatusForRole(String) - Method in interface org.apache.jackrabbit.oak.api.jmx.RepositoryManagementMBean

Revision garbage collection status for a given role.

getRows() - Method in interface org.apache.jackrabbit.oak.api.Result

Get the rows.

getSaveCount() - Method in interface org.apache.jackrabbit.oak.api.jmx.SessionMBean

getSaveRate() - Method in interface org.apache.jackrabbit.oak.api.jmx.SessionMBean

getSelectorNames() - Method in interface org.apache.jackrabbit.oak.api.Result

Get the list of selector names.

getSessionAttributes() - Method in interface org.apache.jackrabbit.oak.api.jmx.SessionMBean

getSessionCount() - Method in interface org.apache.jackrabbit.oak.api.jmx.RepositoryStatsMBean

See org.apache.jackrabbit.api.stats.RepositoryStatistics.Type#SESSION_COUNT

getSessionLogin() - Method in interface org.apache.jackrabbit.oak.api.jmx.RepositoryStatsMBean

See org.apache.jackrabbit.api.stats.RepositoryStatistics.Type#SESSION_LOGIN_COUNTER

getSessionReadAverage() - Method in interface org.apache.jackrabbit.oak.api.jmx.RepositoryStatsMBean

See org.apache.jackrabbit.api.stats.RepositoryStatistics.Type#SESSION_READ_AVERAGE

getSessionReadCount() - Method in interface org.apache.jackrabbit.oak.api.jmx.RepositoryStatsMBean

See org.apache.jackrabbit.api.stats.RepositoryStatistics.Type#SESSION_READ_COUNTER

getSessionReadDuration() - Method in interface org.apache.jackrabbit.oak.api.jmx.RepositoryStatsMBean

See org.apache.jackrabbit.api.stats.RepositoryStatistics.Type#SESSION_READ_DURATION

getSessionWriteAverage() - Method in interface org.apache.jackrabbit.oak.api.jmx.RepositoryStatsMBean

See org.apache.jackrabbit.api.stats.RepositoryStatistics.Type#SESSION_WRITE_AVERAGE

getSessionWriteCount() - Method in interface org.apache.jackrabbit.oak.api.jmx.RepositoryStatsMBean

See org.apache.jackrabbit.api.stats.RepositoryStatistics.Type#SESSION_WRITE_COUNTER

getSessionWriteDuration() - Method in interface org.apache.jackrabbit.oak.api.jmx.RepositoryStatsMBean

See org.apache.jackrabbit.api.stats.RepositoryStatistics.Type#SESSION_READ_DURATION

getSize() - Method in interface org.apache.jackrabbit.oak.api.Result

Get the number of rows, if known.

getSize(Result.SizePrecision, long) - Method in interface org.apache.jackrabbit.oak.api.Result

Get the number of rows, if known.

getSource() - Method in exception org.apache.jackrabbit.oak.api.CommitFailedException

Returns the name of the source of this exception.

getStart() - Method in interface org.apache.jackrabbit.oak.api.jmx.IndexStatsMBean

getStatus() - Method in interface org.apache.jackrabbit.oak.api.jmx.CopyOnWriteStoreMBean

Returns the copy-on-write status

getStatus() - Method in interface org.apache.jackrabbit.oak.api.jmx.IndexStatsMBean

Returns the current status of the indexing job

getStatus() - Method in interface org.apache.jackrabbit.oak.api.Tree

Get the Status of this tree instance.

getSupportedQueryLanguages() - Method in interface org.apache.jackrabbit.oak.api.QueryEngine

Get the set of supported query languages.

getTemporaryCheckpoints() - Method in interface org.apache.jackrabbit.oak.api.jmx.IndexStatsMBean

Temporary checkpoints represent old checkpoints that have been processed but the cleanup was not successful of did not happen at all (like in the event the system was forcibly stopped).

getTotalLoadTime() - Method in interface org.apache.jackrabbit.oak.api.jmx.CacheStatsMBean

Returns the total number of nanoseconds the cache has spent loading new values.

getTree(String) - Method in interface org.apache.jackrabbit.oak.api.ResultRow

The tree for the given selector name.

getTree(String) - Method in interface org.apache.jackrabbit.oak.api.Root

Retrieve the possible non existing Tree at the given absolute path.

getType() - Method in exception org.apache.jackrabbit.oak.api.CommitFailedException

Return the name of the type of this exception.

getType() - Method in interface org.apache.jackrabbit.oak.api.PropertyState

Determine the type of this property

getType() - Method in interface org.apache.jackrabbit.oak.api.PropertyValue

Determine the type of this value

getUpdates() - Method in interface org.apache.jackrabbit.oak.api.jmx.IndexStatsMBean

Returns the number of updates from the current run cycle.

getUsedSpaceHistory() - Method in interface org.apache.jackrabbit.oak.api.jmx.PersistentCacheStatsMBean

getUserID() - Method in interface org.apache.jackrabbit.oak.api.AuthInfo

Return the user ID to be exposed on the JCR Session object.

getValue(String) - Method in interface org.apache.jackrabbit.oak.api.Descriptors

The value of a single-value descriptor is found by passing the key for that descriptor to this method.

getValue(Type<T>) - Method in interface org.apache.jackrabbit.oak.api.PropertyState

Value of this property.

getValue(Type<T>, int) - Method in interface org.apache.jackrabbit.oak.api.PropertyState

Value at the given index.

getValue(Type<T>) - Method in interface org.apache.jackrabbit.oak.api.PropertyValue

Value of this object.

getValue(Type<T>, int) - Method in interface org.apache.jackrabbit.oak.api.PropertyValue

Value at the given index.

getValue(String) - Method in interface org.apache.jackrabbit.oak.api.ResultRow

The property value.

getValues(String) - Method in interface org.apache.jackrabbit.oak.api.Descriptors

The value array of a multi-value descriptor is found by passing the key for that descriptor to this method.

getValues() - Method in interface org.apache.jackrabbit.oak.api.ResultRow

Get the list of values.

getWorkspaceName() - Method in interface org.apache.jackrabbit.oak.api.ContentSession

The name of the workspace this ContentSession instance has been created for.

getWriteCount() - Method in interface org.apache.jackrabbit.oak.api.jmx.SessionMBean

getWriteRate() - Method in interface org.apache.jackrabbit.oak.api.jmx.SessionMBean

H

hasChild(String) - Method in interface org.apache.jackrabbit.oak.api.Tree

Determine if a child of this Tree instance exists.

hashCode() - Method in class org.apache.jackrabbit.oak.api.Type

hasPendingChanges() - Method in interface org.apache.jackrabbit.oak.api.Root

Determine whether there are changes on this tree

hasProperty(String) - Method in interface org.apache.jackrabbit.oak.api.Tree

Determine if a property state exists and is accessible.

I

IllegalRepositoryStateException - Exception in org.apache.jackrabbit.oak.api

This exception can be thrown by implementers of this API to signal an error condition caused by an invalid state of the repository.

IllegalRepositoryStateException() - Constructor for exception org.apache.jackrabbit.oak.api.IllegalRepositoryStateException

IllegalRepositoryStateException(String) - Constructor for exception org.apache.jackrabbit.oak.api.IllegalRepositoryStateException

IllegalRepositoryStateException(String, Throwable) - Constructor for exception org.apache.jackrabbit.oak.api.IllegalRepositoryStateException

IllegalRepositoryStateException(Throwable) - Constructor for exception org.apache.jackrabbit.oak.api.IllegalRepositoryStateException

Impact - Annotation Type in org.apache.jackrabbit.oak.api.jmx

Produces an operation impact that will be returned by JMX MBeanOperationInfo.getImpact().

ImpactOption - Enum in org.apache.jackrabbit.oak.api.jmx

importIndex(String) - Method in interface org.apache.jackrabbit.oak.api.jmx.IndexerMBean

IndexerMBean - Interface in org.apache.jackrabbit.oak.api.jmx

IndexStatsMBean - Interface in org.apache.jackrabbit.oak.api.jmx

INTEGRITY - Static variable in exception org.apache.jackrabbit.oak.api.CommitFailedException

Type name for referential integrity violation errors.

INTERNAL_SQL2_QUERY - Static variable in interface org.apache.jackrabbit.oak.api.QueryEngine

The suffix for internal SQL-2 statements.

isAccessControlViolation() - Method in exception org.apache.jackrabbit.oak.api.CommitFailedException

Checks whether this is an access control violation exception.

isAccessViolation() - Method in exception org.apache.jackrabbit.oak.api.CommitFailedException

Checks whether this is an access violation exception.

isArray() - Method in interface org.apache.jackrabbit.oak.api.PropertyState

Determine whether the value is an array of atoms

isArray() - Method in interface org.apache.jackrabbit.oak.api.PropertyValue

Determine whether the value is an array of atoms

isArray() - Method in class org.apache.jackrabbit.oak.api.Type

Determine whether this is an array type

isConstraintViolation() - Method in exception org.apache.jackrabbit.oak.api.CommitFailedException

Checks whether this is a constraint violation exception.

isFailing() - Method in interface org.apache.jackrabbit.oak.api.jmx.IndexStatsMBean

isFastQuerySize() - Method in interface org.apache.jackrabbit.oak.api.jmx.QueryEngineSettingsMBean

Whether the query result size should return an estimation for large queries.

isFileSynced(String) - Method in interface org.apache.jackrabbit.oak.api.jmx.ConsolidatedDataStoreCacheStatsMBean

Determines whether a file-like entity with the given name has been "synced" (completely copied) to S3.

isOfType(String) - Method in exception org.apache.jackrabbit.oak.api.CommitFailedException

Checks whether this exception is of the given type.

isPaused() - Method in interface org.apache.jackrabbit.oak.api.jmx.IndexStatsMBean

Returns the value of the 'paused' flag

isRoot() - Method in interface org.apache.jackrabbit.oak.api.Tree

isSingleValueDescriptor(String) - Method in interface org.apache.jackrabbit.oak.api.Descriptors

Returns true if key is a valid single-value descriptor; otherwise returns false

isStandardDescriptor(String) - Method in interface org.apache.jackrabbit.oak.api.Descriptors

Returns true if key is a standard descriptor defined by the string constants in this interface and false if it is either a valid implementation-specific key or not a valid key.

L

LABEL_EXISTS - Static variable in exception org.apache.jackrabbit.oak.api.CommitFailedException

Type name for label exists version errors.

length() - Method in interface org.apache.jackrabbit.oak.api.Blob

Returns the length of this blob or -1 if unknown.

listCheckpoints() - Method in interface org.apache.jackrabbit.oak.api.jmx.CheckpointMBean

List the checkpoints that are currently present along with its id, creation time and expiry time.

LOCK - Static variable in exception org.apache.jackrabbit.oak.api.CommitFailedException

Type name for lock violation errors.

login(Credentials, String) - Method in interface org.apache.jackrabbit.oak.api.ContentRepository

Authenticates a user based on the given credentials or available out-of-band information and, if successful, returns a ContentSession instance for accessing repository content inside the specified workspace as the authenticated user.

LONG - Static variable in class org.apache.jackrabbit.oak.api.Type

Map Long to PropertyType.LONG

LONGS - Static variable in class org.apache.jackrabbit.oak.api.Type

Map Iterable<Long> to array of PropertyType.LONG

M

MERGE - Static variable in exception org.apache.jackrabbit.oak.api.CommitFailedException

Type name for merge errors.

move(String, String) - Method in interface org.apache.jackrabbit.oak.api.Root

Move the child located at sourcePath to a child at destPath.

N

NAME - Static variable in exception org.apache.jackrabbit.oak.api.CommitFailedException

Type name for name violation errors.

NAME - Static variable in annotation type org.apache.jackrabbit.oak.api.jmx.Description

NAME - Static variable in annotation type org.apache.jackrabbit.oak.api.jmx.Impact

Name - Annotation Type in org.apache.jackrabbit.oak.api.jmx

Produces a parameter name that will be returned by JMX MBeanFeatureInfo.getName().

NAME - Static variable in annotation type org.apache.jackrabbit.oak.api.jmx.Name

name - Variable in enum org.apache.jackrabbit.oak.api.jmx.RepositoryManagementMBean.StatusCode

NAME - Static variable in class org.apache.jackrabbit.oak.api.Type

Map String to PropertyType.STRING

NAMES - Static variable in class org.apache.jackrabbit.oak.api.Type

Map Iterable<String> to array of PropertyType.NAME

NAMESPACE - Static variable in exception org.apache.jackrabbit.oak.api.CommitFailedException

Type name for namespace violation errors.

NO_BINDINGS - Static variable in interface org.apache.jackrabbit.oak.api.QueryEngine

Empty set of variables bindings.

NO_MAPPINGS - Static variable in interface org.apache.jackrabbit.oak.api.QueryEngine

Empty set of namespace prefix mappings.

NODE_TYPE - Static variable in exception org.apache.jackrabbit.oak.api.CommitFailedException

Type name for node type violation errors.

O

OAK - Static variable in exception org.apache.jackrabbit.oak.api.CommitFailedException

Source name for exceptions thrown by components in the Oak project.

orderBefore(String) - Method in interface org.apache.jackrabbit.oak.api.Tree

Orders this Tree before the sibling tree with the given name.

org.apache.jackrabbit.oak.api - package org.apache.jackrabbit.oak.api

Oak repository API

org.apache.jackrabbit.oak.api.jmx - package org.apache.jackrabbit.oak.api.jmx

P

PATH - Static variable in class org.apache.jackrabbit.oak.api.Type

Map String to PropertyType.PATH

PATHS - Static variable in class org.apache.jackrabbit.oak.api.Type

Map Iterable<String> to array of PropertyType.PATH

pause() - Method in interface org.apache.jackrabbit.oak.api.jmx.IndexStatsMBean

Pauses the background indexing process.

PersistentCacheStatsMBean - Interface in org.apache.jackrabbit.oak.api.jmx

PropertyState - Interface in org.apache.jackrabbit.oak.api

Immutable property state.

PropertyValue - Interface in org.apache.jackrabbit.oak.api

Immutable property value.

Q

QueryEngine - Interface in org.apache.jackrabbit.oak.api

The query engine allows to parse and execute queries.

QueryEngineSettingsMBean - Interface in org.apache.jackrabbit.oak.api.jmx

R

rebase() - Method in interface org.apache.jackrabbit.oak.api.Root

Rebase this root instance to the latest revision.

REFERENCE - Static variable in class org.apache.jackrabbit.oak.api.Type

Map String to PropertyType.REFERENCE

REFERENCES - Static variable in class org.apache.jackrabbit.oak.api.Type

Map Iterable<String> to array of PropertyType.REFERENCE

refresh() - Method in interface org.apache.jackrabbit.oak.api.jmx.SessionMBean

Refresh this session.

refresh() - Method in interface org.apache.jackrabbit.oak.api.Root

Reverts all changes made to this root and refreshed to the latest trunk.

refreshAllSessions() - Method in interface org.apache.jackrabbit.oak.api.jmx.RepositoryManagementMBean

Refresh all currently open sessions.

registerAsyncIndexer(String, long) - Method in interface org.apache.jackrabbit.oak.api.jmx.IndexStatsMBean

Starts a new background indexing task and registers the JMX MBeans for it

releaseCheckpoint(String) - Method in interface org.apache.jackrabbit.oak.api.jmx.CheckpointMBean

Release the checkpoint with the given id.

remove() - Method in interface org.apache.jackrabbit.oak.api.Tree

Remove this tree instance.

removeProperty(String) - Method in interface org.apache.jackrabbit.oak.api.Tree

Remove the property with the given name.

RepositoryManagementMBean - Interface in org.apache.jackrabbit.oak.api.jmx

This interface exposes repository management operations and the status of such operations.

RepositoryManagementMBean.StatusCode - Enum in org.apache.jackrabbit.oak.api.jmx

Enum whose ordinals correspond to the status codes.

RepositoryStatsMBean - Interface in org.apache.jackrabbit.oak.api.jmx

MBean for providing repository wide statistics.

resetConsolidatedExecutionStats() - Method in interface org.apache.jackrabbit.oak.api.jmx.IndexStatsMBean

Deprecated.

resetStats() - Method in interface org.apache.jackrabbit.oak.api.jmx.CacheStatsMBean

Reset the cache stats

Result - Interface in org.apache.jackrabbit.oak.api

A result from executing a query.

Result.SizePrecision - Enum in org.apache.jackrabbit.oak.api

ResultRow - Interface in org.apache.jackrabbit.oak.api

A query result row.

resume() - Method in interface org.apache.jackrabbit.oak.api.jmx.IndexStatsMBean

Resumes the indexing process.

Root - Interface in org.apache.jackrabbit.oak.api

A Root instance serves as a container for a Tree.

S

SessionMBean - Interface in org.apache.jackrabbit.oak.api.jmx

MBean providing basic Session information and statistics.

setFailTraversal(boolean) - Method in interface org.apache.jackrabbit.oak.api.jmx.QueryEngineSettingsMBean

Set whether queries that don't use an index will fail (throw an exception).

setFastQuerySize(boolean) - Method in interface org.apache.jackrabbit.oak.api.jmx.QueryEngineSettingsMBean

setLimitInMemory(long) - Method in interface org.apache.jackrabbit.oak.api.jmx.QueryEngineSettingsMBean

Change the limit.

setLimitReads(long) - Method in interface org.apache.jackrabbit.oak.api.jmx.QueryEngineSettingsMBean

Change the limit.

setOrderableChildren(boolean) - Method in interface org.apache.jackrabbit.oak.api.Tree

Changes the nature of this tree such that the order of the children is kept stable.

setProperty(PropertyState) - Method in interface org.apache.jackrabbit.oak.api.Tree

Set a property state

setProperty(String, T) - Method in interface org.apache.jackrabbit.oak.api.Tree

Set a property state

setProperty(String, T, Type<T>) - Method in interface org.apache.jackrabbit.oak.api.Tree

Set a property state

size() - Method in interface org.apache.jackrabbit.oak.api.PropertyState

The size of the value of this property.

size(int) - Method in interface org.apache.jackrabbit.oak.api.PropertyState

The size of the value at the given index.

size() - Method in interface org.apache.jackrabbit.oak.api.PropertyValue

The size of the value of this object.

size(int) - Method in interface org.apache.jackrabbit.oak.api.PropertyValue

The size of the value at the given index.

splitIndexingTask(String, String) - Method in interface org.apache.jackrabbit.oak.api.jmx.IndexStatsMBean

Splits the current indexing tasks into 2, indexes that are passed in as an input will have their 'async' property updated to newIndexTaskName.

startBackup() - Method in interface org.apache.jackrabbit.oak.api.jmx.FileStoreBackupRestoreMBean

Initiate a backup operation.

startBackup() - Method in interface org.apache.jackrabbit.oak.api.jmx.RepositoryManagementMBean

Initiate a backup operation.

startDataStoreGC(boolean) - Method in interface org.apache.jackrabbit.oak.api.jmx.RepositoryManagementMBean

Initiate a data store garbage collection operation

startPropertyIndexAsyncReindex() - Method in interface org.apache.jackrabbit.oak.api.jmx.RepositoryManagementMBean

Initiate a reindex operation for the property indexes marked for reindexing

startRestore() - Method in interface org.apache.jackrabbit.oak.api.jmx.FileStoreBackupRestoreMBean

Initiate a restore operation.

startRestore() - Method in interface org.apache.jackrabbit.oak.api.jmx.RepositoryManagementMBean

Initiate a restore operation.

startRevisionGC() - Method in interface org.apache.jackrabbit.oak.api.jmx.RepositoryManagementMBean

Initiate a revision garbage collection operation

startRevisionGCForRole(String) - Method in interface org.apache.jackrabbit.oak.api.jmx.RepositoryManagementMBean

Initiate a revision garbage collection operation

STATE - Static variable in exception org.apache.jackrabbit.oak.api.CommitFailedException

Type name for state violation errors.

STATUS_DONE - Static variable in interface org.apache.jackrabbit.oak.api.jmx.IndexStatsMBean

STATUS_FAILING - Static variable in interface org.apache.jackrabbit.oak.api.jmx.IndexStatsMBean

STATUS_INIT - Static variable in interface org.apache.jackrabbit.oak.api.jmx.IndexStatsMBean

STATUS_INTERRUPTED - Static variable in interface org.apache.jackrabbit.oak.api.jmx.IndexStatsMBean

STATUS_RUNNING - Static variable in interface org.apache.jackrabbit.oak.api.jmx.IndexStatsMBean

STRING - Static variable in class org.apache.jackrabbit.oak.api.Type

Map String to PropertyType.STRING

STRINGS - Static variable in class org.apache.jackrabbit.oak.api.Type

Map Iterable<String> to array of PropertyType.STRING

T

tag() - Method in class org.apache.jackrabbit.oak.api.Type

Corresponding type tag as defined in PropertyType.

toString() - Method in class org.apache.jackrabbit.oak.api.Type

Tree - Interface in org.apache.jackrabbit.oak.api

A tree instance represents a snapshot of the ContentRepository tree at the time the instance was acquired from a ContentSession.

Tree.Status - Enum in org.apache.jackrabbit.oak.api

Status of an item in a Tree

TYPE - Static variable in interface org.apache.jackrabbit.oak.api.jmx.CacheStatsMBean

TYPE - Static variable in interface org.apache.jackrabbit.oak.api.jmx.CheckpointMBean

TYPE - Static variable in interface org.apache.jackrabbit.oak.api.jmx.ConsolidatedCacheStatsMBean

TYPE - Static variable in interface org.apache.jackrabbit.oak.api.jmx.ConsolidatedDataStoreCacheStatsMBean

TYPE - Static variable in interface org.apache.jackrabbit.oak.api.jmx.CopyOnWriteStoreMBean

TYPE - Static variable in interface org.apache.jackrabbit.oak.api.jmx.FileStoreBackupRestoreMBean

TYPE - Static variable in interface org.apache.jackrabbit.oak.api.jmx.IndexerMBean

TYPE - Static variable in interface org.apache.jackrabbit.oak.api.jmx.IndexStatsMBean

TYPE - Static variable in interface org.apache.jackrabbit.oak.api.jmx.PersistentCacheStatsMBean

TYPE - Static variable in interface org.apache.jackrabbit.oak.api.jmx.QueryEngineSettingsMBean

TYPE - Static variable in interface org.apache.jackrabbit.oak.api.jmx.RepositoryManagementMBean

TYPE - Static variable in interface org.apache.jackrabbit.oak.api.jmx.RepositoryStatsMBean

TYPE - Static variable in interface org.apache.jackrabbit.oak.api.jmx.SessionMBean

Type<T> - Class in org.apache.jackrabbit.oak.api

Instances of this class map Java types to property types.

U

UNDEFINED - Static variable in class org.apache.jackrabbit.oak.api.Type

The special "undefined" type, never encountered in normal values

UNDEFINEDS - Static variable in class org.apache.jackrabbit.oak.api.Type

Multi-valued "undefined" type, never encountered in normal values

UNSUPPORTED - Static variable in exception org.apache.jackrabbit.oak.api.CommitFailedException

Unsupported operation or feature

URI - Static variable in class org.apache.jackrabbit.oak.api.Type

Map String to PropertyType.URI

URIS - Static variable in class org.apache.jackrabbit.oak.api.Type

Map Iterable<String> to array of PropertyType.URI

V

value() - Method in enum org.apache.jackrabbit.oak.api.jmx.ImpactOption

valueOf(String) - Static method in enum org.apache.jackrabbit.oak.api.jmx.ImpactOption

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum org.apache.jackrabbit.oak.api.jmx.RepositoryManagementMBean.StatusCode

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum org.apache.jackrabbit.oak.api.Result.SizePrecision

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum org.apache.jackrabbit.oak.api.Tree.Status

Returns the enum constant of this type with the specified name.

values() - Static method in enum org.apache.jackrabbit.oak.api.jmx.ImpactOption

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum org.apache.jackrabbit.oak.api.jmx.RepositoryManagementMBean.StatusCode

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum org.apache.jackrabbit.oak.api.Result.SizePrecision

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum org.apache.jackrabbit.oak.api.Tree.Status

Returns an array containing the constants of this enum type, in the order they are declared.

VERSION - Static variable in exception org.apache.jackrabbit.oak.api.CommitFailedException

Type name for version violation errors.

W

WEAKREFERENCE - Static variable in class org.apache.jackrabbit.oak.api.Type

Map String to PropertyType.WEAKREFERENCE

WEAKREFERENCES - Static variable in class org.apache.jackrabbit.oak.api.Type

Map Iterable<String> to array of PropertyType.WEAKREFERENCE

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