diff --git a/source/java/org/alfresco/repo/web/auth/NoopAuthenticationListener.java b/source/java/org/alfresco/repo/web/auth/NoopAuthenticationListener.java index 1ff7afa083..2018fab176 100644 --- a/source/java/org/alfresco/repo/web/auth/NoopAuthenticationListener.java +++ b/source/java/org/alfresco/repo/web/auth/NoopAuthenticationListener.java @@ -20,7 +20,7 @@ package org.alfresco.repo.web.auth; /** - * {@link AuthenticationEventListener} that does nothing. + * {@link AuthenticationListener} that does nothing. * * @author Alex Miller */ diff --git a/source/java/org/alfresco/repo/web/auth/TenantAuthentication.java b/source/java/org/alfresco/repo/web/auth/TenantAuthentication.java index a1f06a8a6a..27b069fc98 100644 --- a/source/java/org/alfresco/repo/web/auth/TenantAuthentication.java +++ b/source/java/org/alfresco/repo/web/auth/TenantAuthentication.java @@ -5,7 +5,7 @@ public interface TenantAuthentication /** * Authenticate user against tenant * - * @param email + * @param username * @param tenant * @return true => authenticated, false => not authenticated */ diff --git a/source/java/org/alfresco/repo/web/auth/TicketCredentials.java b/source/java/org/alfresco/repo/web/auth/TicketCredentials.java index 46ec8dab8c..6a5cbd681c 100644 --- a/source/java/org/alfresco/repo/web/auth/TicketCredentials.java +++ b/source/java/org/alfresco/repo/web/auth/TicketCredentials.java @@ -20,7 +20,7 @@ package org.alfresco.repo.web.auth; /** - * {@link WebScriptCrednetials} class for holding Alfresco tickets. + * {@link WebCredentials} class for holding Alfresco tickets. * * @author Alex Miller */ diff --git a/source/java/org/alfresco/repo/web/auth/WebCredentials.java b/source/java/org/alfresco/repo/web/auth/WebCredentials.java index 53f42d3525..98b4457974 100644 --- a/source/java/org/alfresco/repo/web/auth/WebCredentials.java +++ b/source/java/org/alfresco/repo/web/auth/WebCredentials.java @@ -23,7 +23,7 @@ import java.io.Serializable; /** * WebScriptCredentials interface. * - * Passed to {@link AuthenticationEventListener}s with credentials used in an authentication attempt. + * Passed to {@link AuthenticationListener}s with credentials used in an authentication attempt. * * @author Alex Miller */ diff --git a/source/java/org/alfresco/repo/web/scripts/DeclarativeSpreadsheetWebScript.java b/source/java/org/alfresco/repo/web/scripts/DeclarativeSpreadsheetWebScript.java index 181a73179f..822fa40b62 100644 --- a/source/java/org/alfresco/repo/web/scripts/DeclarativeSpreadsheetWebScript.java +++ b/source/java/org/alfresco/repo/web/scripts/DeclarativeSpreadsheetWebScript.java @@ -114,7 +114,7 @@ public abstract class DeclarativeSpreadsheetWebScript extends DeclarativeWebScri /** * Set the CSVStrategy * - * @param strategy + * @param csvStrategy CSVStrategy */ public void setCsvStrategy(CSVStrategy csvStrategy) { @@ -139,7 +139,7 @@ public abstract class DeclarativeSpreadsheetWebScript extends DeclarativeWebScri } /** - * @see org.alfresco.web.scripts.DeclarativeWebScript#executeImpl(org.alfresco.web.scripts.WebScriptRequest, org.alfresco.web.scripts.Status) + * @see org.springframework.extensions.webscripts.DeclarativeWebScript#executeImpl(org.springframework.extensions.webscripts.WebScriptRequest, org.springframework.extensions.webscripts.Status) */ @Override protected Map executeImpl(WebScriptRequest req, Status status) diff --git a/source/java/org/alfresco/repo/web/scripts/ExtensibilityContainer.java b/source/java/org/alfresco/repo/web/scripts/ExtensibilityContainer.java index 0eda247862..c0e88d0835 100644 --- a/source/java/org/alfresco/repo/web/scripts/ExtensibilityContainer.java +++ b/source/java/org/alfresco/repo/web/scripts/ExtensibilityContainer.java @@ -51,7 +51,7 @@ import org.springframework.extensions.webscripts.WebScriptRequest; import org.springframework.extensions.webscripts.WebScriptResponse; /** - *

A simple extensibility {@link Container} for processing WebScripts. This extends the {@link RepositoryContainer} and + *

A simple extensibility {@link org.springframework.extensions.webscripts.Container} for processing WebScripts. This extends the {@link RepositoryContainer} and * implements the {@link HandlesExtensibility} interface to provide extensibility capabilities.

* * @author David Draper @@ -114,7 +114,7 @@ public class ExtensibilityContainer extends RepositoryContainer implements Handl private WebScriptExtensibilityModuleHandler extensibilityModuleHandler = null; /** - *

Sets the {@link WebScriptExtensibilityModuleHandler} for this {@link Container}.

+ *

Sets the {@link WebScriptExtensibilityModuleHandler} for this {@link org.springframework.extensions.webscripts.Container}.

* @param extensibilityModuleHandler */ public void setExtensibilityModuleHandler(WebScriptExtensibilityModuleHandler extensibilityModuleHandler) @@ -218,7 +218,7 @@ public class ExtensibilityContainer extends RepositoryContainer implements Handl * for the lifetime of the request as different modules may be applied to the same WebScript for different requests.

* * @param webScriptId The id of the WebScript to cache the extended bundle against. - * @param extensionBUndle The extended bundle to cache. + * @param extensionBundle The extended bundle to cache. */ public void addExtensionBundleToCache(String webScriptId, WebScriptPropertyResourceBundle extensionBundle) { @@ -273,7 +273,7 @@ public class ExtensibilityContainer extends RepositoryContainer implements Handl } /** - *

The list of {@link ExtensionModule} instances that have been evaluated as applicable to + *

The list of {@link org.springframework.extensions.surf.types.ExtensionModule} instances that have been evaluated as applicable to * this RequestContext. This is set to null when during instantiation and is only * properly set the first time the getEvaluatedModules method is invoked. This ensures * that module evaluation only occurs once per request.

@@ -281,11 +281,11 @@ public class ExtensibilityContainer extends RepositoryContainer implements Handl private ThreadLocal> evaluatedModules = new ThreadLocal>(); /** - *

Retrieve the list of {@link ExtensionModule} instances that have been evaluated as applicable - * for the current request. If this list has not yet been populated then use the {@link ExtensibilityModuleHandler} + *

Retrieve the list of {@link org.springframework.extensions.surf.types.ExtensionModule} instances that have been evaluated as applicable + * for the current request. If this list has not yet been populated then use the {@link org.springframework.extensions.surf.extensibility.ExtensibilityModuleHandler} * configured in the Spring application context to evaluate them.

* - * @return A list of {@link ExtensionModule} instances that are applicable to the current request. + * @return A list of {@link org.springframework.extensions.surf.types.ExtensionModule} instances that are applicable to the current request. */ public List getEvaluatedModules() { @@ -313,7 +313,7 @@ public class ExtensibilityContainer extends RepositoryContainer implements Handl /** *

This is a local {@link ConfigImpl} instance that will only be used when extension modules are employed. It will * initially be populated with the default "static" global configuration taken from the {@link ConfigService} associated - * with this {@link RequestContext} but then updated to include global configuration provided by extension modules that + * with this {@link org.springframework.extensions.surf.RequestContext} but then updated to include global configuration provided by extension modules that * have been evaluated to be applied to the current request.

*/ private ThreadLocal globalConfig = new ThreadLocal(); @@ -321,7 +321,7 @@ public class ExtensibilityContainer extends RepositoryContainer implements Handl /** *

This map represents {@link ConfigSection} instances mapped by area. It will only be used when extension modules are * employed. It will initially be populated with the default "static" configuration taken from the {@link ConfigService} associated - * with this {@link RequestContext} but then updated to include configuration provided by extension modules that have been evaluated + * with this {@link org.springframework.extensions.surf.RequestContext} but then updated to include configuration provided by extension modules that have been evaluated * to be applied to the current request.

*/ private ThreadLocal>> sectionsByArea = new ThreadLocal>>(); @@ -329,7 +329,7 @@ public class ExtensibilityContainer extends RepositoryContainer implements Handl /** *

A list of {@link ConfigSection} instances that are only applicable to the current request. It will only be used when extension modules are * employed. It will initially be populated with the default "static" configuration taken from the {@link ConfigService} associated - * with this {@link RequestContext} but then updated to include configuration provided by extension modules that have been evaluated + * with this {@link org.springframework.extensions.surf.RequestContext} but then updated to include configuration provided by extension modules that have been evaluated * to be applied to the current request.

*/ private ThreadLocal> sections = new ThreadLocal>(); diff --git a/source/java/org/alfresco/repo/web/scripts/RepoStore.java b/source/java/org/alfresco/repo/web/scripts/RepoStore.java index fc6677da24..d491babb33 100644 --- a/source/java/org/alfresco/repo/web/scripts/RepoStore.java +++ b/source/java/org/alfresco/repo/web/scripts/RepoStore.java @@ -1021,7 +1021,8 @@ public class RepoStore extends AbstractStore implements TenantDeployer /** * Construct * - * @param location + * @param path + * @param nodeRef */ public RepoScriptContent(String path, NodeRef nodeRef) { diff --git a/source/java/org/alfresco/repo/web/scripts/archive/ArchivedNodesGet.java b/source/java/org/alfresco/repo/web/scripts/archive/ArchivedNodesGet.java index 368f5da3c1..f44ca1b1ea 100644 --- a/source/java/org/alfresco/repo/web/scripts/archive/ArchivedNodesGet.java +++ b/source/java/org/alfresco/repo/web/scripts/archive/ArchivedNodesGet.java @@ -48,7 +48,7 @@ public class ArchivedNodesGet extends AbstractArchivedNodeWebScript List nodeFilters = new ArrayList(); /** - * This method is used to inject {@link ArchivedNodeFilter node filters} on this GET call. + * This method is used to inject {@link org.alfresco.repo.web.scripts.archive.ArchivedNodesFilter node filters} on this GET call. * * @param nodeFilters */ diff --git a/source/java/org/alfresco/repo/web/scripts/bean/ADMRemoteStore.java b/source/java/org/alfresco/repo/web/scripts/bean/ADMRemoteStore.java index 50fade7563..28a5067ed7 100644 --- a/source/java/org/alfresco/repo/web/scripts/bean/ADMRemoteStore.java +++ b/source/java/org/alfresco/repo/web/scripts/bean/ADMRemoteStore.java @@ -385,7 +385,9 @@ public class ADMRemoteStore extends BaseRemoteStore /** * Creates multiple XML documents encapsulated in a single one. * - * @param content XML document containing multiple document contents to write + * @param res WebScriptResponse + * @param store String + * @param in XML document containing multiple document contents to write */ @Override protected void createDocuments(WebScriptResponse res, String store, InputStream in) diff --git a/source/java/org/alfresco/repo/web/scripts/bean/BaseRemoteStore.java b/source/java/org/alfresco/repo/web/scripts/bean/BaseRemoteStore.java index 3be495f6d5..8e06852b58 100644 --- a/source/java/org/alfresco/repo/web/scripts/bean/BaseRemoteStore.java +++ b/source/java/org/alfresco/repo/web/scripts/bean/BaseRemoteStore.java @@ -415,9 +415,9 @@ public abstract class BaseRemoteStore extends AbstractWebScript /** * Creates multiple XML documents encapsulated in a single one. - * + * + * @param res WebScriptResponse * @param store the store id - * @param path document path * @param content content of the document to write * * @throws IOException if the create fails diff --git a/source/java/org/alfresco/repo/web/scripts/bean/SearchProxy.java b/source/java/org/alfresco/repo/web/scripts/bean/SearchProxy.java index 4846d6a73d..c78637c160 100644 --- a/source/java/org/alfresco/repo/web/scripts/bean/SearchProxy.java +++ b/source/java/org/alfresco/repo/web/scripts/bean/SearchProxy.java @@ -192,7 +192,9 @@ public class SearchProxy extends AbstractWebScript implements InitializingBean /** * Construct * - * @param requestUrl + * @param rootPath + * @param engine + * @param engineUrl * @param response * @param headers request headers * @throws MalformedURLException diff --git a/source/java/org/alfresco/repo/web/scripts/blogs/AbstractBlogWebScript.java b/source/java/org/alfresco/repo/web/scripts/blogs/AbstractBlogWebScript.java index 6bdb4e2e6c..2cbfcaa5ec 100644 --- a/source/java/org/alfresco/repo/web/scripts/blogs/AbstractBlogWebScript.java +++ b/source/java/org/alfresco/repo/web/scripts/blogs/AbstractBlogWebScript.java @@ -112,8 +112,12 @@ public abstract class AbstractBlogWebScript extends DeclarativeWebScript /** * Generates an activity entry for the discussion item * - * @param thing Either post or reply * @param event One of created, updated, deleted + * @param blog Either post or reply + * @param site site + * @param req request + * @param json json + * @param nodeRef NodeRef */ protected void addActivityEntry(String event, BlogPostInfo blog, SiteInfo site, WebScriptRequest req, JSONObject json, NodeRef nodeRef) diff --git a/source/java/org/alfresco/repo/web/scripts/bulkimport/BulkFilesystemImportStatusWebScript.java b/source/java/org/alfresco/repo/web/scripts/bulkimport/BulkFilesystemImportStatusWebScript.java index 5984e0e271..572f2c2238 100644 --- a/source/java/org/alfresco/repo/web/scripts/bulkimport/BulkFilesystemImportStatusWebScript.java +++ b/source/java/org/alfresco/repo/web/scripts/bulkimport/BulkFilesystemImportStatusWebScript.java @@ -67,7 +67,7 @@ public class BulkFilesystemImportStatusWebScript extends DeclarativeWebScript } /** - * @see org.alfresco.web.scripts.DeclarativeWebScript#executeImpl(org.alfresco.web.scripts.WebScriptRequest, org.alfresco.web.scripts.Status, org.alfresco.web.scripts.Cache) + * @see org.springframework.extensions.webscripts.DeclarativeWebScript#executeImpl(WebScriptRequest, Status, Cache) */ @Override protected Map executeImpl(WebScriptRequest request, Status status, Cache cache) diff --git a/source/java/org/alfresco/repo/web/scripts/config/OpenSearchConfigElement.java b/source/java/org/alfresco/repo/web/scripts/config/OpenSearchConfigElement.java index f871027020..3b3cbdf33d 100644 --- a/source/java/org/alfresco/repo/web/scripts/config/OpenSearchConfigElement.java +++ b/source/java/org/alfresco/repo/web/scripts/config/OpenSearchConfigElement.java @@ -62,7 +62,7 @@ public class OpenSearchConfigElement extends ConfigElementAdapter } /** - * @see org.alfresco.config.ConfigElement#getChildren() + * @see ConfigElement#getChildren() */ public List getChildren() { @@ -70,7 +70,7 @@ public class OpenSearchConfigElement extends ConfigElementAdapter } /** - * @see org.alfresco.config.ConfigElement#combine(org.alfresco.config.ConfigElement) + * @see ConfigElement#combine(ConfigElement) */ public ConfigElement combine(ConfigElement configElement) { @@ -139,7 +139,7 @@ public class OpenSearchConfigElement extends ConfigElementAdapter /** * Adds an engine * - * @param pluginConfig A pre-configured engine config object + * @param engineConfig A pre-configured engine config object */ /*package*/ void addEngine(EngineConfig engineConfig) { @@ -231,7 +231,8 @@ public class OpenSearchConfigElement extends ConfigElementAdapter /** * Adds a url * - * @param pluginConfig A pre-configured plugin config object + * @param mimetype mime type + * @param uri uri */ /*package*/ void addUrl(String mimetype, String uri) { diff --git a/source/java/org/alfresco/repo/web/scripts/content/ContentGet.java b/source/java/org/alfresco/repo/web/scripts/content/ContentGet.java index 909d5958ba..dccc065acd 100644 --- a/source/java/org/alfresco/repo/web/scripts/content/ContentGet.java +++ b/source/java/org/alfresco/repo/web/scripts/content/ContentGet.java @@ -92,7 +92,7 @@ public class ContentGet extends StreamContent implements ServletContextAware } /** - * @see org.alfresco.web.scripts.WebScript#execute(org.alfresco.web.scripts.WebScriptRequest, org.alfresco.web.scripts.WebScriptResponse) + * @see org.springframework.extensions.webscripts.WebScript#execute(WebScriptRequest, WebScriptResponse) */ public void execute(WebScriptRequest req, WebScriptResponse res) throws IOException diff --git a/source/java/org/alfresco/repo/web/scripts/content/ContentStreamer.java b/source/java/org/alfresco/repo/web/scripts/content/ContentStreamer.java index a496713981..4c8a7d5a22 100644 --- a/source/java/org/alfresco/repo/web/scripts/content/ContentStreamer.java +++ b/source/java/org/alfresco/repo/web/scripts/content/ContentStreamer.java @@ -94,7 +94,7 @@ public class ContentStreamer implements ResourceLoaderAware } /** - * @param EventPublisher + * @param eventPublisher EventPublisher */ public void setEventPublisher(EventPublisher eventPublisher) { @@ -102,7 +102,7 @@ public class ContentStreamer implements ResourceLoaderAware } /** - * @param SiteService + * @param siteService SiteService */ public void setSiteService(SiteService siteService) { diff --git a/source/java/org/alfresco/repo/web/scripts/content/StreamACP.java b/source/java/org/alfresco/repo/web/scripts/content/StreamACP.java index dc343ae149..63c46fbe25 100644 --- a/source/java/org/alfresco/repo/web/scripts/content/StreamACP.java +++ b/source/java/org/alfresco/repo/web/scripts/content/StreamACP.java @@ -79,7 +79,7 @@ public class StreamACP extends StreamContent } /** - * @see org.alfresco.web.scripts.WebScript#execute(org.alfresco.web.scripts.WebScriptRequest, org.alfresco.web.scripts.WebScriptResponse) + * @see org.springframework.extensions.webscripts.WebScript#execute(org.springframework.extensions.webscripts.WebScriptRequest, org.springframework.extensions.webscripts.WebScriptResponse) */ public void execute(WebScriptRequest req, WebScriptResponse res) throws IOException { @@ -168,7 +168,7 @@ public class StreamACP extends StreamContent * NodeRefs from the given JSON object. If the nodeRefs * property is not present a WebScriptException is thrown. * - * @param nodeRefs Comma delimited string of NodeRefs + * @param json JSONObject * @return Array of NodeRef objects */ protected NodeRef[] getNodeRefs(JSONObject json) throws JSONException diff --git a/source/java/org/alfresco/repo/web/scripts/content/StreamContent.java b/source/java/org/alfresco/repo/web/scripts/content/StreamContent.java index 3430904d28..45860131af 100644 --- a/source/java/org/alfresco/repo/web/scripts/content/StreamContent.java +++ b/source/java/org/alfresco/repo/web/scripts/content/StreamContent.java @@ -105,7 +105,7 @@ public class StreamContent extends AbstractWebScript } /** - * @see org.alfresco.web.scripts.WebScript#execute(org.alfresco.web.scripts.WebScriptRequest, org.alfresco.web.scripts.WebScriptResponse) + * @see org.springframework.extensions.webscripts.WebScript#execute(org.springframework.extensions.webscripts.WebScriptRequest, org.springframework.extensions.webscripts.WebScriptResponse) */ public void execute(WebScriptRequest req, WebScriptResponse res) throws IOException { diff --git a/source/java/org/alfresco/repo/web/scripts/content/StreamJMXDump.java b/source/java/org/alfresco/repo/web/scripts/content/StreamJMXDump.java index 034986fe4f..f5ba7c2fb6 100644 --- a/source/java/org/alfresco/repo/web/scripts/content/StreamJMXDump.java +++ b/source/java/org/alfresco/repo/web/scripts/content/StreamJMXDump.java @@ -63,7 +63,7 @@ public class StreamJMXDump extends StreamContent } /** - * @see org.alfresco.web.scripts.WebScript#execute(org.alfresco.web.scripts.WebScriptRequest, org.alfresco.web.scripts.WebScriptResponse) + * @see org.springframework.extensions.webscripts.WebScript#execute(org.springframework.extensions.webscripts.WebScriptRequest, org.springframework.extensions.webscripts.WebScriptResponse) */ public void execute(WebScriptRequest req, WebScriptResponse res) throws IOException { diff --git a/source/java/org/alfresco/repo/web/scripts/datalist/DataListDownloadWebScript.java b/source/java/org/alfresco/repo/web/scripts/datalist/DataListDownloadWebScript.java index 12fe1fda8d..7fb4acf4f3 100644 --- a/source/java/org/alfresco/repo/web/scripts/datalist/DataListDownloadWebScript.java +++ b/source/java/org/alfresco/repo/web/scripts/datalist/DataListDownloadWebScript.java @@ -95,7 +95,7 @@ public class DataListDownloadWebScript extends DeclarativeSpreadsheetWebScript } /** - * @param nodeService + * @param siteService SiteService */ public void setSiteService(SiteService siteService) { diff --git a/source/java/org/alfresco/repo/web/scripts/dictionary/AbstractAssociationsGet.java b/source/java/org/alfresco/repo/web/scripts/dictionary/AbstractAssociationsGet.java index 4322c2f16d..53c1dde31e 100644 --- a/source/java/org/alfresco/repo/web/scripts/dictionary/AbstractAssociationsGet.java +++ b/source/java/org/alfresco/repo/web/scripts/dictionary/AbstractAssociationsGet.java @@ -120,7 +120,8 @@ public abstract class AbstractAssociationsGet extends DictionaryWebServiceBase protected abstract QName getClassQname(WebScriptRequest req); /** - * @param req - webscript request + * @param namespacePrefix - namespace prefix + * @param name - name * @return qualified name for association */ protected abstract QName getAssociationQname(String namespacePrefix, String name); diff --git a/source/java/org/alfresco/repo/web/scripts/dictionary/AbstractClassesGet.java b/source/java/org/alfresco/repo/web/scripts/dictionary/AbstractClassesGet.java index 3279b912b4..5186ae8f76 100644 --- a/source/java/org/alfresco/repo/web/scripts/dictionary/AbstractClassesGet.java +++ b/source/java/org/alfresco/repo/web/scripts/dictionary/AbstractClassesGet.java @@ -177,7 +177,8 @@ public abstract class AbstractClassesGet extends DictionaryWebServiceBase protected abstract QName getQNameForModel(String namespacePrefix, String name); /** - * @param req - webscript request + * @param namespacePrefix namespace prefix + * @param name name * @return qualified name for class */ protected abstract QName getClassQname(String namespacePrefix, String name); diff --git a/source/java/org/alfresco/repo/web/scripts/dictionary/DictionaryWebServiceBase.java b/source/java/org/alfresco/repo/web/scripts/dictionary/DictionaryWebServiceBase.java index 3399b34d20..70842cfdcc 100644 --- a/source/java/org/alfresco/repo/web/scripts/dictionary/DictionaryWebServiceBase.java +++ b/source/java/org/alfresco/repo/web/scripts/dictionary/DictionaryWebServiceBase.java @@ -60,7 +60,7 @@ public abstract class DictionaryWebServiceBase extends DeclarativeWebScript /** * Set the namespaceService property. * - * @param namespaceService The namespace service instance to set + * @param namespaceservice The namespace service instance to set */ public void setNamespaceService(NamespaceService namespaceservice) { @@ -131,7 +131,7 @@ public abstract class DictionaryWebServiceBase extends DeclarativeWebScript } /** - * @param className the class name as cm_person + * @param classname the class name as cm_person * @return String the full name in the following format {namespaceuri}shorname */ public String getFullNamespaceURI(String classname) @@ -212,7 +212,7 @@ public abstract class DictionaryWebServiceBase extends DeclarativeWebScript } /** - * @param namespaceprefix - gets a valid namespaceprefix as input + * @param modelname String * @return modelname from namespaceprefix - returns null if invalid namespaceprefix is given */ public String getPrefixFromModelName(String modelname) diff --git a/source/java/org/alfresco/repo/web/scripts/facet/FacetablePropertyFTL.java b/source/java/org/alfresco/repo/web/scripts/facet/FacetablePropertyFTL.java index 05731a554d..e7cee633c6 100644 --- a/source/java/org/alfresco/repo/web/scripts/facet/FacetablePropertyFTL.java +++ b/source/java/org/alfresco/repo/web/scripts/facet/FacetablePropertyFTL.java @@ -28,7 +28,7 @@ import org.alfresco.service.namespace.QName; /** * This interface defines a simple POJO/DTO for use in the FTL model and rendering in the JSON API. - * @param T a type to ensure that the comparator is implemented in a typesafe way. + * @param a type to ensure that the comparator is implemented in a typesafe way. * @since 5.0 */ public abstract class FacetablePropertyFTL implements Comparable diff --git a/source/java/org/alfresco/repo/web/scripts/person/UserCSVUploadPost.java b/source/java/org/alfresco/repo/web/scripts/person/UserCSVUploadPost.java index 3f6be56219..9792c00798 100644 --- a/source/java/org/alfresco/repo/web/scripts/person/UserCSVUploadPost.java +++ b/source/java/org/alfresco/repo/web/scripts/person/UserCSVUploadPost.java @@ -154,7 +154,7 @@ public class UserCSVUploadPost extends DeclarativeWebScript /** - * @see org.alfresco.web.scripts.DeclarativeWebScript#executeImpl(org.alfresco.web.scripts.WebScriptRequest, org.alfresco.web.scripts.Status) + * @see DeclarativeWebScript#executeImpl(org.springframework.extensions.webscripts.WebScriptRequest, org.springframework.extensions.webscripts.Status) */ @Override protected Map executeImpl(WebScriptRequest req, Status status) diff --git a/source/java/org/alfresco/repo/web/scripts/portlet/JSR168PortletAuthenticatorFactory.java b/source/java/org/alfresco/repo/web/scripts/portlet/JSR168PortletAuthenticatorFactory.java index 13e2b6ae10..b86929a129 100644 --- a/source/java/org/alfresco/repo/web/scripts/portlet/JSR168PortletAuthenticatorFactory.java +++ b/source/java/org/alfresco/repo/web/scripts/portlet/JSR168PortletAuthenticatorFactory.java @@ -88,7 +88,6 @@ public class JSR168PortletAuthenticatorFactory implements PortletAuthenticatorFa /** * Construct * - * @param authenticationService * @param req * @param res */ diff --git a/source/java/org/alfresco/repo/web/scripts/rule/ruleset/RuleRef.java b/source/java/org/alfresco/repo/web/scripts/rule/ruleset/RuleRef.java index 61539f99d1..36bb08dfe9 100644 --- a/source/java/org/alfresco/repo/web/scripts/rule/ruleset/RuleRef.java +++ b/source/java/org/alfresco/repo/web/scripts/rule/ruleset/RuleRef.java @@ -66,7 +66,7 @@ public class RuleRef /** * Set the owning file info reference for rule * - * @param owningNodeRef the owning file info reference to set + * @param owningFileInfo the owning file info reference to set */ public void setOwningFileInfo(FileInfo owningFileInfo) { diff --git a/source/java/org/alfresco/repo/web/scripts/servlet/BasicHttpAuthenticatorFactory.java b/source/java/org/alfresco/repo/web/scripts/servlet/BasicHttpAuthenticatorFactory.java index c2db284224..3f881f4876 100644 --- a/source/java/org/alfresco/repo/web/scripts/servlet/BasicHttpAuthenticatorFactory.java +++ b/source/java/org/alfresco/repo/web/scripts/servlet/BasicHttpAuthenticatorFactory.java @@ -113,7 +113,6 @@ public class BasicHttpAuthenticatorFactory implements ServletAuthenticatorFactor /** * Construct * - * @param authenticationService * @param req * @param res * @param listener diff --git a/source/java/org/alfresco/repo/web/util/paging/PagedResults.java b/source/java/org/alfresco/repo/web/util/paging/PagedResults.java index f08b14fa12..d9523fa876 100644 --- a/source/java/org/alfresco/repo/web/util/paging/PagedResults.java +++ b/source/java/org/alfresco/repo/web/util/paging/PagedResults.java @@ -51,7 +51,7 @@ public class PagedResults implements Serializable /** * Construct * - * @param results results for the page within cursor + * @param result results for the page within cursor * @param cursor the cursor */ /*Package*/ PagedResults(Object result, Cursor cursor) diff --git a/source/java/org/alfresco/repo/web/util/paging/Paging.java b/source/java/org/alfresco/repo/web/util/paging/Paging.java index 6fc560f654..6efe6eecb8 100644 --- a/source/java/org/alfresco/repo/web/util/paging/Paging.java +++ b/source/java/org/alfresco/repo/web/util/paging/Paging.java @@ -292,7 +292,7 @@ public class Paging /** * Create a Paged Result Set * - * @param results the results for the page within the cursor + * @param result the results for the page within the cursor * @param cursor the cursor * @return the paged result set */ diff --git a/source/java/org/alfresco/repo/webdav/ActivityPosterImpl.java b/source/java/org/alfresco/repo/webdav/ActivityPosterImpl.java index 9966a68812..901ef23596 100644 --- a/source/java/org/alfresco/repo/webdav/ActivityPosterImpl.java +++ b/source/java/org/alfresco/repo/webdav/ActivityPosterImpl.java @@ -54,7 +54,7 @@ public class ActivityPosterImpl implements WebDAVActivityPoster * Constructor * * @param appTool - * @param activityPoster + * @param poster */ public ActivityPosterImpl(String appTool, ActivityPoster poster) { diff --git a/source/java/org/alfresco/repo/webdav/PropFindMethod.java b/source/java/org/alfresco/repo/webdav/PropFindMethod.java index cf50979bb7..ea8794a0e6 100644 --- a/source/java/org/alfresco/repo/webdav/PropFindMethod.java +++ b/source/java/org/alfresco/repo/webdav/PropFindMethod.java @@ -388,7 +388,7 @@ public class PropFindMethod extends WebDAVMethod * Generates the required response XML for the current node * * @param xml XMLWriter - * @param node NodeRef + * @param nodeInfo FileInfo * @param path String */ protected void generateResponseForNode(XMLWriter xml, FileInfo nodeInfo, String path) throws Exception @@ -431,7 +431,7 @@ public class PropFindMethod extends WebDAVMethod * specific set of properties * * @param xml XMLWriter - * @param node NodeRef + * @param nodeInfo FileInfo * @param isDir boolean */ private void generateNamedPropertiesResponse(XMLWriter xml, FileInfo nodeInfo, boolean isDir) throws Exception @@ -706,7 +706,7 @@ public class PropFindMethod extends WebDAVMethod * properties * * @param xml XMLWriter - * @param node NodeRef + * @param nodeInfo FileInfo * @param isDir boolean */ protected void generateAllPropertiesResponse(XMLWriter xml, FileInfo nodeInfo, boolean isDir) throws Exception @@ -857,7 +857,7 @@ public class PropFindMethod extends WebDAVMethod * all known properties * * @param xml XMLWriter - * @param node NodeRef + * @param nodeInfo FileInfo * @param isDir boolean */ protected void generateFindPropertiesResponse(XMLWriter xml, FileInfo nodeInfo, boolean isDir) @@ -915,7 +915,7 @@ public class PropFindMethod extends WebDAVMethod * given path * * @param xml XMLWriter - * @param node NodeRef + * @param nodeInfo FileInfo * @param isDir boolean */ protected void generateLockDiscoveryResponse(XMLWriter xml, FileInfo nodeInfo, boolean isDir) throws Exception diff --git a/source/java/org/alfresco/repo/webdav/PropPatchMethod.java b/source/java/org/alfresco/repo/webdav/PropPatchMethod.java index 46251fcf9d..9e646b6208 100644 --- a/source/java/org/alfresco/repo/webdav/PropPatchMethod.java +++ b/source/java/org/alfresco/repo/webdav/PropPatchMethod.java @@ -330,8 +330,9 @@ public class PropPatchMethod extends PropFindMethod * all known properties * * @param xml XMLWriter - * @param node NodeRef - * @param isDir boolean + * @param property WebDAVProperty + * @param status int + * @param description String */ protected void generatePropertyResponse(XMLWriter xml, WebDAVProperty property, int status, String description) { diff --git a/source/java/org/alfresco/repo/webdav/WebDAV.java b/source/java/org/alfresco/repo/webdav/WebDAV.java index 0bfac9fae4..fd786cd33c 100644 --- a/source/java/org/alfresco/repo/webdav/WebDAV.java +++ b/source/java/org/alfresco/repo/webdav/WebDAV.java @@ -261,7 +261,7 @@ public class WebDAV /** * Formats the given date so that it conforms with the Last-Modified HTTP header * - * @param date long + * @param ldate long * @return The formatted date string */ public static String formatModifiedDate(long ldate) @@ -283,7 +283,7 @@ public class WebDAV /** * Formats the given date so that it conforms with the WebDAV creation date/time format * - * @param date long + * @param ldate long * @return The formatted date string */ public static String formatCreationDate(long ldate) @@ -308,7 +308,7 @@ public class WebDAV /** * Formats the given date for use in the HTTP header * - * @param date long + * @param ldate long * @return String */ public static String formatHeaderDate(long ldate) diff --git a/source/java/org/alfresco/repo/webdav/WebDAVHelper.java b/source/java/org/alfresco/repo/webdav/WebDAVHelper.java index 3fc10a7f96..9faf678cc1 100644 --- a/source/java/org/alfresco/repo/webdav/WebDAVHelper.java +++ b/source/java/org/alfresco/repo/webdav/WebDAVHelper.java @@ -1092,11 +1092,11 @@ public class WebDAVHelper /** * Notifies listeners that a read has taken place - * @param nodeRef - * @param propertyQName - * @param attach + * @param realNodeInfo * @param mimetype * @param size + * @param contentEncoding + * @param range */ protected void publishReadEvent(final FileInfo realNodeInfo, final String mimetype, final Long size, final String contentEncoding, final String range) { @@ -1182,7 +1182,7 @@ public class WebDAVHelper /** * Indicates if the node is unlocked or the current user has a WRITE_LOCK

* - * @see LockService#isLockedAndReadOnly(NodeRef) + * @see LockUtils#isLockedAndReadOnly(org.alfresco.service.cmr.repository.NodeRef, org.alfresco.service.cmr.lock.LockService) * * @param nodeRef the node reference */ diff --git a/source/java/org/alfresco/repo/webdav/WebDAVLockService.java b/source/java/org/alfresco/repo/webdav/WebDAVLockService.java index c1e8e39c71..98092dd624 100644 --- a/source/java/org/alfresco/repo/webdav/WebDAVLockService.java +++ b/source/java/org/alfresco/repo/webdav/WebDAVLockService.java @@ -61,7 +61,7 @@ public interface WebDAVLockService /** * Gets the lock info for the node reference relative to the current user. * - * @see LockService#getLockStatus(NodeRef, NodeRef) + * @see LockService#getLockStatus(org.alfresco.service.cmr.repository.NodeRef, java.lang.String) * * @param nodeRef the node reference * @return the lock status diff --git a/source/java/org/alfresco/repo/webdav/WebDAVLockServiceImpl.java b/source/java/org/alfresco/repo/webdav/WebDAVLockServiceImpl.java index 23bdc9877e..7414b3ba6a 100644 --- a/source/java/org/alfresco/repo/webdav/WebDAVLockServiceImpl.java +++ b/source/java/org/alfresco/repo/webdav/WebDAVLockServiceImpl.java @@ -106,7 +106,7 @@ public class WebDAVLockServiceImpl implements WebDAVLockService /** * Caches current session to the thread local variable * - * @param currentSession + * @param session HttpSession */ @Override public void setCurrentSession(HttpSession session) @@ -282,7 +282,7 @@ public class WebDAVLockServiceImpl implements WebDAVLockService * to the current session locked resources list. * * @param nodeRef the node to lock - * @param lockType the lock type + * @param userName userName * @param timeout the number of seconds before the locks expires */ @Override @@ -330,7 +330,7 @@ public class WebDAVLockServiceImpl implements WebDAVLockService /** * Gets the lock status for the node reference relative to the current user. * - * @see LockService#getLockStatus(NodeRef, NodeRef) + * @see LockService#getLockStatus(org.alfresco.service.cmr.repository.NodeRef, String) * * @param nodeRef the node reference * @return the lock status @@ -434,8 +434,10 @@ public class WebDAVLockServiceImpl implements WebDAVLockService /** * Create a new lock * - * @param lockNode NodeRef + * @param nodeRef NodeRef * @param userName String + * @param createExclusive boolean + * @param timeoutSecs int * @exception WebDAVServerException */ private LockInfo createLock(NodeRef nodeRef, String userName, boolean createExclusive, int timeoutSecs) diff --git a/source/java/org/alfresco/repo/webdav/WebDAVMethod.java b/source/java/org/alfresco/repo/webdav/WebDAVMethod.java index dbae0045da..faf0b9e4f2 100644 --- a/source/java/org/alfresco/repo/webdav/WebDAVMethod.java +++ b/source/java/org/alfresco/repo/webdav/WebDAVMethod.java @@ -169,8 +169,8 @@ public abstract class WebDAVMethod * HttpServletRequest * @param resp * HttpServletResponse - * @param registry - * ServiceRegistry + * @param davHelper + * WebDAVHelper * @param rootNode * NodeRef */ diff --git a/source/java/org/alfresco/repo/webdav/WebDAVProperty.java b/source/java/org/alfresco/repo/webdav/WebDAVProperty.java index aced945d37..c91c824c03 100644 --- a/source/java/org/alfresco/repo/webdav/WebDAVProperty.java +++ b/source/java/org/alfresco/repo/webdav/WebDAVProperty.java @@ -1,19 +1,19 @@ /* - * Copyright (C) 2005-2010 Alfresco Software Limited. - * - * This file is part of Alfresco - * - * Alfresco is free software: you can redistribute it and/or modify - * it under the terms of the GNU Lesser General Public License as published by - * the Free Software Foundation, either version 3 of the License, or - * (at your option) any later version. - * - * Alfresco is distributed in the hope that it will be useful, - * but WITHOUT ANY WARRANTY; without even the implied warranty of - * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the - * GNU Lesser General Public License for more details. - * - * You should have received a copy of the GNU Lesser General Public License + * Copyright (C) 2005-2010 Alfresco Software Limited. + * + * This file is part of Alfresco + * + * Alfresco is free software: you can redistribute it and/or modify + * it under the terms of the GNU Lesser General Public License as published by + * the Free Software Foundation, either version 3 of the License, or + * (at your option) any later version. + * + * Alfresco is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public License * along with Alfresco. If not, see . */ package org.alfresco.repo.webdav; @@ -52,7 +52,6 @@ public class WebDAVProperty * @param strName * @param strNamespaceUri * @param strNamespaceName - * @param strValue */ public WebDAVProperty(String strName, String strNamespaceUri, String strNamespaceName) { diff --git a/source/java/org/alfresco/repo/webdav/auth/BaseAuthenticationFilter.java b/source/java/org/alfresco/repo/webdav/auth/BaseAuthenticationFilter.java index 31775c8d2c..e6b35323c2 100644 --- a/source/java/org/alfresco/repo/webdav/auth/BaseAuthenticationFilter.java +++ b/source/java/org/alfresco/repo/webdav/auth/BaseAuthenticationFilter.java @@ -271,8 +271,7 @@ public abstract class BaseAuthenticationFilter /** * Remove the user from the session and expire the session - after failed ticket auth. * - * @param session - * the session + * @param req HttpServletRequest */ protected void invalidateSession(HttpServletRequest req) { diff --git a/source/java/org/alfresco/repo/webdav/auth/BaseKerberosAuthenticationFilter.java b/source/java/org/alfresco/repo/webdav/auth/BaseKerberosAuthenticationFilter.java index beba070cd1..e0b515d1d5 100644 --- a/source/java/org/alfresco/repo/webdav/auth/BaseKerberosAuthenticationFilter.java +++ b/source/java/org/alfresco/repo/webdav/auth/BaseKerberosAuthenticationFilter.java @@ -118,8 +118,8 @@ public abstract class BaseKerberosAuthenticationFilter extends BaseSSOAuthentica /** * Sets the HTTP service login configuration entry name. The default is "AlfrescoHTTP". * - * @param loginEntryName - * the loginEntryName to set + * @param jaasConfigEntryName + * the jaasConfigEntryName to set */ public void setJaasConfigEntryName(String jaasConfigEntryName) { @@ -612,8 +612,9 @@ public abstract class BaseKerberosAuthenticationFilter extends BaseSSOAuthentica /** * Restart the Kerberos logon process * + * @param context ServletContext + * @param req HttpServletRequest * @param resp HttpServletResponse - * @param httpSess HttpSession * @throws IOException */ public void restartLoginChallenge(ServletContext context, HttpServletRequest req, HttpServletResponse resp) throws IOException diff --git a/source/java/org/alfresco/repo/webdav/auth/BaseNTLMAuthenticationFilter.java b/source/java/org/alfresco/repo/webdav/auth/BaseNTLMAuthenticationFilter.java index 7ab31798c4..93220e8f7b 100644 --- a/source/java/org/alfresco/repo/webdav/auth/BaseNTLMAuthenticationFilter.java +++ b/source/java/org/alfresco/repo/webdav/auth/BaseNTLMAuthenticationFilter.java @@ -318,7 +318,6 @@ public abstract class BaseNTLMAuthenticationFilter extends BaseSSOAuthentication * @param type1Msg Type1NTLMMessage * @param req HttpServletRequest * @param res HttpServletResponse - * @param session HttpSession * @exception IOException */ protected void processType1(Type1NTLMMessage type1Msg, HttpServletRequest req, @@ -428,9 +427,7 @@ public abstract class BaseNTLMAuthenticationFilter extends BaseSSOAuthentication * @param type3Msg Type3NTLMMessage * @param req HttpServletRequest * @param res HttpServletResponse - * @param session HttpSession - * @param chain FilterChain - * + * * @exception IOException * @exception ServletException */ @@ -746,9 +743,9 @@ public abstract class BaseNTLMAuthenticationFilter extends BaseSSOAuthentication /** * Perform an NTLMv1 hashed password check * - * @param String md4hash - * @param byte[] challenge - * @param Type3NTLMMessage type3Msg + * @param md4hash String + * @param challenge byte[] + * @param type3Msg Type3NTLMMessage * @param checkLMHash boolean * @return boolean */ @@ -801,9 +798,9 @@ public abstract class BaseNTLMAuthenticationFilter extends BaseSSOAuthentication /** * Perform an NTLMv2 check * - * @param String md4hash - * @param byte[] challenge - * @param Type3NTLMMessage type3Msg + * @param md4hash String + * @param challenge byte[] + * @param type3Msg Type3NTLMMessage * @return boolean */ protected final boolean checkNTLMv2(String md4hash, byte[] challenge, Type3NTLMMessage type3Msg) @@ -900,9 +897,9 @@ public abstract class BaseNTLMAuthenticationFilter extends BaseSSOAuthentication /** * Perform an NTLMv2 session key check * - * @param String md4hash - * @param byte[] challenge - * @param Type3NTLMMessage type3Msg + * @param md4hash String + * @param challenge byte[] + * @param type3Msg Type3NTLMMessage * @return boolean */ protected final boolean checkNTLMv2SessionKey(String md4hash, byte[] challenge, Type3NTLMMessage type3Msg) @@ -982,8 +979,7 @@ public abstract class BaseNTLMAuthenticationFilter extends BaseSSOAuthentication * Get the stored MD4 hashed password for the user, or null if the user does not exist * * @param userName - * @param md4hash - * + * * @return MD4 hash or null */ protected String getMD4Hash(String userName) @@ -1039,9 +1035,9 @@ public abstract class BaseNTLMAuthenticationFilter extends BaseSSOAuthentication /** * Restart the NTLM logon process * - * @param context - * @param resp - * @param httpSess + * @param context ServletContext + * @param req HttpServletRequest + * @param res SessHttpServletResponse * @throws IOException */ public void restartLoginChallenge(ServletContext context, HttpServletRequest req, HttpServletResponse res) throws IOException diff --git a/source/java/org/alfresco/repo/webdav/auth/BaseSSOAuthenticationFilter.java b/source/java/org/alfresco/repo/webdav/auth/BaseSSOAuthenticationFilter.java index 3e407c4dfc..56481810ac 100644 --- a/source/java/org/alfresco/repo/webdav/auth/BaseSSOAuthenticationFilter.java +++ b/source/java/org/alfresco/repo/webdav/auth/BaseSSOAuthenticationFilter.java @@ -545,8 +545,8 @@ public abstract class BaseSSOAuthenticationFilter extends BaseAuthenticationFilt * to be redirected to the login page. * * @param context ServletContext + * @param req HttpServletRequest * @param resp HttpServletResponse - * @param httpSess HttpSession * @throws IOException */ protected void writeLoginPageLink(ServletContext context, HttpServletRequest req, HttpServletResponse resp) throws IOException diff --git a/source/java/org/alfresco/repo/webdav/auth/KerberosAuthenticationFilter.java b/source/java/org/alfresco/repo/webdav/auth/KerberosAuthenticationFilter.java index b9da6c7a12..47a48bf805 100644 --- a/source/java/org/alfresco/repo/webdav/auth/KerberosAuthenticationFilter.java +++ b/source/java/org/alfresco/repo/webdav/auth/KerberosAuthenticationFilter.java @@ -73,8 +73,8 @@ public class KerberosAuthenticationFilter extends BaseKerberosAuthenticationFilt * to be redirected to the login page. * * @param context ServletContext + * @param req HttpServletRequest * @param resp HttpServletResponse - * @param httpSess HttpSession * @throws IOException */ protected void writeLoginPageLink(ServletContext context, HttpServletRequest req, HttpServletResponse resp) throws IOException diff --git a/source/java/org/alfresco/rest/api/Nodes.java b/source/java/org/alfresco/rest/api/Nodes.java index c1a85631f8..8a96de61c1 100644 --- a/source/java/org/alfresco/rest/api/Nodes.java +++ b/source/java/org/alfresco/rest/api/Nodes.java @@ -36,7 +36,7 @@ public interface Nodes /** * Get the node representation for the given node. - * @param nodeRef + * @param nodeId * @return */ Node getNode(String nodeId); diff --git a/source/java/org/alfresco/rest/api/PublicApiAuthenticatorFactory.java b/source/java/org/alfresco/rest/api/PublicApiAuthenticatorFactory.java index 994ae4ebbf..71842d787a 100644 --- a/source/java/org/alfresco/rest/api/PublicApiAuthenticatorFactory.java +++ b/source/java/org/alfresco/rest/api/PublicApiAuthenticatorFactory.java @@ -147,9 +147,9 @@ public class PublicApiAuthenticatorFactory extends RemoteUserAuthenticatorFactor /** * Construct * - * @param authenticationService * @param req * @param res + * @param proxyListener ProxyListener */ public PublicApiAuthenticator(WebScriptServletRequest req, WebScriptServletResponse res, ProxyListener proxyListener) { diff --git a/source/java/org/alfresco/rest/api/PublicApiCredentials.java b/source/java/org/alfresco/rest/api/PublicApiCredentials.java index 797998dfb4..74706bf258 100644 --- a/source/java/org/alfresco/rest/api/PublicApiCredentials.java +++ b/source/java/org/alfresco/rest/api/PublicApiCredentials.java @@ -5,7 +5,7 @@ import java.util.Map; import org.alfresco.repo.web.auth.WebCredentials; /** - * {@link WebScriptCrednetials} class for holding information related to authentication when using the public API.. + * {@link WebCredentials} class for holding information related to authentication when using the public API.. * * @author Alex Miller */ diff --git a/source/java/org/alfresco/rest/api/Sites.java b/source/java/org/alfresco/rest/api/Sites.java index 7442c9b2ee..8197909862 100644 --- a/source/java/org/alfresco/rest/api/Sites.java +++ b/source/java/org/alfresco/rest/api/Sites.java @@ -40,9 +40,9 @@ public interface Sites /** * people//sites/ * - * @param siteId * @param personId - * @return + * @param siteShortName + * @return */ MemberOfSite getMemberOfSite(String personId, String siteShortName); SiteMember getSiteMember(String personId, String siteShortName); diff --git a/source/java/org/alfresco/rest/api/TenantCredentials.java b/source/java/org/alfresco/rest/api/TenantCredentials.java index bf8c1248fa..f4942a0394 100644 --- a/source/java/org/alfresco/rest/api/TenantCredentials.java +++ b/source/java/org/alfresco/rest/api/TenantCredentials.java @@ -4,7 +4,7 @@ import org.alfresco.repo.web.auth.WebCredentials; import org.alfresco.repo.web.scripts.servlet.BasicHttpAuthenticatorFactory.BasicHttpAuthenticator; /** - * {@link WebScriptCrednetials} class which wraps the credentials from the {@link BasicHttpAuthenticator} and adds + * {@link WebCredentials} class which wraps the credentials from the {@link BasicHttpAuthenticator} and adds * additional information related to TenantBased logins. * * @author Alex Miller diff --git a/source/java/org/alfresco/rest/api/people/PeopleEntityResource.java b/source/java/org/alfresco/rest/api/people/PeopleEntityResource.java index d9c215fb35..b3e9d90734 100644 --- a/source/java/org/alfresco/rest/api/people/PeopleEntityResource.java +++ b/source/java/org/alfresco/rest/api/people/PeopleEntityResource.java @@ -57,7 +57,7 @@ public class PeopleEntityResource implements EntityResourceAction.ReadById, RelationshipResourceAction.De /** * List the favourite site information for a specific site. * - * @see org.alfresco.rest.framework.resource.actions.interfaces.RelationshipResourceAction.ReadById#readById(java.lang.String, java.lang.String) + * @see org.alfresco.rest.framework.resource.actions.interfaces.RelationshipResourceAction.ReadById#readById(String, String, org.alfresco.rest.framework.resource.parameters.Parameters) */ @Override @WebApiDescription(title = "Get Person Favorite Site", description = "Get information on a person's specific favorite site") @@ -83,7 +83,7 @@ RelationshipResourceAction.Create, RelationshipResourceAction.De /** * Adds the given site as a favourite site for the user. * - * @see org.alfresco.rest.framework.resource.actions.interfaces.RelationshipResourceAction.Create#create(java.lang.String, org.alfresco.rest.api.model.FavouriteSite) + * @see org.alfresco.rest.framework.resource.actions.interfaces.RelationshipResourceAction.Create#create(String, java.util.List, org.alfresco.rest.framework.resource.parameters.Parameters) */ @Override @WebApiDescription(title = "Add Person Favorite Site", description = "Favorite a site") diff --git a/source/java/org/alfresco/rest/api/people/PersonFavouritesRelation.java b/source/java/org/alfresco/rest/api/people/PersonFavouritesRelation.java index a383a41c4a..f46ce8a706 100644 --- a/source/java/org/alfresco/rest/api/people/PersonFavouritesRelation.java +++ b/source/java/org/alfresco/rest/api/people/PersonFavouritesRelation.java @@ -50,7 +50,7 @@ RelationshipResourceAction.Create, RelationshipResourceAction.Delete /** * Adds the given site as a favourite site for the user. * - * @see org.alfresco.rest.framework.resource.actions.interfaces.RelationshipResourceAction.Create#create(java.lang.String, org.alfresco.rest.api.model.FavouriteSite) + * @see org.alfresco.rest.framework.resource.actions.interfaces.RelationshipResourceAction.Create#create(String, java.util.List, org.alfresco.rest.framework.resource.parameters.Parameters) */ @Override @WebApiDescription(title = "Add Person Favorite", description = "Favorite something") diff --git a/source/java/org/alfresco/rest/api/people/PersonPreferencesRelation.java b/source/java/org/alfresco/rest/api/people/PersonPreferencesRelation.java index 57bd52d2e7..c6e48d5978 100644 --- a/source/java/org/alfresco/rest/api/people/PersonPreferencesRelation.java +++ b/source/java/org/alfresco/rest/api/people/PersonPreferencesRelation.java @@ -67,7 +67,7 @@ public class PersonPreferencesRelation implements RelationshipResourceAction.Rea * * If personId does not exist, NotFoundException (status 404). * - * @see org.alfresco.rest.framework.resource.actions.interfaces.RelationshipResourceAction.ReadById#readById(java.lang.String, java.lang.String) + * @see org.alfresco.rest.framework.resource.actions.interfaces.RelationshipResourceAction.ReadById#readById(String, String, org.alfresco.rest.framework.resource.parameters.Parameters) */ @Override @WebApiDescription(title = "Preference value for preference 'preferenceName' for person 'personId'.") diff --git a/source/java/org/alfresco/rest/api/people/PersonSitesRelation.java b/source/java/org/alfresco/rest/api/people/PersonSitesRelation.java index 9a8779d772..9ba8950a03 100644 --- a/source/java/org/alfresco/rest/api/people/PersonSitesRelation.java +++ b/source/java/org/alfresco/rest/api/people/PersonSitesRelation.java @@ -60,7 +60,7 @@ public class PersonSitesRelation implements RelationshipResourceAction.Read, RelationshipResourceAction.Update * @throws If siteId does not exist, NotFoundException (status 404). * * (non-Javadoc) - * @see org.alfresco.rest.framework.resource.actions.interfaces.RelationshipCollectionResourceAction.Read#readAll(java.lang.String, org.alfresco.rest.framework.resource.parameters.Paging) + * @see org.alfresco.rest.framework.resource.actions.interfaces.EntityResourceAction.Read#readAll(org.alfresco.rest.framework.resource.parameters.Parameters) */ @Override @WebApiDescription(title="A paged list of all the members of the site 'siteId'.") @@ -83,7 +83,7 @@ RelationshipResourceAction.Create, RelationshipResourceAction.Update * @throws If personId does not exist, NotFoundException (status 404). * @throws If siteMember. does not exist, NotFoundException (status 404). * - * @see org.alfresco.rest.framework.resource.actions.interfaces.RelationshipResourceAction.Create#create(java.io.Serializable) + * @see org.alfresco.rest.framework.resource.actions.interfaces.RelationshipResourceAction.Create#create(String, java.util.List, org.alfresco.rest.framework.resource.parameters.Parameters) */ @Override @WebApiDescription(title="Adds personId as a member of site siteId.") diff --git a/source/java/org/alfresco/rest/framework/core/ResourceInspector.java b/source/java/org/alfresco/rest/framework/core/ResourceInspector.java index 75b5c36049..c424873326 100644 --- a/source/java/org/alfresco/rest/framework/core/ResourceInspector.java +++ b/source/java/org/alfresco/rest/framework/core/ResourceInspector.java @@ -202,7 +202,7 @@ public class ResourceInspector /** * Determines if the resources supports the resource action specified by resourceInterfaceWithOneMethod * @param resourceInterfaceWithOneMethod The resource action - * @param method http method the action supports. + * @param httpMethod http method the action supports. * @param helper Holder of simple meta data */ private static void findOperation(Class resourceInterfaceWithOneMethod, HttpMethod httpMethod, MetaHelperCallback helper) @@ -228,7 +228,6 @@ public class ResourceInspector * @param resource * @param aMethod * @param httpMethod - * @param defaultParams * @return ResourceOperation */ public static ResourceOperation inspectOperation(Class resource, Method aMethod, HttpMethod httpMethod) @@ -356,7 +355,7 @@ public class ResourceInspector /** * Indicates the number of params of the Kind specified * @param params - * @param KIND kind of parameter eg. URL_PATH + * @param kind kind of parameter eg. URL_PATH * @return int count */ private static int paramsCount(List params, KIND kind) @@ -450,7 +449,7 @@ public class ResourceInspector /** * Finds the name of the entity collection using the meta information. - * @param entityAnnot + * @param meta ResourceMetadata * @return the entity name/path */ public static String findEntityCollectionNameName(ResourceMetadata meta) @@ -570,7 +569,7 @@ public class ResourceInspector /** * Finds a single method with the @UniqueId annotation. * - * @param obj any object + * @param objClass any object class * @return the Method * @throws IllegalArgumentException if there is is more than 1 method annotated with @UniqueId */ @@ -592,7 +591,7 @@ public class ResourceInspector /** * Finds the property name that is used as the unique id. - * @param Method uniqueIdMethod + * @param uniqueIdMethod Method * @return String the property name that is used as the unique id. */ public static String findUniqueIdName(Method uniqueIdMethod) diff --git a/source/java/org/alfresco/rest/framework/core/ResourceInspectorUtil.java b/source/java/org/alfresco/rest/framework/core/ResourceInspectorUtil.java index 4f3ff38676..b19caa8360 100755 --- a/source/java/org/alfresco/rest/framework/core/ResourceInspectorUtil.java +++ b/source/java/org/alfresco/rest/framework/core/ResourceInspectorUtil.java @@ -24,7 +24,7 @@ public class ResourceInspectorUtil * Determine the expected type as the returned type of the method. * If the return type is a List it will return the generic element type instead of a List. * @param resource - resource with methods - * @param methodName + * @param method Method * @return Class - type of class it needs. */ @SuppressWarnings("rawtypes") diff --git a/source/java/org/alfresco/rest/framework/core/exceptions/EntityNotFoundException.java b/source/java/org/alfresco/rest/framework/core/exceptions/EntityNotFoundException.java index 563ba815cf..fbe63f9699 100644 --- a/source/java/org/alfresco/rest/framework/core/exceptions/EntityNotFoundException.java +++ b/source/java/org/alfresco/rest/framework/core/exceptions/EntityNotFoundException.java @@ -12,8 +12,7 @@ public class EntityNotFoundException extends NotFoundException /** * The entity id param will be shown in the default error message. - * @param msgId - * @param entity + * @param entityId */ public EntityNotFoundException(String entityId) { diff --git a/source/java/org/alfresco/rest/framework/core/exceptions/RelationshipResourceNotFoundException.java b/source/java/org/alfresco/rest/framework/core/exceptions/RelationshipResourceNotFoundException.java index 3674c01e92..00605b84ff 100644 --- a/source/java/org/alfresco/rest/framework/core/exceptions/RelationshipResourceNotFoundException.java +++ b/source/java/org/alfresco/rest/framework/core/exceptions/RelationshipResourceNotFoundException.java @@ -12,8 +12,8 @@ public class RelationshipResourceNotFoundException extends NotFoundException /** * The entity id param will be shown in the default error message. - * @param msgId - * @param entity + * @param entityId + * @param relationshipId */ public RelationshipResourceNotFoundException(String entityId, String relationshipId) { diff --git a/source/java/org/alfresco/rest/framework/jacksonextensions/ExecutionResult.java b/source/java/org/alfresco/rest/framework/jacksonextensions/ExecutionResult.java index d1dfdf976f..5caec70766 100644 --- a/source/java/org/alfresco/rest/framework/jacksonextensions/ExecutionResult.java +++ b/source/java/org/alfresco/rest/framework/jacksonextensions/ExecutionResult.java @@ -39,7 +39,6 @@ public class ExecutionResult /** * Adds embeddeds object to the enclosing root object - * @param key * @param embedded objects to add */ public void addEmbedded(Map embedded) @@ -49,7 +48,6 @@ public class ExecutionResult /** * Adds related object to the enclosing root object - * @param key * @param related objects to add */ public void addRelated(Map related) diff --git a/source/java/org/alfresco/rest/framework/resource/content/BinaryProperty.java b/source/java/org/alfresco/rest/framework/resource/content/BinaryProperty.java index 2c4ff48cf0..50fd877207 100755 --- a/source/java/org/alfresco/rest/framework/resource/content/BinaryProperty.java +++ b/source/java/org/alfresco/rest/framework/resource/content/BinaryProperty.java @@ -39,7 +39,7 @@ public class BinaryProperty implements ContentInfo, Serializable /** * This is the preferred constructor to use. Takes the properties from content reader that it needs. - * @param ContentReader + * @param reader ContentReader */ public BinaryProperty(ContentReader reader) { diff --git a/source/java/org/alfresco/rest/framework/resource/parameters/CollectionWithPagingInfo.java b/source/java/org/alfresco/rest/framework/resource/parameters/CollectionWithPagingInfo.java index 7d1b64a399..1727dfcbe4 100644 --- a/source/java/org/alfresco/rest/framework/resource/parameters/CollectionWithPagingInfo.java +++ b/source/java/org/alfresco/rest/framework/resource/parameters/CollectionWithPagingInfo.java @@ -25,9 +25,9 @@ public class CollectionWithPagingInfo /** * Constructs a new CollectionWithPagingInfo. - * @param aCollection - the collection that needs to be paged. - * @param hasMoreItems - Are there more items after this Collection? + * @param collection - the collection that needs to be paged. * @param paging - Paging request info + * @param hasMoreItems - Are there more items after this Collection? * @param totalItems - The total number of items available. * @return CollectionWithPagingInfo */ @@ -103,8 +103,6 @@ public class CollectionWithPagingInfo /** * Indicates if the returned collection has more items after the current returned list. - * - * @param hasMoreItems */ public boolean hasMoreItems() { diff --git a/source/java/org/alfresco/rest/framework/resource/parameters/where/QueryHelper.java b/source/java/org/alfresco/rest/framework/resource/parameters/where/QueryHelper.java index badd9f5175..ea25ba1d2f 100644 --- a/source/java/org/alfresco/rest/framework/resource/parameters/where/QueryHelper.java +++ b/source/java/org/alfresco/rest/framework/resource/parameters/where/QueryHelper.java @@ -55,7 +55,7 @@ public abstract class QueryHelper /** * Called any time a MATCHES clause is encountered. - * @param propertyName Name of the property + * @param property Name of the property * @param propertyValue * @param negated returns true if "NOT MATCHES" was used */ diff --git a/source/java/org/alfresco/rest/framework/webscripts/AbstractResourceWebScript.java b/source/java/org/alfresco/rest/framework/webscripts/AbstractResourceWebScript.java index 74b6efa12e..d5886b42e7 100644 --- a/source/java/org/alfresco/rest/framework/webscripts/AbstractResourceWebScript.java +++ b/source/java/org/alfresco/rest/framework/webscripts/AbstractResourceWebScript.java @@ -128,7 +128,7 @@ public abstract class AbstractResourceWebScript extends ApiWebScript implements * Renders the result of an execution. * * @param res WebScriptResponse - * @param respons result of an execution + * @param toSerialize result of an execution * @throws IOException */ protected void renderJsonResponse(final WebScriptResponse res, final Object toSerialize) diff --git a/source/java/org/alfresco/rest/framework/webscripts/ResourceWebScriptHelper.java b/source/java/org/alfresco/rest/framework/webscripts/ResourceWebScriptHelper.java index c49df16d93..08e0d22d92 100644 --- a/source/java/org/alfresco/rest/framework/webscripts/ResourceWebScriptHelper.java +++ b/source/java/org/alfresco/rest/framework/webscripts/ResourceWebScriptHelper.java @@ -86,7 +86,7 @@ public class ResourceWebScriptHelper * filter param is set then a default BeanFilter is returned that will never * filter properties (ie. Returns all bean properties). * - * @param req + * @param filterParams * @return BeanPropertyFilter - if no parameter then returns a new * ReturnAllBeanProperties class */ @@ -114,7 +114,7 @@ public class ResourceWebScriptHelper * filter param is set then a default BeanFilter is returned that will never * filter properties (ie. Returns all bean properties). * - * @param req + * @param filterParams * @return BeanPropertiesFilter - if no parameter then returns a new * ReturnAllBeanProperties class */ @@ -397,8 +397,10 @@ public class ResourceWebScriptHelper * * Either returns a ExecutionResult object or a CollectionWithPagingInfo containing a collection of ExecutionResult objects. * - * @param objectToWrap - * @param result + * @param api Api + * @param entityCollectionName String + * @param params Params + * @param objectToWrap Object * @return Object - Either ExecutionResult or CollectionWithPagingInfo */ public Object postProcessResponse(Api api, String entityCollectionName, Params params, Object objectToWrap) diff --git a/source/java/org/alfresco/rest/workflow/api/impl/MapBasedQueryWalker.java b/source/java/org/alfresco/rest/workflow/api/impl/MapBasedQueryWalker.java index 5151f0c396..931d42c6ff 100644 --- a/source/java/org/alfresco/rest/workflow/api/impl/MapBasedQueryWalker.java +++ b/source/java/org/alfresco/rest/workflow/api/impl/MapBasedQueryWalker.java @@ -288,8 +288,8 @@ public class MapBasedQueryWalker extends WalkerCallbackAdapter /** * Get the property value, converted to the requested type. * - * @param parameters used to extract parameter value from * @param propertyName name of the parameter + * @param type int * @param returnType type of object to return * @return the converted parameter value. Null, if the property has no * value. diff --git a/source/java/org/alfresco/rest/workflow/api/impl/RestVariableHelper.java b/source/java/org/alfresco/rest/workflow/api/impl/RestVariableHelper.java index 65455950c5..eccaa52e05 100644 --- a/source/java/org/alfresco/rest/workflow/api/impl/RestVariableHelper.java +++ b/source/java/org/alfresco/rest/workflow/api/impl/RestVariableHelper.java @@ -83,8 +83,9 @@ public class RestVariableHelper /** * @param localVariables raw local task variables, can be null. - * @param globalvariables raw global taks variables, can be null. - * @param typeDefinition the typê definition for this task, used to extract types. + * @param globalVariables raw global taks variables, can be null. + * @param startFormTypeDefinition TypeDefinition + * @param taskTypeDefinition the typê definition for this task, used to extract types. * @return list of {@link TaskVariable}, representing the given raw variables */ public List getTaskVariables(Map localVariables, Map globalVariables, diff --git a/source/java/org/alfresco/slingshot/web/scripts/NodeBrowserScript.java b/source/java/org/alfresco/slingshot/web/scripts/NodeBrowserScript.java index af908bbb38..169c69d637 100644 --- a/source/java/org/alfresco/slingshot/web/scripts/NodeBrowserScript.java +++ b/source/java/org/alfresco/slingshot/web/scripts/NodeBrowserScript.java @@ -855,7 +855,7 @@ public class NodeBrowserScript extends DeclarativeWebScript implements Serializa /** * Construct * - * @param name property name + * @param qname property name * @param value property values */ @SuppressWarnings("unchecked") diff --git a/source/test-java/org/alfresco/repo/web/scripts/BaseWebScriptTest.java b/source/test-java/org/alfresco/repo/web/scripts/BaseWebScriptTest.java index 08de9dd807..c6d3fe7cce 100644 --- a/source/test-java/org/alfresco/repo/web/scripts/BaseWebScriptTest.java +++ b/source/test-java/org/alfresco/repo/web/scripts/BaseWebScriptTest.java @@ -158,8 +158,8 @@ public abstract class BaseWebScriptTest extends TestCase /** * Sets Test Listener - * - * @param resultPrinter + * + * @param listener WebScriptTestListener */ public void setListener(WebScriptTestListener listener) { @@ -447,7 +447,6 @@ public abstract class BaseWebScriptTest extends TestCase * * @param req * @param expectedStatus - * @param asUser * @return response * @throws IOException */ diff --git a/source/test-java/org/alfresco/repo/web/scripts/rating/RatingRestApiTest.java b/source/test-java/org/alfresco/repo/web/scripts/rating/RatingRestApiTest.java index 2c7e99afd5..776f4feb21 100644 --- a/source/test-java/org/alfresco/repo/web/scripts/rating/RatingRestApiTest.java +++ b/source/test-java/org/alfresco/repo/web/scripts/rating/RatingRestApiTest.java @@ -43,7 +43,7 @@ import org.springframework.extensions.webscripts.TestWebScriptServer.PostRequest import org.springframework.extensions.webscripts.TestWebScriptServer.Response; /** - * This class tests the ReST API of the {@link RatingService}. + * This class tests the ReST API of the {@link org.alfresco.service.cmr.rating.RatingService}. * * @author Neil McErlean * @since 3.4 diff --git a/source/test-java/org/alfresco/repo/webdav/PutMethodTest.java b/source/test-java/org/alfresco/repo/webdav/PutMethodTest.java index 2c05a4bb1e..de2f16bd1e 100644 --- a/source/test-java/org/alfresco/repo/webdav/PutMethodTest.java +++ b/source/test-java/org/alfresco/repo/webdav/PutMethodTest.java @@ -831,7 +831,7 @@ public class PutMethodTest *

* Sets content to request from a test file * - * @param method Method to prepare, should be initialized (PUT, LOCK, UNLOCK are supported) + * @param methodName Method to prepare, should be initialized (PUT, LOCK, UNLOCK are supported) * @param fileName the name of the file set to the context, can be used with path, i.e. "path/to/file/fileName.txt" * @param content If not null adds test content to the request * @param headers to set to request, can be null diff --git a/source/test-java/org/alfresco/repo/webdav/WebDAVonContentUpdateTest.java b/source/test-java/org/alfresco/repo/webdav/WebDAVonContentUpdateTest.java index 068de9d8dc..a502f8fe39 100644 --- a/source/test-java/org/alfresco/repo/webdav/WebDAVonContentUpdateTest.java +++ b/source/test-java/org/alfresco/repo/webdav/WebDAVonContentUpdateTest.java @@ -255,7 +255,7 @@ public class WebDAVonContentUpdateTest *

* Sets content to request from a test file * - * @param method Method to prepare, should be initialized (PUT, LOCK, UNLOCK are supported) + * @param methodName Method name to prepare, should be initialized (PUT, LOCK, UNLOCK are supported) * @param fileName the name of the file set to the context, can be used with path, i.e. "path/to/file/fileName.txt" * @param content If not null adds test content to the request * @param headers to set to request, can be null diff --git a/source/test-java/org/alfresco/rest/api/tests/client/AuthenticatedHttp.java b/source/test-java/org/alfresco/rest/api/tests/client/AuthenticatedHttp.java index 95f58d05d4..a42e84a93d 100644 --- a/source/test-java/org/alfresco/rest/api/tests/client/AuthenticatedHttp.java +++ b/source/test-java/org/alfresco/rest/api/tests/client/AuthenticatedHttp.java @@ -37,7 +37,7 @@ public class AuthenticatedHttp extends AbstractHttp /** * @param httpProvider provider class for http-client - * @param authDetailProvider provider for authentication details + * @param authenticationDetailsProvider provider for authentication details */ public AuthenticatedHttp(HttpClientProvider httpProvider, AuthenticationDetailsProvider authenticationDetailsProvider) { diff --git a/source/test-java/org/alfresco/rest/api/tests/client/AuthenticationDetailsProvider.java b/source/test-java/org/alfresco/rest/api/tests/client/AuthenticationDetailsProvider.java index 349ac85b64..144178fafc 100644 --- a/source/test-java/org/alfresco/rest/api/tests/client/AuthenticationDetailsProvider.java +++ b/source/test-java/org/alfresco/rest/api/tests/client/AuthenticationDetailsProvider.java @@ -41,7 +41,8 @@ public interface AuthenticationDetailsProvider /** * Update the value of the ticket for the given user. - * @param username + * @param userName + * @param ticket * @throws IllegalArgumentException when the user does not exist. */ void updateTicketForUser(String userName, String ticket) throws IllegalArgumentException; diff --git a/source/test-java/org/alfresco/rest/framework/tests/core/WhereTests.java b/source/test-java/org/alfresco/rest/framework/tests/core/WhereTests.java index 890cfe15ba..607fd84d9a 100644 --- a/source/test-java/org/alfresco/rest/framework/tests/core/WhereTests.java +++ b/source/test-java/org/alfresco/rest/framework/tests/core/WhereTests.java @@ -444,10 +444,11 @@ public class WhereTests { /** * Used by ComparisonClauseTest, validates the clause - * @param theQuery - * @param tree + * @param theQuery Query * @param comparisonOperator One of EQUALS LESSTHAN GREATERTHAN LESSTHANOREQUALS GREATERTHANOREQUALS - */ + * @param propName String + * @param propVal String + */ private void comparisonChecks(Query theQuery, final int comparisonOperator, final String propName, final String propVal) { assertNotNull(theQuery); CommonTree tree = theQuery.getTree();