You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@jackrabbit.apache.org by md...@apache.org on 2011/09/07 11:49:40 UTC
svn commit: r1166087 [3/3] - in /jackrabbit/sandbox/jackrabbit-mk:
jackrabbit-jcr2spi/src/main/java/org/apache/jackrabbit/jcr2spi/
jackrabbit-jcr2spi/src/main/java/org/apache/jackrabbit/jcr2spi/hierarchy/
jackrabbit-jcr2spi/src/main/java/org/apache/jac...
Modified: jackrabbit/sandbox/jackrabbit-mk/jackrabbit-spi/src/main/java/org/apache/jackrabbit/spi/QueryResultRow.java
URL: http://svn.apache.org/viewvc/jackrabbit/sandbox/jackrabbit-mk/jackrabbit-spi/src/main/java/org/apache/jackrabbit/spi/QueryResultRow.java?rev=1166087&r1=1166086&r2=1166087&view=diff
==============================================================================
--- jackrabbit/sandbox/jackrabbit-mk/jackrabbit-spi/src/main/java/org/apache/jackrabbit/spi/QueryResultRow.java (original)
+++ jackrabbit/sandbox/jackrabbit-mk/jackrabbit-spi/src/main/java/org/apache/jackrabbit/spi/QueryResultRow.java Wed Sep 7 09:49:37 2011
@@ -17,20 +17,20 @@
package org.apache.jackrabbit.spi;
/**
- * <code>QueryResultRow</code> represents the SPI equivalent of a query result
+ * {@code QueryResultRow} represents the SPI equivalent of a query result
* row. It provides access to the id of the Node this row represents as well
* as to the score and to the values represented in this result row.
*/
public interface QueryResultRow {
/**
- * Returns {@link NodeId} of node for a given <code>selector name</code> this
+ * Returns {@link NodeId} of node for a given {@code selector name} this
* result row represents.
*
- * @param selectorName the name of a selector or <code>null</code> for the
+ * @param selectorName the name of a selector or {@code null} for the
* default selector.
- * @return node id of the <code>Node</code> this result row represents or
- * <code>null</code> if there is no node present in this row for the
+ * @return node id of the {@code Node} this result row represents or
+ * {@code null} if there is no node present in this row for the
* given selector name.
* @see javax.jcr.query.Row#getNode()
* @see javax.jcr.query.Row#getNode(String)
@@ -38,18 +38,18 @@ public interface QueryResultRow {
NodeId getNodeId(Name selectorName);
/**
- * Returns score for the given <code>selectorName</code> of this result row.
+ * Returns score for the given {@code selectorName} of this result row.
*
- * @param selectorName the name of a selector or <code>null</code> for the
+ * @param selectorName the name of a selector or {@code null} for the
* default selector.
* @return score for the given selector in this result row.
*/
double getScore(Name selectorName);
/**
- * Returns an array of <code>QValue</code>s.
+ * Returns an array of {@code QValue}s.
*
- * @return an array of <code>QValue</code>s representing the values present
+ * @return an array of {@code QValue}s representing the values present
* in this result row.
* @see javax.jcr.query.Row#getValue(String)
* @see javax.jcr.query.Row#getValues()
Modified: jackrabbit/sandbox/jackrabbit-mk/jackrabbit-spi/src/main/java/org/apache/jackrabbit/spi/RepositoryService.java
URL: http://svn.apache.org/viewvc/jackrabbit/sandbox/jackrabbit-mk/jackrabbit-spi/src/main/java/org/apache/jackrabbit/spi/RepositoryService.java?rev=1166087&r1=1166086&r2=1166087&view=diff
==============================================================================
--- jackrabbit/sandbox/jackrabbit-mk/jackrabbit-spi/src/main/java/org/apache/jackrabbit/spi/RepositoryService.java (original)
+++ jackrabbit/sandbox/jackrabbit-mk/jackrabbit-spi/src/main/java/org/apache/jackrabbit/spi/RepositoryService.java Wed Sep 7 09:49:37 2011
@@ -43,10 +43,9 @@ import java.io.InputStream;
import java.util.Iterator;
import java.util.Map;
import java.util.concurrent.ExecutorService;
-import java.util.concurrent.Executors;
/**
- * The <code>RepositoryService</code> interface defines methods used to
+ * The {@code 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.
* The implementation of this interface is intended to hold only the state of
@@ -61,15 +60,15 @@ import java.util.concurrent.Executors;
* Name destName)
* </pre>
* This method performs an immediate persistent copy of the node identified by
- * srcNodeId and that node's subtree to a position as child of the node
+ * srcNodeId and that node's sub tree to a position as child of the node
* identified by destParentNodeId and assigns the newly copied node the name
* destName.<br>
- * The <code>SessionInfo</code> object provides user and workspace identification
+ * The {@code SessionInfo} object provides user and workspace identification
* as well as eventual lock tokens required to execute the copy.<br>
- * If <code>srcWorkspaceName</code> differs from the workspace name present with
+ * If {@code srcWorkspaceName} differs from the workspace name present with
* the SessionInfo, the copy is corresponds to a copy across workspaces.
* The source and destination of the copy operation are specified by
- * {@link NodeId}s. The <code>Name</code> holds the new name. Taken together,
+ * {@link NodeId}s. The {@code Name} holds the new name. Taken together,
* this information is sufficient to completely specify and authorize the copy
* operations.<p/>
*
@@ -80,39 +79,39 @@ import java.util.concurrent.Executors;
public interface RepositoryService {
/**
- * Return the <code>IdFactory</code>.
+ * Return the {@code IdFactory}.
*
- * @return The <code>IdFactory</code>.
+ * @return The {@code IdFactory}.
* @throws RepositoryException If an error occurs.
*/
IdFactory getIdFactory() throws RepositoryException;
/**
- * Return the <code>NameFactory</code>.
+ * Return the {@code NameFactory}.
*
- * @return The <code>NameFactory</code>.
+ * @return The {@code NameFactory}.
* @throws RepositoryException If an error occurs.
*/
NameFactory getNameFactory() throws RepositoryException;
/**
- * Return the <code>PathFactory</code>.
+ * Return the {@code PathFactory}.
*
- * @return The <code>PathFactory</code>.
+ * @return The {@code PathFactory}.
* @throws RepositoryException If an error occurs.
*/
PathFactory getPathFactory() throws RepositoryException;
/**
- * Return the <code>QValueFactory</code> defined with this SPI implementation.
+ * Return the {@code QValueFactory} defined with this SPI implementation.
*
- * @return The <code>QValueFactory</code>.
+ * @return The {@code QValueFactory}.
* @throws RepositoryException If an error occurs.
*/
QValueFactory getQValueFactory() throws RepositoryException;
/**
- * Returns a {@link ItemInfoCache} for the given <code>SessionInfo</code>.
+ * Returns a {@link ItemInfoCache} for the given {@code SessionInfo}.
* @param sessionInfo
* @return
* @throws RepositoryException
@@ -123,7 +122,7 @@ public interface RepositoryService {
/**
* Returns all property descriptors that can be exposed with the
* {@link javax.jcr.Repository Repository} implementation built on top of
- * this <code>RepositoryService</code>.
+ * this {@code RepositoryService}.
*
* @return key-value pairs for repository descriptor keys and values.
* @throws javax.jcr.RepositoryException
@@ -134,18 +133,18 @@ public interface RepositoryService {
//-----------------------------------< SessionInfo creation and release >---
/**
- * Returns a <code>SessionInfo</code> that will be used by other methods
- * on the <code>RepositoryService</code>.
+ * Returns a {@code SessionInfo} that will be used by other methods
+ * on the {@code RepositoryService}.
* An implementation may choose to authenticate the user using the supplied
- * <code>credentials</code>.
+ * {@code credentials}.
*
* @param credentials the credentials of the user.
- * @param workspaceName the name of the workspace the <code>SessionInfo</code>
- * should be built for. If the specified workspaceName is <code>null</code>
+ * @param workspaceName the name of the workspace the {@code SessionInfo}
+ * should be built for. If the specified workspaceName is {@code null}
* the implementation should select a default workspace.
- * @return a <code>SessionInfo</code> if authentication was successful.
+ * @return a {@code SessionInfo} if authentication was successful.
* @throws LoginException if authentication of the user fails.
- * @throws NoSuchWorkspaceException if the specified <code>workspaceName</code>
+ * @throws NoSuchWorkspaceException if the specified {@code workspaceName}
* is not recognized.
* @throws RepositoryException if an error occurs.
*/
@@ -153,16 +152,16 @@ public interface RepositoryService {
throws LoginException, NoSuchWorkspaceException, RepositoryException;
/**
- * Returns a new <code>SessionInfo</code> for the given workspace name that
- * will be used by other methods on the <code>RepositoryService</code>.
+ * Returns a new {@code SessionInfo} for the given workspace name that
+ * will be used by other methods on the {@code RepositoryService}.
*
* @param sessionInfo for another workspace
- * @param workspaceName the name of the workspace the new <code>SessionInfo</code>
- * should be built for. If the specified workspaceName is <code>null</code>
+ * @param workspaceName the name of the workspace the new {@code SessionInfo}
+ * should be built for. If the specified workspaceName is {@code null}
* the implementation should select a default workspace.
- * @return a <code>SessionInfo</code> if authentication was successful.
+ * @return a {@code SessionInfo} if authentication was successful.
* @throws LoginException if authentication of the user fails.
- * @throws NoSuchWorkspaceException if the specified <code>workspaceName</code>
+ * @throws NoSuchWorkspaceException if the specified {@code workspaceName}
* is not recognized.
* @throws RepositoryException if an error occurs.
*/
@@ -170,12 +169,12 @@ public interface RepositoryService {
throws LoginException, NoSuchWorkspaceException, RepositoryException;
/**
- * Returns a <code>SessionInfo</code> that will be used by other methods
- * on the <code>RepositoryService</code>.
+ * Returns a {@code SessionInfo} that will be used by other methods
+ * on the {@code RepositoryService}.
*
* @param sessionInfo
* @param credentials
- * @return a <code>SessionInfo</code> if impersonate was successful.
+ * @return a {@code SessionInfo} if impersonate was successful.
* @throws LoginException
* @throws RepositoryException
* @see javax.jcr.Session#impersonate(javax.jcr.Credentials)
@@ -183,7 +182,7 @@ public interface RepositoryService {
SessionInfo impersonate(SessionInfo sessionInfo, Credentials credentials) throws LoginException, RepositoryException;
/**
- * Indicates to the <code>RepositoryService</code>, that the given SessionInfo
+ * Indicates to the {@code RepositoryService}, that the given SessionInfo
* will not be used any more.
*
* @param sessionInfo
@@ -193,7 +192,7 @@ public interface RepositoryService {
//--------------------------------------------------------------------------
/**
- * Return all workspace names available for the given <code>SessionInfo</code>.
+ * Return all workspace names available for the given {@code SessionInfo}.
*
* @param sessionInfo
* @return An array of workspace names.
@@ -206,22 +205,22 @@ public interface RepositoryService {
//-----------------------------------------------------< Access Control >---
/**
* Returns true if all actions defined in the specified array are granted
- * to given <code>SessionInfo</code>. False otherwise.
+ * to given {@code SessionInfo}. False otherwise.
*
* @param sessionInfo
* @param itemId
* @param actions
- * @return true if the session with the given <code>SessionInfo</code> has
+ * @return true if the session with the given {@code SessionInfo} has
* the specified rights for the given item.
* @throws javax.jcr.RepositoryException
* @see javax.jcr.Session#checkPermission(String, String)
- * @see javax.jcr.Session#hasPermission(String, String)
+ * @see javax.jcr.Session#hasPermission(String, String)
*/
boolean isGranted(SessionInfo sessionInfo, ItemId itemId, String[] actions) throws RepositoryException;
//------------------------------------------------------< Reading items >---
/**
- * Returns the <code>QNodeDefinition</code> for the <code>Node</code>
+ * Returns the {@code QNodeDefinition} for the {@code Node}
* identified by the given id. This method should only be used if the
* caller is not able to unambiguously determine the applicable definition
* from the parent node type definition or if no parent exists (i.e. for
@@ -229,21 +228,21 @@ public interface RepositoryService {
*
* @param sessionInfo
* @param nodeId
- * @return The node definition applicable to the <code>Node</code> identified
+ * @return The node definition applicable to the {@code Node} identified
* by the given id.
* @throws javax.jcr.RepositoryException
*/
QNodeDefinition getNodeDefinition(SessionInfo sessionInfo, NodeId nodeId) throws RepositoryException;
/**
- * Returns the <code>QPropertyDefinition</code> for the <code>Property</code>
+ * Returns the {@code QPropertyDefinition} for the {@code Property}
* identified by the given id. This method should only be used if the
* caller is not able to unambiguously determine the applicable definition
* from the parent node type definition.
*
* @param sessionInfo
* @param propertyId
- * @return The property definition applicable for the <code>Property</code>
+ * @return The property definition applicable for the {@code Property}
* identified by the given id.
* @throws javax.jcr.RepositoryException
*/
@@ -251,17 +250,17 @@ public interface RepositoryService {
/**
* Method used to 'batch-read' from the persistent storage. It returns the
- * <code>ItemInfo</code> for the given <code>ItemId</code> as the first
- * element in the <code>Iterator</code>. In addition the iterator may contain
- * arbitrary <code>ItemInfo</code>s.
+ * {@code ItemInfo} for the given {@code ItemId} as the first
+ * element in the {@code Iterator}. In addition the iterator may contain
+ * arbitrary {@code ItemInfo}s.
*
* @param sessionInfo
* @param itemId
- * @return An <code>Iterator</code> of <code>ItemInfo</code>s containing
- * at least a single element: the <code>ItemInfo</code> that represents
- * the Item identified by the given <code>ItemId</code>. If the Iterator
+ * @return An {@code Iterator} of {@code ItemInfo}s containing
+ * at least a single element: the {@code ItemInfo} that represents
+ * the Item identified by the given {@code ItemId}. If the Iterator
* contains multiple elements, the first is expected to represent the Item
- * identified by the given <code>ItemId</code>.
+ * identified by the given {@code ItemId}.
* @throws javax.jcr.ItemNotFoundException
* @throws javax.jcr.RepositoryException
* @see javax.jcr.Session#getItem(String)
@@ -278,12 +277,12 @@ public interface RepositoryService {
RepositoryException;
/**
- * Returns an Iterator of <code>ChildInfo</code>s present on the
+ * Returns an Iterator of {@code ChildInfo}s present on the
* Node represented by the given parentId.
*
* @param sessionInfo
* @param parentId
- * @return An Iterator of <code>ChildInfo</code>s present on the
+ * @return An Iterator of {@code ChildInfo}s present on the
* Node represented by the given parentId.
* @throws ItemNotFoundException
* @throws RepositoryException
@@ -293,20 +292,20 @@ public interface RepositoryService {
/**
* Returns the {@link PropertyId Id}s of the properties that are referencing
- * the node identified by the given <code>nodeId</code>. If
- * <code>weakReferences</code> is <code>true</code> the ids of
+ * the node identified by the given {@code nodeId}. If
+ * {@code weakReferences} is {@code true} the ids of
* {@link javax.jcr.PropertyType#WEAKREFERENCE WEAKREFERENCE} properties are
* returned, otherwise the property must be of type {@link javax.jcr.PropertyType#REFERENCE REFERENCE}.
*
* @param sessionInfo
* @param nodeId
* @param propertyName name filter of referring properties to be returned;
- * if <code>null</code> then all references are returned.
- * @param weakReferences If <code>true</code> the properties must be of type
+ * if {@code null} then all references are returned.
+ * @param weakReferences If {@code true} the properties must be of type
* {@link javax.jcr.PropertyType#WEAKREFERENCE}, otherwise of type
* {@link javax.jcr.PropertyType#REFERENCE}.
* @return An Iterator of {@link PropertyId Id}s of the properties that are
- * referencing the node identified by the given <code>nodeId</code> or an
+ * referencing the node identified by the given {@code nodeId} or an
* empty iterator if the node is not referenceable or no references exist.
* @throws ItemNotFoundException
* @throws RepositoryException
@@ -325,8 +324,8 @@ public interface RepositoryService {
*
* @param sessionInfo
* @param itemId Id of the Item that is a common ancestor of all
- * <code>Item</code>s affected upon batch execution. This <code>Item</code>
- * might itself be modified within the scope of the <code>Batch</code>.
+ * {@code Item}s affected upon batch execution. This {@code Item}
+ * might itself be modified within the scope of the {@code Batch}.
* @return A Batch indicating the start of a set of transient modifications
* that will be execute at once upon {@link #submit(Batch)}.
* @throws RepositoryException
@@ -360,7 +359,7 @@ public interface RepositoryService {
//-------------------------------------------------------------< Import >---
/**
- * Imports the data present in the given <code>InputStream</code> into the
+ * Imports the data present in the given {@code InputStream} into the
* persistent layer. Note, that the implementation is responsible for
* validating the data presented and for the integrity of the repository
* upon completion.
@@ -384,9 +383,9 @@ public interface RepositoryService {
//---------------------------------------------------------< Copy, Move >---
/**
- * Moves the node identified by the given <code>srcNodeId</code> (and its
- * entire subtree) to the new location defined by <code>destParentNodeId</code>
- * and a new name (<code>destName</code>).
+ * Moves the node identified by the given {@code srcNodeId} (and its
+ * entire sub tree) to the new location defined by{@code >destParentNodeId}
+ * and a new name ({@code destName}).
*
* @param sessionInfo
* @param srcNodeId
@@ -406,13 +405,13 @@ public interface RepositoryService {
throws ItemExistsException, PathNotFoundException, VersionException, ConstraintViolationException, LockException, AccessDeniedException, UnsupportedRepositoryOperationException, RepositoryException;
/**
- * Clone the subtree identified by the given <code>srcNodeId</code>
- * in workspace named <code>srcWorkspaceName</code> to the destination
- * in the workspace specified by the given <code>SessionInfo</code>. The
+ * Clone the sub tree identified by the given{@code >srcNodeId}
+ * in workspace named {@code srcWorkspaceName} to the destination
+ * in the workspace specified by the given {@code SessionInfo}. The
* destination is composed by the given parent id and the new name
- * as indicated by <code>destName</code>.<p/>
- * Note, that <code>srcWorkspaceName</code> may be the same as the one
- * specified within the <code>SessionInfo</code>. In this case the copy
+ * as indicated by {@code destName}.<p/>
+ * Note, that {@code srcWorkspaceName} may be the same as the one
+ * specified within the {@code SessionInfo}. In this case the copy
* corresponds to a copy within a single workspace.
*
* @param sessionInfo
@@ -437,9 +436,9 @@ public interface RepositoryService {
//------------------------------------------------------< Update, Clone >---
/**
- * Updates the node identified by the given <code>NodeId</code> replacing
- * it (an the complete subtree) with a clone of its corresponding node
- * present in the workspace with the given <code>srcWorkspaceName</code>.
+ * Updates the node identified by the given {@code NodeId} replacing
+ * it (an the complete sub tree) with a clone of its corresponding node
+ * present in the workspace with the given {@code srcWorkspaceName}.
*
* @param sessionInfo
* @param nodeId
@@ -454,11 +453,11 @@ public interface RepositoryService {
void update(SessionInfo sessionInfo, NodeId nodeId, String srcWorkspaceName) throws NoSuchWorkspaceException, AccessDeniedException, LockException, InvalidItemStateException, RepositoryException;
/**
- * Clone the subtree identified by the given <code>srcNodeId</code>
- * in workspace named <code>srcWorkspaceName</code> to the destination
- * in the workspace specified by the given <code>SessionInfo</code>. The
+ * Clone the sub tree identified by the given{@code >srcNodeId}
+ * in workspace named {@code srcWorkspaceName} to the destination
+ * in the workspace specified by the given {@code SessionInfo}. The
* destination is composed by the given parent id and the new name
- * as indicated by <code>destName</code>.
+ * as indicated by {@code destName}.
*
* @param sessionInfo
* @param srcWorkspaceName
@@ -484,14 +483,14 @@ public interface RepositoryService {
//------------------------------------------------------------< Locking >---
/**
- * Returns the lock information that applies to <code>Node</code> identified
- * by the given <code>NodeId</code> or <code>null</code>. If the implementation
- * does not support locking at all, this method always returns <code>null</code>.
+ * Returns the lock information that applies to {@code Node} identified
+ * by the given {@code NodeId} or {@code null}. If the implementation
+ * does not support locking at all, this method always returns {@code null}.
*
* @param sessionInfo
* @param nodeId
* @return The lock information for the Node identified by the given
- * <code>nodeId</code> or <code>null</code> if no lock applies to that Node.
+ * {@code nodeId} or {@code null} if no lock applies to that Node.
* @throws javax.jcr.AccessDeniedException
* @throws javax.jcr.RepositoryException If some other error occurs.
* @see Node#getLock()
@@ -499,13 +498,13 @@ public interface RepositoryService {
LockInfo getLockInfo(SessionInfo sessionInfo, NodeId nodeId) throws AccessDeniedException, RepositoryException;
/**
- * Create a lock on the <code>Node</code> identified by the given id.
+ * Create a lock on the {@code Node} identified by the given id.
*
* @param sessionInfo
* @param nodeId
* @param deep
* @param sessionScoped
- * @return The <code>LockInfo</code> associated with the new lock
+ * @return The {@code LockInfo} associated with the new lock
* that has been created.
* @throws javax.jcr.UnsupportedRepositoryOperationException If this SPI
* implementation does not support locking at all.
@@ -519,7 +518,7 @@ public interface RepositoryService {
throws UnsupportedRepositoryOperationException, LockException, AccessDeniedException, RepositoryException;
/**
- * Create a lock on the <code>Node</code> identified by the given id.
+ * Create a lock on the {@code Node} identified by the given id.
*
* @param sessionInfo
* @param nodeId
@@ -529,7 +528,7 @@ public interface RepositoryService {
* The implementation is free to ignore the hint.
* @param ownerHint String indicating the desired lockOwner info. The
* implementation is free to ignore the hint.
- * @return The <code>LockInfo</code> associated with the new lock
+ * @return The {@code LockInfo} associated with the new lock
* that has been created.
* @throws javax.jcr.UnsupportedRepositoryOperationException If this SPI
* implementation does not support locking at all.
@@ -553,7 +552,7 @@ public interface RepositoryService {
* @throws javax.jcr.UnsupportedRepositoryOperationException If this SPI
* implementation does not support locking at all.
* @throws javax.jcr.lock.LockException If the Node identified by the given
- * id is not locked (any more) or if the <code>SessionInfo</code> does not
+ * id is not locked (any more) or if the {@code SessionInfo} does not
* contain the token associated with the lock to be refreshed.
* @throws javax.jcr.AccessDeniedException
* @throws javax.jcr.RepositoryException If another error occurs.
@@ -563,8 +562,8 @@ public interface RepositoryService {
LockException, AccessDeniedException, RepositoryException;
/**
- * Releases the lock on the <code>Node</code> identified by the given
- * <code>NodeId</code>.<p/>
+ * Releases the lock on the {@code Node} identified by the given
+ * {@code NodeId}.<p/>
* Please note, that on {@link javax.jcr.Session#logout() logout} all
* session-scoped locks must be released by calling unlock.
*
@@ -573,7 +572,7 @@ public interface RepositoryService {
* @throws javax.jcr.UnsupportedRepositoryOperationException If this SPI
* implementation does not support locking at all.
* @throws javax.jcr.lock.LockException If the Node identified by the given
- * id is not locked or if the <code>SessionInfo</code> does not contain the
+ * id is not locked or if the {@code SessionInfo} does not contain the
* token associated with the lock to be released.
* @throws javax.jcr.AccessDeniedException
* @throws javax.jcr.RepositoryException If another error occurs.
@@ -585,12 +584,12 @@ public interface RepositoryService {
//---------------------------------------------------------< Versioning >---
/**
- * Performs a checkin for the <code>Node</code> identified by the given
- * <code>NodeId</code>.
+ * Performs a checkin for the {@code Node} identified by the given
+ * {@code NodeId}.
*
* @param sessionInfo
* @param nodeId
- * @return <code>NodeId</code> of newly created version
+ * @return {@code NodeId} of newly created version
* @throws javax.jcr.version.VersionException
* @throws javax.jcr.UnsupportedRepositoryOperationException
* @throws javax.jcr.InvalidItemStateException
@@ -602,9 +601,9 @@ public interface RepositoryService {
InvalidItemStateException, LockException, RepositoryException;
/**
- * Performs a checkout for the <code>Node</code> identified by the given
- * <code>NodeId</code>. Same as {@link #checkout(SessionInfo, NodeId, NodeId)}
- * where the <code>activityId</code> is <code>null</code>.
+ * Performs a checkout for the {@code Node} identified by the given
+ * {@code NodeId}. Same as {@link #checkout(SessionInfo, NodeId, NodeId)}
+ * where the {@code activityId} is {@code null}.
*
* @param sessionInfo
* @param nodeId
@@ -617,15 +616,15 @@ public interface RepositoryService {
RepositoryException;
/**
- * Performs a checkout for the <code>Node</code> identified by the given
- * <code>NodeId</code> and for activity identified by the specified
- * <code>activityId</code>. If the <code>activityId</code> is <code>null</code>
+ * Performs a checkout for the {@code Node} identified by the given
+ * {@code NodeId} and for activity identified by the specified
+ * {@code activityId}. If the {@code activityId} is {@code null}
* this corresponds to {@link #checkout(SessionInfo, NodeId)}
*
* @param sessionInfo
* @param nodeId
* @param activityId Id of the activity node set to the editing session or
- * <code>null</code> if no activity is in effect.
+ * {@code null} if no activity is in effect.
* @throws UnsupportedRepositoryOperationException
* @throws LockException
* @throws RepositoryException
@@ -635,12 +634,12 @@ public interface RepositoryService {
throws UnsupportedRepositoryOperationException, LockException, RepositoryException;
/**
- * Performs a checkpoint for the <code>Node</code> identified by the given
- * <code>NodeId</code>.
+ * Performs a checkpoint for the {@code Node} identified by the given
+ * {@code NodeId}.
*
* @param sessionInfo
* @param nodeId
- * @return <code>NodeId</code> of newly created version
+ * @return {@code NodeId} of newly created version
* @throws javax.jcr.UnsupportedRepositoryOperationException
* @throws javax.jcr.RepositoryException
* @see javax.jcr.version.VersionManager#checkpoint(String)
@@ -650,14 +649,14 @@ public interface RepositoryService {
RepositoryException;
/**
- * Performs a checkpoint for the <code>Node</code> identified by the given
- * <code>NodeId</code>. For the checkout part the specified <code>activityId</code>
+ * Performs a checkpoint for the {@code Node} identified by the given
+ * {@code NodeId}. For the checkout part the specified {@code activityId}
* is taken into account as specified in {@link #checkout(SessionInfo, NodeId, NodeId)}.
*
* @param sessionInfo
* @param nodeId
* @param activityId Id of the activity node set to the editing session or
- * <code>null</code> if no activity is in effect.
+ * {@code null} if no activity is in effect.
* @throws UnsupportedRepositoryOperationException
* @throws LockException
* @throws RepositoryException
@@ -667,11 +666,11 @@ public interface RepositoryService {
throws UnsupportedRepositoryOperationException, RepositoryException;
/**
- * Remove the version identified by the specified <code>versionId</code>.
+ * Remove the version identified by the specified {@code versionId}.
*
* @param sessionInfo
- * @param versionHistoryId <code>NodeId</code> identifying the version
- * history the version identified by <code>versionId</code> belongs to.
+ * @param versionHistoryId {@code NodeId} identifying the version
+ * history the version identified by {@code versionId} belongs to.
* @param versionId
* @throws ReferentialIntegrityException
* @throws AccessDeniedException
@@ -685,17 +684,17 @@ public interface RepositoryService {
VersionException, RepositoryException;
/**
- * Restores the node identified by <code>nodeId</code> to the state defined
- * by the version with the specified <code>versionId</code>.
+ * Restores the node identified by {@code nodeId} to the state defined
+ * by the version with the specified {@code versionId}.
*
* @param sessionInfo
* @param nodeId
* @param versionId
* @param removeExisting boolean flag indicating how to deal with an
- * identifier collision that may occur if a node exists outside the subtree
+ * identifier collision that may occur if a node exists outside the sub tree
* to be restored with the same identified as a node that would be
- * introduces by the restore. If the <code>removeExisting</code> is
- * <code>true</code> the restored node takes precedence and the
+ * introduces by the restore. If the {@code removeExisting} is
+ * {@code true} the restored node takes precedence and the
* existing node is removed. Otherwise the restore fails.
* @throws javax.jcr.version.VersionException
* @throws javax.jcr.PathNotFoundException
@@ -715,15 +714,15 @@ public interface RepositoryService {
/**
* Restore multiple versions at once. The versions to be restored are
- * identified by the given array of <code>NodeId</code>s.
+ * identified by the given array of {@code NodeId}s.
*
* @param sessionInfo
* @param versionIds
* @param removeExisting boolean flag indicating how to deal with an
- * identifier collision that may occur if a node exists outside the subtrees
+ * identifier collision that may occur if a node exists outside the sub trees
* to be restored with the same identified as any node that would be
- * introduces by the restore. If the <code>removeExisting</code> is
- * <code>true</code> the node to be restored takes precedence and the
+ * introduces by the restore. If the {@code removeExisting} is
+ * {@code true} the node to be restored takes precedence and the
* existing node is removed. Otherwise the restore fails.
* @throws javax.jcr.ItemExistsException
* @throws javax.jcr.UnsupportedRepositoryOperationException
@@ -738,15 +737,15 @@ public interface RepositoryService {
RepositoryException;
/**
- * Merge the node identified by the given <code>NodeId</code> and its subtree
+ * Merge the node identified by the given {@code NodeId} and its sub tree
* with the corresponding node present in the workspace with the name of
- * <code>srcWorkspaceName</code>.
+ * {@code srcWorkspaceName}.
*
* @param sessionInfo
* @param nodeId
* @param srcWorkspaceName
* @param bestEffort
- * @return an <code>Iterator</code> over the {@link NodeId}s of all nodes that
+ * @return an {@code Iterator} over the {@link NodeId}s of all nodes that
* received a merge result of "fail" in the course of this operation.
* @throws javax.jcr.NoSuchWorkspaceException
* @throws javax.jcr.AccessDeniedException
@@ -761,15 +760,15 @@ public interface RepositoryService {
InvalidItemStateException, RepositoryException;
/**
- * Merge the node identified by the given <code>NodeId</code> and its subtree
+ * Merge the node identified by the given {@code NodeId} and its sub tree
* with the corresponding node present in the workspace with the name of
- * <code>srcWorkspaceName</code>.
+ * {@code srcWorkspaceName}.
*
* @param sessionInfo
* @param nodeId
* @param srcWorkspaceName
* @param bestEffort
- * @return an <code>Iterator</code> over the {@link NodeId}s of all nodes that
+ * @return an {@code Iterator} over the {@link NodeId}s of all nodes that
* received a merge result of "fail" in the course of this operation.
* @throws javax.jcr.NoSuchWorkspaceException
* @throws javax.jcr.AccessDeniedException
@@ -786,11 +785,11 @@ public interface RepositoryService {
/**
* Resolve an existing merge conflict present with the node identified by
- * the given <code>NodeId</code>.
+ * the given {@code NodeId}.
*
* @param sessionInfo
* @param nodeId
- * @param mergeFailedIds The <code>NodeId</code>s remaining in the jcr:mergeFailed
+ * @param mergeFailedIds The {@code NodeId}s remaining in the jcr:mergeFailed
* REFERENCE property. The version id(s) to be resolved were removed from the
* array and added to the predecessor ids in case of {@link Node#doneMerge(Version)}.
* In case of a {@link Node#cancelMerge(Version)} the version id only gets
@@ -812,15 +811,15 @@ public interface RepositoryService {
* Add the given version label in the persistent layer.
*
* @param sessionInfo
- * @param versionHistoryId <code>NodeId</code> identifying the version
- * history the version identified by <code>versionId</code> belongs to.
- * @param versionId <code>NodeId</code> identifying the version the
+ * @param versionHistoryId {@code NodeId} identifying the version
+ * history the version identified by {@code versionId} belongs to.
+ * @param versionId {@code NodeId} identifying the version the
* label belongs to.
* @param label The label to be added.
* @param moveLabel If the label is already assigned to a version within
- * the same version history this parameter has the following effect: If <code>true</code>
+ * the same version history this parameter has the following effect: If {@code true}
* the label already present gets moved to be now be a label of the version
- * indicated by <code>versionId</code>. If <code>false</code> this method
+ * indicated by {@code versionId}. If {@code false} this method
* fails and the label remains with the original version.
* @throws javax.jcr.version.VersionException
* @throws javax.jcr.RepositoryException
@@ -833,9 +832,9 @@ public interface RepositoryService {
* Remove the given version label in the persistent layer.
*
* @param sessionInfo
- * @param versionHistoryId <code>NodeId</code> identifying the version
- * history the version identified by <code>versionId</code> belongs to.
- * @param versionId <code>NodeId</code> identifying the version the
+ * @param versionHistoryId {@code NodeId} identifying the version
+ * history the version identified by {@code versionId} belongs to.
+ * @param versionId {@code NodeId} identifying the version the
* label belongs to.
* @param label The label to be removed.
* @throws javax.jcr.version.VersionException
@@ -850,7 +849,7 @@ public interface RepositoryService {
*
* @param sessionInfo
* @param title
- * @return the <code>NodeId</code> of the new activity node.
+ * @return the {@code NodeId} of the new activity node.
* @throws javax.jcr.UnsupportedRepositoryOperationException
* @throws javax.jcr.RepositoryException
* @see javax.jcr.version.VersionManager#createActivity(String)
@@ -860,7 +859,7 @@ public interface RepositoryService {
throws UnsupportedRepositoryOperationException, RepositoryException;
/**
- * Removes the activity identified by the specified <code>activityId</code>.
+ * Removes the activity identified by the specified {@code activityId}.
*
* @param sessionInfo
* @param activityId
@@ -873,12 +872,12 @@ public interface RepositoryService {
throws UnsupportedRepositoryOperationException, RepositoryException;
/**
- * Merges the activity identified by the given <code>activityId</code> into
- * the workspace the specified <code>sessionInfo</code> has been created for.
+ * Merges the activity identified by the given {@code activityId} into
+ * the workspace the specified {@code sessionInfo} has been created for.
*
* @param sessionInfo
* @param activityId
- * @return an <code>Iterator</code> over the {@link NodeId}s of all nodes that
+ * @return an {@code Iterator} over the {@link NodeId}s of all nodes that
* received a merge result of "fail" in the course of this operation.
* @throws UnsupportedRepositoryOperationException
* @throws RepositoryException
@@ -912,15 +911,15 @@ public interface RepositoryService {
String[] getSupportedQueryLanguages(SessionInfo sessionInfo) throws RepositoryException;
/**
- * Checks if the query <code>statement</code> is valid according to the
- * specified query <code>language</code> and returns the bind variable
+ * Checks if the query {@code statement} is valid according to the
+ * specified query {@code language} and returns the bind variable
* names found in the query statement.
*
* @param sessionInfo the session info.
* @param statement the query statement to check.
* @param language the query language.
* @param namespaces the locally re-mapped namespace which may be used in
- * the query <code>statement</code>.
+ * the query {@code statement}.
* @return the bind variable names.
* @throws InvalidQueryException if the query statement is invalid or the
* language is not supported.
@@ -933,19 +932,19 @@ public interface RepositoryService {
/**
* Execute the given query statement with the specified query language. The
- * additional <code>namespaces</code> parameter provides a mapping of prefix
- * to namespace uri in order to be able to properly resolve prefix:localname
+ * additional {@code namespaces} parameter provides a mapping of prefix
+ * to namespace uri in order to be able to properly resolve prefix:localName
* patterns present within the query statement.
*
* @param sessionInfo the session info that wants to execute the query.
* @param statement the query statement to be execute.
* @param language the query language used to parse the query
- * <code>statement</code>.
+ * {@code statement}.
* @param namespaces the locally re-mapped namespace which may be used in
- * the query <code>statement</code>.
- * @param limit The maximum result size or <code>-1</code> is no
+ * the query {@code statement}.
+ * @param limit The maximum result size or {@code -1} is no
* maximum is set.
- * @param offset The offset in the total result set or <code>-1</code>
+ * @param offset The offset in the total result set or {@code -1}
* is no offset is set.
* @param values A Map of name/value pairs collected upon calls to
* {@link javax.jcr.query.Query#bindValue(String,
@@ -960,7 +959,7 @@ public interface RepositoryService {
//--------------------------------------------------------< Observation >---
/**
- * Return an executor service to use for change polling. If <code>null</code>
+ * Return an executor service to use for change polling. If {@code null}
* observation is disabled.
* @return
*/
@@ -976,12 +975,12 @@ public interface RepositoryService {
*
* @param sessionInfo the session info which requests an event filter.
* @param eventTypes A combination of one or more event type constants
- * encoded as a bitmask.
+ * encoded as a bit mask.
* @param absPath An absolute path.
- * @param isDeep A <code>boolean</code>.
+ * @param isDeep A {@code boolean}.
* @param uuid Array of jcr:uuid properties.
* @param nodeTypeName Array of node type names.
- * @param noLocal A <code>boolean</code>.
+ * @param noLocal A {@code boolean}.
* @return the event filter instance with the given parameters.
* @throws UnsupportedRepositoryOperationException if this SPI implementation
* does not allow to create event filters.
@@ -1016,11 +1015,11 @@ public interface RepositoryService {
* Updates events filters on the subscription. When this method returns all
* events that go through the passed subscription and have been generated
* after this method call must be filtered using the passed
- * <code>filters</code>.
+ * {@code filters}.
* <p/>
* An implementation is required to accept at least event filter instances
* created by {@link RepositoryService#createEventFilter}. Optionally an
- * implementation may also support event filters instanciated by the client
+ * implementation may also support event filters instanciated by the client
* itself. An implementation may require special deployment in that case,
* e.g. to make the event filter implementation class available to the
* repository server.
@@ -1058,20 +1057,20 @@ public interface RepositoryService {
*
* @param subscription a subscription.
* @param timeout a timeout in milliseconds to wait at most for an
- * event bundle. If <code>timeout</code> is up and no
+ * event bundle. If {@code timeout} is up and no
* event occurred meanwhile an empty array is returned.
- * @return an array of <code>EventBundle</code>s representing the events
+ * @return an array of {@code EventBundle}s representing the events
* that occurred.
* @throws RepositoryException if an error occurs while retrieving the
* event bundles.
* @throws InterruptedException if the calling thread is interrupted while
* waiting for events within the specified
- * <code>timeout</code>.
+ * {@code timeout}.
*/
EventBundle[] getEvents(Subscription subscription, long timeout) throws RepositoryException, InterruptedException;
/**
- * Returns events from the <code>EventJournal</code> after a given point in
+ * Returns events from the {@code EventJournal} after a given point in
* time. The returned event bundle may only contain events up to a given
* time. In order to retrieve more events a client must call this method
* again with the timestamp from the last event bundle. An empty bundle
@@ -1079,7 +1078,7 @@ public interface RepositoryService {
*
* @param sessionInfo the session info.
* @param filter the event filter to apply. Please note: the
- * <code>noLocal</code> flag is ignored.
+ * {@code noLocal} flag is ignored.
* @param after retrieve events that occurred after the given
* timestamp.
* @return the event bundle.
@@ -1119,11 +1118,11 @@ public interface RepositoryService {
Map<String, String> getRegisteredNamespaces(SessionInfo sessionInfo) throws RepositoryException;
/**
- * Returns the namespace URI for the given namespace <code>prefix</code>.
+ * Returns the namespace URI for the given namespace {@code prefix}.
*
* @param sessionInfo the session info.
* @param prefix a namespace prefix to resolve.
- * @return the namespace URI for the given namespace <code>prefix</code>.
+ * @return the namespace URI for the given namespace {@code prefix}.
* @throws NamespaceException if prefix is not mapped to a namespace URI.
* @throws RepositoryException if another error occurs.
* @see javax.jcr.NamespaceRegistry#getURI(String)
@@ -1131,7 +1130,7 @@ public interface RepositoryService {
String getNamespaceURI(SessionInfo sessionInfo, String prefix) throws NamespaceException, RepositoryException;
/**
- * Returns the namespace prefix for the given namespace <code>uri</code>.
+ * Returns the namespace prefix for the given namespace {@code uri}.
*
* @param sessionInfo the session info.
* @param uri the namespace URI.
@@ -1173,7 +1172,7 @@ public interface RepositoryService {
//----------------------------------------------------------< NodeTypes >---
/**
- * Retrieve the <code>QNodeTypeDefinition</code>s of all registered nodetypes.
+ * Retrieve the {@code QNodeTypeDefinition}s of all registered nodetypes.
*
* @param sessionInfo
* @return Iterator of {@link QNodeTypeDefinition}s.
@@ -1187,18 +1186,18 @@ public interface RepositoryService {
Iterator<QNodeTypeDefinition> getQNodeTypeDefinitions(SessionInfo sessionInfo) throws RepositoryException;
/**
- * Retrieve <code>QNodeTypeDefinition</code>s for the given names. The
+ * Retrieve {@code QNodeTypeDefinition}s for the given names. The
* implementation is free to return additional definitions which will (probably)
* be needed by the caller due to node type inheritance. The caller must be
- * able to deal with any kind of additional <code>QNodeTypeDefinition</code>s
- * present in the <code>Iterator</code> irrespective whether they have been
+ * able to deal with any kind of additional {@code QNodeTypeDefinition}s
+ * present in the {@code Iterator} irrespective whether they have been
* loaded before or not.
*
* @param sessionInfo
* @param nodetypeNames names of node types to retrieve
* @return {@link QNodeTypeDefinition}
* @throws javax.jcr.nodetype.NoSuchNodeTypeException if for any of the given
- * names no <code>QNodeTypeDefinition</code> exists.
+ * names no {@code QNodeTypeDefinition} exists.
* @throws javax.jcr.RepositoryException
* @see javax.jcr.Workspace#getNodeTypeManager()
* @see javax.jcr.nodetype.NodeTypeManager#getAllNodeTypes()
@@ -1210,10 +1209,10 @@ public interface RepositoryService {
throws RepositoryException;
/**
- * Registers the node types with the specified <code>QNodeTypeDefinition</code>s.
- * If <code>allowUpdate</code> is <code>true</code> this method may also be
- * used to reregister existing node types with a modified definition, otherwise
- * this method will fail with <code>NodeTypeExistsException</code> if any of
+ * Registers the node types with the specified {@code QNodeTypeDefinition}s.
+ * If {@code allowUpdate} is {@code true} this method may also be
+ * used to re-register existing node types with a modified definition, otherwise
+ * this method will fail with {@code NodeTypeExistsException} if any of
* the specified definition has the name of an already registered node type.
*
* @param sessionInfo
@@ -1222,7 +1221,7 @@ public interface RepositoryService {
* @throws InvalidNodeTypeDefinitionException If any of the specified definitions
* is invalid.
* @throws NodeTypeExistsException If any of the specified definitions has the
- * name of an already registered node type and <code>allowUpdate</code> is <code>false</code>.
+ * name of an already registered node type and {@code allowUpdate} is {@code false}.
* @throws UnsupportedRepositoryOperationException If registering node types
* is not supported.
* @throws RepositoryException If another error occurs.
@@ -1232,7 +1231,7 @@ public interface RepositoryService {
throws InvalidNodeTypeDefinitionException, NodeTypeExistsException, UnsupportedRepositoryOperationException, RepositoryException;
/**
- * Unregisters the node types with the specified <code>names</code>.
+ * Unregisters the node types with the specified {@code names}.
*
* @param sessionInfo
* @param nodeTypeNames
@@ -1248,9 +1247,9 @@ public interface RepositoryService {
//-----------------------------------------------< Workspace Management >---
/**
- * Create a new workspace with the specified <code>name</code>. If
- * <code>srcWorkspaceName</code> isn't <code>null</code> the content of
- * that workspace is 'cloned' to the new workspace as inital content,
+ * Create a new workspace with the specified {@code name}. If
+ * {@code srcWorkspaceName} isn't {@code null} the content of
+ * that workspace is 'cloned' to the new workspace as initial content,
* otherwise an empty workspace will be created.
*
* @param sessionInfo
@@ -1269,7 +1268,7 @@ public interface RepositoryService {
UnsupportedRepositoryOperationException, NoSuchWorkspaceException, RepositoryException;
/**
- * Deletes the workspace with the specified <code>name</code>.
+ * Deletes the workspace with the specified {@code name}.
*
* @param sessionInfo
* @param name The name of the workspace to be deleted.
Modified: jackrabbit/sandbox/jackrabbit-mk/jackrabbit-spi/src/main/java/org/apache/jackrabbit/spi/RepositoryServiceFactory.java
URL: http://svn.apache.org/viewvc/jackrabbit/sandbox/jackrabbit-mk/jackrabbit-spi/src/main/java/org/apache/jackrabbit/spi/RepositoryServiceFactory.java?rev=1166087&r1=1166086&r2=1166087&view=diff
==============================================================================
--- jackrabbit/sandbox/jackrabbit-mk/jackrabbit-spi/src/main/java/org/apache/jackrabbit/spi/RepositoryServiceFactory.java (original)
+++ jackrabbit/sandbox/jackrabbit-mk/jackrabbit-spi/src/main/java/org/apache/jackrabbit/spi/RepositoryServiceFactory.java Wed Sep 7 09:49:37 2011
@@ -28,11 +28,11 @@ public interface RepositoryServiceFactor
/**
* Create a new {@link RepositoryService}. If the factory does not understand the
- * passed <code>parameters</code> it <em>must</em> return <code>null</code>.
+ * passed {@code parameters} it <em>must</em> return {@code null}.
* @param parameters implementation specific set of parameters
- * @return a fresh <code>RepositoryService</code> instance or <code>null</code>.
+ * @return a fresh {@code RepositoryService} instance or {@code null}.
* @throws RepositoryException If there was an error creating the
- * <code>RepositoryService</code> instance
+ * {@code RepositoryService} instance
*/
RepositoryService createRepositoryService(Map<?, ?> parameters) throws RepositoryException;
}
Modified: jackrabbit/sandbox/jackrabbit-mk/jackrabbit-spi/src/main/java/org/apache/jackrabbit/spi/SessionInfo.java
URL: http://svn.apache.org/viewvc/jackrabbit/sandbox/jackrabbit-mk/jackrabbit-spi/src/main/java/org/apache/jackrabbit/spi/SessionInfo.java?rev=1166087&r1=1166086&r2=1166087&view=diff
==============================================================================
--- jackrabbit/sandbox/jackrabbit-mk/jackrabbit-spi/src/main/java/org/apache/jackrabbit/spi/SessionInfo.java (original)
+++ jackrabbit/sandbox/jackrabbit-mk/jackrabbit-spi/src/main/java/org/apache/jackrabbit/spi/SessionInfo.java Wed Sep 7 09:49:37 2011
@@ -21,7 +21,7 @@ import javax.jcr.RepositoryException;
import javax.jcr.lock.LockException;
/**
- * <code>SessionInfo</code> is created upon
+ * {@code SessionInfo} is created upon
* {@link RepositoryService#obtain(javax.jcr.Credentials, String)} or
* {@link RepositoryService#obtain(SessionInfo, String)} and will be used for
* any call on the RepositoryService that requires user and workspace
@@ -52,16 +52,16 @@ public interface SessionInfo {
String getWorkspaceName();
/**
- * Returns the lock tokens present on this <code>SessionInfo</code>.
+ * Returns the lock tokens present on this {@code SessionInfo}.
*
- * @return lock tokens present on this <code>SessionInfo</code>.
+ * @return lock tokens present on this {@code SessionInfo}.
* @throws UnsupportedRepositoryOperationException If locking is not supported.
* @throws RepositoryException If another error occurs.
*/
String[] getLockTokens() throws UnsupportedRepositoryOperationException, RepositoryException;
/**
- * Add the given lock token to this <code>SessionInfo</code>. The token will
+ * Add the given lock token to this {@code SessionInfo}. The token will
* enable the SessionInfo to operate on Items that are affected by the
* lock identified by the given token.
*
@@ -74,11 +74,11 @@ public interface SessionInfo {
void addLockToken(String lockToken) throws UnsupportedRepositoryOperationException, LockException, RepositoryException;
/**
- * Removes the given lock token from this <code>SessionInfo</code>.
+ * Removes the given lock token from this {@code SessionInfo}.
* This must happen if the associated Session successfully removes the Lock
* from a Node or if the token is removed from the Session itself by calling
* {@link javax.jcr.Session#removeLockToken(String)}. Consequently all
- * <code>RepositoryService</code> operations affected by a lock will fail
+ * {@code RepositoryService} operations affected by a lock will fail
* with LockException provided the lock hasn't been released.
*
* @param lockToken to be removed.
Modified: jackrabbit/sandbox/jackrabbit-mk/jackrabbit-spi/src/main/java/org/apache/jackrabbit/spi/Subscription.java
URL: http://svn.apache.org/viewvc/jackrabbit/sandbox/jackrabbit-mk/jackrabbit-spi/src/main/java/org/apache/jackrabbit/spi/Subscription.java?rev=1166087&r1=1166086&r2=1166087&view=diff
==============================================================================
--- jackrabbit/sandbox/jackrabbit-mk/jackrabbit-spi/src/main/java/org/apache/jackrabbit/spi/Subscription.java (original)
+++ jackrabbit/sandbox/jackrabbit-mk/jackrabbit-spi/src/main/java/org/apache/jackrabbit/spi/Subscription.java Wed Sep 7 09:49:37 2011
@@ -19,7 +19,7 @@ package org.apache.jackrabbit.spi;
import java.util.concurrent.ExecutorService;
/**
- * <code>Subscription</code> defines a marker interface for an event
+ * {@code Subscription} defines a marker interface for an event
* subscription. An implementation will likely keep information in this object
* about the last consumed events and other implementation specific data. A
* client will usually first create an event filter and then a subscription
Modified: jackrabbit/sandbox/jackrabbit-mk/jackrabbit-spi/src/main/java/org/apache/jackrabbit/spi/XASessionInfo.java
URL: http://svn.apache.org/viewvc/jackrabbit/sandbox/jackrabbit-mk/jackrabbit-spi/src/main/java/org/apache/jackrabbit/spi/XASessionInfo.java?rev=1166087&r1=1166086&r2=1166087&view=diff
==============================================================================
--- jackrabbit/sandbox/jackrabbit-mk/jackrabbit-spi/src/main/java/org/apache/jackrabbit/spi/XASessionInfo.java (original)
+++ jackrabbit/sandbox/jackrabbit-mk/jackrabbit-spi/src/main/java/org/apache/jackrabbit/spi/XASessionInfo.java Wed Sep 7 09:49:37 2011
@@ -19,17 +19,17 @@ package org.apache.jackrabbit.spi;
import javax.transaction.xa.XAResource;
/**
- * <code>XASessionInfo</code> extends the <code>SessionInfo</code> and provides
+ * {@code XASessionInfo} extends the {@code SessionInfo} and provides
* access to the XAResource of the session info.
*/
public interface XASessionInfo extends SessionInfo {
/**
- * Retrieves an <code>XAResource</code> object that the transaction manager
- * will use to manage this <code>XASessionInfo</code> object's participation
+ * Retrieves an {@code XAResource} object that the transaction manager
+ * will use to manage this {@code XASessionInfo} object's participation
* in a distributed transaction.
*
- * @return the <code>XAResource</code> object.
+ * @return the {@code XAResource} object.
*/
XAResource getXAResource();
}
Added: jackrabbit/sandbox/jackrabbit-mk/jackrabbit-spi/src/main/java/org/apache/jackrabbit/spi/package-info.java
URL: http://svn.apache.org/viewvc/jackrabbit/sandbox/jackrabbit-mk/jackrabbit-spi/src/main/java/org/apache/jackrabbit/spi/package-info.java?rev=1166087&view=auto
==============================================================================
--- jackrabbit/sandbox/jackrabbit-mk/jackrabbit-spi/src/main/java/org/apache/jackrabbit/spi/package-info.java (added)
+++ jackrabbit/sandbox/jackrabbit-mk/jackrabbit-spi/src/main/java/org/apache/jackrabbit/spi/package-info.java Wed Sep 7 09:49:37 2011
@@ -0,0 +1,51 @@
+/**
+ * <!--
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements. See the NOTICE file distributed with
+ * this work for additional information regarding copyright ownership.
+ * The ASF licenses this file to You under the Apache License, Version 2.0
+ * (the "License"); you may not use this file except in compliance with
+ * the License. You may obtain a copy of the License at
+ * http://www.apache.org/licenses/LICENSE-2.0
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ * -->
+ * <body>
+ * Defines the interfaces of the JCR SPI (Service Provider Interface).
+ * <p/>
+ * The SPI cuts the JCR stack into two parts:
+ * <ul>
+ * <li>Above the SPI an implementation that wishes to expose the JCR API again
+ * needs to implement the transient item space, the session local namespace mapping
+ * and various conversions from the value representation in the SPI to
+ * the resolved values in the JCR API.</li>
+ * <li>An implementation of the SPI interfaces has to deal with the persistent
+ * view of a JCR repository. This includes almost all aspects of the JSR 170
+ * specification, except the previously stated transient space and the session
+ * local namespace resolution to prefixes.</li>
+ * </ul>
+ * <h3>Observation</h3>
+ * Because one of the goals of this SPI is to make it easier to implement a
+ * remoting layer using various existing protocols, the observation mechanism has
+ * been design with this goal in mind. Instead of a listener registration with
+ * a callback for each event bundle, the SPI uses a polling mechanism with a
+ * timeout: {@link RepositoryService#getEvents
+ * RepositoryService.getEvents()}. With every call to this method the repository
+ * is advised to return the events that occurred since the last call. As a
+ * reference to the last retrieved {@link EventBundle}
+ * the {@link SessionInfo} contains a bundle identifier
+ * which is automatically updated on each call to {@code RepositoryService.getEvents()}.
+ * While this design allows for a polling implementation on top of the SPI it is
+ * also well suited for a listener based observation implementation on top of the
+ * SPI. With only little thread synchronization overhead events can be acquired
+ * using a {@code timeout} of {@link Long#MAX_VALUE}.
+ * <p/>
+ * If an SPI implementation does not support observation, the method
+ * {@code RepositoryService.getEvents()} will always throw an
+ * {@link javax.jcr.UnsupportedRepositoryOperationException}.
+ * </body>
+ */
+package org.apache.jackrabbit.spi;
\ No newline at end of file