inteligr8/alfresco-community-repo
1
0
Fork 0
mirror of https://github.com/Alfresco/alfresco-community-repo.git synced 2025-08-21 18:09:20 +00:00
Code Issues Packages Projects Releases Wiki Activity

Merged HEAD-BUG-FIX (5.1/Cloud) to HEAD (5.1/Cloud)

Browse Source 
107541: Merged 5.0.N (5.0.3) to HEAD-BUG-FIX (5.1/Cloud) (PARTIAL MERGE)
      107413: Merged DEV to 5.0.N (5.0.3)
         106858 : MNT-13545: JavaDoc : Inconsistencies between the Java doc and the actual code
            - Cleaning of Javadoc,
   107565: MNT-13545 Fix compilation after merge of Javadoc


git-svn-id: https://svn.alfresco.com/repos/alfresco-enterprise/alfresco/HEAD/root@107633 c4b6b30b-aa2e-2d43-bbcb-ca4b014f7261
This commit is contained in:
Tatyana Valkevych
2015-07-02 16:13:03 +00:00
parent a5f8df310a
commit 22d2935235
119 changed files with 444 additions and 434 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
source/java/org/alfresco/rest/framework/webscripts/AbstractResourceWebScript.java
View File

@@ -152,7 +152,7 @@ public abstract class AbstractResourceWebScript extends ApiWebScript implements
/**
* The response status must be set before the response is written by Jackson (which will by default close and commit the response).
* In a r/w txn, web script buffered responses ensure that it doesn't really matter but for r/o txns this is important.
* @param res
* @param res WebScriptResponse
*/
protected void setSuccessResponseStatus(final WebScriptResponse res)
{
@@ -164,7 +164,7 @@ public abstract class AbstractResourceWebScript extends ApiWebScript implements
* Finds the action executor to execute actions on.
* @param httpMethod - the http method
* @param params Params
* @param resource
* @param resource ResourceWithMetadata
* @param contentType Request content type
* @return ActionExecutor the action executor
*/

2
source/java/org/alfresco/rest/framework/webscripts/ResourceWebScriptDelete.java
View File

@@ -73,7 +73,7 @@ public class ResourceWebScriptDelete extends AbstractResourceWebScript implement
/**
* Executes the action on the resource
* @param resource
* @param resource ResourceWithMetadata
* @param params parameters to use
* @return anObject the result of the execute
*/

2
source/java/org/alfresco/rest/framework/webscripts/ResourceWebScriptGet.java
View File

@@ -79,7 +79,7 @@ public class ResourceWebScriptGet extends AbstractResourceWebScript implements P
/**
* Executes the action on the resource
* @param resource
* @param resource ResourceWithMetadata
* @param params parameters to use
* @return anObject the result of the execute
*/

48
source/java/org/alfresco/rest/framework/webscripts/ResourceWebScriptHelper.java
View File

@@ -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 filterParams
* @param filterParams String
* @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 filterParams
* @param filterParams String
* @return BeanPropertiesFilter - if no parameter then returns a new
* ReturnAllBeanProperties class
*/
@@ -149,7 +149,7 @@ public class ResourceWebScriptHelper
/**
* Takes the "select" parameter and turns it into a List<String> property names
* @param selectParam
* @param selectParam String
* @return List<String> bean property names potentially using JSON Pointer syntax
*/
@SuppressWarnings("unchecked")
@@ -188,7 +188,7 @@ public class ResourceWebScriptHelper
/**
* Takes the "where" parameter and turns it into a Java Object that can be used for querying
* @param whereParam
* @param whereParam String
* @return Query a parsed version of the where clause, represented in Java
*/
public static Query getWhereClause(String whereParam) throws InvalidQueryException
@@ -312,8 +312,8 @@ public class ResourceWebScriptHelper
* invoke it. If it fails it just swallows the exceptions and doesn't throw
* them further.
*
* @param theObj
* @param uniqueId
* @param theObj Object
* @param uniqueId String
*/
public static void setUniqueId(Object theObj, String uniqueId)
{
@@ -393,7 +393,7 @@ public class ResourceWebScriptHelper
/**
* Looks at the object passed in and recursively expands any @EmbeddedEntityResource annotations or related relationship.
* @EmbeddedEntityResource is expanded by calling the ReadById method for this entity.
* {@link org.alfresco.rest.framework.resource.EmbeddedEntityResource EmbeddedEntityResource} is expanded by calling the ReadById method for this entity.
*
* Either returns a ExecutionResult object or a CollectionWithPagingInfo containing a collection of ExecutionResult objects.
*
@@ -456,17 +456,19 @@ public class ResourceWebScriptHelper
/**
* Loops through the embedded Resources and executes them. The results are added to list of embedded results used by
* the ExecutionResult object.
*
* @param relatedResources
* @param execRes
* @param uniqueEntityId
*
* @param api Api
* @param params Params
* @param objectToWrap Object
* @param embeddded Map<String, Pair<String, Method>>
* @return Map
*/
private Map<String, Object> executeEmbeddedResources(Api api, Params params, Object objectToWrap, Map<String, Pair<String, Method>> embeddded)
{
final Map<String,Object> results = new HashMap<String,Object>(embeddded.size());
for (Entry<String, Pair<String,Method>> embeddedEntry : embeddded.entrySet())
{
ResourceWithMetadata res = locator.locateEntityResource(api,embeddedEntry.getValue().getFirst(), HttpMethod.GET);
ResourceWithMetadata res = locator.locateEntityResource(api, embeddedEntry.getValue().getFirst(), HttpMethod.GET);
if (res != null)
{
Object id = ResourceInspectorUtil.invokeMethod(embeddedEntry.getValue().getSecond(), objectToWrap);
@@ -495,10 +497,12 @@ public class ResourceWebScriptHelper
/**
* Loops through the related Resources and executed them. The results are added to list of embedded results used by
* the ExecutionResult object.
*
* @param relatedResources
* @param execRes
* @param uniqueEntityId
*
* @param api Api
* @param filters Map<String, BeanPropertiesFilter>
* @param relatedResources Map<String, ResourceWithMetadata>
* @param uniqueEntityId String
* @return Map
*/
private Map<String,Object> executeRelatedResources(final Api api, Map<String, BeanPropertiesFilter> filters,
Map<String, ResourceWithMetadata> relatedResources,
@@ -519,9 +523,13 @@ public class ResourceWebScriptHelper
/**
* Executes a single related Resource. The results are added to list of embedded results used by
* the ExecutionResult object.
*
* @param relatedResources
* @param uniqueEntityId
*
* @param api Api
* @param filters Map<String, BeanPropertiesFilter>
* @param uniqueEntityId String
* @param resourceKey String
* @param resource ResourceWithMetadata
* @return Object
*/
private Object executeRelatedResource(final Api api, final Map<String, BeanPropertiesFilter> filters,
final String uniqueEntityId, final String resourceKey, final ResourceWithMetadata resource)
@@ -573,7 +581,7 @@ public class ResourceWebScriptHelper
* and returns them for use.
*
* @param req - the WebScriptRequest object
* @return Map<String, String[]> the request parameters
* @return the request parameters
*/
public static Map<String, String[]> getRequestParameters(WebScriptRequest req)
{

6
source/java/org/alfresco/rest/framework/webscripts/ResourceWebScriptPost.java
View File

@@ -78,8 +78,8 @@ public class ResourceWebScriptPost extends AbstractResourceWebScript implements
/**
* If the @WebApiParam has been used and set allowMultiple to false then this will get a single entry. It
* should error if an array is passed in.
* @param resourceMeta
* @param req
* @param resourceMeta ResourceMetadata
* @param req WebScriptRequest
* @return Either an object
*/
private Object extractObjFromJson(ResourceMetadata resourceMeta, WebScriptRequest req)
@@ -118,7 +118,7 @@ public class ResourceWebScriptPost extends AbstractResourceWebScript implements
/**
* Executes the action on the resource
* @param resource
* @param resource ResourceWithMetadata
* @param params parameters to use
* @return anObject the result of the execute
*/

10
source/java/org/alfresco/rest/framework/webscripts/ResourceWebScriptPut.java
View File

@@ -87,9 +87,8 @@ public class ResourceWebScriptPut extends AbstractResourceWebScript implements P
/**
* Returns the basic content info from the request.
* @param req
* @param req WebScriptRequest
* @return BasicContentInfo
* @throws IOException
*/
private BasicContentInfo getContentInfo(WebScriptRequest req) {
@@ -111,9 +110,8 @@ public class ResourceWebScriptPut extends AbstractResourceWebScript implements P
/**
* Returns the input stream for the request
* @param req
* @return
* @throws IOException
* @param req WebScriptRequest
* @return InputStream
*/
private InputStream getStream(WebScriptRequest req)
{
@@ -134,7 +132,7 @@ public class ResourceWebScriptPut extends AbstractResourceWebScript implements P
/**
* Executes the action on the resource
* @param resource
* @param resource ResourceWithMetadata
* @param params parameters to use
* @return anObject the result of the execute
*/

4
source/java/org/alfresco/rest/framework/webscripts/metadata/WebScriptOptionsMetaData.java
View File

@@ -96,8 +96,8 @@ public class WebScriptOptionsMetaData extends ApiWebScript implements ResourceMe
/**
* Processes the resulting resource and returns the data to be displayed
* @param resource
* @param apiResources
* @param resource ResourceWithMetadata
* @param apiResources Map<String, ResourceWithMetadata>
* @return Either a ExecutionResult or a CollectionWithPagingInfo
*/
public static Object processResult(ResourceWithMetadata resource, Map<String, ResourceWithMetadata> apiResources)