JavaDoc fixes
git-svn-id: https://svn.apache.org/repos/asf/chemistry/opencmis/trunk@1746713 13f79535-47bb-0310-9956-ffa450edef68
diff --git a/chemistry-opencmis-client/chemistry-opencmis-client-api/src/main/java/org/apache/chemistry/opencmis/client/SessionFactoryFinder.java b/chemistry-opencmis-client/chemistry-opencmis-client-api/src/main/java/org/apache/chemistry/opencmis/client/SessionFactoryFinder.java
index 35f188b..435a32a 100644
--- a/chemistry-opencmis-client/chemistry-opencmis-client-api/src/main/java/org/apache/chemistry/opencmis/client/SessionFactoryFinder.java
+++ b/chemistry-opencmis-client/chemistry-opencmis-client-api/src/main/java/org/apache/chemistry/opencmis/client/SessionFactoryFinder.java
@@ -30,7 +30,7 @@
* Finds a {@link SessionFactory} implementation and creates a factory object.
* <p>
* Sample code:
- * <p>
+ * </p>
*
* <pre>
* SessionFactory factory = SessionFactoryFinder.find();
diff --git a/chemistry-opencmis-client/chemistry-opencmis-client-api/src/main/java/org/apache/chemistry/opencmis/client/SessionParameterMap.java b/chemistry-opencmis-client/chemistry-opencmis-client-api/src/main/java/org/apache/chemistry/opencmis/client/SessionParameterMap.java
index c2c26c2..1defe76 100644
--- a/chemistry-opencmis-client/chemistry-opencmis-client-api/src/main/java/org/apache/chemistry/opencmis/client/SessionParameterMap.java
+++ b/chemistry-opencmis-client/chemistry-opencmis-client-api/src/main/java/org/apache/chemistry/opencmis/client/SessionParameterMap.java
@@ -46,7 +46,7 @@
* A map with convenience methods to set session parameters.
* <p>
* Sample code:
- * <p>
+ * </p>
*
* <pre>
* SessionFactory factory = ...
@@ -60,6 +60,7 @@
* Session session = factory.createSession(parameter);
* </pre>
*
+ *
* @see SessionParameter
* @see SessionFactory
*/
diff --git a/chemistry-opencmis-client/chemistry-opencmis-client-api/src/main/java/org/apache/chemistry/opencmis/client/api/ItemIterable.java b/chemistry-opencmis-client/chemistry-opencmis-client-api/src/main/java/org/apache/chemistry/opencmis/client/api/ItemIterable.java
index 188b61f..3b3a0fd 100644
--- a/chemistry-opencmis-client/chemistry-opencmis-client-api/src/main/java/org/apache/chemistry/opencmis/client/api/ItemIterable.java
+++ b/chemistry-opencmis-client/chemistry-opencmis-client-api/src/main/java/org/apache/chemistry/opencmis/client/api/ItemIterable.java
@@ -33,6 +33,7 @@
* Skips to position within CMIS collection.
*
* @param position
+ * offset where to skip to
*
* @return iterable whose starting point is the specified skip to position.
* This iterable <em>may</em> be the same as {@code this}
diff --git a/chemistry-opencmis-client/chemistry-opencmis-client-api/src/main/java/org/apache/chemistry/opencmis/client/api/SessionFactory.java b/chemistry-opencmis-client/chemistry-opencmis-client-api/src/main/java/org/apache/chemistry/opencmis/client/api/SessionFactory.java
index d4e1edd..f1f5747 100644
--- a/chemistry-opencmis-client/chemistry-opencmis-client-api/src/main/java/org/apache/chemistry/opencmis/client/api/SessionFactory.java
+++ b/chemistry-opencmis-client/chemistry-opencmis-client-api/src/main/java/org/apache/chemistry/opencmis/client/api/SessionFactory.java
@@ -33,13 +33,15 @@
* {@link org.apache.chemistry.opencmis.commons.SessionParameter} class which is
* part of the commons package. Parameters specify connection settings (user
* name, authentication, connection URL, binding type, etc.).
+ * </p>
* <p>
* The {@link Session} class which is constructed is either the {@code session}
* base class which is the default implementation or it can be derived from that
* implementing special behavior for the session.
+ * </p>
* <p>
* Sample code:
- * <p>
+ * </p>
*
* <pre>
* SessionFactory factory = ...
diff --git a/chemistry-opencmis-client/chemistry-opencmis-client-bindings/src/main/java/org/apache/chemistry/opencmis/client/bindings/CmisBindingFactory.java b/chemistry-opencmis-client/chemistry-opencmis-client-bindings/src/main/java/org/apache/chemistry/opencmis/client/bindings/CmisBindingFactory.java
index 8171531..f5c84c8 100644
--- a/chemistry-opencmis-client/chemistry-opencmis-client-bindings/src/main/java/org/apache/chemistry/opencmis/client/bindings/CmisBindingFactory.java
+++ b/chemistry-opencmis-client/chemistry-opencmis-client-bindings/src/main/java/org/apache/chemistry/opencmis/client/bindings/CmisBindingFactory.java
@@ -63,6 +63,8 @@
/**
* Creates a new factory instance.
+ *
+ * @return a new factory instance
*/
public static CmisBindingFactory newInstance() {
return new CmisBindingFactory();
@@ -70,6 +72,8 @@
/**
* Returns the default session parameters.
+ *
+ * @return the default session parameters
*/
public Map<String, String> getDefaultSessionParameters() {
return defaults;
@@ -77,6 +81,9 @@
/**
* Sets the default session parameters.
+ *
+ * @param sessionParameters
+ * the session parameters
*/
public void setDefaultSessionParameters(Map<String, String> sessionParameters) {
if (sessionParameters == null) {
@@ -89,6 +96,10 @@
/**
* Creates a CMIS binding instance. A binding class has to be provided in
* the session parameters.
+ *
+ * @param sessionParameters
+ * the session parameters
+ * @return the binding object
*/
public CmisBinding createCmisBinding(Map<String, String> sessionParameters) {
return createCmisBinding(sessionParameters, null, null);
@@ -97,6 +108,10 @@
/**
* Creates a CMIS binding instance. A binding class has to be provided in
* the session parameters.
+ *
+ * @param sessionParameters
+ * the session parameters
+ * @return the binding object
*/
public CmisBinding createCmisBinding(Map<String, String> sessionParameters,
AuthenticationProvider authenticationProvider, TypeDefinitionCache typeDefCache) {
@@ -109,6 +124,10 @@
/**
* Creates a default CMIS AtomPub binding instance.
+ *
+ * @param sessionParameters
+ * the session parameters
+ * @return the binding object
*/
public CmisBinding createCmisAtomPubBinding(Map<String, String> sessionParameters) {
return createCmisAtomPubBinding(sessionParameters, null, null);
@@ -117,6 +136,10 @@
/**
* Creates a default CMIS AtomPub binding instance with a custom
* authentication provider.
+ *
+ * @param sessionParameters
+ * the session parameters
+ * @return the binding object
*/
public CmisBinding createCmisAtomPubBinding(Map<String, String> sessionParameters,
AuthenticationProvider authenticationProvider, TypeDefinitionCache typeDefCache) {
@@ -150,6 +173,10 @@
/**
* Creates a default CMIS Web Services binding instance.
+ *
+ * @param sessionParameters
+ * the session parameters
+ * @return the binding object
*/
public CmisBinding createCmisWebServicesBinding(Map<String, String> sessionParameters) {
return createCmisWebServicesBinding(sessionParameters, null, null);
@@ -158,6 +185,10 @@
/**
* Creates a default CMIS Web Services binding instance with a custom
* authentication provider.
+ *
+ * @param sessionParameters
+ * the session parameters
+ * @return the binding object
*/
public CmisBinding createCmisWebServicesBinding(Map<String, String> sessionParameters,
AuthenticationProvider authenticationProvider, TypeDefinitionCache typeDefCache) {
@@ -210,6 +241,10 @@
/**
* Creates a default CMIS Browser binding instance.
+ *
+ * @param sessionParameters
+ * the session parameters
+ * @return the binding object
*/
public CmisBinding createCmisBrowserBinding(Map<String, String> sessionParameters) {
return createCmisBrowserBinding(sessionParameters, null, null);
@@ -218,6 +253,10 @@
/**
* Creates a default CMIS Browser binding instance with a custom
* authentication provider.
+ *
+ * @param sessionParameters
+ * the session parameters
+ * @return the binding object
*/
public CmisBinding createCmisBrowserBinding(Map<String, String> sessionParameters,
AuthenticationProvider authenticationProvider, TypeDefinitionCache typeDefCache) {
@@ -254,6 +293,10 @@
/**
* Creates a default CMIS local binding instance.
+ *
+ * @param sessionParameters
+ * the session parameters
+ * @return the binding object
*/
public CmisBinding createCmisLocalBinding(Map<String, String> sessionParameters) {
return createCmisLocalBinding(sessionParameters, null);
@@ -261,6 +304,10 @@
/**
* Creates a default CMIS local binding instance.
+ *
+ * @param sessionParameters
+ * the session parameters
+ * @return the binding object
*/
public CmisBinding createCmisLocalBinding(Map<String, String> sessionParameters, TypeDefinitionCache typeDefCache) {
checkSessionParameters(sessionParameters, false);
diff --git a/chemistry-opencmis-client/chemistry-opencmis-client-impl/src/main/java/org/apache/chemistry/opencmis/client/util/FileUtils.java b/chemistry-opencmis-client/chemistry-opencmis-client-impl/src/main/java/org/apache/chemistry/opencmis/client/util/FileUtils.java
index dc82d65..9d4e4ac 100644
--- a/chemistry-opencmis-client/chemistry-opencmis-client-impl/src/main/java/org/apache/chemistry/opencmis/client/util/FileUtils.java
+++ b/chemistry-opencmis-client/chemistry-opencmis-client-impl/src/main/java/org/apache/chemistry/opencmis/client/util/FileUtils.java
@@ -55,7 +55,9 @@
* @param session
* the session
* @return the object
+ *
* @throws CmisBaseException
+ * if something go wrong, for example the object doesn't exist
*/
public static CmisObject getObject(String pathOrIdOfObject, Session session) {
if (session == null) {
@@ -83,7 +85,9 @@
* @param session
* the session
* @return the folder object
+ *
* @throws CmisBaseException
+ * if something go wrong, for example the object doesn't exist
*/
public static Folder getFolder(String pathOrIdOfObject, Session session) {
CmisObject folder = getObject(pathOrIdOfObject, session);
@@ -107,8 +111,11 @@
* @param versioningState
* the versioning state or <code>null</code>
* @return the newly created document
+ *
* @throws FileNotFoundException
+ * if the file does not exist
* @throws CmisBaseException
+ * if something go wrong, for example the object doesn't exist
*/
public static Document createDocumentFromFile(String parentIdOrPath, File file, String type,
VersioningState versioningState, Session session) throws FileNotFoundException {
@@ -182,7 +189,10 @@
* @param type
* the folder type (defaults to <code>cmis:folder</code>)
* @return the newly created folder
+ *
* @throws CmisBaseException
+ * if something go wrong, for example the parent folder doesn't
+ * exist
*/
public static Folder createFolder(Folder parentFolder, String name, String type) {
if (type == null) {
@@ -208,7 +218,10 @@
* @param session
* the session
* @return the newly created folder
+ *
* @throws CmisBaseException
+ * if something go wrong, for example the parent folder doesn't
+ * exist
*/
public static Folder createFolder(String parentIdOrPath, String name, String type, Session session) {
Folder parentFolder = getFolder(parentIdOrPath, session);
@@ -231,8 +244,11 @@
* the document
* @param destinationPath
* the destination path
+ *
* @throws IOException
+ * if the download fails because of an IO problem
* @throws CmisBaseException
+ * if something go wrong, for example the document doesn't exist
*/
public static void download(Document doc, String destinationPath) throws IOException {
if (doc == null) {
@@ -262,8 +278,11 @@
* the destination path
* @param session
* the session
+ *
* @throws IOException
+ * if the download fails because of an IO problem
* @throws CmisBaseException
+ * if something go wrong, for example the document doesn't exist
*/
public static void download(String docIdOrPath, String destinationPath, Session session) throws IOException {
CmisObject doc = getObject(docIdOrPath, session);
@@ -282,7 +301,9 @@
* the id or path of the object
* @param session
* the session
+ *
* @throws CmisBaseException
+ * if something go wrong, for example the object doesn't exist
*/
public static void delete(String pathOrIdOfObject, Session session) {
CmisObject object = getObject(pathOrIdOfObject, session);
diff --git a/chemistry-opencmis-commons/chemistry-opencmis-commons-api/src/main/java/org/apache/chemistry/opencmis/commons/definitions/TypeDefinitionContainer.java b/chemistry-opencmis-commons/chemistry-opencmis-commons-api/src/main/java/org/apache/chemistry/opencmis/commons/definitions/TypeDefinitionContainer.java
index d6b02d0..eb6a148 100644
--- a/chemistry-opencmis-commons/chemistry-opencmis-commons-api/src/main/java/org/apache/chemistry/opencmis/commons/definitions/TypeDefinitionContainer.java
+++ b/chemistry-opencmis-commons/chemistry-opencmis-commons-api/src/main/java/org/apache/chemistry/opencmis/commons/definitions/TypeDefinitionContainer.java
@@ -30,11 +30,15 @@
/**
* Returns the type definition at this level.
+ *
+ * @return the type definition
*/
TypeDefinition getTypeDefinition();
/**
* Returns direct children of the type definition at this level.
+ *
+ * @return the children of this type
*/
List<TypeDefinitionContainer> getChildren();
}
diff --git a/chemistry-opencmis-commons/chemistry-opencmis-commons-api/src/main/java/org/apache/chemistry/opencmis/commons/exceptions/CmisBaseException.java b/chemistry-opencmis-commons/chemistry-opencmis-commons-api/src/main/java/org/apache/chemistry/opencmis/commons/exceptions/CmisBaseException.java
index 0fe18a0..7c25001 100644
--- a/chemistry-opencmis-commons/chemistry-opencmis-commons-api/src/main/java/org/apache/chemistry/opencmis/commons/exceptions/CmisBaseException.java
+++ b/chemistry-opencmis-commons/chemistry-opencmis-commons-api/src/main/java/org/apache/chemistry/opencmis/commons/exceptions/CmisBaseException.java
@@ -208,6 +208,9 @@
/**
* Returns additional data, if available.
*
+ * @param key
+ * the data key
+ *
* @return additional data, can be {@code null}
*/
public String getAdditionalData(String key) {
@@ -230,6 +233,8 @@
/**
* Returns the name of the exception as defined in the CMIS specification.
+ *
+ * @return the exception name
*/
public abstract String getExceptionName();
}
diff --git a/chemistry-opencmis-commons/chemistry-opencmis-commons-api/src/main/java/org/apache/chemistry/opencmis/commons/server/CallContext.java b/chemistry-opencmis-commons/chemistry-opencmis-commons-api/src/main/java/org/apache/chemistry/opencmis/commons/server/CallContext.java
index ef72a04..5be4862 100644
--- a/chemistry-opencmis-commons/chemistry-opencmis-commons-api/src/main/java/org/apache/chemistry/opencmis/commons/server/CallContext.java
+++ b/chemistry-opencmis-commons/chemistry-opencmis-commons-api/src/main/java/org/apache/chemistry/opencmis/commons/server/CallContext.java
@@ -70,19 +70,26 @@
String MAX_CONTENT_SIZE = "maxContentSize";
/** Key: encrypt temp files (values is a Boolean) */
String ENCRYPT_TEMP_FILE = "encryptTempFiles";
- /** Key: factory for threshold streams (value is a TempStoreOutputStreamFactory) */
+ /**
+ * Key: factory for threshold streams (value is a
+ * TempStoreOutputStreamFactory)
+ */
String STREAM_FACTORY = "streamFactory";
-
+
/**
* Returns the binding. Usually it returns
* {@link CallContext#BINDING_ATOMPUB},
* {@link CallContext#BINDING_WEBSERVICES},
* {@link CallContext#BINDING_BROWSER} or {@link CallContext#BINDING_LOCAL}.
+ *
+ * @return the binding
*/
String getBinding();
/**
- * Returns if <code>true</code> object infos can improve the performance.
+ * Returns if {@code true} object infos can improve the performance.
+ *
+ * @return if object infos are required
*/
boolean isObjectInfoRequired();
@@ -91,62 +98,86 @@
*
* @param key
* the key
- * @return the data if the key is valid, <code>null</code> otherwise
+ *
+ * @return the data if the key is valid, {@code null} otherwise
*/
Object get(String key);
/**
* Returns the CMIS version.
+ *
+ * @return the CMIS version, not {@code null}
*/
CmisVersion getCmisVersion();
/**
- * Returns the repository id.
+ * Returns the repository ID.
+ *
+ * @return the repository ID or {@code null} if it's a repository info call
*/
String getRepositoryId();
/**
* Returns the user name.
+ *
+ * @return the user name if provided
*/
String getUsername();
/**
* Returns the password.
+ *
+ * @return the password if provided
*/
String getPassword();
/**
* Returns the locale.
+ *
+ * @return the locale if set
*/
String getLocale();
/**
- * Returns the content offset if set, <code>null</code> otherwise
+ * Returns the content offset.
+ *
+ * @return the content offset if set, {@code null} otherwise
*/
BigInteger getOffset();
/**
- * Returns the content length if set, <code>null</code> otherwise
+ * Returns the content length.
+ *
+ * @return the content length if set, {@code null} otherwise
*/
BigInteger getLength();
/**
* Returns the temp directory.
+ *
+ * @return the temp directory
*/
File getTempDirectory();
/**
* Returns if temp files should be encrypted.
+ *
+ * @return {@code true} if temp files should be encrypted, {@code false}
+ * otherwise
*/
boolean encryptTempFiles();
/**
* Returns the memory threshold.
+ *
+ * @return the memory threshold in bytes
*/
int getMemoryThreshold();
/**
- * Returns the may size of content.
+ * Returns the max size of content.
+ *
+ * @return the max content size in bytes
*/
long getMaxContentSize();
}
diff --git a/chemistry-opencmis-commons/chemistry-opencmis-commons-api/src/main/java/org/apache/chemistry/opencmis/commons/server/CmisService.java b/chemistry-opencmis-commons/chemistry-opencmis-commons-api/src/main/java/org/apache/chemistry/opencmis/commons/server/CmisService.java
index 2a7da9c..f6ede50 100644
--- a/chemistry-opencmis-commons/chemistry-opencmis-commons-api/src/main/java/org/apache/chemistry/opencmis/commons/server/CmisService.java
+++ b/chemistry-opencmis-commons/chemistry-opencmis-commons-api/src/main/java/org/apache/chemistry/opencmis/commons/server/CmisService.java
@@ -83,6 +83,8 @@
* @param policies
* <em>(optional)</em> a list of policy IDs that MUST be applied
* to the newly created object
+ * @param extension
+ * extension data
* @return the object ID of the newly created object
*/
String create(String repositoryId, Properties properties, String folderId, ContentStream contentStream,
@@ -101,9 +103,11 @@
* @param objectId
* the identifier for the object
* @param allVersions
- * <em>(optional)</em> If <code>true</code> then delete all
- * versions of the document, otherwise delete only the document
- * object specified (default is <code>true</code>)
+ * <em>(optional)</em> If {@code true} then delete all versions
+ * of the document, otherwise delete only the document object
+ * specified (default is {@code true})
+ * @param extension
+ * extension data
*/
void deleteObjectOrCancelCheckOut(String repositoryId, String objectId, Boolean allVersions,
ExtensionsData extension);
@@ -124,12 +128,13 @@
* @param aclPropagation
* <em>(optional)</em> specifies how ACEs should be handled
* (default is {@link AclPropagation#REPOSITORYDETERMINED})
+ * @return new ACL
*/
Acl applyAcl(String repositoryId, String objectId, Acl aces, AclPropagation aclPropagation);
/**
- * Returns the {@link ObjectInfo} of the given object id or
- * <code>null</code> if no object info exists.
+ * Returns the {@link ObjectInfo} of the given object id or {@code null} if
+ * no object info exists.
*
* Only AtomPub requests will require object infos.
*
@@ -137,6 +142,7 @@
* the identifier for the repository
* @param objectId
* the identifier for the object
+ * @return the object info
*/
ObjectInfo getObjectInfo(String repositoryId, String objectId);
diff --git a/chemistry-opencmis-commons/chemistry-opencmis-commons-api/src/main/java/org/apache/chemistry/opencmis/commons/server/TempStoreOutputStream.java b/chemistry-opencmis-commons/chemistry-opencmis-commons-api/src/main/java/org/apache/chemistry/opencmis/commons/server/TempStoreOutputStream.java
index d21834e..ae2d90c 100644
--- a/chemistry-opencmis-commons/chemistry-opencmis-commons-api/src/main/java/org/apache/chemistry/opencmis/commons/server/TempStoreOutputStream.java
+++ b/chemistry-opencmis-commons/chemistry-opencmis-commons-api/src/main/java/org/apache/chemistry/opencmis/commons/server/TempStoreOutputStream.java
@@ -74,6 +74,11 @@
*
* Implementations should clean up all attached resources when this stream
* is closed.
+ *
+ * @return the input stream
+ *
+ * @throws IOException
+ * if the input stream could not be created
*/
public abstract InputStream getInputStream() throws IOException;
diff --git a/chemistry-opencmis-commons/chemistry-opencmis-commons-api/src/main/java/org/apache/chemistry/opencmis/commons/spi/AclService.java b/chemistry-opencmis-commons/chemistry-opencmis-commons-api/src/main/java/org/apache/chemistry/opencmis/commons/spi/AclService.java
index 12ef7ad..788bf6b 100644
--- a/chemistry-opencmis-commons/chemistry-opencmis-commons-api/src/main/java/org/apache/chemistry/opencmis/commons/spi/AclService.java
+++ b/chemistry-opencmis-commons/chemistry-opencmis-commons-api/src/main/java/org/apache/chemistry/opencmis/commons/spi/AclService.java
@@ -43,7 +43,9 @@
* the identifier for the object
* @param onlyBasicPermissions
* <em>(optional)</em> an indicator if only basic permissions
- * should be returned (default is <code>true</code>)
+ * should be returned (default is {@code true})
+ * @param extension
+ * extension data
* @return the ACL of the object
*/
Acl getAcl(String repositoryId, String objectId, Boolean onlyBasicPermissions, ExtensionsData extension);
@@ -62,6 +64,8 @@
* @param aclPropagation
* <em>(optional)</em> specifies how ACEs should be handled
* (default is {@link AclPropagation#REPOSITORYDETERMINED})
+ * @param extension
+ * extension data
* @return the ACL of the object
*/
Acl applyAcl(String repositoryId, String objectId, Acl addAces, Acl removeAces, AclPropagation aclPropagation,
diff --git a/chemistry-opencmis-commons/chemistry-opencmis-commons-api/src/main/java/org/apache/chemistry/opencmis/commons/spi/DiscoveryService.java b/chemistry-opencmis-commons/chemistry-opencmis-commons-api/src/main/java/org/apache/chemistry/opencmis/commons/spi/DiscoveryService.java
index bf2d2ae..06cc8a3 100644
--- a/chemistry-opencmis-commons/chemistry-opencmis-commons-api/src/main/java/org/apache/chemistry/opencmis/commons/spi/DiscoveryService.java
+++ b/chemistry-opencmis-commons/chemistry-opencmis-commons-api/src/main/java/org/apache/chemistry/opencmis/commons/spi/DiscoveryService.java
@@ -38,6 +38,14 @@
/**
* Executes a CMIS query statement against the contents of the repository.
+ *
+ * @param repositoryId
+ * the identifier for the repository
+ * @param statement
+ * the query statement
+ * @param extension
+ * extension data
+ * @return the query result
*/
ObjectList query(String repositoryId, String statement, Boolean searchAllVersions, Boolean includeAllowableActions,
IncludeRelationships includeRelationships, String renditionFilter, BigInteger maxItems,
@@ -45,6 +53,12 @@
/**
* Gets a list of content changes.
+ *
+ * @param repositoryId
+ * the identifier for the repository
+ * @param extension
+ * extension data
+ * @return the list of changes
*/
ObjectList getContentChanges(String repositoryId, Holder<String> changeLogToken, Boolean includeProperties,
String filter, Boolean includePolicyIds, Boolean includeAcl, BigInteger maxItems, ExtensionsData extension);
diff --git a/chemistry-opencmis-commons/chemistry-opencmis-commons-api/src/main/java/org/apache/chemistry/opencmis/commons/spi/ExtendedRepositoryService.java b/chemistry-opencmis-commons/chemistry-opencmis-commons-api/src/main/java/org/apache/chemistry/opencmis/commons/spi/ExtendedRepositoryService.java
index 1d26e65..14b7d58 100644
--- a/chemistry-opencmis-commons/chemistry-opencmis-commons-api/src/main/java/org/apache/chemistry/opencmis/commons/spi/ExtendedRepositoryService.java
+++ b/chemistry-opencmis-commons/chemistry-opencmis-commons-api/src/main/java/org/apache/chemistry/opencmis/commons/spi/ExtendedRepositoryService.java
@@ -39,9 +39,12 @@
* the identifier for the repository
* @param typeId
* typeId of an object type specified in the repository
+ * @param extension
+ * extension data
* @param useCache
* specifies whether the type definition should be looked up in
* the type definition cache first or not
+ * @return the type definition
*/
TypeDefinition getTypeDefinition(String repositoryId, String typeId, ExtensionsData extension, boolean useCache);
}
diff --git a/chemistry-opencmis-commons/chemistry-opencmis-commons-api/src/main/java/org/apache/chemistry/opencmis/commons/spi/MultiFilingService.java b/chemistry-opencmis-commons/chemistry-opencmis-commons-api/src/main/java/org/apache/chemistry/opencmis/commons/spi/MultiFilingService.java
index 0579123..2a3c6c4 100644
--- a/chemistry-opencmis-commons/chemistry-opencmis-commons-api/src/main/java/org/apache/chemistry/opencmis/commons/spi/MultiFilingService.java
+++ b/chemistry-opencmis-commons/chemistry-opencmis-commons-api/src/main/java/org/apache/chemistry/opencmis/commons/spi/MultiFilingService.java
@@ -34,12 +34,33 @@
/**
* Adds an existing fileable non-folder object to a folder.
+ *
+ * @param repositoryId
+ * the identifier for the repository
+ * @param objectId
+ * the object to add
+ * @param folderId
+ * the folder
+ * @param allVersions
+ * a flag that indicates if all versions of a document should be
+ * added to the folder or just this single version
+ * @param extension
+ * extension data
*/
void addObjectToFolder(String repositoryId, String objectId, String folderId, Boolean allVersions,
ExtensionsData extension);
/**
* Removes an existing fileable non-folder object from a folder.
+ *
+ * @param repositoryId
+ * the identifier for the repository
+ * @param objectId
+ * the object to remove
+ * @param folderId
+ * the folder
+ * @param extension
+ * extension data
*/
void removeObjectFromFolder(String repositoryId, String objectId, String folderId, ExtensionsData extension);
}
diff --git a/chemistry-opencmis-commons/chemistry-opencmis-commons-api/src/main/java/org/apache/chemistry/opencmis/commons/spi/NavigationService.java b/chemistry-opencmis-commons/chemistry-opencmis-commons-api/src/main/java/org/apache/chemistry/opencmis/commons/spi/NavigationService.java
index c7badba..1de4fc5 100644
--- a/chemistry-opencmis-commons/chemistry-opencmis-commons-api/src/main/java/org/apache/chemistry/opencmis/commons/spi/NavigationService.java
+++ b/chemistry-opencmis-commons/chemistry-opencmis-commons-api/src/main/java/org/apache/chemistry/opencmis/commons/spi/NavigationService.java
@@ -58,9 +58,9 @@
* followed by the ascending modifier "ASC" or the descending
* modifier "DESC" (default is repository specific)
* @param includeAllowableActions
- * <em>(optional)</em> if <code>true</code>, then the repository
- * must return the available actions for each object in the
- * result set (default is <code>false</code>)
+ * <em>(optional)</em> if {@code true}, then the repository must
+ * return the available actions for each object in the result set
+ * (default is {@code false})
* @param includeRelationships
* <em>(optional)</em> indicates what relationships in which the
* objects participate must be returned (default is
@@ -68,11 +68,11 @@
* @param renditionFilter
* <em>(optional)</em> indicates what set of renditions the
* repository must return whose kind matches this filter (default
- * is <code>"cmis:none"</code>)
+ * is {@code "cmis:none"})
* @param includePathSegment
- * <em>(optional)</em> if <code>true</code>, returns a path
- * segment for each child object for use in constructing that
- * object's path (default is <code>false</code>)
+ * <em>(optional)</em> if {@code true}, returns a path segment
+ * for each child object for use in constructing that object's
+ * path (default is {@code false})
* @param maxItems
* <em>(optional)</em> the maximum number of items to return in a
* response (default is repository specific)
@@ -80,6 +80,9 @@
* <em>(optional)</em> number of potential results that the
* repository MUST skip/page over before returning any results
* (default is 0)
+ * @param extension
+ * extension data
+ * @return the list of children
*/
ObjectInFolderList getChildren(String repositoryId, String folderId, String filter, String orderBy,
Boolean includeAllowableActions, IncludeRelationships includeRelationships, String renditionFilter,
@@ -101,9 +104,9 @@
* defines which properties must be returned by the repository
* (default is repository specific)
* @param includeAllowableActions
- * <em>(optional)</em> if <code>true</code>, then the repository
- * must return the available actions for each object in the
- * result set (default is <code>false</code>)
+ * <em>(optional)</em> if {@code true}, then the repository must
+ * return the available actions for each object in the result set
+ * (default is {@code false})
* @param includeRelationships
* <em>(optional)</em> indicates what relationships in which the
* objects participate must be returned (default is
@@ -111,11 +114,14 @@
* @param renditionFilter
* <em>(optional)</em> indicates what set of renditions the
* repository must return whose kind matches this filter (default
- * is <code>"cmis:none"</code>)
+ * is {@code "cmis:none"})
* @param includePathSegment
- * <em>(optional)</em> if <code>true</code>, returns a path
- * segment for each child object for use in constructing that
- * object's path (default is <code>false</code>)
+ * <em>(optional)</em> if {@code true}, returns a path segment
+ * for each child object for use in constructing that object's
+ * path (default is {@code false})
+ * @param extension
+ * extension data
+ * @return the tree of descendants
**/
List<ObjectInFolderContainer> getDescendants(String repositoryId, String folderId, BigInteger depth, String filter,
Boolean includeAllowableActions, IncludeRelationships includeRelationships, String renditionFilter,
@@ -137,9 +143,9 @@
* defines which properties must be returned by the repository
* (default is repository specific)
* @param includeAllowableActions
- * <em>(optional)</em> if <code>true</code>, then the repository
- * must return the available actions for each object in the
- * result set (default is <code>false</code>)
+ * <em>(optional)</em> if {@code true}, then the repository must
+ * return the available actions for each object in the result set
+ * (default is {@code false})
* @param includeRelationships
* <em>(optional)</em> indicates what relationships in which the
* objects participate must be returned (default is
@@ -147,11 +153,14 @@
* @param renditionFilter
* <em>(optional)</em> indicates what set of renditions the
* repository must return whose kind matches this filter (default
- * is <code>"cmis:none"</code>)
+ * is {@code "cmis:none"})
* @param includePathSegment
- * <em>(optional)</em> if <code>true</code>, returns a path
- * segment for each child object for use in constructing that
- * object's path (default is <code>false</code>)
+ * <em>(optional)</em> if {@code true}, returns a path segment
+ * for each child object for use in constructing that object's
+ * path (default is {@code false})
+ * @param extension
+ * extension data
+ * @return the folder tree
**/
List<ObjectInFolderContainer> getFolderTree(String repositoryId, String folderId, BigInteger depth, String filter,
Boolean includeAllowableActions, IncludeRelationships includeRelationships, String renditionFilter,
@@ -169,9 +178,9 @@
* defines which properties must be returned by the repository
* (default is repository specific)
* @param includeAllowableActions
- * <em>(optional)</em> if <code>true</code>, then the repository
- * must return the available actions for each object in the
- * result set (default is <code>false</code>)
+ * <em>(optional)</em> if {@code true}, then the repository must
+ * return the available actions for each object in the result set
+ * (default is {@code false})
* @param includeRelationships
* <em>(optional)</em> indicates what relationships in which the
* objects participate must be returned (default is
@@ -179,11 +188,14 @@
* @param renditionFilter
* <em>(optional)</em> indicates what set of renditions the
* repository must return whose kind matches this filter (default
- * is <code>"cmis:none"</code>)
+ * is {@code "cmis:none"})
* @param includeRelativePathSegment
- * <em>(optional)</em> if <code>true</code>, returns a relative
- * path segment for each parent object for use in constructing
- * that object's path (default is <code>false</code>)
+ * <em>(optional)</em> if {@code true}, returns a relative path
+ * segment for each parent object for use in constructing that
+ * object's path (default is {@code false})
+ * @param extension
+ * extension data
+ * @return the list of parents
*/
List<ObjectParentData> getObjectParents(String repositoryId, String objectId, String filter,
Boolean includeAllowableActions, IncludeRelationships includeRelationships, String renditionFilter,
@@ -200,6 +212,9 @@
* <em>(optional)</em> a comma-separated list of query names that
* defines which properties must be returned by the repository
* (default is repository specific)
+ * @param extension
+ * extension data
+ * @return the folder parent
*/
ObjectData getFolderParent(String repositoryId, String folderId, String filter, ExtensionsData extension);
@@ -221,9 +236,9 @@
* followed by the ascending modifier "ASC" or the descending
* modifier "DESC" (default is repository specific)
* @param includeAllowableActions
- * <em>(optional)</em> if <code>true</code>, then the repository
- * must return the available actions for each object in the
- * result set (default is <code>false</code>)
+ * <em>(optional)</em> if {@code true}, then the repository must
+ * return the available actions for each object in the result set
+ * (default is {@code false})
* @param includeRelationships
* <em>(optional)</em> indicates what relationships in which the
* objects participate must be returned (default is
@@ -231,7 +246,7 @@
* @param renditionFilter
* <em>(optional)</em> indicates what set of renditions the
* repository must return whose kind matches this filter (default
- * is <code>"cmis:none"</code>)
+ * is {@code "cmis:none"})
* @param maxItems
* <em>(optional)</em> the maximum number of items to return in a
* response (default is repository specific)
@@ -239,6 +254,9 @@
* <em>(optional)</em> number of potential results that the
* repository MUST skip/page over before returning any results
* (default is 0)
+ * @param extension
+ * extension data
+ * @return the list of checked out documents
*/
ObjectList getCheckedOutDocs(String repositoryId, String folderId, String filter, String orderBy,
Boolean includeAllowableActions, IncludeRelationships includeRelationships, String renditionFilter,
diff --git a/chemistry-opencmis-commons/chemistry-opencmis-commons-api/src/main/java/org/apache/chemistry/opencmis/commons/spi/ObjectService.java b/chemistry-opencmis-commons/chemistry-opencmis-commons-api/src/main/java/org/apache/chemistry/opencmis/commons/spi/ObjectService.java
index 4593b9a..bfa2aa6 100644
--- a/chemistry-opencmis-commons/chemistry-opencmis-commons-api/src/main/java/org/apache/chemistry/opencmis/commons/spi/ObjectService.java
+++ b/chemistry-opencmis-commons/chemistry-opencmis-commons-api/src/main/java/org/apache/chemistry/opencmis/commons/spi/ObjectService.java
@@ -75,13 +75,16 @@
* @param addAces
* <em>(optional)</em> a list of ACEs that must be added to the
* newly created document object, either using the ACL from
- * <code>folderId</code> if specified, or being applied if no
- * <code>folderId</code> is specified
+ * {@code folderId} if specified, or being applied if no
+ * {@code folderId} is specified
* @param removeAces
* <em>(optional)</em> a list of ACEs that must be removed from
* the newly created document object, either using the ACL from
- * <code>folderId</code> if specified, or being ignored if no
- * <code>folderId</code> is specified
+ * {@code folderId} if specified, or being ignored if no
+ * {@code folderId} is specified
+ * @param extension
+ * extension data
+ * @return the ID of the newly created document
*/
String createDocument(String repositoryId, Properties properties, String folderId, ContentStream contentStream,
VersioningState versioningState, List<String> policies, Acl addAces, Acl removeAces,
@@ -112,13 +115,16 @@
* @param addAces
* <em>(optional)</em> a list of ACEs that must be added to the
* newly created document object, either using the ACL from
- * <code>folderId</code> if specified, or being applied if no
- * <code>folderId</code> is specified
+ * {@code folderId} if specified, or being applied if no
+ * {@code folderId} is specified
* @param removeAces
* <em>(optional)</em> a list of ACEs that must be removed from
* the newly created document object, either using the ACL from
- * <code>folderId</code> if specified, or being ignored if no
- * <code>folderId</code> is specified
+ * {@code folderId} if specified, or being ignored if no
+ * {@code folderId} is specified
+ * @param extension
+ * extension data
+ * @return the ID of the newly created document
*/
String createDocumentFromSource(String repositoryId, String sourceId, Properties properties, String folderId,
VersioningState versioningState, List<String> policies, Acl addAces, Acl removeAces,
@@ -141,13 +147,16 @@
* @param addAces
* <em>(optional)</em> a list of ACEs that must be added to the
* newly created folder object, either using the ACL from
- * <code>folderId</code> if specified, or being applied if no
- * <code>folderId</code> is specified
+ * {@code folderId} if specified, or being applied if no
+ * {@code folderId} is specified
* @param removeAces
* <em>(optional)</em> a list of ACEs that must be removed from
* the newly created folder object, either using the ACL from
- * <code>folderId</code> if specified, or being ignored if no
- * <code>folderId</code> is specified
+ * {@code folderId} if specified, or being ignored if no
+ * {@code folderId} is specified
+ * @param extension
+ * extension data
+ * @return the ID of the newly created folder
*/
String createFolder(String repositoryId, Properties properties, String folderId, List<String> policies,
Acl addAces, Acl removeAces, ExtensionsData extension);
@@ -167,13 +176,16 @@
* @param addAces
* <em>(optional)</em> a list of ACEs that must be added to the
* newly created relationship object, either using the ACL from
- * <code>folderId</code> if specified, or being applied if no
- * <code>folderId</code> is specified
+ * {@code folderId} if specified, or being applied if no
+ * {@code folderId} is specified
* @param removeAces
* <em>(optional)</em> a list of ACEs that must be removed from
* the newly created relationship object, either using the ACL
- * from <code>folderId</code> if specified, or being ignored if
- * no <code>folderId</code> is specified
+ * from {@code folderId} if specified, or being ignored if no
+ * {@code folderId} is specified
+ * @param extension
+ * extension data
+ * @return the ID of the newly created relationship
*/
String createRelationship(String repositoryId, Properties properties, List<String> policies, Acl addAces,
Acl removeAces, ExtensionsData extension);
@@ -197,13 +209,16 @@
* @param addAces
* <em>(optional)</em> a list of ACEs that must be added to the
* newly created policy object, either using the ACL from
- * <code>folderId</code> if specified, or being applied if no
- * <code>folderId</code> is specified
+ * {@code folderId} if specified, or being applied if no
+ * {@code folderId} is specified
* @param removeAces
* <em>(optional)</em> a list of ACEs that must be removed from
* the newly created policy object, either using the ACL from
- * <code>folderId</code> if specified, or being ignored if no
- * <code>folderId</code> is specified
+ * {@code folderId} if specified, or being ignored if no
+ * {@code folderId} is specified
+ * @param extension
+ * extension data
+ * @return the ID of the newly created policy
*/
String createPolicy(String repositoryId, Properties properties, String folderId, List<String> policies,
Acl addAces, Acl removeAces, ExtensionsData extension);
@@ -227,13 +242,16 @@
* @param addAces
* <em>(optional)</em> a list of ACEs that must be added to the
* newly created policy object, either using the ACL from
- * <code>folderId</code> if specified, or being applied if no
- * <code>folderId</code> is specified
+ * {@code folderId} if specified, or being applied if no
+ * {@code folderId} is specified
* @param removeAces
* <em>(optional)</em> a list of ACEs that must be removed from
* the newly created policy object, either using the ACL from
- * <code>folderId</code> if specified, or being ignored if no
- * <code>folderId</code> is specified
+ * {@code folderId} if specified, or being ignored if no
+ * {@code folderId} is specified
+ * @param extension
+ * extension data
+ * @return the ID of the newly created item
*/
String createItem(String repositoryId, Properties properties, String folderId, List<String> policies, Acl addAces,
Acl removeAces, ExtensionsData extension);
@@ -245,6 +263,9 @@
* the identifier for the repository
* @param objectId
* the identifier for the object
+ * @param extension
+ * extension data
+ * @return the allowable actions
*/
AllowableActions getAllowableActions(String repositoryId, String objectId, ExtensionsData extension);
@@ -260,9 +281,9 @@
* defines which properties must be returned by the repository
* (default is repository specific)
* @param includeAllowableActions
- * <em>(optional)</em> if <code>true</code>, then the repository
- * must return the allowable actions for the object (default is
- * <code>false</code>)
+ * <em>(optional)</em> if {@code true}, then the repository must
+ * return the allowable actions for the object (default is
+ * {@code false})
* @param includeRelationships
* <em>(optional)</em> indicates what relationships in which the
* object participates must be returned (default is
@@ -272,13 +293,15 @@
* repository must return whose kind matches this filter (default
* is <code>"cmis:none"</code>)
* @param includePolicyIds
- * <em>(optional)</em> if <code>true</code>, then the repository
- * must return the policy ids for the object (default is
- * <code>false</code>)
+ * <em>(optional)</em> if {@code true}, then the repository must
+ * return the policy ids for the object (default is {@code false}
+ * )
* @param includeAcl
- * <em>(optional)</em> if <code>true</code>, then the repository
- * must return the ACL for the object (default is
- * <code>false</code>)
+ * <em>(optional)</em> if {@code true}, then the repository must
+ * return the ACL for the object (default is {@code false})
+ * @param extension
+ * extension data
+ * @return the object
*/
ObjectData getObject(String repositoryId, String objectId, String filter, Boolean includeAllowableActions,
IncludeRelationships includeRelationships, String renditionFilter, Boolean includePolicyIds,
@@ -295,6 +318,9 @@
* <em>(optional)</em> a comma-separated list of query names that
* defines which properties must be returned by the repository
* (default is repository specific)
+ * @param extension
+ * extension data
+ * @return the object properties
*/
Properties getProperties(String repositoryId, String objectId, String filter, ExtensionsData extension);
@@ -317,6 +343,9 @@
* <em>(optional)</em> number of potential results that the
* repository must skip/page over before returning any results
* (default is 0)
+ * @param extension
+ * extension data
+ * @return the list of renditions
*/
List<RenditionData> getRenditions(String repositoryId, String objectId, String renditionFilter,
BigInteger maxItems, BigInteger skipCount, ExtensionsData extension);
@@ -333,9 +362,9 @@
* defines which properties must be returned by the repository
* (default is repository specific)
* @param includeAllowableActions
- * <em>(optional)</em> if <code>true</code>, then the repository
- * must return the allowable actions for the object (default is
- * <code>false</code>)
+ * <em>(optional)</em> if {@code true}, then the repository must
+ * return the allowable actions for the object (default is
+ * {@code false})
* @param includeRelationships
* <em>(optional)</em> indicates what relationships in which the
* object participates must be returned (default is
@@ -345,13 +374,15 @@
* repository must return whose kind matches this filter (default
* is <code>"cmis:none"</code>)
* @param includePolicyIds
- * <em>(optional)</em> if <code>true</code>, then the repository
- * must return the policy ids for the object (default is
- * <code>false</code>)
+ * <em>(optional)</em> if {@code true}, then the repository must
+ * return the policy ids for the object (default is {@code false}
+ * )
* @param includeAcl
- * <em>(optional)</em> if <code>true</code>, then the repository
- * must return the ACL for the object (default is
- * <code>false</code>)
+ * <em>(optional)</em> if {@code true}, then the repository must
+ * return the ACL for the object (default is {@code false})
+ * @param extension
+ * extension data
+ * @return the object
*/
ObjectData getObjectByPath(String repositoryId, String path, String filter, Boolean includeAllowableActions,
IncludeRelationships includeRelationships, String renditionFilter, Boolean includePolicyIds,
@@ -366,6 +397,9 @@
* the identifier for the repository
* @param objectId
* the identifier for the object
+ * @param extension
+ * extension data
+ * @return the content stream
*/
ContentStream getContentStream(String repositoryId, String objectId, String streamId, BigInteger offset,
BigInteger length, ExtensionsData extension);
@@ -381,9 +415,11 @@
* @param changeToken
* <em>(optional)</em> the last change token of this object that
* the client received. The repository might return a new change
- * token (default is <code>null</code>)
+ * token (default is {@code null})
* @param properties
* the updated property values that must be applied to the object
+ * @param extension
+ * extension data
*/
void updateProperties(String repositoryId, Holder<String> objectId, Holder<String> changeToken,
Properties properties, ExtensionsData extension);
@@ -401,6 +437,9 @@
* the secondary types to apply
* @param removeSecondaryTypeIds
* the secondary types to remove
+ * @param extension
+ * extension data
+ * @return the list of updated objects with their change tokens
*/
List<BulkUpdateObjectIdAndChangeToken> bulkUpdateProperties(String repositoryId,
List<BulkUpdateObjectIdAndChangeToken> objectIdsAndChangeTokens, Properties properties,
@@ -418,6 +457,8 @@
* the identifier for the target folder
* @param sourceFolderId
* the identifier for the source folder
+ * @param extension
+ * extension data
*/
void moveObject(String repositoryId, Holder<String> objectId, String targetFolderId, String sourceFolderId,
ExtensionsData extension);
@@ -430,9 +471,11 @@
* @param objectId
* the identifier for the object
* @param allVersions
- * <em>(optional)</em> If <code>true</code> then delete all
- * versions of the document, otherwise delete only the document
- * object specified (default is <code>true</code>)
+ * <em>(optional)</em> If {@code true} then delete all versions
+ * of the document, otherwise delete only the document object
+ * specified (default is {@code true})
+ * @param extension
+ * extension data
*/
void deleteObject(String repositoryId, String objectId, Boolean allVersions, ExtensionsData extension);
@@ -445,18 +488,22 @@
* @param folderId
* the identifier for the folder
* @param allVersions
- * <em>(optional)</em> If <code>true</code> then delete all
- * versions of the document, otherwise delete only the document
- * object specified (default is <code>true</code>)
+ * <em>(optional)</em> If {@code true} then delete all versions
+ * of the document, otherwise delete only the document object
+ * specified (default is {@code true})
* @param unfileObjects
* <em>(optional)</em> defines how the repository must process
* file-able child- or descendant-objects (default is
* {@link UnfileObject#DELETE})
* @param continueOnFailure
- * <em>(optional)</em> If <code>true</code>, then the repository
+ * <em>(optional)</em> If {@code true}, then the repository
* should continue attempting to perform this operation even if
* deletion of a child- or descendant-object in the specified
- * folder cannot be deleted (default is <code>false</code>)
+ * folder cannot be deleted (default is {@code false})
+ * @param extension
+ * extension data
+ * @return a (possibly incomplete) collection of object IDs of objects that
+ * couldn't be deleted
*/
FailedToDeleteData deleteTree(String repositoryId, String folderId, Boolean allVersions,
UnfileObject unfileObjects, Boolean continueOnFailure, ExtensionsData extension);
@@ -473,18 +520,20 @@
* the identifier for the object. The repository might return a
* different/new object id
* @param overwriteFlag
- * <em>(optional)</em> If <code>true</code>, then the repository
- * must replace the existing content stream for the object (if
- * any) with the input content stream. If If <code>false</code>,
- * then the repository must only set the input content stream for
- * the object if the object currently does not have a content
- * stream (default is <code>true</code>)
+ * <em>(optional)</em> If {@code true}, then the repository must
+ * replace the existing content stream for the object (if any)
+ * with the input content stream. If If {@code false}, then the
+ * repository must only set the input content stream for the
+ * object if the object currently does not have a content stream
+ * (default is {@code true})
* @param changeToken
* <em>(optional)</em> the last change token of this object that
* the client received. The repository might return a new change
- * token (default is <code>null</code>)
+ * token (default is {@code null})
* @param contentStream
* the content stream
+ * @param extension
+ * extension data
*/
void setContentStream(String repositoryId, Holder<String> objectId, Boolean overwriteFlag,
Holder<String> changeToken, ContentStream contentStream, ExtensionsData extension);
@@ -500,7 +549,9 @@
* @param changeToken
* <em>(optional)</em> the last change token of this object that
* the client received. The repository might return a new change
- * token (default is <code>null</code>)
+ * token (default is {@code null})
+ * @param extension
+ * extension data
*/
void deleteContentStream(String repositoryId, Holder<String> objectId, Holder<String> changeToken,
ExtensionsData extension);
@@ -516,11 +567,13 @@
* @param changeToken
* <em>(optional)</em> the last change token of this object that
* the client received. The repository might return a new change
- * token (default is <code>null</code>)
+ * token (default is {@code null})
* @param contentStream
* the content stream to append
* @param isLastChunk
* indicates if this content stream is the last chunk
+ * @param extension
+ * extension data
*/
void appendContentStream(String repositoryId, Holder<String> objectId, Holder<String> changeToken,
ContentStream contentStream, boolean isLastChunk, ExtensionsData extension);
diff --git a/chemistry-opencmis-commons/chemistry-opencmis-commons-api/src/main/java/org/apache/chemistry/opencmis/commons/spi/PolicyService.java b/chemistry-opencmis-commons/chemistry-opencmis-commons-api/src/main/java/org/apache/chemistry/opencmis/commons/spi/PolicyService.java
index d915918..faf71a4 100644
--- a/chemistry-opencmis-commons/chemistry-opencmis-commons-api/src/main/java/org/apache/chemistry/opencmis/commons/spi/PolicyService.java
+++ b/chemistry-opencmis-commons/chemistry-opencmis-commons-api/src/main/java/org/apache/chemistry/opencmis/commons/spi/PolicyService.java
@@ -37,16 +37,47 @@
/**
* Applies a specified policy to an object.
+ *
+ * @param repositoryId
+ * the identifier for the repository
+ * @param policyId
+ * the policy to add
+ * @param objectId
+ * the object
+ * @param extension
+ * extension data
*/
void applyPolicy(String repositoryId, String policyId, String objectId, ExtensionsData extension);
/**
* Removes a specified policy from an object.
+ *
+ * @param repositoryId
+ * the identifier for the repository
+ * @param policyId
+ * the policy to remove
+ * @param objectId
+ * the object
+ * @param extension
+ * extension data
*/
void removePolicy(String repositoryId, String policyId, String objectId, ExtensionsData extension);
/**
* Gets the list of policies currently applied to the specified object.
+ *
+ * @param repositoryId
+ * the identifier for the repository
+ * @param objectId
+ * the object
+ * @param filter
+ * <em>(optional)</em> a comma-separated list of query names that
+ * defines which properties must be returned by the repository
+ * (default is repository specific)
+ * @param extension
+ * extension data
+ *
+ * @return the list of applied policies
*/
List<ObjectData> getAppliedPolicies(String repositoryId, String objectId, String filter, ExtensionsData extension);
}
diff --git a/chemistry-opencmis-commons/chemistry-opencmis-commons-api/src/main/java/org/apache/chemistry/opencmis/commons/spi/RelationshipService.java b/chemistry-opencmis-commons/chemistry-opencmis-commons-api/src/main/java/org/apache/chemistry/opencmis/commons/spi/RelationshipService.java
index 1028bc5..d646474 100644
--- a/chemistry-opencmis-commons/chemistry-opencmis-commons-api/src/main/java/org/apache/chemistry/opencmis/commons/spi/RelationshipService.java
+++ b/chemistry-opencmis-commons/chemistry-opencmis-commons-api/src/main/java/org/apache/chemistry/opencmis/commons/spi/RelationshipService.java
@@ -39,6 +39,14 @@
/**
* Gets all or a subset of relationships associated with an independent
* object.
+ *
+ * @param repositoryId
+ * the identifier for the repository
+ * @param objectId
+ * the object
+ * @param extension
+ * extension data
+ * @return the list of relationships
*/
ObjectList getObjectRelationships(String repositoryId, String objectId, Boolean includeSubRelationshipTypes,
RelationshipDirection relationshipDirection, String typeId, String filter, Boolean includeAllowableActions,
diff --git a/chemistry-opencmis-commons/chemistry-opencmis-commons-api/src/main/java/org/apache/chemistry/opencmis/commons/spi/RepositoryService.java b/chemistry-opencmis-commons/chemistry-opencmis-commons-api/src/main/java/org/apache/chemistry/opencmis/commons/spi/RepositoryService.java
index e262bec..2c2e60e 100644
--- a/chemistry-opencmis-commons/chemistry-opencmis-commons-api/src/main/java/org/apache/chemistry/opencmis/commons/spi/RepositoryService.java
+++ b/chemistry-opencmis-commons/chemistry-opencmis-commons-api/src/main/java/org/apache/chemistry/opencmis/commons/spi/RepositoryService.java
@@ -45,6 +45,10 @@
*
* In contrast to the CMIS specification this method returns repository
* infos not only repository IDs.
+ *
+ * @param extension
+ * extension data
+ * @return the list of repositories
*/
List<RepositoryInfo> getRepositoryInfos(ExtensionsData extension);
@@ -54,6 +58,9 @@
*
* @param repositoryId
* the identifier for the repository
+ * @param extension
+ * extension data
+ * @return the repository info
*/
RepositoryInfo getRepositoryInfo(String repositoryId, ExtensionsData extension);
@@ -78,6 +85,9 @@
* <em>(optional)</em> number of potential results that the
* repository MUST skip/page over before returning any results
* (default is 0)
+ * @param extension
+ * extension data
+ * @return the list of type children
*/
TypeDefinitionList getTypeChildren(String repositoryId, String typeId, Boolean includePropertyDefinitions,
BigInteger maxItems, BigInteger skipCount, ExtensionsData extension);
@@ -100,6 +110,9 @@
* <em>(optional)</em> if <code>true</code> the repository MUST
* return the property definitions for each object type returned
* (default is <code>false</code>)
+ * @param extension
+ * extension data
+ * @return the tree of type descendants
*/
List<TypeDefinitionContainer> getTypeDescendants(String repositoryId, String typeId, BigInteger depth,
Boolean includePropertyDefinitions, ExtensionsData extension);
@@ -111,6 +124,9 @@
* the identifier for the repository
* @param typeId
* typeId of an object type specified in the repository
+ * @param extension
+ * extension data
+ * @return the type definition
*/
TypeDefinition getTypeDefinition(String repositoryId, String typeId, ExtensionsData extension);
@@ -121,6 +137,8 @@
* the identifier for the repository
* @param type
* the type definition
+ * @param extension
+ * extension data
* @return the newly created type
*/
TypeDefinition createType(String repositoryId, TypeDefinition type, ExtensionsData extension);
@@ -132,6 +150,8 @@
* the identifier for the repository
* @param type
* the type definition
+ * @param extension
+ * extension data
* @return the updated type
*/
TypeDefinition updateType(String repositoryId, TypeDefinition type, ExtensionsData extension);
@@ -143,6 +163,8 @@
* the identifier for the repository
* @param typeId
* typeId of an object type specified in the repository
+ * @param extension
+ * extension data
*/
void deleteType(String repositoryId, String typeId, ExtensionsData extension);
}
diff --git a/chemistry-opencmis-commons/chemistry-opencmis-commons-api/src/main/java/org/apache/chemistry/opencmis/commons/spi/VersioningService.java b/chemistry-opencmis-commons/chemistry-opencmis-commons-api/src/main/java/org/apache/chemistry/opencmis/commons/spi/VersioningService.java
index 600ea4c..f057bfa 100644
--- a/chemistry-opencmis-commons/chemistry-opencmis-commons-api/src/main/java/org/apache/chemistry/opencmis/commons/spi/VersioningService.java
+++ b/chemistry-opencmis-commons/chemistry-opencmis-commons-api/src/main/java/org/apache/chemistry/opencmis/commons/spi/VersioningService.java
@@ -46,6 +46,8 @@
* @param objectId
* input: the identifier for the document that should be checked
* out, output: the identifier for the newly created PWC
+ * @param extension
+ * extension data
* @param contentCopied
* output: indicator if the content of the original document has
* been copied to the PWC
@@ -59,14 +61,16 @@
* the identifier for the repository
* @param objectId
* the identifier for the PWC
+ * @param extension
+ * extension data
*/
void cancelCheckOut(String repositoryId, String objectId, ExtensionsData extension);
/**
* Checks-in the private working copy (PWC) document.
*
- * The stream in <code>contentStream</code> is consumed but not closed by
- * this method.
+ * The stream in {@code contentStream} is consumed but not closed by this
+ * method.
*
* @param repositoryId
* the identifier for the repository
@@ -75,7 +79,7 @@
* the newly created version document
* @param major
* indicator if the new version should become a major (
- * <code>true</code>) or minor (<code>false</code>) version
+ * {@code true}) or minor ({@code false}) version
* @param properties
* <em>(optional)</em> the property values that must be applied
* to the newly created document object
@@ -93,6 +97,8 @@
* @param removeAces
* <em>(optional)</em> a list of ACEs that must be removed from
* the newly created document object
+ * @param extension
+ * extension data
*/
void checkIn(String repositoryId, Holder<String> objectId, Boolean major, Properties properties,
ContentStream contentStream, String checkinComment, List<String> policies, Acl addAces, Acl removeAces,
@@ -103,6 +109,17 @@
*
* @param repositoryId
* the identifier for the repository
+ * @param objectId
+ * the identifier for the object
+ * @param versionSeriesId
+ * the version series ID
+ * @param filter
+ * <em>(optional)</em> a comma-separated list of query names that
+ * defines which properties must be returned by the repository
+ * (default is repository specific)
+ * @param extension
+ * extension data
+ * @return the document object
*/
ObjectData getObjectOfLatestVersion(String repositoryId, String objectId, String versionSeriesId, Boolean major,
String filter, Boolean includeAllowableActions, IncludeRelationships includeRelationships,
@@ -114,6 +131,17 @@
*
* @param repositoryId
* the identifier for the repository
+ * @param objectId
+ * the identifier for the object
+ * @param versionSeriesId
+ * the version series ID
+ * @param filter
+ * <em>(optional)</em> a comma-separated list of query names that
+ * defines which properties must be returned by the repository
+ * (default is repository specific)
+ * @param extension
+ * extension data
+ * @return the document properties
*/
Properties getPropertiesOfLatestVersion(String repositoryId, String objectId, String versionSeriesId,
Boolean major, String filter, ExtensionsData extension);
@@ -122,8 +150,8 @@
* Returns the list of all document objects in the specified version series,
* sorted by the property "cmis:creationDate" descending.
*
- * Either the <code>objectId</code> or the <code>versionSeriesId</code>
- * parameter must be set.
+ * Either the {@code objectId} or the {@code versionSeriesId} parameter must
+ * be set.
*
* @param repositoryId
* the identifier for the repository
@@ -136,10 +164,11 @@
* defines which properties must be returned by the repository
* (default is repository specific)
* @param includeAllowableActions
- * <em>(optional)</em> if <code>true</code>, then the repository
- * must return the allowable actions for the objects (default is
- * <code>false</code>)
- *
+ * <em>(optional)</em> if {@code true}, then the repository must
+ * return the allowable actions for the objects (default is
+ * {@code false})
+ * @param extension
+ * extension data
* @return the complete version history of the version series
*/
List<ObjectData> getAllVersions(String repositoryId, String objectId, String versionSeriesId, String filter,
diff --git a/chemistry-opencmis-server/chemistry-opencmis-server-bindings/src/main/java/org/apache/chemistry/opencmis/server/impl/endpoints/SimpleCmisEndpointsDocumentServlet.java b/chemistry-opencmis-server/chemistry-opencmis-server-bindings/src/main/java/org/apache/chemistry/opencmis/server/impl/endpoints/SimpleCmisEndpointsDocumentServlet.java
index dd18bcc..be6c187 100644
--- a/chemistry-opencmis-server/chemistry-opencmis-server-bindings/src/main/java/org/apache/chemistry/opencmis/server/impl/endpoints/SimpleCmisEndpointsDocumentServlet.java
+++ b/chemistry-opencmis-server/chemistry-opencmis-server-bindings/src/main/java/org/apache/chemistry/opencmis/server/impl/endpoints/SimpleCmisEndpointsDocumentServlet.java
@@ -57,13 +57,16 @@
}
// load template from file
+ InputStream stream = null;
try {
- InputStream stream = config.getServletContext().getResourceAsStream(template);
+ stream = config.getServletContext().getResourceAsStream(template);
if (stream != null) {
endpointsDocument = IOUtils.readAllLines(stream);
}
} catch (Exception e) {
LOG.error("Could not read CMIS Endpoints Document template from {}!", template, e);
+ } finally {
+ IOUtils.closeQuietly(stream);
}
}
diff --git a/chemistry-opencmis-server/chemistry-opencmis-server-support/src/main/java/org/apache/chemistry/opencmis/server/support/query/PredicateWalkerBase.java b/chemistry-opencmis-server/chemistry-opencmis-server-support/src/main/java/org/apache/chemistry/opencmis/server/support/query/PredicateWalkerBase.java
index e3ab4ac..0ad7d76 100644
--- a/chemistry-opencmis-server/chemistry-opencmis-server-support/src/main/java/org/apache/chemistry/opencmis/server/support/query/PredicateWalkerBase.java
+++ b/chemistry-opencmis-server/chemistry-opencmis-server-support/src/main/java/org/apache/chemistry/opencmis/server/support/query/PredicateWalkerBase.java
@@ -23,10 +23,10 @@
/**
* Base interface for a tree walker of a WHERE clause.
* <p>
- * COntains only a single method used by the ANTLR query walker to
- * initiate a tree walk for evaluating the query. You can inherit from
- * this interface if you want to have your own walking mechanism
- * <p>
+ * COntains only a single method used by the ANTLR query walker to initiate a
+ * tree walk for evaluating the query. You can inherit from this interface if
+ * you want to have your own walking mechanism
+ * </p>
*/
public interface PredicateWalkerBase {
diff --git a/chemistry-opencmis-server/chemistry-opencmis-server-support/src/main/java/org/apache/chemistry/opencmis/server/support/query/QueryUtil.java b/chemistry-opencmis-server/chemistry-opencmis-server-support/src/main/java/org/apache/chemistry/opencmis/server/support/query/QueryUtil.java
index a04fd15..967026c 100644
--- a/chemistry-opencmis-server/chemistry-opencmis-server-support/src/main/java/org/apache/chemistry/opencmis/server/support/query/QueryUtil.java
+++ b/chemistry-opencmis-server/chemistry-opencmis-server-support/src/main/java/org/apache/chemistry/opencmis/server/support/query/QueryUtil.java
@@ -64,8 +64,6 @@
* @param statement
* CMISQL statement
* @return an AntLR tree grammar that can be traversed to evaluate the query
- *
- * @throws RecognitionException
*/
public static CmisQueryWalker getWalker(String statement) throws RecognitionException {
CharStream input = new ANTLRStringStream(statement);
@@ -104,9 +102,6 @@
* @param pw
* predicate walker that evaluates the where clause
* @return AntLR tree grammar created by this statement
- *
- * @throws IOException
- * @throws RecognitionException
*/
public CmisQueryWalker traverseStatement(String statement, QueryObject queryObj, PredicateWalkerBase pw)
throws IOException, RecognitionException {
diff --git a/chemistry-opencmis-server/chemistry-opencmis-server-support/src/main/java/org/apache/chemistry/opencmis/server/support/query/QueryUtilBase.java b/chemistry-opencmis-server/chemistry-opencmis-server-support/src/main/java/org/apache/chemistry/opencmis/server/support/query/QueryUtilBase.java
index 77ff022..0974c2c 100644
--- a/chemistry-opencmis-server/chemistry-opencmis-server-support/src/main/java/org/apache/chemistry/opencmis/server/support/query/QueryUtilBase.java
+++ b/chemistry-opencmis-server/chemistry-opencmis-server-support/src/main/java/org/apache/chemistry/opencmis/server/support/query/QueryUtilBase.java
@@ -53,8 +53,6 @@
* parse the statement, check for syntax errors and create an AST
*
* @return the abstract syntax tree of the parsed statement
- *
- * @throws RecognitionException
*/
public abstract CommonTree parseStatement() throws RecognitionException;
@@ -63,16 +61,12 @@
* check for semantic errors, fill the query object. Usually a walker will
* be CmisQueryWalker (or subclass) if the supporting OpenCMIS query classes
* are used.
- *
- * @throws RecognitionException
*/
public abstract void walkStatement() throws RecognitionException;
/**
* Fully process a query by parsing and walking it and setting up the
* supporting objects
- *
- * @throws RecognitionException
*/
public void processStatement() throws RecognitionException {
parseStatement();
@@ -104,18 +98,19 @@
/**
* Same as traverseStatement but throws only CMIS Exceptions
- */
+ */
public void processStatementUsingCmisExceptions() {
try {
processStatement();
} catch (RecognitionException e) {
String errorMsg = getErrorMessage(e);
- throw new CmisInvalidArgumentException("Processing of query statement failed with RecognitionException error: \n "
- + errorMsg, e);
+ throw new CmisInvalidArgumentException(
+ "Processing of query statement failed with RecognitionException error: \n " + errorMsg, e);
} catch (CmisBaseException e) {
throw e;
} catch (Exception e) {
- throw new CmisInvalidArgumentException("Processing of query statement failed with exception: " + e.getMessage(), e);
+ throw new CmisInvalidArgumentException("Processing of query statement failed with exception: "
+ + e.getMessage(), e);
}
}
diff --git a/chemistry-opencmis-server/chemistry-opencmis-server-support/src/main/java/org/apache/chemistry/opencmis/server/support/wrapper/AbstractCmisServiceWrapper.java b/chemistry-opencmis-server/chemistry-opencmis-server-support/src/main/java/org/apache/chemistry/opencmis/server/support/wrapper/AbstractCmisServiceWrapper.java
index a2fdaee..a68d90e 100644
--- a/chemistry-opencmis-server/chemistry-opencmis-server-support/src/main/java/org/apache/chemistry/opencmis/server/support/wrapper/AbstractCmisServiceWrapper.java
+++ b/chemistry-opencmis-server/chemistry-opencmis-server-support/src/main/java/org/apache/chemistry/opencmis/server/support/wrapper/AbstractCmisServiceWrapper.java
@@ -71,6 +71,9 @@
/**
* Initializes the wrapper with a set of parameters.
+ *
+ * @param params
+ * an array of parameter objects
*/
public void initialize(Object[] params) {
}
diff --git a/chemistry-opencmis-server/chemistry-opencmis-server-support/src/main/java/org/apache/chemistry/opencmis/server/support/wrapper/ConformanceCmisServiceWrapper.java b/chemistry-opencmis-server/chemistry-opencmis-server-support/src/main/java/org/apache/chemistry/opencmis/server/support/wrapper/ConformanceCmisServiceWrapper.java
index e3e7367..35b7811 100644
--- a/chemistry-opencmis-server/chemistry-opencmis-server-support/src/main/java/org/apache/chemistry/opencmis/server/support/wrapper/ConformanceCmisServiceWrapper.java
+++ b/chemistry-opencmis-server/chemistry-opencmis-server-support/src/main/java/org/apache/chemistry/opencmis/server/support/wrapper/ConformanceCmisServiceWrapper.java
@@ -72,6 +72,9 @@
/**
* Constructor used by {@link CmisServiceWrapperManager}.
+ *
+ * @param service
+ * the {@link CmisService} object, not {@code null}
*/
public ConformanceCmisServiceWrapper(CmisService service) {
super(service);
@@ -79,6 +82,9 @@
/**
* Alternative constructor.
+ *
+ * @param service
+ * the {@link CmisService} object, not {@code null}
*/
public ConformanceCmisServiceWrapper(CmisService service, BigInteger defaultTypesMaxItems,
BigInteger defaultTypesDepth, BigInteger defaultMaxItems, BigInteger defaultDepth) {
@@ -346,7 +352,7 @@
}
/**
- * Returns <code>true</code> if <code>value</code> is {@code null}.
+ * Returns {@code true} if {@code value} is {@code null}.
*/
protected Boolean getDefaultTrue(Boolean value) {
if (value == null) {
@@ -357,7 +363,7 @@
}
/**
- * Returns <code>false</code> if <code>value</code> is {@code null}.
+ * Returns {@code false} if {@code value} is {@code null}.
*/
protected Boolean getDefaultFalse(Boolean value) {
if (value == null) {
@@ -368,8 +374,8 @@
}
/**
- * Returns the <code>IncludeRelationships.NONE</code> if <code>value</code>
- * is {@code null}.
+ * Returns {@code IncludeRelationships.NONE} if {@code value} is
+ * {@code null}.
*/
protected IncludeRelationships getDefault(IncludeRelationships value) {
if (value == null) {
@@ -380,8 +386,7 @@
}
/**
- * Returns the <code>UnfileObjects.DELETE</code> if <code>value</code> is
- * {@code null}.
+ * Returns {@code UnfileObjects.DELETE} if {@code value} is {@code null}.
*/
protected UnfileObject getDefault(UnfileObject value) {
if (value == null) {
@@ -392,8 +397,8 @@
}
/**
- * Returns the <code>AclPropagation.REPOSITORYDETERMINED</code> if
- * <code>value</code> is {@code null}.
+ * Returns the {@code AclPropagation.REPOSITORYDETERMINED} if {@code value}
+ * is {@code null}.
*/
protected AclPropagation getDefault(AclPropagation value) {
if (value == null) {
@@ -404,8 +409,8 @@
}
/**
- * Returns the <code>RelationshipDirection.SOURCE</code> if
- * <code>value</code> is {@code null} .
+ * Returns the {@code RelationshipDirection.SOURCE} if {@code value} is
+ * {@code null} .
*/
protected RelationshipDirection getDefault(RelationshipDirection value) {
if (value == null) {
@@ -416,8 +421,7 @@
}
/**
- * Returns the <code>"cmis:none"</code> if <code>value</code> is
- * {@code null}.
+ * Returns the {@code "cmis:none"} if {@code value} is {@code null}.
*/
protected String getDefaultRenditionFilter(String value) {
if ((value == null) || (value.length() == 0)) {
@@ -428,9 +432,9 @@
}
/**
- * Returns the default maxItems if <code>maxItems</code> == {@code null},
- * throws an exception if <code>maxItems</code> < 0, returns
- * <code>maxItems</code> otherwise.
+ * Returns the default maxItems if {@code maxItems} == {@code null}, throws
+ * an exception if {@code maxItems} < 0, returns {@code maxItems}
+ * otherwise.
*/
protected BigInteger getTypesMaxItems(BigInteger maxItems) {
if (maxItems == null) {
@@ -465,9 +469,9 @@
}
/**
- * Returns the default maxItems if <code>maxItems</code> == {@code null},
- * throws an exception if <code>maxItems</code> < 0, returns
- * <code>maxItems</code> otherwise.
+ * Returns the default maxItems if {@code maxItems} == {@code null}, throws
+ * an exception if {@code maxItems} < 0, returns {@code maxItems}
+ * otherwise.
*/
protected BigInteger getMaxItems(BigInteger maxItems) {
if (maxItems == null) {
@@ -482,9 +486,8 @@
}
/**
- * Returns 0 if <code>skipCount</code> == {@code null}, throws an exception
- * if <code>skipCount</code> < 0, returns <code>skipCount</code>
- * otherwise.
+ * Returns 0 if {@code skipCount} == {@code null}, throws an exception if
+ * {@code skipCount} < 0, returns {@code skipCount} otherwise.
*/
protected BigInteger getSkipCount(BigInteger skipCount) {
if (skipCount == null) {
diff --git a/pom.xml b/pom.xml
index 2de521d..5fc3469 100644
--- a/pom.xml
+++ b/pom.xml
@@ -556,87 +556,92 @@
<version>2.7</version>
</plugin>
<plugin>
- <groupId>org.apache.maven.plugins</groupId>
- <artifactId>maven-javadoc-plugin</artifactId>
- <version>2.10.3</version>
- <inherited>false</inherited>
- <reportSets>
- <reportSet>
- <id>aggregate</id>
- <reports>
- <report>aggregate</report>
- </reports>
- </reportSet>
- </reportSets>
- <configuration>
- <doctitle>Apache Chemistry OpenCMIS ${project.version}</doctitle>
- <windowtitle>Apache Chemistry OpenCMIS ${project.version}</windowtitle>
- <!-- TODO: Update this for new packages -->
- <groups>
- <group>
- <title>OpenCMIS Client API</title>
- <packages>org.apache.chemistry.opencmis.client:org.apache.chemistry.opencmis.client.api:org.apache.chemistry.opencmis.client.util</packages>
- </group>
- <group>
- <title>OpenCMIS Commons API</title>
- <packages>org.apache.chemistry.opencmis.commons:org.apache.chemistry.opencmis.commons.*</packages>
- </group>
- <group>
- <title>OpenCMIS Bindings SPI</title>
- <packages>org.apache.chemistry.opencmis.client.bindings</packages>
- </group>
- <group>
- <title>OpenCMIS Server</title>
- <packages>org.apache.chemistry.opencmis.commons.server:org.apache.chemistry.opencmis.commons.impl.server:org.apache.chemistry.opencmis.server.support:org.apache.chemistry.opencmis.server.support.wrapper:org.apache.chemistry.opencmis.server.support.query:org.apache.chemistry.opencmis.server.filter:org.apache.chemistry.opencmis.server.shared</packages>
- </group>
- <group>
- <title>OpenCMIS Server (async)</title>
- <packages>org.apache.chemistry.opencmis.server.async</packages>
- </group>
- <group>
- <title>OpenCMIS Bridge</title>
- <packages>org.apache.chemistry.opencmis.bridge*</packages>
- </group>
- <group>
- <title>OpenCMIS TCK</title>
- <packages>org.apache.chemistry.opencmis.tck*</packages>
- </group>
+ <groupId>org.apache.maven.plugins</groupId>
+ <artifactId>maven-javadoc-plugin</artifactId>
+ <version>2.10.3</version>
+ <inherited>false</inherited>
+ <reportSets>
+ <reportSet>
+ <id>aggregate</id>
+ <reports>
+ <report>aggregate</report>
+ </reports>
+ </reportSet>
+ </reportSets>
+ <configuration>
+ <doctitle>Apache Chemistry OpenCMIS ${project.version}</doctitle>
+ <windowtitle>Apache Chemistry OpenCMIS ${project.version}</windowtitle>
+
+ <sourcepath>
+ ${basedir}/chemistry-opencmis-commons/chemistry-opencmis-commons-api/src/main/java:
+ ${basedir}/chemistry-opencmis-commons/chemistry-opencmis-commons-impl/src/main/java:
+ ${basedir}/chemistry-opencmis-client/chemistry-opencmis-client-api/src/main/java:
+ ${basedir}/chemistry-opencmis-client/chemistry-opencmis-client-bindings/src/main/java:
+ ${basedir}/chemistry-opencmis-client/chemistry-opencmis-client-impl/src/main/java:
+ ${basedir}/chemistry-opencmis-server/chemistry-opencmis-server-bindings/src/main/java:
+ ${basedir}/chemistry-opencmis-server/chemistry-opencmis-server-support/src/main/java:
+ ${basedir}/chemistry-opencmis-server/chemistry-opencmis-server-async/src/main/java:
+ ${basedir}/chemistry-opencmis-server/chemistry-opencmis-bridge/src/main/java:
+ ${basedir}/chemistry-opencmis-server/chemistry-opencmis-test-tck/src/main/java
+ </sourcepath>
+
+ <groups>
+ <group>
+ <title>OpenCMIS Client API</title>
+ <packages>org.apache.chemistry.opencmis.client:org.apache.chemistry.opencmis.client.api:org.apache.chemistry.opencmis.client.util</packages>
+ </group>
+ <group>
+ <title>OpenCMIS Commons API</title>
+ <packages>org.apache.chemistry.opencmis.commons:org.apache.chemistry.opencmis.commons.*</packages>
+ </group>
+ <group>
+ <title>OpenCMIS Bindings SPI</title>
+ <packages>org.apache.chemistry.opencmis.client.bindings</packages>
+ </group>
+ <group>
+ <title>OpenCMIS Server</title>
+ <packages>org.apache.chemistry.opencmis.commons.server:org.apache.chemistry.opencmis.commons.impl.server:org.apache.chemistry.opencmis.server.support:org.apache.chemistry.opencmis.server.support.wrapper:org.apache.chemistry.opencmis.server.support.query:org.apache.chemistry.opencmis.server.filter:org.apache.chemistry.opencmis.server.shared</packages>
+ </group>
+ <group>
+ <title>OpenCMIS Server (async)</title>
+ <packages>org.apache.chemistry.opencmis.server.async</packages>
+ </group>
+ <group>
+ <title>OpenCMIS Bridge</title>
+ <packages>org.apache.chemistry.opencmis.bridge*</packages>
+ </group>
+ <group>
+ <title>OpenCMIS TCK</title>
+ <packages>org.apache.chemistry.opencmis.tck*</packages>
+ </group>
</groups>
- <!--<excludePackageNames>org.apache.chemistry.opencmis.commons.impl:org.apache.chemistry.opencmis.commons.impl.dataobjects:org.apache.chemistry.opencmis.client.runtime:org.apache.chemistry.opencmis.client.runtime.*:org.apache.chemistry.opencmis.commons.impl.jaxb:org.apache.chemistry.opencmis.client.bindings.impl:org.apache.chemistry.opencmis.client.bindings.cache:org.apache.chemistry.opencmis.client.bindings.spi:org.apache.chemistry.opencmis.server.impl:org.apache.chemistry.opencmis.fit:org.apache.chemistry.opencmis.util.repository:org.apache.chemistry.opencmis.fileshare:org.apache.chemistry.opencmis.fileshare:org.apache.chemistry.opencmis.inmemory:org.apache.chemistry.opencmis.fileshare:org.apache.chemistry.opencmis.jcr:org.apache.chemistry.opencmis.browser:org.apache.chemistry.opencmis.workbench:org.apache.chemistry.opencmis.commander:org.apache.chemistry.opencmis.client.osgi</excludePackageNames>-->
+
<sourceFileExcludes>
- <exclude>**/CmisQl*</exclude>
- <exclude>**/CmisQueryWalk*</exclude>
- <exclude>**/TextSearch*</exclude>
- <exclude>org/apache/chemistry/opencmis/commons/impl/*</exclude>
- <exclude>org/apache/chemistry/opencmis/commons/impl/dataobjects/**</exclude>
- <exclude>org/apache/chemistry/opencmis/commons/impl/json/**</exclude>
- <exclude>org/apache/chemistry/opencmis/commons/impl/jaxb/**</exclude>
- <exclude>org/apache/chemistry/opencmis/commons/impl/server/ObjectInfoImpl*</exclude>
- <exclude>org/apache/chemistry/opencmis/commons/impl/server/RenditionInfoImpl*</exclude>
- <exclude>org/apache/chemistry/opencmis/client/runtime/**</exclude>
- <exclude>org/apache/chemistry/opencmis/client/bindings/impl/**</exclude>
- <exclude>org/apache/chemistry/opencmis/client/bindings/cache/**</exclude>
- <exclude>org/apache/chemistry/opencmis/client/bindings/spi/**</exclude>
- <exclude>org/apache/chemistry/opencmis/server/impl/**</exclude>
- <exclude>org/apache/chemistry/opencmis/server/shared/**</exclude>
- <exclude>org/apache/chemistry/opencmis/server/support/filter/**</exclude>
- <exclude>org/apache/chemistry/opencmis/server/async/impl/**</exclude>
- <exclude>org/apache/chemistry/opencmis/fit/**</exclude>
- <exclude>org/apache/chemistry/opencmis/util/**</exclude>
- <exclude>org/apache/chemistry/opencmis/fileshare/**</exclude>
- <exclude>org/apache/chemistry/opencmis/inmemory/**</exclude>
- <exclude>org/apache/chemistry/opencmis/browser/**</exclude>
- <exclude>org/apache/chemistry/opencmis/workbench/**</exclude>
- <exclude>org/apache/chemistry/opencmis/commander/**</exclude>
- <exclude>org/apache/chemistry/opencmis/client/osgi/**</exclude>
- <exclude>org/apache/chemistry/opencmis/tools/**</exclude>
+ <exclude>**/CmisQl*</exclude>
+ <exclude>**/CmisQueryWalk*</exclude>
+ <exclude>**/TextSearch*</exclude>
+ <exclude>org/apache/chemistry/opencmis/commons/impl/*</exclude>
+ <exclude>org/apache/chemistry/opencmis/commons/impl/dataobjects/**</exclude>
+ <exclude>org/apache/chemistry/opencmis/commons/impl/json/**</exclude>
+ <exclude>org/apache/chemistry/opencmis/commons/impl/jaxb/**</exclude>
+ <exclude>org/apache/chemistry/opencmis/commons/impl/server/ObjectInfoImpl*</exclude>
+ <exclude>org/apache/chemistry/opencmis/commons/impl/server/RenditionInfoImpl*</exclude>
+ <exclude>org/apache/chemistry/opencmis/commons/impl/server/LinkInfoImp*</exclude>
+ <exclude>org/apache/chemistry/opencmis/client/runtime/**</exclude>
+ <exclude>org/apache/chemistry/opencmis/client/bindings/impl/**</exclude>
+ <exclude>org/apache/chemistry/opencmis/client/bindings/cache/**</exclude>
+ <exclude>org/apache/chemistry/opencmis/client/bindings/spi/**</exclude>
+ <exclude>org/apache/chemistry/opencmis/server/impl/**</exclude>
+ <exclude>org/apache/chemistry/opencmis/server/shared/**</exclude>
+ <exclude>org/apache/chemistry/opencmis/server/support/filter/**</exclude>
+ <exclude>org/apache/chemistry/opencmis/server/async/impl/**</exclude>
</sourceFileExcludes>
<tags>
- <tag>
- <name>cmis</name>
- <placement>a</placement>
- <head>CMIS:</head>
- </tag>
+ <tag>
+ <name>cmis</name>
+ <placement>a</placement>
+ <head>CMIS:</head>
+ </tag>
</tags>
</configuration>
</plugin>
@@ -733,16 +738,17 @@
</plugins>
</build>
</profile>
- <!-- Added profile to fix "doclint" (see http://stackoverflow.com/questions/15886209/maven-is-not-working-in-java-8-when-javadoc-tags-are-incomplete).
+ <!-- Added profile to fix "doclint" (see http://stackoverflow.com/questions/15886209/maven-is-not-working-in-java-8-when-javadoc-tags-are-incomplete).
TODO: This is a temporary solution, until we solve https://issues.apache.org/jira/browse/CMIS-977
-->
+
<profile>
<id>disable-java8-doclint</id>
<activation>
<jdk>[1.8,)</jdk>
</activation>
<properties>
- <additionalparam>-Xdoclint:none</additionalparam>
+ <additionalparam>-Xdoclint:accessibility -Xdoclint:html -Xdoclint:reference -Xdoclint:syntax</additionalparam>
</properties>
</profile>
</profiles>
