You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@stratos.apache.org by im...@apache.org on 2014/12/12 12:10:39 UTC
stratos git commit: Updating method comments in StratosApi41
Repository: stratos
Updated Branches:
refs/heads/4.1.0-test 0e018793e -> c8c7d28ab
Updating method comments in StratosApi41
Project: http://git-wip-us.apache.org/repos/asf/stratos/repo
Commit: http://git-wip-us.apache.org/repos/asf/stratos/commit/c8c7d28a
Tree: http://git-wip-us.apache.org/repos/asf/stratos/tree/c8c7d28a
Diff: http://git-wip-us.apache.org/repos/asf/stratos/diff/c8c7d28a
Branch: refs/heads/4.1.0-test
Commit: c8c7d28abe827768f4169f179ac11e6e609fc592
Parents: 0e01879
Author: Imesh Gunaratne <im...@apache.org>
Authored: Fri Dec 12 16:40:12 2014 +0530
Committer: Imesh Gunaratne <im...@apache.org>
Committed: Fri Dec 12 16:40:25 2014 +0530
----------------------------------------------------------------------
.../rest/endpoint/api/StratosApiV41.java | 32 ++++++++++----------
1 file changed, 16 insertions(+), 16 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/stratos/blob/c8c7d28a/components/org.apache.stratos.rest.endpoint/src/main/java/org/apache/stratos/rest/endpoint/api/StratosApiV41.java
----------------------------------------------------------------------
diff --git a/components/org.apache.stratos.rest.endpoint/src/main/java/org/apache/stratos/rest/endpoint/api/StratosApiV41.java b/components/org.apache.stratos.rest.endpoint/src/main/java/org/apache/stratos/rest/endpoint/api/StratosApiV41.java
index 23893ea..d827519 100644
--- a/components/org.apache.stratos.rest.endpoint/src/main/java/org/apache/stratos/rest/endpoint/api/StratosApiV41.java
+++ b/components/org.apache.stratos.rest.endpoint/src/main/java/org/apache/stratos/rest/endpoint/api/StratosApiV41.java
@@ -167,41 +167,41 @@ public class StratosApiV41 extends AbstractApi {
rb.entity(cartridges.isEmpty() ? new Cartridge[0] : cartridges.toArray(new Cartridge[cartridges.size()]));
return rb.build();
}
-
+
/**
- * Gets the cartridges by category.
- *
- * @param category the category
- * @param criteria the criteria if required for further filtering
- * @return the cartridges by category
- * @throws RestAPIException the rest api exception
+ * Returns cartridges by category.
+ * @param filter
+ * @param criteria
+ * @return
+ * @throws RestAPIException
*/
@GET
@Path("/cartridges/{filter}")
@Produces("application/json")
@Consumes("application/json")
@AuthorizationAction("/permission/admin/manage/view/cartridge")
- public Response getCartridgesByFilter(@DefaultValue("") @PathParam("filter") String filter, @QueryParam("criteria") String criteria) throws RestAPIException {
+ public Response getCartridgesByFilter(@DefaultValue("") @PathParam("filter") String filter,
+ @QueryParam("criteria") String criteria) throws RestAPIException {
List<Cartridge> cartridges = StratosApiV41Utils.getCartridgesByFilter(filter, criteria, getConfigContext());
ResponseBuilder rb = Response.ok();
rb.entity(cartridges.isEmpty() ? new Cartridge[0] : cartridges.toArray(new Cartridge[cartridges.size()]));
return rb.build();
}
-
+
/**
- * Gets a specific cartridge by category.
- *
- * @param category the category
- * @param cartridgeType the cartridge type
- * @return the cartridge by category
- * @throws RestAPIException the rest api exception
+ * Returns a specific cartridge by category.
+ * @param filter
+ * @param cartridgeType
+ * @return
+ * @throws RestAPIException
*/
@GET
@Path("/cartridges/{filter}/{cartridgeType}")
@Produces("application/json")
@Consumes("application/json")
@AuthorizationAction("/permission/admin/manage/view/cartridge")
- public Response getCartridgeByFilter(@DefaultValue("") @PathParam("filter") String filter, @PathParam("cartridgeType") String cartridgeType) throws RestAPIException {
+ public Response getCartridgeByFilter(@DefaultValue("") @PathParam("filter") String filter,
+ @PathParam("cartridgeType") String cartridgeType) throws RestAPIException {
Cartridge cartridge = StratosApiV41Utils.getCartridgeByFilter(filter, cartridgeType, getConfigContext());
ResponseBuilder rb = Response.ok();
rb.entity(cartridge);