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

A

accept(Event, boolean) - Method in interface org.apache.jackrabbit.spi.EventFilter
If an implementation returns true the event will be included in the event bundle returned by RepositoryService.getEvents(Subscription, long).
addChild(Name, Name, String) - Method in interface org.apache.jackrabbit.spi.Tree
 
addLockToken(String) - Method in interface org.apache.jackrabbit.spi.SessionInfo
Add the given lock token to this SessionInfo.
addNode(NodeId, Name, Name, String) - Method in interface org.apache.jackrabbit.spi.Batch
Add a new node to the persistent layer.
addProperty(NodeId, Name, QValue) - Method in interface org.apache.jackrabbit.spi.Batch
Add a new property to the persistent layer.
addProperty(NodeId, Name, QValue[]) - Method in interface org.apache.jackrabbit.spi.Batch
Add a new multi-valued property to the persistent layer.
addProperty(NodeId, Name, int, QValue) - Method in interface org.apache.jackrabbit.spi.Tree
 
addProperty(NodeId, Name, int, QValue[]) - Method in interface org.apache.jackrabbit.spi.Tree
 
addVersionLabel(SessionInfo, NodeId, NodeId, Name, boolean) - Method in interface org.apache.jackrabbit.spi.RepositoryService
Add the given version label in the persistent layer.
ALL_TYPES - Static variable in interface org.apache.jackrabbit.spi.Event
Constant for observation listener interested in all types of events.
allowsSameNameSiblings() - Method in interface org.apache.jackrabbit.spi.QNodeDefinition
Reports whether this node can have same-name siblings.

B

Batch - Interface in org.apache.jackrabbit.spi
The Batch defines an ordered list of of operations that must be executed at once on the persistent layer.

C

check(QValue) - Method in interface org.apache.jackrabbit.spi.QValueConstraint
Check if the specified value matches this constraint.
checkin(SessionInfo, NodeId) - Method in interface org.apache.jackrabbit.spi.RepositoryService
Performs a checkin for the Node identified by the given NodeId.
checkout(SessionInfo, NodeId) - Method in interface org.apache.jackrabbit.spi.RepositoryService
Performs a checkout for the Node identified by the given NodeId.
checkout(SessionInfo, NodeId, NodeId) - Method in interface org.apache.jackrabbit.spi.RepositoryService
Performs a checkout for the Node identified by the given NodeId and for activity identified by the specified activityId.
checkpoint(SessionInfo, NodeId) - Method in interface org.apache.jackrabbit.spi.RepositoryService
Performs a checkpoint for the Node identified by the given NodeId.
checkpoint(SessionInfo, NodeId, NodeId) - Method in interface org.apache.jackrabbit.spi.RepositoryService
Performs a checkpoint for the Node identified by the given NodeId.
checkQueryStatement(SessionInfo, String, String, Map<String, String>) - Method in interface org.apache.jackrabbit.spi.RepositoryService
Checks if the query statement is valid according to the specified query language and returns the bind variable names found in the query statement.
ChildInfo - Interface in org.apache.jackrabbit.spi
ChildInfo...
clone(SessionInfo, String, NodeId, NodeId, Name, boolean) - Method in interface org.apache.jackrabbit.spi.RepositoryService
Clone the subtree identified by the given srcNodeId in workspace named srcWorkspaceName to the destination in the workspace specified by the given SessionInfo.
computeAutoValues(QPropertyDefinition) - Method in interface org.apache.jackrabbit.spi.QValueFactory
Given the QPropertyDefinition of an autocreated property, compute suitable values to be used in transient space until the newly created node gets saved.
computeRelativePath(Path) - Method in interface org.apache.jackrabbit.spi.Path
Computes the relative path from this absolute path to other.
copy(SessionInfo, String, NodeId, NodeId, Name) - Method in interface org.apache.jackrabbit.spi.RepositoryService
Clone the subtree identified by the given srcNodeId in workspace named srcWorkspaceName to the destination in the workspace specified by the given SessionInfo.
create(String, String) - Method in interface org.apache.jackrabbit.spi.NameFactory
Returns a Name with the given namespace URI and local part and validates the given parameters.
create(String) - Method in interface org.apache.jackrabbit.spi.NameFactory
Returns a Name holding the value of the specified string.
create(Path, Path, boolean) - Method in interface org.apache.jackrabbit.spi.PathFactory
Return a new Path out of the given parent path and the given relative path.
create(Path, Name, boolean) - Method in interface org.apache.jackrabbit.spi.PathFactory
Creates a new Path out of the given parent path and the give name.
create(Path, Name, int, boolean) - Method in interface org.apache.jackrabbit.spi.PathFactory
Creates a new Path out of the given parent path and the give name and normalized index.
create(Name) - Method in interface org.apache.jackrabbit.spi.PathFactory
Creates a relative path based on a Name.
create(Name, int) - Method in interface org.apache.jackrabbit.spi.PathFactory
Creates a relative path based on a Name and a normalized index.
create(Path.Element) - Method in interface org.apache.jackrabbit.spi.PathFactory
Creates a path from the given element.
create(Path.Element[]) - Method in interface org.apache.jackrabbit.spi.PathFactory
Create a new Path from the given elements.
create(String) - Method in interface org.apache.jackrabbit.spi.PathFactory
Returns a Path holding the value of the specified string.
create(String, int) - Method in interface org.apache.jackrabbit.spi.QValueFactory
Create a new QValue using the given String representation of the value and its type.
create(Calendar) - Method in interface org.apache.jackrabbit.spi.QValueFactory
Create a new QValue with type PropertyType.DATE.
create(double) - Method in interface org.apache.jackrabbit.spi.QValueFactory
Create a new QValue with type PropertyType.DOUBLE.
create(long) - Method in interface org.apache.jackrabbit.spi.QValueFactory
Create a new QValue with type PropertyType.LONG.
create(boolean) - Method in interface org.apache.jackrabbit.spi.QValueFactory
Create a new QValue with type PropertyType.BOOLEAN.
create(Name) - Method in interface org.apache.jackrabbit.spi.QValueFactory
Create a new QValue with type PropertyType.NAME.
create(Path) - Method in interface org.apache.jackrabbit.spi.QValueFactory
Create a new QValue with type PropertyType.PATH.
create(BigDecimal) - Method in interface org.apache.jackrabbit.spi.QValueFactory
Create a new QValue with type PropertyType.DECIMAL.
create(URI) - Method in interface org.apache.jackrabbit.spi.QValueFactory
Create a new QValue with type PropertyType.URI.
create(byte[]) - Method in interface org.apache.jackrabbit.spi.QValueFactory
Create a new QValue with type PropertyType.BINARY.
create(InputStream) - Method in interface org.apache.jackrabbit.spi.QValueFactory
Creates a QValue that contains the given binary stream.
create(File) - Method in interface org.apache.jackrabbit.spi.QValueFactory
Create a new QValue with type PropertyType.BINARY.
createActivity(SessionInfo, String) - Method in interface org.apache.jackrabbit.spi.RepositoryService
Create a new activity.
createBatch(SessionInfo, ItemId) - Method in interface org.apache.jackrabbit.spi.RepositoryService
Indicates the start of a set of operations that cause modifications on the underlying persistence layer.
createConfiguration(SessionInfo, NodeId) - Method in interface org.apache.jackrabbit.spi.RepositoryService
 
createElement(Name) - Method in interface org.apache.jackrabbit.spi.PathFactory
Creates a path element from the given name.
createElement(Name, int) - Method in interface org.apache.jackrabbit.spi.PathFactory
Same as PathFactory.createElement(Name) except that an explicit index can be specified.
createElement(String) - Method in interface org.apache.jackrabbit.spi.PathFactory
Creates a path element from the given identifier.
createEventFilter(SessionInfo, int, Path, boolean, String[], Name[], boolean) - Method in interface org.apache.jackrabbit.spi.RepositoryService
Creates an event filter.
createNodeId(NodeId, Path) - Method in interface org.apache.jackrabbit.spi.IdFactory
Creates a new NodeId from the given parent id and the given Path object.
createNodeId(String, Path) - Method in interface org.apache.jackrabbit.spi.IdFactory
Creates a new NodeId from the given unique id (which identifies an ancestor Node) and the given Path object.
createNodeId(String) - Method in interface org.apache.jackrabbit.spi.IdFactory
Creates a new NodeId from the given unique id.
createPropertyId(NodeId, Name) - Method in interface org.apache.jackrabbit.spi.IdFactory
Creates a new PropertyId from the given parent id and property name.
createRepositoryService(Map<?, ?>) - Method in interface org.apache.jackrabbit.spi.RepositoryServiceFactory
Create a new RepositoryService.
createSubscription(SessionInfo, EventFilter[]) - Method in interface org.apache.jackrabbit.spi.RepositoryService
Creates a new Subscription for events with an initial set of EventFilters.
createTree(SessionInfo, Batch, Name, Name, String) - Method in interface org.apache.jackrabbit.spi.RepositoryService
Creates a new Tree that can be populated and later on be applied to the specified Batch by calling #setTree.
createWorkspace(SessionInfo, String, String) - Method in interface org.apache.jackrabbit.spi.RepositoryService
Create a new workspace with the specified name.

D

definesNode() - Method in interface org.apache.jackrabbit.spi.QItemDefinition
Determines whether this item definition defines a node.
definesResidual() - Method in interface org.apache.jackrabbit.spi.QItemDefinition
Determines whether this item definition defines a residual set of child items.
deleteWorkspace(SessionInfo, String) - Method in interface org.apache.jackrabbit.spi.RepositoryService
Deletes the workspace with the specified name.
DELIMITER - Static variable in interface org.apache.jackrabbit.spi.Path
Delimiter used in order to concatenate the Path.Element objects upon Path.getString().
denotesCurrent() - Method in interface org.apache.jackrabbit.spi.Path
Checks if the last path element is the current element (".").
denotesCurrent() - Method in interface org.apache.jackrabbit.spi.Path.Element
Returns true if this element denotes the current ('.') element, otherwise returns false.
denotesIdentifier() - Method in interface org.apache.jackrabbit.spi.Path
Test if this path consists of a single identifier element.
denotesIdentifier() - Method in interface org.apache.jackrabbit.spi.Path.Element
Returns true if this element represents an identifier element.
denotesName() - Method in interface org.apache.jackrabbit.spi.Path
Checks if the last path element is a named and optionally indexed element.
denotesName() - Method in interface org.apache.jackrabbit.spi.Path.Element
Returns true if this element represents a regular name (i.e. neither root, '.' nor '..'), otherwise returns false.
denotesNode() - Method in interface org.apache.jackrabbit.spi.ItemId
 
denotesNode() - Method in interface org.apache.jackrabbit.spi.ItemInfo
Returns true if this ItemInfo denotes a node, false otherwise.
denotesParent() - Method in interface org.apache.jackrabbit.spi.Path
Checks if the last path element is the parent element ("..").
denotesParent() - Method in interface org.apache.jackrabbit.spi.Path.Element
Returns true if this element denotes the parent ('..') element, otherwise returns false.
denotesRoot() - Method in interface org.apache.jackrabbit.spi.Path
Tests whether this is the root path, i.e. "/".
denotesRoot() - Method in interface org.apache.jackrabbit.spi.Path.Element
Returns true if this element denotes the root element, otherwise returns false.
discard() - Method in interface org.apache.jackrabbit.spi.QValue
Frees temporarily allocated resources such as temporary file, buffer, etc.
dispose() - Method in interface org.apache.jackrabbit.spi.ItemInfoCache
Clear the cache and dispose all entries.
dispose(SessionInfo) - Method in interface org.apache.jackrabbit.spi.RepositoryService
Indicates to the RepositoryService, that the given SessionInfo will not be used any more.
dispose(Subscription) - Method in interface org.apache.jackrabbit.spi.RepositoryService
Indicates that the passed subscription is no longer needed.

E

EMPTY_ARRAY - Static variable in interface org.apache.jackrabbit.spi.Name
Empty array of Name
EMPTY_ARRAY - Static variable in interface org.apache.jackrabbit.spi.QItemDefinition
Empty array of QItemDefinition.
EMPTY_ARRAY - Static variable in interface org.apache.jackrabbit.spi.QNodeDefinition
Empty array of QNodeDefinition.
EMPTY_ARRAY - Static variable in interface org.apache.jackrabbit.spi.QPropertyDefinition
Empty array of QPropertyDefinition.
EMPTY_ARRAY - Static variable in interface org.apache.jackrabbit.spi.QValue
 
EMPTY_ARRAY - Static variable in interface org.apache.jackrabbit.spi.QValueConstraint
Empty array of QValueConstraint.
Entry(T, long) - Constructor for class org.apache.jackrabbit.spi.ItemInfoCache.Entry
Create a new cache entry containing info with a given generation.
equals(Object) - Method in class org.apache.jackrabbit.spi.ItemInfoCache.Entry
 
Event - Interface in org.apache.jackrabbit.spi
Event is similar to the regular JCR Event and adds additional information about the affected item.
EventBundle - Interface in org.apache.jackrabbit.spi
An EventBundle is similar to the EventIterator interface.
EventFilter - Interface in org.apache.jackrabbit.spi
An EventFilter is applied to the events as generated on the repository server.
executeQuery(SessionInfo, String, String, Map<String, String>, long, long, Map<String, QValue>) - Method in interface org.apache.jackrabbit.spi.RepositoryService
Execute the given query statement with the specified query language.

F

fromJcrIdentifier(String) - Method in interface org.apache.jackrabbit.spi.IdFactory
Create a new NodeId from the given JCR string representation.

G

generation - Variable in class org.apache.jackrabbit.spi.ItemInfoCache.Entry
The generation
getAncestor(int) - Method in interface org.apache.jackrabbit.spi.Path
Normalizes this path and returns the ancestor path of the specified relative degree.
getAncestorCount() - Method in interface org.apache.jackrabbit.spi.Path
Returns the number of ancestors of this path.
getAvailableQueryOperators() - Method in interface org.apache.jackrabbit.spi.QPropertyDefinition
Returns the available query operators.
getBinary() - Method in interface org.apache.jackrabbit.spi.QValue
Returns a Binary representation of this QValue object.
getBoolean() - Method in interface org.apache.jackrabbit.spi.QValue
Returns a boolean representation of this value.
getCalendar() - Method in interface org.apache.jackrabbit.spi.QValue
Returns a Calendar representation of this value.
getCanonicalPath() - Method in interface org.apache.jackrabbit.spi.Path
Returns the canonical path representation of this path.
getChildInfos() - Method in interface org.apache.jackrabbit.spi.NodeInfo
Return all ChildInfos of the node represent by this info, an empty iterator if that node doesn't have any child nodes or null if the implementation is not able or for some internal reasons not willing to compute the ChildInfo iterator.
getChildInfos(SessionInfo, NodeId) - Method in interface org.apache.jackrabbit.spi.RepositoryService
Returns an Iterator of ChildInfos present on the Node represented by the given parentId.
getChildNodeDefs() - Method in interface org.apache.jackrabbit.spi.QNodeTypeDefinition
Returns an array containing the child node definitions.
getColumnNames() - Method in interface org.apache.jackrabbit.spi.QueryInfo
 
getCurrentElement() - Method in interface org.apache.jackrabbit.spi.PathFactory
Return the current element.
getDate() - Method in interface org.apache.jackrabbit.spi.Event
Returns the date when the change was persisted that caused this event.
getDecimal() - Method in interface org.apache.jackrabbit.spi.QValue
Returns a BigDecimal representation of this value.
getDeclaredAggregateNames() - Method in interface org.apache.jackrabbit.spi.PrivilegeDefinition
 
getDeclaringNodeType() - Method in interface org.apache.jackrabbit.spi.QItemDefinition
Gets the name of the declaring node type.
getDefaultPrimaryType() - Method in interface org.apache.jackrabbit.spi.QNodeDefinition
Returns the name of the default primary type.
getDefaultValues() - Method in interface org.apache.jackrabbit.spi.QPropertyDefinition
Returns the array of default values or null if no default values are defined.
getDependencies() - Method in interface org.apache.jackrabbit.spi.QNodeTypeDefinition
Returns a collection of node type Names that are being referenced by this node type definition (e.g. as supertypes, as required/default primary types in child node definitions, as REFERENCE value constraints in property definitions).
getDepth() - Method in interface org.apache.jackrabbit.spi.Path
Returns the depth of this path.
getDouble() - Method in interface org.apache.jackrabbit.spi.QValue
Returns a double representation of this value.
getElements() - Method in interface org.apache.jackrabbit.spi.Path
Returns the elements of this path.
getEvents() - Method in interface org.apache.jackrabbit.spi.EventBundle
Returns the events of this bundle.
getEvents(Subscription, long) - Method in interface org.apache.jackrabbit.spi.RepositoryService
Retrieves the events that occurred since the last call to this method for the passed subscription.
getEvents(SessionInfo, EventFilter, long) - Method in interface org.apache.jackrabbit.spi.RepositoryService
Returns events from the EventJournal after a given point in time.
getFirstElements() - Method in interface org.apache.jackrabbit.spi.Path
Returns a path that consists of all but the last element of this path.
getId() - Method in interface org.apache.jackrabbit.spi.ItemInfo
 
getId() - Method in interface org.apache.jackrabbit.spi.NodeInfo
Returns the NodeId for the node that is based on this info object.
getId() - Method in interface org.apache.jackrabbit.spi.PropertyInfo
 
getIdentifier() - Method in interface org.apache.jackrabbit.spi.Path.Element
Returns the identifier of an identifier element, or null for other kinds of elements.
getIdentifier() - Method in interface org.apache.jackrabbit.spi.Path
Returns the identifier of a single identifier element.
getIdFactory() - Method in interface org.apache.jackrabbit.spi.RepositoryService
Return the IdFactory.
getIndex() - Method in interface org.apache.jackrabbit.spi.ChildInfo
Returns the index of the child Node.
getIndex() - Method in interface org.apache.jackrabbit.spi.NodeInfo
Index of the node.
getIndex() - Method in interface org.apache.jackrabbit.spi.Path.Element
Returns the index of the element as it has been assigned upon creation.
getIndex() - Method in interface org.apache.jackrabbit.spi.Path
Returns the index of the last path element, or Path.INDEX_UNDEFINED if the index is not defined or not applicable.
getInfo() - Method in interface org.apache.jackrabbit.spi.Event
Returns the information map associated with this event.
getItemId() - Method in interface org.apache.jackrabbit.spi.Event
 
getItemInfoCache(SessionInfo) - Method in interface org.apache.jackrabbit.spi.RepositoryService
Returns a ItemInfoCache for the given SessionInfo.
getItemInfos(SessionInfo, ItemId) - Method in interface org.apache.jackrabbit.spi.RepositoryService
Method used to 'batch-read' from the persistent storage.
getLastElement() - Method in interface org.apache.jackrabbit.spi.Path
Returns a path that consists of only the last element of this path.
getLength() - Method in interface org.apache.jackrabbit.spi.Path
Returns the length of this path, i.e. the number of its elements.
getLength() - Method in interface org.apache.jackrabbit.spi.QValue
Returns the length of the internal value or -1 if the implementation cannot determine the length at this time.
getLocalName() - Method in interface org.apache.jackrabbit.spi.Name
Returns the local part of this Name object.
getLockInfo(SessionInfo, NodeId) - Method in interface org.apache.jackrabbit.spi.RepositoryService
Returns the lock information that applies to Node identified by the given NodeId or null.
getLockToken() - Method in interface org.apache.jackrabbit.spi.LockInfo
Returns the lock token for this lock or null if the token should not be exposed to the API user.
getLockTokens() - Method in interface org.apache.jackrabbit.spi.SessionInfo
Returns the lock tokens present on this SessionInfo.
getLong() - Method in interface org.apache.jackrabbit.spi.QValue
Returns a long representation of this value.
getMixins() - Method in interface org.apache.jackrabbit.spi.NodeInfo
 
getMixinTypeNames() - Method in interface org.apache.jackrabbit.spi.Event
 
getName() - Method in interface org.apache.jackrabbit.spi.ChildInfo
Returns the name of the child Node.
getName() - Method in interface org.apache.jackrabbit.spi.Path.Element
Returns the name of this path element.
getName() - Method in interface org.apache.jackrabbit.spi.Path
Returns the name of the last path element, or null for an identifier.
getName() - Method in interface org.apache.jackrabbit.spi.PrivilegeDefinition
 
getName() - Method in interface org.apache.jackrabbit.spi.PropertyId
Returns the Name of the property identified by this id.
getName() - Method in interface org.apache.jackrabbit.spi.QItemDefinition
Gets the name of the child item.
getName() - Method in interface org.apache.jackrabbit.spi.QNodeTypeDefinition
Returns the name of the node type being defined or null if not set.
getName() - Method in interface org.apache.jackrabbit.spi.QValue
Returns a Name representation of this value.
getName() - Method in interface org.apache.jackrabbit.spi.Tree
 
getNameElement() - Method in interface org.apache.jackrabbit.spi.Path
Returns the name element (i.e. the last element) of this path.
getNameFactory() - Method in interface org.apache.jackrabbit.spi.RepositoryService
Return the NameFactory.
getNamespacePrefix(SessionInfo, String) - Method in interface org.apache.jackrabbit.spi.RepositoryService
Returns the namespace prefix for the given namespace uri.
getNamespaceURI() - Method in interface org.apache.jackrabbit.spi.Name
Returns the namespace URI of this Name object.
getNamespaceURI(SessionInfo, String) - Method in interface org.apache.jackrabbit.spi.RepositoryService
Returns the namespace URI for the given namespace prefix.
getNodeDefinition(SessionInfo, NodeId) - Method in interface org.apache.jackrabbit.spi.RepositoryService
Returns the QNodeDefinition for the Node identified by the given id.
getNodeId() - Method in interface org.apache.jackrabbit.spi.LockInfo
Returns the NodeId of the lock-holding Node.
getNodeId(String) - Method in interface org.apache.jackrabbit.spi.QueryResultRow
Returns NodeId of node for a given selectorname this result row represents.
getNodeInfo(NodeId) - Method in interface org.apache.jackrabbit.spi.ItemInfoCache
Retrieve a cache entry for the given nodeId or null if no such entry is in the cache.
getNodeInfo(SessionInfo, NodeId) - Method in interface org.apache.jackrabbit.spi.RepositoryService
getNodetype() - Method in interface org.apache.jackrabbit.spi.NodeInfo
 
getNormalizedIndex() - Method in interface org.apache.jackrabbit.spi.Path.Element
Returns the normalized index of this path element, i.e. the index is always equals or greater that Path.INDEX_DEFAULT.
getNormalizedIndex() - Method in interface org.apache.jackrabbit.spi.Path
Returns the normalized index of the last path element.
getNormalizedPath() - Method in interface org.apache.jackrabbit.spi.Path
Returns the normalized path representation of this path.
getOnParentVersion() - Method in interface org.apache.jackrabbit.spi.QItemDefinition
Gets the 'onParentVersion' attribute of the item.
getOwner() - Method in interface org.apache.jackrabbit.spi.LockInfo
Returns the user ID of the user who owns this lock or some user defined information about the lock owner.
getParentElement() - Method in interface org.apache.jackrabbit.spi.PathFactory
Return the parent element.
getParentId() - Method in interface org.apache.jackrabbit.spi.Event
 
getParentId() - Method in interface org.apache.jackrabbit.spi.PropertyId
Returns the NodeId of the parent.
getPath() - Method in interface org.apache.jackrabbit.spi.Event
 
getPath() - Method in interface org.apache.jackrabbit.spi.ItemId
 
getPath() - Method in interface org.apache.jackrabbit.spi.ItemInfo
Returns the Path of the item represented by this ItemInfo.
getPath() - Method in interface org.apache.jackrabbit.spi.QValue
Returns a Path representation of this value.
getPathFactory() - Method in interface org.apache.jackrabbit.spi.RepositoryService
Return the PathFactory.
getPrimaryItemName() - Method in interface org.apache.jackrabbit.spi.QNodeTypeDefinition
Returns the name of the primary item (one of the child items of the node's of this node type) or null if not set.
getPrimaryNodeTypeName() - Method in interface org.apache.jackrabbit.spi.Event
 
getPrimaryTypeName() - Method in interface org.apache.jackrabbit.spi.Tree
 
getPrivilegeDefinitions(SessionInfo) - Method in interface org.apache.jackrabbit.spi.RepositoryService
TODO
getPrivilegeNames(SessionInfo, NodeId) - Method in interface org.apache.jackrabbit.spi.RepositoryService
TODO
getPropertyDefinition(SessionInfo, PropertyId) - Method in interface org.apache.jackrabbit.spi.RepositoryService
Returns the QPropertyDefinition for the Property identified by the given id.
getPropertyDefs() - Method in interface org.apache.jackrabbit.spi.QNodeTypeDefinition
Returns an array containing the property definitions.
getPropertyIds() - Method in interface org.apache.jackrabbit.spi.NodeInfo
 
getPropertyInfo(PropertyId) - Method in interface org.apache.jackrabbit.spi.ItemInfoCache
Retrieve a cache entry for the given propertyId or null if no such entry is in the cache.
getPropertyInfo(SessionInfo, PropertyId) - Method in interface org.apache.jackrabbit.spi.RepositoryService
getQNodeTypeDefinitions(SessionInfo) - Method in interface org.apache.jackrabbit.spi.RepositoryService
Retrieve the QNodeTypeDefinitions of all registered nodetypes.
getQNodeTypeDefinitions(SessionInfo, Name[]) - Method in interface org.apache.jackrabbit.spi.RepositoryService
Retrieve QNodeTypeDefinitions for the given names.
getQValueFactory() - Method in interface org.apache.jackrabbit.spi.RepositoryService
Return the QValueFactory defined with this SPI implementation.
getReferences() - Method in interface org.apache.jackrabbit.spi.NodeInfo
getReferences(SessionInfo, NodeId, Name, boolean) - Method in interface org.apache.jackrabbit.spi.RepositoryService
Returns the Ids of the properties that are referencing the node identified by the given nodeId.
getRegisteredNamespaces(SessionInfo) - Method in interface org.apache.jackrabbit.spi.RepositoryService
Retrieve all registered namespaces.
getRepositoryDescriptors() - Method in interface org.apache.jackrabbit.spi.RepositoryService
Returns all property descriptors that can be exposed with the Repository implementation built on top of this RepositoryService.
getRequiredPrimaryTypes() - Method in interface org.apache.jackrabbit.spi.QNodeDefinition
Returns the array of names of the required primary types.
getRequiredType() - Method in interface org.apache.jackrabbit.spi.QPropertyDefinition
Returns the required type.
getRootElement() - Method in interface org.apache.jackrabbit.spi.PathFactory
Return the root element.
getRootPath() - Method in interface org.apache.jackrabbit.spi.PathFactory
Return the Path of the root node.
getRows() - Method in interface org.apache.jackrabbit.spi.QueryInfo
 
getScore(String) - Method in interface org.apache.jackrabbit.spi.QueryResultRow
Returns score for the given selectorName of this result row.
getSecondsRemaining() - Method in interface org.apache.jackrabbit.spi.LockInfo
Returns the seconds remaining until the lock times out or (Long.MAX_VALUE if the timeout is unknown or infinite).
getSelectorNames() - Method in interface org.apache.jackrabbit.spi.QueryInfo
 
getStream() - Method in interface org.apache.jackrabbit.spi.QValue
Returns an InputStream representation of this QValue object.
getString() - Method in interface org.apache.jackrabbit.spi.Path.Element
Return the String presentation of a Path.Element.
getString() - Method in interface org.apache.jackrabbit.spi.Path
Returns the String representation of this Path as it is used by PathFactory.create(String).
getString() - Method in interface org.apache.jackrabbit.spi.QValue
Returns a String representation of this QValue object.
getString() - Method in interface org.apache.jackrabbit.spi.QValueConstraint
For constraints that are not namespace prefix mapping sensitive this method returns the same defined in PropertyDefinition.getValueConstraints().
getSupertypes() - Method in interface org.apache.jackrabbit.spi.QNodeTypeDefinition
Returns an array containing the names of the supertypes.
getSupportedMixinTypes() - Method in interface org.apache.jackrabbit.spi.QNodeTypeDefinition
Returns an array containing the names of additional mixin types supported on this node type.
getSupportedPrivileges(SessionInfo, NodeId) - Method in interface org.apache.jackrabbit.spi.RepositoryService
TODO
getSupportedQueryLanguages(SessionInfo) - Method in interface org.apache.jackrabbit.spi.RepositoryService
Returns a String array identifying all query languages supported by this SPI implementation.
getType() - Method in interface org.apache.jackrabbit.spi.Event
Returns the type of this event: a constant defined by this interface.
getType() - Method in interface org.apache.jackrabbit.spi.PropertyInfo
 
getType() - Method in interface org.apache.jackrabbit.spi.QValue
Returns the PropertyType of this QValue object.
getUniqueID() - Method in interface org.apache.jackrabbit.spi.ChildInfo
Returns the uniqueID of the child Node or null if the Node is not identified by a uniqueID.
getUniqueID() - Method in interface org.apache.jackrabbit.spi.ItemId
 
getUniqueId() - Method in interface org.apache.jackrabbit.spi.Tree
 
getURI() - Method in interface org.apache.jackrabbit.spi.QValue
Returns an URI representation of this value.
getUserData() - Method in interface org.apache.jackrabbit.spi.Event
Returns the user data.
getUserID() - Method in interface org.apache.jackrabbit.spi.Event
Returns the user ID connected with this event.
getUserID() - Method in interface org.apache.jackrabbit.spi.SessionInfo
Returns the user id.
getValueConstraints() - Method in interface org.apache.jackrabbit.spi.QPropertyDefinition
Returns the array of value constraints.
getValues() - Method in interface org.apache.jackrabbit.spi.PropertyInfo
 
getValues() - Method in interface org.apache.jackrabbit.spi.QueryResultRow
Returns an array of QValues.
getWorkspaceName() - Method in interface org.apache.jackrabbit.spi.SessionInfo
Returns the workspace name.
getWorkspaceNames(SessionInfo) - Method in interface org.apache.jackrabbit.spi.RepositoryService
Return all workspace names available for the given SessionInfo.
getXAResource() - Method in interface org.apache.jackrabbit.spi.XASessionInfo
Retrieves an XAResource object that the transaction manager will use to manage this XASessionInfo object's participation in a distributed transaction.

H

hashCode() - Method in class org.apache.jackrabbit.spi.ItemInfoCache.Entry
 
hasOrderableChildNodes() - Method in interface org.apache.jackrabbit.spi.QNodeTypeDefinition
Returns the value of the orderableChildNodes flag.

I

IdFactory - Interface in org.apache.jackrabbit.spi
IdFactory defines methods to construct new ItemIds.
impersonate(SessionInfo, Credentials) - Method in interface org.apache.jackrabbit.spi.RepositoryService
Returns a SessionInfo that will be used by other methods on the RepositoryService.
importXml(SessionInfo, NodeId, InputStream, int) - Method in interface org.apache.jackrabbit.spi.RepositoryService
Imports the data present in the given InputStream into the persistent layer.
INDEX_DEFAULT - Static variable in interface org.apache.jackrabbit.spi.Path
Constant representing the default (initial) index value.
INDEX_UNDEFINED - Static variable in interface org.apache.jackrabbit.spi.Path
Constant representing an undefined index value
info - Variable in class org.apache.jackrabbit.spi.ItemInfoCache.Entry
isAbsolute() - Method in interface org.apache.jackrabbit.spi.Path
Tests whether this path is absolute, i.e. whether it starts with "/" or is an identifier based path.
isAbstract() - Method in interface org.apache.jackrabbit.spi.PrivilegeDefinition
 
isAbstract() - Method in interface org.apache.jackrabbit.spi.QNodeTypeDefinition
Returns true if the definition is abstract; false otherwise.
isAncestorOf(Path) - Method in interface org.apache.jackrabbit.spi.Path
Determines if this path is an ancestor of the specified path, based on their (absolute or relative) hierarchy level as returned by Path.getDepth().
isAutoCreated() - Method in interface org.apache.jackrabbit.spi.QItemDefinition
Determines whether the item is 'autoCreated'.
isCanonical() - Method in interface org.apache.jackrabbit.spi.Path
Tests whether this path is canonical, i.e. whether it is absolute and does not contain redundant elements such as "." and "..".
isDeep() - Method in interface org.apache.jackrabbit.spi.LockInfo
Returns true if the Lock is deep.
isDescendantOf(Path) - Method in interface org.apache.jackrabbit.spi.Path
Determines if this path is a descendant of the specified path, based on their (absolute or relative) hierarchy level as returned by Path.getDepth().
isEquivalentTo(Path) - Method in interface org.apache.jackrabbit.spi.Path
Determines if the the other path would be equal to this path if both of them are normalized.
isFullTextSearchable() - Method in interface org.apache.jackrabbit.spi.QPropertyDefinition
Reports whether this property definition is full text searchable.
isGranted(SessionInfo, ItemId, String[]) - Method in interface org.apache.jackrabbit.spi.RepositoryService
Returns true if all actions defined in the specified array are granted to given SessionInfo.
isIdentifierBased() - Method in interface org.apache.jackrabbit.spi.Path
Test if this path represents an unresolved identifier-based path.
isLocal() - Method in interface org.apache.jackrabbit.spi.EventBundle
Returns true if this event bundle is associated with a change that was initiated by a local session info.
isLockOwner() - Method in interface org.apache.jackrabbit.spi.LockInfo
Returns true if the SessionInfo used to retrieve this LockInfo is the lock holder and thus enabled to refresh or release the lock.
isMandatory() - Method in interface org.apache.jackrabbit.spi.QItemDefinition
Determines whether the item is 'mandatory'.
isMixin() - Method in interface org.apache.jackrabbit.spi.QNodeTypeDefinition
Returns the value of the mixin flag.
isMultiple() - Method in interface org.apache.jackrabbit.spi.QPropertyDefinition
Reports whether this property can have multiple values.
isMultiValued() - Method in interface org.apache.jackrabbit.spi.PropertyInfo
 
isNormalized() - Method in interface org.apache.jackrabbit.spi.Path
Tests whether this path is normalized, i.e. whether it does not contain redundant elements such as "." and "..".
isProtected() - Method in interface org.apache.jackrabbit.spi.QItemDefinition
Determines whether the item is 'protected'.
isQueryable() - Method in interface org.apache.jackrabbit.spi.QNodeTypeDefinition
Returns true if the definition is queryable; false otherwise.
isQueryOrderable() - Method in interface org.apache.jackrabbit.spi.QPropertyDefinition
Reports whether this property definition is query-orderable.
isSessionScoped() - Method in interface org.apache.jackrabbit.spi.LockInfo
Returns true if the Lock is session scoped.
ItemId - Interface in org.apache.jackrabbit.spi
An ItemId identifies an item using a combination of unique ID and path.
ItemInfo - Interface in org.apache.jackrabbit.spi
The ItemInfo is the base interface of NodeInfo and PropertyInfo.
ItemInfoCache - Interface in org.apache.jackrabbit.spi
ItemInfoCache instances are responsible for caching ItemInfos along with an opaque generation counter.
ItemInfoCache.Entry<T extends ItemInfo> - Class in org.apache.jackrabbit.spi
This class represents a cache entry.

L

lock(SessionInfo, NodeId, boolean, boolean) - Method in interface org.apache.jackrabbit.spi.RepositoryService
Create a lock on the Node identified by the given id.
lock(SessionInfo, NodeId, boolean, boolean, long, String) - Method in interface org.apache.jackrabbit.spi.RepositoryService
Create a lock on the Node identified by the given id.
LockInfo - Interface in org.apache.jackrabbit.spi
LockInfo is used to transport lock information across the SPI boundary.

M

merge(SessionInfo, NodeId, String, boolean) - Method in interface org.apache.jackrabbit.spi.RepositoryService
Merge the node identified by the given NodeId and its subtree with the corresponding node present in the workspace with the name of srcWorkspaceName.
merge(SessionInfo, NodeId, String, boolean, boolean) - Method in interface org.apache.jackrabbit.spi.RepositoryService
Merge the node identified by the given NodeId and its subtree with the corresponding node present in the workspace with the name of srcWorkspaceName.
mergeActivity(SessionInfo, NodeId) - Method in interface org.apache.jackrabbit.spi.RepositoryService
Merges the activity identified by the given activityId into the workspace the specified sessionInfo has been created for.
move(NodeId, NodeId, Name) - Method in interface org.apache.jackrabbit.spi.Batch
Move the node identified by the given srcNodeId to the new parent identified by destParentNodeId and change its name to destName.
move(SessionInfo, NodeId, NodeId, Name) - Method in interface org.apache.jackrabbit.spi.RepositoryService
Moves the node identified by the given srcNodeId (and its entire subtree) to the new location defined by destParentNodeId and a new name (destName).

N

Name - Interface in org.apache.jackrabbit.spi
A Name is a combination of a namespace URI and a local part.
NameFactory - Interface in org.apache.jackrabbit.spi
NameFactory...
NODE_ADDED - Static variable in interface org.apache.jackrabbit.spi.Event
An event of this type is generated when a node is added.
NODE_MOVED - Static variable in interface org.apache.jackrabbit.spi.Event
An event of this type is generated when a node is moved.
NODE_REMOVED - Static variable in interface org.apache.jackrabbit.spi.Event
An event of this type is generated when a node is removed.
NodeId - Interface in org.apache.jackrabbit.spi
NodeId identifies a node on the SPI layer.
NodeInfo - Interface in org.apache.jackrabbit.spi
The NodeInfo provides the basic information required to build nodes making up the repository hierarchy.
NS_DEFAULT_URI - Static variable in interface org.apache.jackrabbit.spi.Name
 
NS_EMPTY_PREFIX - Static variable in interface org.apache.jackrabbit.spi.Name
 
NS_JCR_PREFIX - Static variable in interface org.apache.jackrabbit.spi.Name
 
NS_JCR_URI - Static variable in interface org.apache.jackrabbit.spi.Name
 
NS_MIX_PREFIX - Static variable in interface org.apache.jackrabbit.spi.Name
 
NS_MIX_URI - Static variable in interface org.apache.jackrabbit.spi.Name
 
NS_NT_PREFIX - Static variable in interface org.apache.jackrabbit.spi.Name
 
NS_NT_URI - Static variable in interface org.apache.jackrabbit.spi.Name
 
NS_REP_PREFIX - Static variable in interface org.apache.jackrabbit.spi.Name
 
NS_REP_URI - Static variable in interface org.apache.jackrabbit.spi.Name
 
NS_SV_PREFIX - Static variable in interface org.apache.jackrabbit.spi.Name
 
NS_SV_URI - Static variable in interface org.apache.jackrabbit.spi.Name
 
NS_XML_PREFIX - Static variable in interface org.apache.jackrabbit.spi.Name
 
NS_XML_URI - Static variable in interface org.apache.jackrabbit.spi.Name
 
NS_XMLNS_PREFIX - Static variable in interface org.apache.jackrabbit.spi.Name
 
NS_XMLNS_URI - Static variable in interface org.apache.jackrabbit.spi.Name
 

O

obtain(Credentials, String) - Method in interface org.apache.jackrabbit.spi.RepositoryService
Returns a SessionInfo that will be used by other methods on the RepositoryService.
obtain(SessionInfo, String) - Method in interface org.apache.jackrabbit.spi.RepositoryService
Returns a new SessionInfo for the given workspace name that will be used by other methods on the RepositoryService.
org.apache.jackrabbit.spi - package org.apache.jackrabbit.spi
Defines the interfaces of the JCR SPI (Service Provider Interface).

P

Path - Interface in org.apache.jackrabbit.spi
The Path interface defines the SPI level representation of a JCR path.
Path.Element - Interface in org.apache.jackrabbit.spi
Object representation of a single JCR path element.
PathFactory - Interface in org.apache.jackrabbit.spi
PathFactory...
PERSIST - Static variable in interface org.apache.jackrabbit.spi.Event
If event bundling is supported, this event is used to indicate a bundle boundary within the event journal.
PrivilegeDefinition - Interface in org.apache.jackrabbit.spi
PrivilegeDefinition...
PROPERTY_ADDED - Static variable in interface org.apache.jackrabbit.spi.Event
An event of this type is generated when a property is added.
PROPERTY_CHANGED - Static variable in interface org.apache.jackrabbit.spi.Event
An event of this type is generated when a property is changed.
PROPERTY_REMOVED - Static variable in interface org.apache.jackrabbit.spi.Event
An event of this type is generated when a property is removed.
PropertyId - Interface in org.apache.jackrabbit.spi
PropertyId identifies a property on the SPI layer.
PropertyInfo - Interface in org.apache.jackrabbit.spi
The PropertyInfo provides the basic information to build a Property.
put(ItemInfo, long) - Method in interface org.apache.jackrabbit.spi.ItemInfoCache
Create a ItemInfoCache.Entry for info and generation and put it into the cache.

Q

QItemDefinition - Interface in org.apache.jackrabbit.spi
QItemDefinition is the SPI representation of an item definition.
QNodeDefinition - Interface in org.apache.jackrabbit.spi
QNodeDefinition is the SPI representation of a node definition.
QNodeTypeDefinition - Interface in org.apache.jackrabbit.spi
QNodeTypeDefinition is the SPI representation of a node type.
QPropertyDefinition - Interface in org.apache.jackrabbit.spi
QPropertyDefinition is the SPI representation of a property definition.
QueryInfo - Interface in org.apache.jackrabbit.spi
QueryInfo is the the return value of RepositoryService.executeQuery(SessionInfo, String, String, Map, long, long, Map) which is used to run a query on the RepositoryService.
QueryResultRow - Interface in org.apache.jackrabbit.spi
QueryResultRow represents the SPI equivalent of a query result row.
QValue - Interface in org.apache.jackrabbit.spi
QValue is the SPI representation of a jcr value.
QValueConstraint - Interface in org.apache.jackrabbit.spi
QValueConstraint is used to check the syntax of a value constraint and to test if a specific value satisfies it.
QValueFactory - Interface in org.apache.jackrabbit.spi
QValueFactory defines methods to create QValue instances.

R

refreshLock(SessionInfo, NodeId) - Method in interface org.apache.jackrabbit.spi.RepositoryService
Explicit refresh of an existing lock.
registerNamespace(SessionInfo, String, String) - Method in interface org.apache.jackrabbit.spi.RepositoryService
Register a new namespace with the given prefix and uri.
registerNodeTypes(SessionInfo, QNodeTypeDefinition[], boolean) - Method in interface org.apache.jackrabbit.spi.RepositoryService
Registers the node types with the specified QNodeTypeDefinitions.
remove(ItemId) - Method in interface org.apache.jackrabbit.spi.Batch
Remove an existing item.
removeActivity(SessionInfo, NodeId) - Method in interface org.apache.jackrabbit.spi.RepositoryService
Removes the activity identified by the specified activityId.
removeLockToken(String) - Method in interface org.apache.jackrabbit.spi.SessionInfo
Removes the given lock token from this SessionInfo.
removeVersion(SessionInfo, NodeId, NodeId) - Method in interface org.apache.jackrabbit.spi.RepositoryService
Remove the version identified by the specified versionId.
removeVersionLabel(SessionInfo, NodeId, NodeId, Name) - Method in interface org.apache.jackrabbit.spi.RepositoryService
Remove the given version label in the persistent layer.
reorderNodes(NodeId, NodeId, NodeId) - Method in interface org.apache.jackrabbit.spi.Batch
Modify the order of the child nodes identified by the given NodeIds.
RepositoryService - Interface in org.apache.jackrabbit.spi
The RepositoryService interface defines methods used to retrieve information from the persistent layer of the repository as well as the methods that modify its persistent state.
RepositoryServiceFactory - Interface in org.apache.jackrabbit.spi
Factory for creating RepositoryService instances.
resolve(Path.Element) - Method in interface org.apache.jackrabbit.spi.Path
Resolves the given path element against this path.
resolve(Path) - Method in interface org.apache.jackrabbit.spi.Path
Resolves the given path against this path.
resolveMergeConflict(SessionInfo, NodeId, NodeId[], NodeId[]) - Method in interface org.apache.jackrabbit.spi.RepositoryService
Resolve an existing merge conflict present with the node identified by the given NodeId.
restore(SessionInfo, NodeId, NodeId, boolean) - Method in interface org.apache.jackrabbit.spi.RepositoryService
Restores the node identified by nodeId to the state defined by the version with the specified versionId.
restore(SessionInfo, NodeId[], boolean) - Method in interface org.apache.jackrabbit.spi.RepositoryService
Restore multiple versions at once.
ROOT_DEPTH - Static variable in interface org.apache.jackrabbit.spi.Path
Constant defining the depth of the root path

S

SessionInfo - Interface in org.apache.jackrabbit.spi
SessionInfo is created upon RepositoryService.obtain(javax.jcr.Credentials, String) or RepositoryService.obtain(SessionInfo, String) and will be used for any call on the RepositoryService that requires user and workspace identification.
setMixins(NodeId, Name[]) - Method in interface org.apache.jackrabbit.spi.Batch
Modify the set of mixin node types present on the node identified by the given id.
setPrimaryType(NodeId, Name) - Method in interface org.apache.jackrabbit.spi.Batch
Change the primary type of the node identified by the given nodeId.
setTree(NodeId, Tree) - Method in interface org.apache.jackrabbit.spi.Batch
Add a new content tree to the persistent layer.
setUserData(String) - Method in interface org.apache.jackrabbit.spi.SessionInfo
Sets the user data used for Event.getUserData().
setValue(PropertyId, QValue) - Method in interface org.apache.jackrabbit.spi.Batch
Modify the value of an existing property.
setValue(PropertyId, QValue[]) - Method in interface org.apache.jackrabbit.spi.Batch
Modify the value of an existing, multi-valued property.
submit(Batch) - Method in interface org.apache.jackrabbit.spi.RepositoryService
Completes the given Batch or discard all the previous modifications.
subPath(int, int) - Method in interface org.apache.jackrabbit.spi.Path
Returns a new Path consisting of those Path.Element objects between the given from, inclusive, and the given to, exclusive.
Subscription - Interface in org.apache.jackrabbit.spi
Subscription defines a marker interface for an event subscription.

T

toJcrIdentifier(NodeId) - Method in interface org.apache.jackrabbit.spi.IdFactory
Returns the JCR string representation of the given nodeId.
Tree - Interface in org.apache.jackrabbit.spi
Interface for building a hierarchy of JCR items on the SPI layer.

U

unlock(SessionInfo, NodeId) - Method in interface org.apache.jackrabbit.spi.RepositoryService
Releases the lock on the Node identified by the given NodeId.
unregisterNamespace(SessionInfo, String) - Method in interface org.apache.jackrabbit.spi.RepositoryService
Unregister the namespace identified by the given uri
unregisterNodeTypes(SessionInfo, Name[]) - Method in interface org.apache.jackrabbit.spi.RepositoryService
Unregisters the node types with the specified names.
update(SessionInfo, NodeId, String) - Method in interface org.apache.jackrabbit.spi.RepositoryService
Updates the node identified by the given NodeId replacing it (an the complete subtree) with a clone of its corresponding node present in the workspace with the given srcWorkspaceName.
updateEventFilters(Subscription, EventFilter[]) - Method in interface org.apache.jackrabbit.spi.RepositoryService
Updates events filters on the subscription.

X

XASessionInfo - Interface in org.apache.jackrabbit.spi
XASessionInfo extends the SessionInfo and provides access to the XAResource of the session info.
A B C D E F G H I L M N O P Q R S T U X 
Skip navigation links

Copyright © 2004–2022 The Apache Software Foundation. All rights reserved.