A B C D E F G H I J L M N O P Q R S T U V W X
All Classes All Packages
All Classes All Packages
All Classes All Packages
A
- ACTION_ADD_PROPERTY - Static variable in interface org.apache.jackrabbit.api.JackrabbitSession
-
A constant representing the
add_property
action string, used to determine if thisSession
has permission to add a new property. - ACTION_LOCKING - Static variable in interface org.apache.jackrabbit.api.JackrabbitSession
-
A constant representing the
locking
action string, used to determine if thisSession
has permission to lock or unlock a node. - ACTION_MODIFY_ACCESS_CONTROL - Static variable in interface org.apache.jackrabbit.api.JackrabbitSession
-
A constant representing the
modify_access_control
action string, used to determine if thisSession
has permission to modify access control content at the given path. - ACTION_MODIFY_PROPERTY - Static variable in interface org.apache.jackrabbit.api.JackrabbitSession
-
A constant representing the
modify_property
action string, used to determine if thisSession
has permission to modify a property. - ACTION_NODE_TYPE_MANAGEMENT - Static variable in interface org.apache.jackrabbit.api.JackrabbitSession
-
A constant representing the
node_type_management
action string, used to determine if thisSession
has permission to write node type information of a node. - ACTION_READ_ACCESS_CONTROL - Static variable in interface org.apache.jackrabbit.api.JackrabbitSession
-
A constant representing the
read_access_control
action string, used to determine if thisSession
has permission to read access control content at the given path. - ACTION_REMOVE_NODE - Static variable in interface org.apache.jackrabbit.api.JackrabbitSession
-
A constant representing the
remove_node
action string, used to determine if thisSession
has permission to remove a node. - ACTION_REMOVE_PROPERTY - Static variable in interface org.apache.jackrabbit.api.JackrabbitSession
-
A constant representing the
remove_property
action string, used to determine if thisSession
has permission to remove a property. - ACTION_USER_MANAGEMENT - Static variable in interface org.apache.jackrabbit.api.JackrabbitSession
-
A constant representing the
user_management
action string, used to determine if thisSession
has permission to perform user management operations at the given path. - ACTION_VERSIONING - Static variable in interface org.apache.jackrabbit.api.JackrabbitSession
-
A constant representing the
versioning
action string, used to determine if thisSession
has permission to perform version operations on a node. - addEntry(Principal, Privilege[], boolean) - Method in interface org.apache.jackrabbit.api.security.JackrabbitAccessControlList
-
Same as
JackrabbitAccessControlList.addEntry(Principal, Privilege[], boolean, Map)
using some implementation specific restrictions. - addEntry(Principal, Privilege[], boolean, Map<String, Value>) - Method in interface org.apache.jackrabbit.api.security.JackrabbitAccessControlList
-
Adds an access control entry to this policy consisting of the specified
principal
, the specifiedprivileges
, theisAllow
flag and an optional map containing additional restrictions. - addEntry(Principal, Privilege[], boolean, Map<String, Value>, Map<String, Value[]>) - Method in interface org.apache.jackrabbit.api.security.JackrabbitAccessControlList
-
Adds an access control entry to this policy consisting of the specified
principal
, the specifiedprivileges
, theisAllow
flag and an optional map containing additional restrictions. - addEntry(String, Privilege[]) - Method in interface org.apache.jackrabbit.api.security.authorization.PrincipalAccessControlList
-
Adds an access control entry to this policy consisting of the specified
effectivePath
and the specifiedprivileges
and indicates upon return if the policy was modified. - addEntry(String, Privilege[], Map<String, Value>, Map<String, Value[]>) - Method in interface org.apache.jackrabbit.api.security.authorization.PrincipalAccessControlList
-
Adds an access control entry to this policy consisting of the specified
effectivePath
, the specifiedprivileges
as well as the specified single and multivalued restrictions and indicates upon return if the policy was modified. - addEventListener(EventListener, JackrabbitEventFilter) - Method in interface org.apache.jackrabbit.api.observation.JackrabbitObservationManager
-
Adds an event listener that listens for the events specified by the passed
JackrabbitEventFilter
. - addMember(Authorizable) - Method in interface org.apache.jackrabbit.api.security.user.Group
-
Add a member to this Group.
- addMembers(String...) - Method in interface org.apache.jackrabbit.api.security.user.Group
-
Add one or more member(s) to this Group.
- addPrincipals(Principal...) - Method in interface org.apache.jackrabbit.api.security.authorization.PrincipalSetPolicy
-
Add
Principal
s that are allowed to perform some implementation specific actions on those items where this policy takes effect. - allows(Subject) - Method in interface org.apache.jackrabbit.api.security.user.Impersonation
-
Test if the given subject (i.e.
- and(T, T) - Method in interface org.apache.jackrabbit.api.security.user.QueryBuilder
-
Return a condition which holds if both sub conditions hold.
- ASCENDING - org.apache.jackrabbit.api.security.user.QueryBuilder.Direction
- Authorizable - Interface in org.apache.jackrabbit.api.security.user
- AuthorizableExistsException - Exception in org.apache.jackrabbit.api.security.user
-
AuthorizableExistsException
- AuthorizableExistsException(String) - Constructor for exception org.apache.jackrabbit.api.security.user.AuthorizableExistsException
- AuthorizableTypeException - Exception in org.apache.jackrabbit.api.security.user
-
The
AuthorizableTypeException
signals anAuthorizable
type mismatch. - AuthorizableTypeException(String) - Constructor for exception org.apache.jackrabbit.api.security.user.AuthorizableTypeException
- autoSave(boolean) - Method in interface org.apache.jackrabbit.api.security.user.UserManager
-
Changes the auto save behavior of this
UserManager
.
B
- beforeScanning(Node) - Method in interface org.apache.jackrabbit.api.management.MarkEventListener
-
This method is called before a node is scanned.
- BinaryDownload - Interface in org.apache.jackrabbit.api.binary
-
This extension interface provides a mechanism whereby a client can download a
Binary
directly from a storage location. - BinaryDownloadOptions - Class in org.apache.jackrabbit.api.binary
-
Specifies the options to be used when obtaining a direct download URI via
BinaryDownload.getURI(BinaryDownloadOptions)
. - BinaryDownloadOptions.BinaryDownloadOptionsBuilder - Class in org.apache.jackrabbit.api.binary
-
Used to build an instance of
BinaryDownloadOptions
with the options set as desired by the caller. - BinaryUpload - Interface in org.apache.jackrabbit.api.binary
-
Describes uploading a binary through HTTP requests in a single or multiple parts.
- BinaryUploadOptions - Class in org.apache.jackrabbit.api.binary
-
Specifies the options to be used when requesting direct upload URIs via
JackrabbitValueFactory.initiateBinaryUpload(long, int, BinaryUploadOptions)
. - BinaryUploadOptions.BinaryUploadOptionsBuilder - Class in org.apache.jackrabbit.api.binary
-
Used to build an instance of
BinaryUploadOptions
with the options set as desired by the caller. - build() - Method in class org.apache.jackrabbit.api.binary.BinaryDownloadOptions.BinaryDownloadOptionsBuilder
-
Construct a
BinaryDownloadOptions
instance with the properties specified to the builder. - build() - Method in class org.apache.jackrabbit.api.binary.BinaryUploadOptions.BinaryUploadOptionsBuilder
-
Construct a
BinaryUploadOptions
instance with the properties specified to the builder. - build(QueryBuilder<T>) - Method in interface org.apache.jackrabbit.api.security.user.Query
-
Build the query using a
QueryBuilder
. - builder() - Static method in class org.apache.jackrabbit.api.binary.BinaryDownloadOptions
-
Returns a
BinaryDownloadOptions.BinaryDownloadOptionsBuilder
instance to be used for creating an instance of this class. - builder() - Static method in class org.apache.jackrabbit.api.binary.BinaryUploadOptions
-
Returns a
BinaryUploadOptions.BinaryUploadOptionsBuilder
instance to be used for creating an instance of this class. - BUNDLE_CACHE_ACCESS_COUNTER - org.apache.jackrabbit.api.stats.RepositoryStatistics.Type
- BUNDLE_CACHE_MISS_AVERAGE - org.apache.jackrabbit.api.stats.RepositoryStatistics.Type
- BUNDLE_CACHE_MISS_COUNTER - org.apache.jackrabbit.api.stats.RepositoryStatistics.Type
- BUNDLE_CACHE_MISS_DURATION - org.apache.jackrabbit.api.stats.RepositoryStatistics.Type
- BUNDLE_CACHE_SIZE_COUNTER - org.apache.jackrabbit.api.stats.RepositoryStatistics.Type
- BUNDLE_COUNTER - org.apache.jackrabbit.api.stats.RepositoryStatistics.Type
- BUNDLE_READ_COUNTER - org.apache.jackrabbit.api.stats.RepositoryStatistics.Type
- BUNDLE_WRITE_AVERAGE - org.apache.jackrabbit.api.stats.RepositoryStatistics.Type
- BUNDLE_WRITE_COUNTER - org.apache.jackrabbit.api.stats.RepositoryStatistics.Type
- BUNDLE_WRITE_DURATION - org.apache.jackrabbit.api.stats.RepositoryStatistics.Type
- BUNDLE_WS_SIZE_COUNTER - org.apache.jackrabbit.api.stats.RepositoryStatistics.Type
C
- changePassword(String) - Method in interface org.apache.jackrabbit.api.security.user.User
-
Change the password of this user.
- changePassword(String, String) - Method in interface org.apache.jackrabbit.api.security.user.User
-
Change the password of this user.
- clearPopularQueriesQueue() - Method in interface org.apache.jackrabbit.api.jmx.QueryStatManagerMBean
-
clears the Popular queue
- clearPopularQueriesQueue() - Method in interface org.apache.jackrabbit.api.stats.QueryStat
-
clears the Popular queue
- clearSlowQueriesQueue() - Method in interface org.apache.jackrabbit.api.jmx.QueryStatManagerMBean
-
clears the Slow queue
- clearSlowQueriesQueue() - Method in interface org.apache.jackrabbit.api.stats.QueryStat
-
clears the Slow queue
- close() - Method in interface org.apache.jackrabbit.api.management.DataStoreGarbageCollector
-
Cleanup resources used internally by this instance.
- completeBinaryUpload(String) - Method in interface org.apache.jackrabbit.api.JackrabbitValueFactory
-
Complete the transaction of uploading a binary directly to a storage location and return a
Binary
to set as value for a binary JCR property. - contains(String, String) - Method in interface org.apache.jackrabbit.api.security.user.QueryBuilder
-
Create a full text search condition.
- createDataStoreGarbageCollector() - Method in interface org.apache.jackrabbit.api.management.RepositoryManager
-
Create a data store garbage collector for this repository.
- createGroup(String) - Method in interface org.apache.jackrabbit.api.security.user.UserManager
-
Creates a Group for the given groupID, which must not be
null
. - createGroup(String, Principal, String) - Method in interface org.apache.jackrabbit.api.security.user.UserManager
-
Creates a new
Group
that is based on the given id, principal and the specifiedintermediatePath
hint. - createGroup(Principal) - Method in interface org.apache.jackrabbit.api.security.user.UserManager
-
Creates a new
Group
that is based on the given principal. - createGroup(Principal, String) - Method in interface org.apache.jackrabbit.api.security.user.UserManager
-
Same as
UserManager.createGroup(String, Principal, String)
where the name of the specified principal is used to create the group's ID. - createSystemUser(String, String) - Method in interface org.apache.jackrabbit.api.security.user.UserManager
-
Create a new system user for the specified
userID
. - createUser(String, String) - Method in interface org.apache.jackrabbit.api.security.user.UserManager
-
Creates an User for the given userID / password pair; neither of the specified parameters can be
null
.
Same asUserManager.createUser(String,String,Principal,String)
where the specified userID is equal to the principal name and the intermediate path isnull
. - createUser(String, String, Principal, String) - Method in interface org.apache.jackrabbit.api.security.user.UserManager
-
Creates an User for the given parameters.
- createWorkspace(String) - Method in interface org.apache.jackrabbit.api.JackrabbitWorkspace
-
Creates a workspace with the given name.
- createWorkspace(String) - Method in interface org.apache.jackrabbit.api.jmx.ManagedRepositoryMBean
-
Creates a new workspace with the given name.
- createWorkspace(String, InputSource) - Method in interface org.apache.jackrabbit.api.JackrabbitWorkspace
-
Creates a workspace with the given name and a workspace configuration template.
D
- DataStoreGarbageCollector - Interface in org.apache.jackrabbit.api.management
-
Garbage collector for DataStore.
- declaredMemberOf() - Method in interface org.apache.jackrabbit.api.security.user.Authorizable
- Default(Privilege[], AccessControlManager) - Constructor for class org.apache.jackrabbit.api.security.authorization.PrivilegeCollection.Default
- DEFAULT - Static variable in class org.apache.jackrabbit.api.binary.BinaryDownloadOptions
-
Provides a default instance of this class.
- DEFAULT - Static variable in class org.apache.jackrabbit.api.binary.BinaryUploadOptions
-
Provides a default instance of this class.
- DESCENDING - org.apache.jackrabbit.api.security.user.QueryBuilder.Direction
- disable(String) - Method in interface org.apache.jackrabbit.api.security.user.User
-
Disable this user thus preventing future login if the
reason
is a non-null String.
Note however, that this user will still be accessible byUserManager.getAuthorizable(java.lang.String)
.
E
- eq(String, Value) - Method in interface org.apache.jackrabbit.api.security.user.QueryBuilder
-
Create a condition which holds if the node of an
Authorizable
has a property atrelPath
which is equal tovalue
. - EventListenerMBean - Interface in org.apache.jackrabbit.api.jmx
-
MBean interface for exposing information about a registered observation listener.
- exists(String) - Method in interface org.apache.jackrabbit.api.security.user.QueryBuilder
-
Create a condition which holds if the node of an
Authorizable
has a property atrelPath
.
F
- findAuthorizables(String, String) - Method in interface org.apache.jackrabbit.api.security.user.UserManager
-
Returns all
Authorizable
s that have aproperty
with the given relative path (or name) that matches the specified value. - findAuthorizables(String, String, int) - Method in interface org.apache.jackrabbit.api.security.user.UserManager
-
Returns all
Authorizable
s that have aproperty
with the given relative path (or name) that matches the specified value. - findAuthorizables(Query) - Method in interface org.apache.jackrabbit.api.security.user.UserManager
-
Return
Authorizable
s that match a specificQuery
. - findPrincipals(String) - Method in interface org.apache.jackrabbit.api.security.principal.PrincipalManager
-
Gets the principals matching a simple filter expression applied against the
principal name
. - findPrincipals(String, int) - Method in interface org.apache.jackrabbit.api.security.principal.PrincipalManager
-
Gets the principals matching a simple filter expression applied against the
principal name
AND the specified search type.
G
- ge(String, Value) - Method in interface org.apache.jackrabbit.api.security.user.QueryBuilder
-
Create a condition which holds if the node of an
Authorizable
has a property atrelPath
which is greater than or equal tovalue
. - getAbsPath() - Method in interface org.apache.jackrabbit.api.jmx.EventListenerMBean
-
Absolute path of the listener registration
- getAbsPath() - Method in class org.apache.jackrabbit.api.observation.JackrabbitEventFilter
-
Returns the
absPath
parameter of the filter. - getAdditionalPaths() - Method in class org.apache.jackrabbit.api.observation.JackrabbitEventFilter
-
Returns the
absPaths
parameter of the filter. - getApplicablePolicies(Principal) - Method in interface org.apache.jackrabbit.api.security.JackrabbitAccessControlManager
-
Returns the applicable policies for the specified
principal
or an empty array if no additional policies can be applied. - getAttribute(String) - Method in class org.apache.jackrabbit.api.security.authentication.token.TokenCredentials
-
Returns the value of the named attribute as an
Object
, ornull
if no attribute of the given name exists. - getAttributeNames() - Method in class org.apache.jackrabbit.api.security.authentication.token.TokenCredentials
-
Returns the names of the attributes available to this credentials instance.
- getAuthorizable(String) - Method in interface org.apache.jackrabbit.api.security.user.UserManager
-
Get the Authorizable by its id.
- getAuthorizable(String, Class<T>) - Method in interface org.apache.jackrabbit.api.security.user.UserManager
-
Get the Authorizable of a specific type by its id.
- getAuthorizable(Principal) - Method in interface org.apache.jackrabbit.api.security.user.UserManager
-
Get the Authorizable by its Principal.
- getAuthorizableByPath(String) - Method in interface org.apache.jackrabbit.api.security.user.UserManager
-
In accordance to
Authorizable.getPath()
this method allows to retrieve an given authorizable by it's path. - getCharacterEncoding() - Method in class org.apache.jackrabbit.api.binary.BinaryDownloadOptions
-
Returns the character encoding that should be assumed for the binary that is to be downloaded.
- getClassName() - Method in interface org.apache.jackrabbit.api.jmx.EventListenerMBean
-
Class name of the event listener
- getContentIdentity() - Method in interface org.apache.jackrabbit.api.JackrabbitValue
-
Get a unique identifier of the content of this value.
- getCreationTime() - Method in interface org.apache.jackrabbit.api.stats.QueryStatDto
- getCredentials() - Method in interface org.apache.jackrabbit.api.security.user.User
-
Returns the internal
Credentials
representation for this user. - getDeclaredMembers() - Method in interface org.apache.jackrabbit.api.security.user.Group
- getDescriptors() - Method in interface org.apache.jackrabbit.api.jmx.ManagedRepositoryMBean
-
Returns all the repository descriptors.
- getDirection() - Method in enum org.apache.jackrabbit.api.security.user.QueryBuilder.Direction
- getDisabledReason() - Method in interface org.apache.jackrabbit.api.security.user.User
- getDispositionType() - Method in class org.apache.jackrabbit.api.binary.BinaryDownloadOptions
-
Returns the disposition type that should be assumed for the binary that is to be downloaded.
- getDuration() - Method in interface org.apache.jackrabbit.api.stats.QueryStatDto
- getEffectivePath() - Method in interface org.apache.jackrabbit.api.security.authorization.PrincipalAccessControlList.Entry
-
Returns the path of target object where this entry will take effect.
- getEffectivePolicies(Set<Principal>) - Method in interface org.apache.jackrabbit.api.security.JackrabbitAccessControlManager
-
Returns the
AccessControlPolicy
objects that are in effect for the givenPrincipal
s. - getEffectivePolicies(Set<Principal>, String...) - Method in interface org.apache.jackrabbit.api.security.JackrabbitAccessControlManager
-
Returns the
AccessControlPolicy
objects that are in effect for the givenPrincipal
s at the specified absolute paths. - getEventConsumerTime() - Method in interface org.apache.jackrabbit.api.jmx.EventListenerMBean
- getEventConsumerTimeRatio() - Method in interface org.apache.jackrabbit.api.jmx.EventListenerMBean
-
Ratio of time spent in event listener vs.
- getEventCount() - Method in interface org.apache.jackrabbit.api.jmx.EventListenerMBean
- getEventDeliveries() - Method in interface org.apache.jackrabbit.api.jmx.EventListenerMBean
-
Number of
onEvent()
calls made on the listener - getEventDeliveriesPerHour() - Method in interface org.apache.jackrabbit.api.jmx.EventListenerMBean
-
Average number of
onEvent()
calls per hour - getEventProducerTime() - Method in interface org.apache.jackrabbit.api.jmx.EventListenerMBean
- getEventsDelivered() - Method in interface org.apache.jackrabbit.api.jmx.EventListenerMBean
-
Number of individual events delivered to the listener
- getEventsDeliveredPerHour() - Method in interface org.apache.jackrabbit.api.jmx.EventListenerMBean
-
Average number of individual events delivered per hour
- getEventTypes() - Method in interface org.apache.jackrabbit.api.jmx.EventListenerMBean
-
Event types of the listener registration
- getEventTypes() - Method in class org.apache.jackrabbit.api.observation.JackrabbitEventFilter
-
Returns the
eventTypes
parameter of the filter. - getEveryone() - Method in interface org.apache.jackrabbit.api.security.principal.PrincipalManager
-
Returns the
Principal
which is implicitly applied to every subject. - getExcludedPaths() - Method in class org.apache.jackrabbit.api.observation.JackrabbitEventFilter
-
Returns the
excludedPaths
parameter of the filter. - getFileName() - Method in class org.apache.jackrabbit.api.binary.BinaryDownloadOptions
-
Returns the filename that should be assumed for the binary that is to be downloaded.
- getGroupMembership(Principal) - Method in interface org.apache.jackrabbit.api.security.principal.PrincipalManager
-
Returns an iterator over all group principals for which the given principal is either direct or indirect member of.
- getID() - Method in interface org.apache.jackrabbit.api.security.user.Authorizable
-
Return the implementation specific identifier for this
Authorizable
. - getIdentifiers() - Method in class org.apache.jackrabbit.api.observation.JackrabbitEventFilter
-
Returns the
uuids
parameter of the filter. - getImpersonation() - Method in interface org.apache.jackrabbit.api.security.user.User
- getImpersonators() - Method in interface org.apache.jackrabbit.api.security.user.Impersonation
- getInitStackTrace() - Method in interface org.apache.jackrabbit.api.jmx.EventListenerMBean
-
Stack trace of where the listener was registered
- getIsDeep() - Method in class org.apache.jackrabbit.api.observation.JackrabbitEventFilter
-
Returns the
isDeep
parameter of the filter. - getItemOrNull(String) - Method in interface org.apache.jackrabbit.api.JackrabbitSession
-
Returns the node at the specified absolute path in the workspace.
- getLanguage() - Method in interface org.apache.jackrabbit.api.stats.QueryStatDto
- getMaxPartSize() - Method in interface org.apache.jackrabbit.api.binary.BinaryUpload
-
Return the largest possible part size in bytes.
- getMediaType() - Method in class org.apache.jackrabbit.api.binary.BinaryDownloadOptions
-
Returns the internet media type that should be assumed for the binary that is to be downloaded.
- getMembers() - Method in interface org.apache.jackrabbit.api.security.user.Group
- getMicrosecondsPerEventDelivered() - Method in interface org.apache.jackrabbit.api.jmx.EventListenerMBean
-
Average time (in microseconds) taken per event delivered
- getMicrosecondsPerEventDelivery() - Method in interface org.apache.jackrabbit.api.jmx.EventListenerMBean
-
Average time (in microseconds) taken per
onEvent()
call - getMinPartSize() - Method in interface org.apache.jackrabbit.api.binary.BinaryUpload
-
Return the smallest possible part size in bytes.
- getMissingValue() - Method in interface org.apache.jackrabbit.api.stats.TimeSeries
-
The value used to encode missing values i.e.
- getName() - Method in interface org.apache.jackrabbit.api.jmx.ManagedRepositoryMBean
-
Returns the name of this repository implementation.
- getNodeOrNull(String) - Method in interface org.apache.jackrabbit.api.JackrabbitNode
-
Returns the node at
relPath
relative tothis
node ornull
if no such node exists. - getNodeOrNull(String) - Method in interface org.apache.jackrabbit.api.JackrabbitSession
-
Returns the node at the specified absolute path in the workspace or
null
if no such node exists. - getNodeTypeName() - Method in interface org.apache.jackrabbit.api.jmx.EventListenerMBean
-
Node types of the listener registration
- getNodeTypes() - Method in class org.apache.jackrabbit.api.observation.JackrabbitEventFilter
-
Returns the
nodeTypeName
parameter of the filter. - getNoExternal() - Method in class org.apache.jackrabbit.api.observation.JackrabbitEventFilter
-
Returns the
noExternal
parameter of the filter. - getNoInternal() - Method in class org.apache.jackrabbit.api.observation.JackrabbitEventFilter
-
Returns the
noInternal
parameter of the filter. - getNoLocal() - Method in class org.apache.jackrabbit.api.observation.JackrabbitEventFilter
-
Returns the
noLocal
parameter of the filter. - getOccurrenceCount() - Method in interface org.apache.jackrabbit.api.stats.QueryStatDto
- getParentOrNull(Item) - Method in interface org.apache.jackrabbit.api.JackrabbitSession
-
Returns the parent of the given
Item
ornull
if no parent exists (either because the givenItem
represents the root node or the current session does not have sufficient access to retrieve the parent). - getPath() - Method in interface org.apache.jackrabbit.api.security.JackrabbitAccessControlPolicy
-
Returns the path of the node this policy has been created for.
- getPath() - Method in interface org.apache.jackrabbit.api.security.principal.ItemBasedPrincipal
-
Returns the JCR path of the item that corresponds to this
Principal
. - getPath() - Method in interface org.apache.jackrabbit.api.security.user.Authorizable
-
Returns a JCR path if this authorizable instance is associated with an item that can be accessed by the editing
Session
. - getPolicies(Principal) - Method in interface org.apache.jackrabbit.api.security.JackrabbitAccessControlManager
-
Returns the
AccessControlPolicy
objects that have been set for the givenprincipal
or an empty array if no policy has been set. - getPopularQueries() - Method in interface org.apache.jackrabbit.api.jmx.QueryStatManagerMBean
- getPopularQueries() - Method in interface org.apache.jackrabbit.api.stats.QueryStat
- getPopularQueriesQueueSize() - Method in interface org.apache.jackrabbit.api.jmx.QueryStatManagerMBean
- getPopularQueriesQueueSize() - Method in interface org.apache.jackrabbit.api.stats.QueryStat
- getPosition() - Method in interface org.apache.jackrabbit.api.stats.QueryStatDto
- getPrincipal() - Method in interface org.apache.jackrabbit.api.security.authorization.PrincipalAccessControlList
-
Returns the
Principal
this policy is bound to. - getPrincipal() - Method in interface org.apache.jackrabbit.api.security.user.Authorizable
- getPrincipal(String) - Method in interface org.apache.jackrabbit.api.security.principal.PrincipalManager
-
Returns the principal with the given name if is known to this manager (with respect to the sessions access rights).
- getPrincipalManager() - Method in interface org.apache.jackrabbit.api.JackrabbitSession
-
Returns the
PrincipalManager
for the currentSession
. - getPrincipals() - Method in interface org.apache.jackrabbit.api.security.authorization.PrincipalSetPolicy
-
Returns the set of
Principal
s that are allowed to perform implementation specific actions on the items affected by this policy. - getPrincipals(int) - Method in interface org.apache.jackrabbit.api.security.principal.PrincipalManager
-
Returns all
Principal
s matching the specified search type. - getPrivilege(String) - Method in interface org.apache.jackrabbit.api.security.authorization.PrivilegeManager
-
Returns the privilege with the specified
privilegeName
. - getPrivilegeCollection() - Method in interface org.apache.jackrabbit.api.security.JackrabbitAccessControlEntry
-
Returns a
PrivilegeCollection
representing the privileges associated with this entry. - getPrivilegeCollection(String) - Method in interface org.apache.jackrabbit.api.security.JackrabbitAccessControlManager
-
Returns the
PrivilegeCollection
for editing session at the given absolute path, which must be an existing node. - getPrivilegeCollection(String, Set<Principal>) - Method in interface org.apache.jackrabbit.api.security.JackrabbitAccessControlManager
-
Returns the
PrivilegeCollection
for the given set of principals at the given absolute path, which must be an existing node. - getPrivilegeManager() - Method in interface org.apache.jackrabbit.api.JackrabbitWorkspace
-
Returns the privilege manager.
- getPrivileges() - Method in class org.apache.jackrabbit.api.security.authorization.PrivilegeCollection.Default
- getPrivileges() - Method in interface org.apache.jackrabbit.api.security.authorization.PrivilegeCollection
-
Return the underlying privilege array.
- getPrivileges(String, Set<Principal>) - Method in interface org.apache.jackrabbit.api.security.JackrabbitAccessControlManager
-
Returns the privileges the given set of
Principal
s has for absolute pathabsPath
, which must be an existing node. - getProperty(String) - Method in interface org.apache.jackrabbit.api.security.user.Authorizable
-
Returns the values for the properties with the specified name or
null
. - getPropertyNames() - Method in interface org.apache.jackrabbit.api.security.user.Authorizable
-
Returns the names of properties present with
this
Authorizable not taking possible relative paths into consideration. - getPropertyNames(String) - Method in interface org.apache.jackrabbit.api.security.user.Authorizable
-
Returns the names of properties present with
this
Authorizable at the specified relative path. - getPropertyOrNull(String) - Method in interface org.apache.jackrabbit.api.JackrabbitNode
-
Returns the property at
relPath
relative tothis
node ornull
if no such property exists. - getPropertyOrNull(String) - Method in interface org.apache.jackrabbit.api.JackrabbitSession
-
Returns the property at the specified absolute path in the workspace or
null
if no such node exists. - getQueueBacklogMillis() - Method in interface org.apache.jackrabbit.api.jmx.EventListenerMBean
-
The time difference between the current system time and the head (oldest) element in the queue in milliseconds.
- getQueueLength() - Method in interface org.apache.jackrabbit.api.jmx.EventListenerMBean
-
time series
of the number of items related to generating observation events that are currently queued by the system. - getRatioOfTimeSpentProcessingEvents() - Method in interface org.apache.jackrabbit.api.jmx.EventListenerMBean
-
Ratio of time spent in event processing
- getReference() - Method in interface org.apache.jackrabbit.api.ReferenceBinary
-
Returns a secure reference to this binary, or
null
if such a reference is not available. - getRegisteredPrivileges() - Method in interface org.apache.jackrabbit.api.security.authorization.PrivilegeManager
-
Returns all registered privileges.
- getRepositoryManager(JackrabbitRepository) - Method in interface org.apache.jackrabbit.api.JackrabbitRepositoryFactory
-
Get the repository management component.
- getRestriction(String) - Method in interface org.apache.jackrabbit.api.security.JackrabbitAccessControlEntry
-
Return the value of the restriction with the specified name or
null
if no such restriction exists. - getRestrictionNames() - Method in interface org.apache.jackrabbit.api.security.JackrabbitAccessControlEntry
-
Return the names of the restrictions present with this access control entry.
- getRestrictionNames() - Method in interface org.apache.jackrabbit.api.security.JackrabbitAccessControlList
-
Returns the names of the supported restrictions or an empty array if no restrictions are respected.
- getRestrictions(String) - Method in interface org.apache.jackrabbit.api.security.JackrabbitAccessControlEntry
-
Return the values of the restriction with the specified name or
null
if no such restriction exists. - getRestrictionType(String) - Method in interface org.apache.jackrabbit.api.security.JackrabbitAccessControlList
-
Return the expected
property type
of the restriction with the specifiedrestrictionName
. - getSleepBetweenNodes() - Method in interface org.apache.jackrabbit.api.management.DataStoreGarbageCollector
-
Get the delay between scanning items.
- getSlowQueries() - Method in interface org.apache.jackrabbit.api.jmx.QueryStatManagerMBean
- getSlowQueries() - Method in interface org.apache.jackrabbit.api.stats.QueryStat
- getSlowQueriesQueueSize() - Method in interface org.apache.jackrabbit.api.jmx.QueryStatManagerMBean
- getSlowQueriesQueueSize() - Method in interface org.apache.jackrabbit.api.stats.QueryStat
- getStatement() - Method in interface org.apache.jackrabbit.api.stats.QueryStatDto
- getTimeSeries(String, boolean) - Method in interface org.apache.jackrabbit.api.stats.RepositoryStatistics
- getTimeSeries(RepositoryStatistics.Type) - Method in interface org.apache.jackrabbit.api.stats.RepositoryStatistics
- getToken() - Method in class org.apache.jackrabbit.api.security.authentication.token.TokenCredentials
-
Returns the token this credentials are built from.
- getToString() - Method in interface org.apache.jackrabbit.api.jmx.EventListenerMBean
-
toString of the event listener
- getTotalSize() - Method in interface org.apache.jackrabbit.api.query.JackrabbitQueryResult
-
Returns the total number of hits.
- getType(String) - Static method in enum org.apache.jackrabbit.api.stats.RepositoryStatistics.Type
- getUploadToken() - Method in interface org.apache.jackrabbit.api.binary.BinaryUpload
-
Returns a token identifying this upload.
- getUploadURIs() - Method in interface org.apache.jackrabbit.api.binary.BinaryUpload
-
Returns a list of URIs that can be used for uploading binary data directly to a storage location in one or more parts.
- getURI(BinaryDownloadOptions) - Method in interface org.apache.jackrabbit.api.binary.BinaryDownload
-
Returns a URI for downloading this binary directly from the storage location.
- getUserManager() - Method in interface org.apache.jackrabbit.api.JackrabbitSession
-
Returns the
UserManager
for the currentSession
. - getUuid() - Method in interface org.apache.jackrabbit.api.jmx.EventListenerMBean
-
UUIDs of the listener registration
- getValuePerHour() - Method in interface org.apache.jackrabbit.api.stats.TimeSeries
-
Returns the measured value per hour over the last week.
- getValuePerMinute() - Method in interface org.apache.jackrabbit.api.stats.TimeSeries
-
Returns the measured value per minute over the last hour.
- getValuePerSecond() - Method in interface org.apache.jackrabbit.api.stats.TimeSeries
-
Returns the measured value per second over the last minute.
- getValuePerWeek() - Method in interface org.apache.jackrabbit.api.stats.TimeSeries
-
Returns the measured value per week over the last three years.
- getVersion() - Method in interface org.apache.jackrabbit.api.jmx.ManagedRepositoryMBean
-
Returns the version of this repository implementation.
- getWorkspaceNames() - Method in interface org.apache.jackrabbit.api.jmx.ManagedRepositoryMBean
-
Returns the names of all the workspaces in this repository.
- getXAResource() - Method in interface org.apache.jackrabbit.api.XASession
-
Deprecated.Retrieves an
XAResource
object that the transaction manager will use to manage this XASession object's participation in a distributed transaction. - grantImpersonation(Principal) - Method in interface org.apache.jackrabbit.api.security.user.Impersonation
- Group - Interface in org.apache.jackrabbit.api.security.user
-
A Group is a collection of
Authorizable
s. - GroupPrincipal - Interface in org.apache.jackrabbit.api.security.principal
-
This interface is used to represent a group of principals.
- gt(String, Value) - Method in interface org.apache.jackrabbit.api.security.user.QueryBuilder
-
Create a condition which holds if the node of an
Authorizable
has a property atrelPath
which is greater thanvalue
.
H
- hasNodeType(String) - Method in interface org.apache.jackrabbit.api.JackrabbitNodeTypeManager
-
Deprecated.Checks if a node type with the given name is registered.
- hasPermission(String, String...) - Method in interface org.apache.jackrabbit.api.JackrabbitSession
-
Returns
true
if thisSession
has permission to perform the specified actions at the specifiedabsPath
andfalse
otherwise. - hasPrincipal(String) - Method in interface org.apache.jackrabbit.api.security.principal.PrincipalManager
-
Checks if the principal with the given name is known to this manager (in respect to the sessions access rights).
- hasPrivileges(String, Set<Principal>, Privilege[]) - Method in interface org.apache.jackrabbit.api.security.JackrabbitAccessControlManager
-
Returns whether the given set of
Principal
s has the specified privileges for absolute pathabsPath
, which must be an existing node. - hasProperty(String) - Method in interface org.apache.jackrabbit.api.security.user.Authorizable
-
Tests if a the property with specified name exists.
I
- impersonates(String) - Method in interface org.apache.jackrabbit.api.security.user.QueryBuilder
-
Create a condition which holds for
Authorizable
s which can impersonate asname
. - Impersonation - Interface in org.apache.jackrabbit.api.security.user
-
The
Impersonation
maintains Principals that are allowed to impersonate. - includes(String...) - Method in class org.apache.jackrabbit.api.security.authorization.PrivilegeCollection.Default
- includes(String...) - Method in interface org.apache.jackrabbit.api.security.authorization.PrivilegeCollection
-
Tests whether the given JCR
privilegeNames
are contained in the privileges for which this instance ofPrivilegeEvaluation
has been created such as e.g. - initiateBinaryUpload(long, int) - Method in interface org.apache.jackrabbit.api.JackrabbitValueFactory
-
Initiate a transaction to upload a binary directly to a storage location and return
BinaryUpload
instructions for a remote client. - initiateBinaryUpload(long, int, BinaryUploadOptions) - Method in interface org.apache.jackrabbit.api.JackrabbitValueFactory
-
Initiate a transaction to upload a binary directly to a storage location and return
BinaryUpload
instructions for a remote client. - isAdmin() - Method in interface org.apache.jackrabbit.api.security.user.User
- isAllow() - Method in interface org.apache.jackrabbit.api.security.JackrabbitAccessControlEntry
- isAutoSave() - Method in interface org.apache.jackrabbit.api.security.user.UserManager
-
If any write operations executed through the User API are automatically persisted this method returns
true
. - isDateAccessedFromExternalEvent() - Method in interface org.apache.jackrabbit.api.jmx.EventListenerMBean
-
Is date information accessed from an external event?
- isDateAccessedWithoutExternalsCheck() - Method in interface org.apache.jackrabbit.api.jmx.EventListenerMBean
-
Is date information accessed without checking if an event is external?
- isDeclaredMember(Authorizable) - Method in interface org.apache.jackrabbit.api.security.user.Group
-
Test whether an
Authorizable
is a declared member of this group. - isDeep() - Method in interface org.apache.jackrabbit.api.jmx.EventListenerMBean
-
Whether the listener registration is deep
- isDisabled() - Method in interface org.apache.jackrabbit.api.security.user.User
-
Returns
true
if this user is disabled,false
otherwise. - isDomainOverrideIgnored() - Method in class org.apache.jackrabbit.api.binary.BinaryUploadOptions
-
Indicates whether the option to ignore any configured domain override setting has been specified.
- isDownloadDomainIgnored() - Method in class org.apache.jackrabbit.api.binary.BinaryDownloadOptions
-
Returns a boolean value that indicates whether the data store should ignore any provided download domain override configuration value when generating the signed URI.
- isEmpty() - Method in interface org.apache.jackrabbit.api.security.JackrabbitAccessControlList
-
Returns
true
if this policy does not yet define any entries. - isEnabled() - Method in interface org.apache.jackrabbit.api.stats.QueryStat
-
If this service is currently registering stats
- isExternal() - Method in interface org.apache.jackrabbit.api.observation.JackrabbitEvent
-
Return a flag indicating whether this is an externally generated event.
- isGroup() - Method in interface org.apache.jackrabbit.api.security.user.Authorizable
- isMember(Principal) - Method in interface org.apache.jackrabbit.api.security.principal.GroupPrincipal
-
Returns true if the passed principal is a member of the group.
- isMember(Authorizable) - Method in interface org.apache.jackrabbit.api.security.user.Group
- isMultiValueRestriction(String) - Method in interface org.apache.jackrabbit.api.security.JackrabbitAccessControlList
-
Returns
true
if the restriction is multivalued;false
otherwise. - isNoLocal() - Method in interface org.apache.jackrabbit.api.jmx.EventListenerMBean
-
Whether the listener registration is non-local
- isPersistenceManagerScan() - Method in interface org.apache.jackrabbit.api.management.DataStoreGarbageCollector
-
Check if using the IterablePersistenceManager interface is allowed.
- isResetValueEachSecond() - Method in enum org.apache.jackrabbit.api.stats.RepositoryStatistics.Type
- isSystemUser() - Method in interface org.apache.jackrabbit.api.security.user.User
- isUserInfoAccessedFromExternalEvent() - Method in interface org.apache.jackrabbit.api.jmx.EventListenerMBean
-
Is user information accessed from an external event?
- isUserInfoAccessedWithoutExternalsCheck() - Method in interface org.apache.jackrabbit.api.jmx.EventListenerMBean
-
Is user information accessed without checking if an event is external?
- ItemBasedPrincipal - Interface in org.apache.jackrabbit.api.security.principal
-
ItemBasedPrincipal
is aPrincipal
having a corresponding item within the JCR repository.
J
- JackrabbitAccessControlEntry - Interface in org.apache.jackrabbit.api.security
-
JackrabbitAccessControlEntry
is a Jackrabbit specific extension of theAccessControlEntry
interface. - JackrabbitAccessControlList - Interface in org.apache.jackrabbit.api.security
-
JackrabbitAccessControlList
is an extension of theAccessControlList
. - JackrabbitAccessControlManager - Interface in org.apache.jackrabbit.api.security
-
JackrabbitAccessControlManager
provides extensions to theAccessControlManager
interface. - JackrabbitAccessControlPolicy - Interface in org.apache.jackrabbit.api.security
-
JackrabbitAccessControlPolicy
is an extension of theAccessControlPolicy
that exposes the path of the Node to which it can be applied usingAccessControlManager.setPolicy(String, javax.jcr.security.AccessControlPolicy)
. - JackrabbitEvent - Interface in org.apache.jackrabbit.api.observation
-
This is an extension of the event interface which provides a method to detect whether the changes happened on locally or remotely in a clustered environment.
- JackrabbitEventFilter - Class in org.apache.jackrabbit.api.observation
-
A storage object for event filter configuration.
- JackrabbitEventFilter() - Constructor for class org.apache.jackrabbit.api.observation.JackrabbitEventFilter
- JackrabbitNode - Interface in org.apache.jackrabbit.api
-
The Jackrabbit Node interface.
- JackrabbitNodeTypeManager - Interface in org.apache.jackrabbit.api
-
Deprecated.Use standard JCR 2.0 API methods defined by
NodeTypeManager
instead. - JackrabbitObservationManager - Interface in org.apache.jackrabbit.api.observation
-
Jackrabbit specific extensions to
ObservationManager
. - JackrabbitPrincipal - Interface in org.apache.jackrabbit.api.security.principal
-
JackrabbitPrincipal
marks the principal to be the result of authentication against the repository. - JackrabbitQueryResult - Interface in org.apache.jackrabbit.api.query
-
The Jackrabbit query result interface.
- JackrabbitRepository - Interface in org.apache.jackrabbit.api
-
The Jackrabbit repository interface.
- JackrabbitRepositoryFactory - Interface in org.apache.jackrabbit.api
-
Classes that implement this interface additionally provide management features.
- JackrabbitSession - Interface in org.apache.jackrabbit.api
-
Jackrabbit specific extension of the JCR
Session
interface. - JackrabbitValue - Interface in org.apache.jackrabbit.api
-
Values returned by Jackrabbit may implement this interface.
- JackrabbitValueFactory - Interface in org.apache.jackrabbit.api
-
Defines optional functionality that a
ValueFactory
may choose to provide. - JackrabbitWorkspace - Interface in org.apache.jackrabbit.api
-
The Jackrabbit workspace interface.
L
- le(String, Value) - Method in interface org.apache.jackrabbit.api.security.user.QueryBuilder
-
Create a condition which holds if the node of an
Authorizable
has a property atrelPath
which is smaller than or equal tovalue
. - like(String, String) - Method in interface org.apache.jackrabbit.api.security.user.QueryBuilder
-
Create a condition which holds if the node of an
Authorizable
has a property atrelPath
which matches the pattern inpattern
. - login(Credentials, String, Map<String, Object>) - Method in interface org.apache.jackrabbit.api.JackrabbitRepository
-
Equivalent to
login(credentials, workspaceName)
except that the returned Session instance contains the given extra session attributes in addition to any included in the given Credentials instance. - lt(String, Value) - Method in interface org.apache.jackrabbit.api.security.user.QueryBuilder
-
Create a condition which holds if the node of an
Authorizable
has a property atrelPath
which is smaller thanvalue
.
M
- ManagedRepositoryMBean - Interface in org.apache.jackrabbit.api.jmx
-
Interface for managing a JCR repository as a JMX MBean.
- mark() - Method in interface org.apache.jackrabbit.api.management.DataStoreGarbageCollector
-
Scan the repository.
- MarkEventListener - Interface in org.apache.jackrabbit.api.management
-
The listener interface for receiving garbage collection scan events.
- memberOf() - Method in interface org.apache.jackrabbit.api.security.user.Authorizable
- members() - Method in interface org.apache.jackrabbit.api.security.principal.GroupPrincipal
-
Returns an enumeration of the members in the group.
N
- NAME - Static variable in interface org.apache.jackrabbit.api.jmx.QueryStatManagerMBean
- nameMatches(String) - Method in interface org.apache.jackrabbit.api.security.user.QueryBuilder
-
Create a condition which holds if the name of the
Authorizable
matches apattern
. - neq(String, Value) - Method in interface org.apache.jackrabbit.api.security.user.QueryBuilder
-
Create a condition which holds if the node of an
Authorizable
has a property atrelPath
which is not equal tovalue
. - nextPrincipal() - Method in interface org.apache.jackrabbit.api.security.principal.PrincipalIterator
-
Returns the next principal.
- not(T) - Method in interface org.apache.jackrabbit.api.security.user.QueryBuilder
-
Return a condition which holds if
condition
does not hold.
O
- OBSERVATION_EVENT_AVERAGE - org.apache.jackrabbit.api.stats.RepositoryStatistics.Type
-
Average time spent processing observation events by all observation listeners in nano seconds.
- OBSERVATION_EVENT_COUNTER - org.apache.jackrabbit.api.stats.RepositoryStatistics.Type
-
Total number of observation
Event
instances delivered to all observation listeners. - OBSERVATION_EVENT_DURATION - org.apache.jackrabbit.api.stats.RepositoryStatistics.Type
-
Total time spent processing observation events by all observation listeners in nano seconds.
- OPTION_PRINCIPAL_MANAGEMENT_SUPPORTED - Static variable in interface org.apache.jackrabbit.api.JackrabbitRepository
-
Key to a
boolean
descriptor. - OPTION_PRIVILEGE_MANAGEMENT_SUPPORTED - Static variable in interface org.apache.jackrabbit.api.JackrabbitRepository
-
Key to a
boolean
descriptor. - OPTION_USER_MANAGEMENT_SUPPORTED - Static variable in interface org.apache.jackrabbit.api.JackrabbitRepository
-
Key to a
boolean
descriptor. - or(T, T) - Method in interface org.apache.jackrabbit.api.security.user.QueryBuilder
-
Return a condition which holds if any of the two sub conditions hold.
- orderBefore(AccessControlEntry, AccessControlEntry) - Method in interface org.apache.jackrabbit.api.security.JackrabbitAccessControlList
-
If the
AccessControlList
implementation supports reordering of entries the specifiedsrcEntry
is inserted at the position of the specifieddestEntry
. - org.apache.jackrabbit.api - package org.apache.jackrabbit.api
-
Jackrabbit extensions for JCR core interfaces
- org.apache.jackrabbit.api.binary - package org.apache.jackrabbit.api.binary
-
Interfaces related to direct upload/download of binaries.
- org.apache.jackrabbit.api.jmx - package org.apache.jackrabbit.api.jmx
-
JMX management interfaces for JCR.
- org.apache.jackrabbit.api.management - package org.apache.jackrabbit.api.management
-
Interfaces for managing a Jackrabbit repository.
- org.apache.jackrabbit.api.observation - package org.apache.jackrabbit.api.observation
-
Jackrabbit extensions for JCR observation.
- org.apache.jackrabbit.api.query - package org.apache.jackrabbit.api.query
- org.apache.jackrabbit.api.security - package org.apache.jackrabbit.api.security
-
Jackrabbit extensions for access control.
- org.apache.jackrabbit.api.security.authentication.token - package org.apache.jackrabbit.api.security.authentication.token
-
Token credentials.
- org.apache.jackrabbit.api.security.authorization - package org.apache.jackrabbit.api.security.authorization
-
Jackrabbit extensions for authorization.
- org.apache.jackrabbit.api.security.principal - package org.apache.jackrabbit.api.security.principal
-
Jackrabbit extensions for JAAS principals.
- org.apache.jackrabbit.api.security.user - package org.apache.jackrabbit.api.security.user
-
Jackrabbit extensions for user management.
- org.apache.jackrabbit.api.stats - package org.apache.jackrabbit.api.stats
-
Jackrabbit repository statistics
P
- PrincipalAccessControlList - Interface in org.apache.jackrabbit.api.security.authorization
-
Extension of the
JackrabbitAccessControlList
that is bound to aPrincipal
. - PrincipalAccessControlList.Entry - Interface in org.apache.jackrabbit.api.security.authorization
-
Extension of the
JackrabbitAccessControlEntry
that additionally defines the target object where this entry will take effect. - PrincipalIterator - Interface in org.apache.jackrabbit.api.security.principal
- PrincipalManager - Interface in org.apache.jackrabbit.api.security.principal
-
This interface defines the principal manager which is the clients view on all principals known to the repository.
- PrincipalSetPolicy - Interface in org.apache.jackrabbit.api.security.authorization
-
Extension of the JCR
AccessControlPolicy
intended to grant a set ofPrincipal
s the ability to perform certain actions. - PrivilegeCollection - Interface in org.apache.jackrabbit.api.security.authorization
-
Wrapper around a set of
Privilege
s that allows to test if a given list of privilege names in included. - PrivilegeCollection.Default - Class in org.apache.jackrabbit.api.security.authorization
-
Default implementation of the
PrivilegeCollection
interface. - privilegeCollectionFromNames(String...) - Method in interface org.apache.jackrabbit.api.security.JackrabbitAccessControlManager
-
Returns the
PrivilegeCollection
for the specifiedprivilegeNames
. - PrivilegeManager - Interface in org.apache.jackrabbit.api.security.authorization
-
PrivilegeManager
is a jackrabbit specific extensions to JCR access control management that allows to retrieve privileges known by this JCR implementation and to register new custom privileges according to implementation specific rules.
Q
- Query - Interface in org.apache.jackrabbit.api.security.user
-
A query to match
Authorizable
s. - QUERY_AVERAGE - org.apache.jackrabbit.api.stats.RepositoryStatistics.Type
-
Average time spent evaluating queries in milli seconds.
- QUERY_COUNT - org.apache.jackrabbit.api.stats.RepositoryStatistics.Type
-
Number of queries executed.
- QUERY_DURATION - org.apache.jackrabbit.api.stats.RepositoryStatistics.Type
-
Total time spent evaluating queries in milli seconds.
- QueryBuilder<T> - Interface in org.apache.jackrabbit.api.security.user
- QueryBuilder.Direction - Enum in org.apache.jackrabbit.api.security.user
-
The sort order of the result set of a query.
- QueryStat - Interface in org.apache.jackrabbit.api.stats
-
Statistics on query operations
- QueryStatDto - Interface in org.apache.jackrabbit.api.stats
-
Object that holds statistical info about a query.
- QueryStatManagerMBean - Interface in org.apache.jackrabbit.api.jmx
-
JMX Bindings for
QueryStat
.
R
- ReferenceBinary - Interface in org.apache.jackrabbit.api
-
Referenceable binary.
- ReferenceBinaryException - Exception in org.apache.jackrabbit.api
- ReferenceBinaryException(String) - Constructor for exception org.apache.jackrabbit.api.ReferenceBinaryException
- registerNodeTypes(InputStream, String) - Method in interface org.apache.jackrabbit.api.JackrabbitNodeTypeManager
-
Deprecated.Registers node types from the given input stream of the given type.
- registerNodeTypes(InputSource) - Method in interface org.apache.jackrabbit.api.JackrabbitNodeTypeManager
-
Deprecated.Registers node types from the given node type XML stream.
- registerPrivilege(String, boolean, String[]) - Method in interface org.apache.jackrabbit.api.security.authorization.PrivilegeManager
-
Creates and registers a new custom privilege with the specified characteristics and returns the new privilege.
- remove() - Method in interface org.apache.jackrabbit.api.security.user.Authorizable
-
Removes this
Authorizable
, if the session has sufficient permissions. - removeAttribute(String) - Method in class org.apache.jackrabbit.api.security.authentication.token.TokenCredentials
-
Removes an attribute from this credentials instance.
- removeMember(Authorizable) - Method in interface org.apache.jackrabbit.api.security.user.Group
-
Remove a member from this Group.
- removeMembers(String...) - Method in interface org.apache.jackrabbit.api.security.user.Group
-
Remove one or several members from this Group.
- removePrincipals(Principal...) - Method in interface org.apache.jackrabbit.api.security.authorization.PrincipalSetPolicy
-
Remove the specified
Principal
s for the set of allowed principals thus revoking their ability to perform the implementation specific actions on items where this policy takes effect. - removeProperty(String) - Method in interface org.apache.jackrabbit.api.security.user.Authorizable
-
Removes the property with the given name.
- rename(String) - Method in interface org.apache.jackrabbit.api.JackrabbitNode
- RepositoryManager - Interface in org.apache.jackrabbit.api.management
-
The repository manager provides life-cycle management features for repositories.
- RepositoryStatistics - Interface in org.apache.jackrabbit.api.stats
-
Statistics on core repository operations
- RepositoryStatistics.Type - Enum in org.apache.jackrabbit.api.stats
-
The values of this enum determine the type of the time series returned by
RepositoryStatistics.getTimeSeries(Type)
and linkRepositoryStatistics.getTimeSeries(String, boolean)
. - reset() - Method in interface org.apache.jackrabbit.api.stats.QueryStat
-
clears all data
- revokeImpersonation(Principal) - Method in interface org.apache.jackrabbit.api.security.user.Impersonation
S
- SEARCH_TYPE_ALL - Static variable in interface org.apache.jackrabbit.api.security.principal.PrincipalManager
-
Filter flag indicating that all
Principal
s should be search irrespective whether they represent a group of Principals or not. - SEARCH_TYPE_AUTHORIZABLE - Static variable in interface org.apache.jackrabbit.api.security.user.UserManager
-
Filter flag indicating that all
Authorizable
s should be searched. - SEARCH_TYPE_GROUP - Static variable in interface org.apache.jackrabbit.api.security.principal.PrincipalManager
-
Filter flag indicating that only
Principal
s that represent a group of Principals should be searched and returned. - SEARCH_TYPE_GROUP - Static variable in interface org.apache.jackrabbit.api.security.user.UserManager
-
Filter flag indicating that only
Group
s should be searched and returned. - SEARCH_TYPE_NOT_GROUP - Static variable in interface org.apache.jackrabbit.api.security.principal.PrincipalManager
-
Filter flag indicating that only
Principal
s that do NOT represent a group should be searched and returned. - SEARCH_TYPE_USER - Static variable in interface org.apache.jackrabbit.api.security.user.UserManager
-
Filter flag indicating that only
User
s should be searched and returned. - SESSION_COUNT - org.apache.jackrabbit.api.stats.RepositoryStatistics.Type
-
Number of currently logged in sessions.
- SESSION_LOGIN_COUNTER - org.apache.jackrabbit.api.stats.RepositoryStatistics.Type
-
Number of calls sessions that have been logged in.
- SESSION_READ_AVERAGE - org.apache.jackrabbit.api.stats.RepositoryStatistics.Type
-
Average time spent reading from sessions in nano seconds.
- SESSION_READ_COUNTER - org.apache.jackrabbit.api.stats.RepositoryStatistics.Type
-
Number of read accesses through any session.
- SESSION_READ_DURATION - org.apache.jackrabbit.api.stats.RepositoryStatistics.Type
-
Total time spent reading from sessions in nano seconds.
- SESSION_WRITE_AVERAGE - org.apache.jackrabbit.api.stats.RepositoryStatistics.Type
-
Average time spent writing to sessions in nano seconds.
- SESSION_WRITE_COUNTER - org.apache.jackrabbit.api.stats.RepositoryStatistics.Type
-
Number of write accesses through any session.
- SESSION_WRITE_DURATION - org.apache.jackrabbit.api.stats.RepositoryStatistics.Type
-
Total time spent writing to sessions in nano seconds.
- setAbsPath(String) - Method in class org.apache.jackrabbit.api.observation.JackrabbitEventFilter
-
Sets the
absPath
parameter of the filter. - setAdditionalPaths(String...) - Method in class org.apache.jackrabbit.api.observation.JackrabbitEventFilter
-
Sets the
absPaths
parameter of the filter. - setAttribute(String, String) - Method in class org.apache.jackrabbit.api.security.authentication.token.TokenCredentials
-
Stores an attribute in this credentials instance.
- setCondition(T) - Method in interface org.apache.jackrabbit.api.security.user.QueryBuilder
-
Set the condition for the query.
- setEnabled(boolean) - Method in interface org.apache.jackrabbit.api.stats.QueryStat
-
Enables/Disables the service
- setEventTypes(int) - Method in class org.apache.jackrabbit.api.observation.JackrabbitEventFilter
-
Sets the
eventTypes
parameter of the filter. - setExcludedPaths(String...) - Method in class org.apache.jackrabbit.api.observation.JackrabbitEventFilter
-
Sets the
excludedPaths
parameter of the filter. - setIdentifiers(String[]) - Method in class org.apache.jackrabbit.api.observation.JackrabbitEventFilter
-
Sets the
identifiers
parameter of the filter. - setIsDeep(boolean) - Method in class org.apache.jackrabbit.api.observation.JackrabbitEventFilter
-
Sets the
isDeep
parameter of the filter. - setLimit(long, long) - Method in interface org.apache.jackrabbit.api.security.user.QueryBuilder
-
Set limits for the query.
- setLimit(Value, long) - Method in interface org.apache.jackrabbit.api.security.user.QueryBuilder
-
Set limits for the query.
- setMarkEventListener(MarkEventListener) - Method in interface org.apache.jackrabbit.api.management.DataStoreGarbageCollector
-
Set the event listener.
- setMixins(String[]) - Method in interface org.apache.jackrabbit.api.JackrabbitNode
- setNodeTypes(String[]) - Method in class org.apache.jackrabbit.api.observation.JackrabbitEventFilter
-
Sets the
nodeTypeNames
parameter of the filter. - setNoExternal(boolean) - Method in class org.apache.jackrabbit.api.observation.JackrabbitEventFilter
-
Sets the
noExternal
parameter of the filter. - setNoInternal(boolean) - Method in class org.apache.jackrabbit.api.observation.JackrabbitEventFilter
-
Sets the
noInternal
parameter of the filter. - setNoLocal(boolean) - Method in class org.apache.jackrabbit.api.observation.JackrabbitEventFilter
-
Sets the
noLocal
parameter of the filter. - setPersistenceManagerScan(boolean) - Method in interface org.apache.jackrabbit.api.management.DataStoreGarbageCollector
-
Enable or disable using the IterablePersistenceManager interface to scan the items.
- setPopularQueriesQueueSize(int) - Method in interface org.apache.jackrabbit.api.jmx.QueryStatManagerMBean
-
Change the size of the Popular queue
- setPopularQueriesQueueSize(int) - Method in interface org.apache.jackrabbit.api.stats.QueryStat
-
Change the size of the Popular queue
- setPosition(long) - Method in interface org.apache.jackrabbit.api.stats.QueryStatDto
- setProperty(String, Value) - Method in interface org.apache.jackrabbit.api.security.user.Authorizable
-
Set an arbitrary property to this
Authorizable
. - setProperty(String, Value[]) - Method in interface org.apache.jackrabbit.api.security.user.Authorizable
-
Set an arbitrary property to this
Authorizable
. - setScope(String, boolean) - Method in interface org.apache.jackrabbit.api.security.user.QueryBuilder
-
Set the scope for the query.
- setSelector(Class<? extends Authorizable>) - Method in interface org.apache.jackrabbit.api.security.user.QueryBuilder
-
Set the selector for the query.
- setSleepBetweenNodes(long) - Method in interface org.apache.jackrabbit.api.management.DataStoreGarbageCollector
-
Set the delay between scanning items.
- setSlowQueriesQueueSize(int) - Method in interface org.apache.jackrabbit.api.jmx.QueryStatManagerMBean
-
Change the size of the Slow queue
- setSlowQueriesQueueSize(int) - Method in interface org.apache.jackrabbit.api.stats.QueryStat
-
Change the size of the Slow queue
- setSortOrder(String, QueryBuilder.Direction) - Method in interface org.apache.jackrabbit.api.security.user.QueryBuilder
-
Set the sort order of the
Authorizable
s returned by the query. - setSortOrder(String, QueryBuilder.Direction, boolean) - Method in interface org.apache.jackrabbit.api.security.user.QueryBuilder
-
Set the sort order of the
Authorizable
s returned by the query. - shutdown() - Method in interface org.apache.jackrabbit.api.JackrabbitRepository
-
Shuts down the repository.
- size() - Method in interface org.apache.jackrabbit.api.security.JackrabbitAccessControlList
-
Returns the number of entries or 0 if the policy
is empty
. - stop() - Method in interface org.apache.jackrabbit.api.management.RepositoryManager
-
Shuts down the repository.
- sweep() - Method in interface org.apache.jackrabbit.api.management.DataStoreGarbageCollector
-
Delete all unused items in the data store.
T
- TEXT_X_JCR_CND - Static variable in interface org.apache.jackrabbit.api.JackrabbitNodeTypeManager
-
Deprecated.The experimental content type for the compact node type definition files.
- TEXT_XML - Static variable in interface org.apache.jackrabbit.api.JackrabbitNodeTypeManager
-
Deprecated.The standard XML content type to be used with XML-formatted node type streams.
- TimeSeries - Interface in org.apache.jackrabbit.api.stats
-
Interface for a time series of the measured values per second, minute, hour and day.
- TokenCredentials - Class in org.apache.jackrabbit.api.security.authentication.token
-
TokenCredentials
implements theCredentials
interface and represents single token credentials. - TokenCredentials(String) - Constructor for class org.apache.jackrabbit.api.security.authentication.token.TokenCredentials
-
Create a new instance.
U
- User - Interface in org.apache.jackrabbit.api.security.user
-
User is a special
Authorizable
that can be authenticated and impersonated. - UserManager - Interface in org.apache.jackrabbit.api.security.user
-
The
UserManager
provides access to and means to maintainauthorizable objects
i.e.
V
- valueOf(String) - Static method in enum org.apache.jackrabbit.api.security.user.QueryBuilder.Direction
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum org.apache.jackrabbit.api.stats.RepositoryStatistics.Type
-
Returns the enum constant of this type with the specified name.
- values() - Static method in enum org.apache.jackrabbit.api.security.user.QueryBuilder.Direction
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum org.apache.jackrabbit.api.stats.RepositoryStatistics.Type
-
Returns an array containing the constants of this enum type, in the order they are declared.
W
- withCharacterEncoding(String) - Method in class org.apache.jackrabbit.api.binary.BinaryDownloadOptions.BinaryDownloadOptionsBuilder
-
Sets the character encoding of the
BinaryDownloadOptions
object to be built. - withDispositionTypeAttachment() - Method in class org.apache.jackrabbit.api.binary.BinaryDownloadOptions.BinaryDownloadOptionsBuilder
-
Sets the disposition type of the
BinaryDownloadOptions
object to be built toattachment
. - withDispositionTypeInline() - Method in class org.apache.jackrabbit.api.binary.BinaryDownloadOptions.BinaryDownloadOptionsBuilder
-
Sets the disposition type of the
BinaryDownloadOptions
object to be built toinline
. - withDomainOverrideIgnore(boolean) - Method in class org.apache.jackrabbit.api.binary.BinaryUploadOptions.BinaryUploadOptionsBuilder
-
Sets the option to ignore any configured domain override setting.
- withDomainOverrideIgnored(boolean) - Method in class org.apache.jackrabbit.api.binary.BinaryDownloadOptions.BinaryDownloadOptionsBuilder
-
Sets a flag to indicate whether any configured download domain override value should be ignored when generating the signed download URI.
- withFileName(String) - Method in class org.apache.jackrabbit.api.binary.BinaryDownloadOptions.BinaryDownloadOptionsBuilder
-
Sets the filename of the
BinaryDownloadOptions
object to be built. - withMediaType(String) - Method in class org.apache.jackrabbit.api.binary.BinaryDownloadOptions.BinaryDownloadOptionsBuilder
-
Sets the internet media type of the
BinaryDownloadOptions
object to be built.
X
- XASession - Interface in org.apache.jackrabbit.api
-
Deprecated.An XA-enabled session should directly implement the
XAResource
interface
All Classes All Packages