mirror of
https://github.com/Alfresco/alfresco-community-repo.git
synced 2025-08-14 17:58:59 +00:00
Merged HEAD-BUG-FIX (5.1/Cloud) to HEAD (5.1/Cloud)
99981: Merged 5.0.N (5.0.2) to HEAD-BUG-FIX (5.1/Cloud) (PARTIAL MERGE)
99482: Merged DEV to 5.0.N (5.0.1)
99198 : MNT-13545: JavaDoc : Inconsistencies between the Java doc and the actual code
- Changed Javadoc typo in project alfresco-jlan
99413 : MNT-13545: JavaDoc : Inconsistencies between the Java doc and the actual code
- Changed Javadoc parameters inconsistence in project alfresco-jlan
99205 : MNT-13545: JavaDoc : Inconsistencies between the Java doc and the actual code
- Changed Javadoc parameters inconsistence in project core
99415 : MNT-13545: JavaDoc : Inconsistencies between the Java doc and the actual code
- Changed Javadoc parameters inconsistence in project data-model
99227 : MNT-13545: JavaDoc : Inconsistencies between the Java doc and the actual code
- Changed Javadoc parameters inconsistence in project file-transfer-receiver
99416 : MNT-13545: JavaDoc : Inconsistencies between the Java doc and the actual code
- Changed Javadoc parameters inconsistence in project legacy-lucene
99417 : MNT-13545: JavaDoc : Inconsistencies between the Java doc and the actual code
- Changed Javadoc parameters inconsistence in project qa-share
99418 : MNT-13545: JavaDoc : Inconsistencies between the Java doc and the actual code
- Changed Javadoc parameters inconsistence in project remote-api
99427 : MNT-13545: JavaDoc : Inconsistencies between the Java doc and the actual code
- Changed Javadoc in project Repository, letters S..Z
99433 : MNT-13545: JavaDoc : Inconsistencies between the Java doc and the actual code
- Changed Javadoc in project Repository, letters A..R
99421 : MNT-13545: JavaDoc : Inconsistencies between the Java doc and the actual code
- Changed Javadoc parameters inconsistence in project share-po
99247 : MNT-13545: JavaDoc : Inconsistencies between the Java doc and the actual code
- Changed Javadoc typo in project slingshot
99248 : MNT-13545: JavaDoc : Inconsistencies between the Java doc and the actual code
- Changed Javadoc parameters inconsistence in project slingshot
99424 : MNT-13545: JavaDoc : Inconsistencies between the Java doc and the actual code
- Changed Javadoc parameters inconsistence in project solr
99426 : MNT-13545: JavaDoc : Inconsistencies between the Java doc and the actual code
- Changed Javadoc parameters inconsistence in project solr4
99253 : MNT-13545: JavaDoc : Inconsistencies between the Java doc and the actual code
- Changed Javadoc parameters inconsistence in project solr-client
99259 : MNT-13545: JavaDoc : Inconsistencies between the Java doc and the actual code
- Changed Javadoc parameters inconsistence in project web-client
99260 : MNT-13545: JavaDoc : Inconsistencies between the Java doc and the actual code
- Changed Javadoc parameters inconsistence in project web-framework-commons
git-svn-id: https://svn.alfresco.com/repos/alfresco-enterprise/alfresco/HEAD/root@100501 c4b6b30b-aa2e-2d43-bbcb-ca4b014f7261
This commit is contained in:
Alan Davis
@@ -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<String, Object> executeImpl(WebScriptRequest req, Status status)
|
||||
|
||||
@@ -51,7 +51,7 @@ import org.springframework.extensions.webscripts.WebScriptRequest;
|
||||
import org.springframework.extensions.webscripts.WebScriptResponse;
|
||||
|
||||
/**
|
||||
* <p>A simple extensibility {@link Container} for processing WebScripts. This extends the {@link RepositoryContainer} and
|
||||
* <p>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.</p>
|
||||
*
|
||||
* @author David Draper
|
||||
@@ -114,7 +114,7 @@ public class ExtensibilityContainer extends RepositoryContainer implements Handl
|
||||
private WebScriptExtensibilityModuleHandler extensibilityModuleHandler = null;
|
||||
|
||||
/**
|
||||
* <p>Sets the {@link WebScriptExtensibilityModuleHandler} for this {@link Container}.</p>
|
||||
* <p>Sets the {@link WebScriptExtensibilityModuleHandler} for this {@link org.springframework.extensions.webscripts.Container}.</p>
|
||||
* @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.</p>
|
||||
*
|
||||
* @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
|
||||
}
|
||||
|
||||
/**
|
||||
* <p>The list of {@link ExtensionModule} instances that have been evaluated as applicable to
|
||||
* <p>The list of {@link org.springframework.extensions.surf.types.ExtensionModule} instances that have been evaluated as applicable to
|
||||
* this RequestContext. This is set to <code>null</code> when during instantiation and is only
|
||||
* properly set the first time the <code>getEvaluatedModules</code> method is invoked. This ensures
|
||||
* that module evaluation only occurs once per request.</p>
|
||||
@@ -281,11 +281,11 @@ public class ExtensibilityContainer extends RepositoryContainer implements Handl
|
||||
private ThreadLocal<List<BasicExtensionModule>> evaluatedModules = new ThreadLocal<List<BasicExtensionModule>>();
|
||||
|
||||
/**
|
||||
* <p>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}
|
||||
* <p>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.</p>
|
||||
*
|
||||
* @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<BasicExtensionModule> getEvaluatedModules()
|
||||
{
|
||||
@@ -313,7 +313,7 @@ public class ExtensibilityContainer extends RepositoryContainer implements Handl
|
||||
/**
|
||||
* <p>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.</p>
|
||||
*/
|
||||
private ThreadLocal<ConfigImpl> globalConfig = new ThreadLocal<ConfigImpl>();
|
||||
@@ -321,7 +321,7 @@ public class ExtensibilityContainer extends RepositoryContainer implements Handl
|
||||
/**
|
||||
* <p>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.</p>
|
||||
*/
|
||||
private ThreadLocal<Map<String, List<ConfigSection>>> sectionsByArea = new ThreadLocal<Map<String,List<ConfigSection>>>();
|
||||
@@ -329,7 +329,7 @@ public class ExtensibilityContainer extends RepositoryContainer implements Handl
|
||||
/**
|
||||
* <p>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.</p>
|
||||
*/
|
||||
private ThreadLocal<List<ConfigSection>> sections = new ThreadLocal<List<ConfigSection>>();
|
||||
|
||||
@@ -1021,7 +1021,8 @@ public class RepoStore extends AbstractStore implements TenantDeployer
|
||||
/**
|
||||
* Construct
|
||||
*
|
||||
* @param location
|
||||
* @param path
|
||||
* @param nodeRef
|
||||
*/
|
||||
public RepoScriptContent(String path, NodeRef nodeRef)
|
||||
{
|
||||
|
||||
@@ -48,7 +48,7 @@ public class ArchivedNodesGet extends AbstractArchivedNodeWebScript
|
||||
List<ArchivedNodesFilter> nodeFilters = new ArrayList<ArchivedNodesFilter>();
|
||||
|
||||
/**
|
||||
* 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
|
||||
*/
|
||||
|
||||
@@ -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)
|
||||
|
||||
@@ -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
|
||||
|
||||
@@ -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
|
||||
|
||||
@@ -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)
|
||||
|
||||
@@ -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<String, Object> executeImpl(WebScriptRequest request, Status status, Cache cache)
|
||||
|
||||
@@ -62,7 +62,7 @@ public class OpenSearchConfigElement extends ConfigElementAdapter
|
||||
}
|
||||
|
||||
/**
|
||||
* @see org.alfresco.config.ConfigElement#getChildren()
|
||||
* @see ConfigElement#getChildren()
|
||||
*/
|
||||
public List<ConfigElement> 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)
|
||||
{
|
||||
|
||||
@@ -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
|
||||
|
||||
@@ -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)
|
||||
{
|
||||
|
||||
@@ -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
|
||||
|
||||
@@ -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
|
||||
{
|
||||
|
||||
@@ -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
|
||||
{
|
||||
|
||||
@@ -95,7 +95,7 @@ public class DataListDownloadWebScript extends DeclarativeSpreadsheetWebScript
|
||||
}
|
||||
|
||||
/**
|
||||
* @param nodeService
|
||||
* @param siteService SiteService
|
||||
*/
|
||||
public void setSiteService(SiteService siteService)
|
||||
{
|
||||
|
||||
@@ -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);
|
||||
|
||||
@@ -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);
|
||||
|
||||
@@ -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)
|
||||
|
||||
@@ -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 <T >a type to ensure that the comparator is implemented in a typesafe way.
|
||||
* @since 5.0
|
||||
*/
|
||||
public abstract class FacetablePropertyFTL<T> implements Comparable<T>
|
||||
|
||||
@@ -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<String, Object> executeImpl(WebScriptRequest req, Status status)
|
||||
|
||||
@@ -88,7 +88,6 @@ public class JSR168PortletAuthenticatorFactory implements PortletAuthenticatorFa
|
||||
/**
|
||||
* Construct
|
||||
*
|
||||
* @param authenticationService
|
||||
* @param req
|
||||
* @param res
|
||||
*/
|
||||
|
||||
@@ -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)
|
||||
{
|
||||
|
||||
@@ -113,7 +113,6 @@ public class BasicHttpAuthenticatorFactory implements ServletAuthenticatorFactor
|
||||
/**
|
||||
* Construct
|
||||
*
|
||||
* @param authenticationService
|
||||
* @param req
|
||||
* @param res
|
||||
* @param listener
|
||||
|
||||
Reference in New Issue
Block a user