Rechange the app manager lifecycle xml file, add comments and headers

components/application-mgt/org.wso2.carbon.device.application.mgt.core/src/main/java/org/wso2/carbon/device/application/mgt/core/lifecycle/LifecycleStateManger.java

@@ -1,3 +1,39 @@
+/*
+ * Copyright (c) 2019, WSO2 Inc. (http://www.wso2.org) All Rights Reserved.
+ *
+ * WSO2 Inc. licenses this file to you under the Apache License,
+ * Version 2.0 (the "License"); you may not use this file except
+ * in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied. See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+
+/*
+ * Copyright (c) 2019, Entgra Inc. (http://www.entgra.io) All Rights Reserved.
+ *
+ * Entgra Inc. licenses this file to you under the Apache License,
+ * Version 2.0 (the "License"); you may not use this file except
+ * in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied. See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+
 package org.wso2.carbon.device.application.mgt.core.lifecycle;
 
 import org.apache.commons.logging.Log;
@@ -32,16 +68,15 @@ public class LifecycleStateManger {
                 s.getProceedingStates().replaceAll(String::toUpperCase);
             }
             lifecycleStates.put(s.getName().toUpperCase(), new State(s.getName().toUpperCase(),
-                    s.getProceedingStates(), s.getPermission(),s.isAppUpdatable(),s.isAppInstallable(),
+                    s.getProceedingStates(), s.getPermission(), s.isAppUpdatable(), s.isAppInstallable(),
-                    s.isInitialState(),s.isEndState()));
+                    s.isInitialState(), s.isEndState()));
             try {
                 PermissionUtils.putPermission(s.getPermission());
             } catch (PermissionManagementException e) {
-                log.error("Error when adding permission " + s.getPermission() + "  related to the state: "
+                String msg = "Error when adding permission " + s.getPermission() + "  related to the state: "
-                        + s.getName(), e);
+                        + s.getName();
-                throw new LifecycleManagementException (
+                log.error(msg, e);
-                        "Error when adding permission " + s.getPermission() + "  related to the state: "
+                throw new LifecycleManagementException(msg, e);
-                                + s.getName(), e);
             }
         }
     }
@@ -53,9 +88,9 @@ public class LifecycleStateManger {
     public boolean isValidStateChange(String currentState, String nextState, String username,
                                       int tenantId) throws LifecycleManagementException {
 
-        UserRealm userRealm = null;
+        UserRealm userRealm;
         String permission = getPermissionForStateChange(nextState);
-        if(permission != null) {
+        if (permission != null) {
             try {
                 userRealm = DataHolder.getInstance().getRealmService().getTenantUserRealm(tenantId);
                 if (userRealm != null && userRealm.getAuthorizationManager() != null &&
@@ -77,17 +112,17 @@ public class LifecycleStateManger {
                         "UserStoreException exception from changing the state from : " + currentState + "  to: "
                                 + nextState + " with username : " + username + " and tenant Id : " + tenantId, e);
             }
-        }else{
+        } else {
             throw new LifecycleManagementException(
-                    "Required permissions cannot be found for the state : "+nextState);
+                    "Required permissions cannot be found for the state : " + nextState);
         }
     }
 
     private State getMatchingState(String currentState) {
         Iterator it = lifecycleStates.entrySet().iterator();
         while (it.hasNext()) {
-            Map.Entry pair = (Map.Entry)it.next();
+            Map.Entry pair = (Map.Entry) it.next();
-            if(pair.getKey().toString().equalsIgnoreCase(currentState)) {
+            if (pair.getKey().toString().equalsIgnoreCase(currentState)) {
                 return lifecycleStates.get(pair.getKey().toString());
             }
             it.remove();
@@ -97,7 +132,7 @@ public class LifecycleStateManger {
 
 
     private boolean getMatchingNextState(Set<String> proceedingStates, String nextState) {
-        for (String state: proceedingStates) {
+        for (String state : proceedingStates) {
             if (state.equalsIgnoreCase(nextState)) {
                 return true;
             }
@@ -105,12 +140,12 @@ public class LifecycleStateManger {
         return false;
     }
 
-    private String getPermissionForStateChange(String nextState){
+    private String getPermissionForStateChange(String nextState) {
         Iterator it = lifecycleStates.entrySet().iterator();
         State nextLifecycleState;
         while (it.hasNext()) {
-            Map.Entry pair = (Map.Entry)it.next();
+            Map.Entry pair = (Map.Entry) it.next();
-            if(pair.getKey().toString().equalsIgnoreCase(nextState)) {
+            if (pair.getKey().toString().equalsIgnoreCase(nextState)) {
                 nextLifecycleState = lifecycleStates.get(nextState);
                 return nextLifecycleState.getPermission();
             }

components/application-mgt/org.wso2.carbon.device.application.mgt.core/src/main/java/org/wso2/carbon/device/application/mgt/core/lifecycle/config/LifecycleState.java

@@ -37,35 +37,49 @@ public class LifecycleState {
         this.proceedingStates = proceedingStates;
     }
 
-    @XmlElement(name="Permission")
+    @XmlElement(name = "Permission")
-    public String getPermission(){return permission;}
+    public String getPermission() {
-
+        return permission;
-    public void setPermission(String permission){
-        this.permission=permission;
     }
 
-    @XmlElement(name="IsAppInstallable")
+    public void setPermission(String permission) {
-    public boolean isAppInstallable(){
+        this.permission = permission;
-         return isAppInstallable;
     }
-    public void setAppInstallable(boolean isAppInstallable){ this.isAppInstallable =isAppInstallable;}
 
-    @XmlElement(name="IsAppUpdatable")
+    @XmlElement(name = "IsAppInstallable")
-    public boolean isAppUpdatable(){
+    public boolean isAppInstallable() {
+        return isAppInstallable;
+    }
+
+    public void setAppInstallable(boolean isAppInstallable) {
+        this.isAppInstallable = isAppInstallable;
+    }
+
+    @XmlElement(name = "IsAppUpdatable")
+    public boolean isAppUpdatable() {
         return isAppUpdatable;
     }
-    public void setAppUpdatable(boolean isAppUpdatable){ this.isAppUpdatable=isAppUpdatable;}
 
-    @XmlElement(name="IsInitialState")
+    public void setAppUpdatable(boolean isAppUpdatable) {
-    public boolean isInitialState(){
+        this.isAppUpdatable = isAppUpdatable;
+    }
+
+    @XmlElement(name = "IsInitialState")
+    public boolean isInitialState() {
         return isInitialState;
     }
-    public void setInitialState(boolean isInitialState){ this.isInitialState=isInitialState;}
 
-    @XmlElement(name="IsEndState")
+    public void setInitialState(boolean isInitialState) {
-    public boolean isEndState(){
+        this.isInitialState = isInitialState;
+    }
+
+    @XmlElement(name = "IsEndState")
+    public boolean isEndState() {
         return isEndState;
     }
-    public void setEndState(boolean isEndState){ this.isEndState=isEndState;}
+
+    public void setEndState(boolean isEndState) {
+        this.isEndState = isEndState;
+    }
 
 }

features/application-mgt/org.wso2.carbon.device.application.mgt.server.feature/src/main/resources/conf/application-mgt.xml

@@ -56,20 +56,8 @@
     If there is a requirement to introduce a new state to the lifecycle, please refer above
     diagram and add relevant state to the below configuration appropriately.
     -->
-    <LifecycleStates>
 
-        <LifecycleState name="Created">
+    <!-- a lifecyclestate can have following properties
-            <IsAppInstallable>false</IsAppInstallable>
-            <IsAppUpdatable>true</IsAppUpdatable>
-            <IsInitialState>true</IsInitialState>
-            <IsEndState>false</IsEndState>
-            <Permission>
-                /device-mgt/applications/life-cycle/create
-            </Permission>
-            <ProceedingStates>
-                <State>In-Review</State>
-            </ProceedingStates>
-        </LifecycleState>
         <LifecycleState name="In-Review">
             <IsAppInstallable>false</IsAppInstallable>
             <IsAppUpdatable>true</IsAppUpdatable>
@@ -83,38 +71,49 @@
                 <State>Approved</State>
             </ProceedingStates>
         </LifecycleState>
-        <LifecycleState name="Approved">
+    -->
-            <IsAppInstallable>false</IsAppInstallable>
+    <LifecycleStates>
-            <IsAppUpdatable>false</IsAppUpdatable>
+        <LifecycleState name="Created">
-            <IsInitialState>false</IsInitialState>
+            <IsAppUpdatable>true</IsAppUpdatable>
-            <IsEndState>false</IsEndState>
+            <IsInitialState>true</IsInitialState>
             <Permission>
-                /device-mgt/applications/life-cycle/approved
+                /device-mgt/applications/life-cycle/create
-            </Permission>
-            <ProceedingStates>
-                <State>Published</State>
-            </ProceedingStates>
-        </LifecycleState>
-        <LifecycleState name="Rejected">
-            <IsAppInstallable>false</IsAppInstallable>
-            <IsAppUpdatable>false</IsAppUpdatable>
-            <IsInitialState>false</IsInitialState>
-            <IsEndState>false</IsEndState>
-            <Permission>
-                /device-mgt/applications/life-cycle/rejected
             </Permission>
             <ProceedingStates>
                 <State>In-Review</State>
+            </ProceedingStates>
+        </LifecycleState>
+        <LifecycleState name="In-Review">
+            <Permission>
+                /device-mgt/applications/life-cycle/in-review
+            </Permission>
+            <ProceedingStates>
+                <State>Rejected</State>
+                <State>Approved</State>
+            </ProceedingStates>
+        </LifecycleState>
+        <LifecycleState name="Approved">
+            <Permission>
+                /device-mgt/applications/life-cycle/approve
+            </Permission>
+            <ProceedingStates>
+                <State>Published</State>
+                <State>Created</State>
+            </ProceedingStates>
+        </LifecycleState>
+        <LifecycleState name="Rejected">
+            <Permission>
+                /device-mgt/applications/life-cycle/reject
+            </Permission>
+            <ProceedingStates>
+                <State>Created</State>
                 <State>Removed</State>
             </ProceedingStates>
         </LifecycleState>
         <LifecycleState name="Published">
             <IsAppInstallable>true</IsAppInstallable>
-            <IsAppUpdatable>false</IsAppUpdatable>
-            <IsInitialState>false</IsInitialState>
-            <IsEndState>false</IsEndState>
             <Permission>
-                /device-mgt/applications/life-cycle/published
+                /device-mgt/applications/life-cycle/publish
             </Permission>
             <ProceedingStates>
                 <State>Unpublished</State>
@@ -122,36 +121,28 @@
             </ProceedingStates>
         </LifecycleState>
         <LifecycleState name="Unpublished">
-            <IsAppInstallable>false</IsAppInstallable>
-            <IsAppUpdatable>false</IsAppUpdatable>
-            <IsInitialState>false</IsInitialState>
-            <IsEndState>false</IsEndState>
             <Permission>
-                /device-mgt/applications/life-cycle/unpublished
+                /device-mgt/applications/life-cycle/unpublish
             </Permission>
             <ProceedingStates>
+                <State>Published</State>
+                <State>In-Review</State>
                 <State>Removed</State>
             </ProceedingStates>
         </LifecycleState>
         <LifecycleState name="Deprecated">
-            <IsAppInstallable>false</IsAppInstallable>
-            <IsAppUpdatable>false</IsAppUpdatable>
-            <IsInitialState>false</IsInitialState>
-            <IsEndState>false</IsEndState>
             <Permission>
-                /device-mgt/applications/life-cycle/deprecated
+                /device-mgt/applications/life-cycle/deprecate
             </Permission>
             <ProceedingStates>
                 <State>Removed</State>
+                <State>In-Review</State>
             </ProceedingStates>
         </LifecycleState>
         <LifecycleState name="Removed">
-            <IsAppInstallable>false</IsAppInstallable>
-            <IsAppUpdatable>false</IsAppUpdatable>
-            <IsInitialState>false</IsInitialState>
             <IsEndState>true</IsEndState>
             <Permission>
-                /device-mgt/applications/life-cycle/removed
+                /device-mgt/applications/life-cycle/remove
             </Permission>
         </LifecycleState>
     </LifecycleStates>