nipuni
/
device-mgt-core
forked from community/device-mgt-core
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

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

Browse Source
feature/appm-store/pbac
Gathika94 6 years ago
parent dc5547bb38
commit bb808fd9e3
3 changed files with 110 additions and 70 deletions
Show Stats Download Patch File Download Diff File

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

@ -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; package org.wso2.carbon.device.application.mgt.core.lifecycle;
import org.apache.commons.logging.Log; import org.apache.commons.logging.Log;
@ -32,16 +68,15 @@ public class LifecycleStateManger {
s.getProceedingStates().replaceAll(String::toUpperCase); s.getProceedingStates().replaceAll(String::toUpperCase);
} }
lifecycleStates.put(s.getName().toUpperCase(), new State(s.getName().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 { try {
PermissionUtils.putPermission(s.getPermission()); PermissionUtils.putPermission(s.getPermission());
} catch (PermissionManagementException e) { } 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, public boolean isValidStateChange(String currentState, String nextState, String username,
int tenantId) throws LifecycleManagementException { int tenantId) throws LifecycleManagementException {
UserRealm userRealm = null; UserRealm userRealm;
String permission = getPermissionForStateChange(nextState); String permission = getPermissionForStateChange(nextState);
if(permission != null) { if (permission != null) {
try { try {
userRealm = DataHolder.getInstance().getRealmService().getTenantUserRealm(tenantId); userRealm = DataHolder.getInstance().getRealmService().getTenantUserRealm(tenantId);
if (userRealm != null && userRealm.getAuthorizationManager() != null && if (userRealm != null && userRealm.getAuthorizationManager() != null &&
@ -77,17 +112,17 @@ public class LifecycleStateManger {
"UserStoreException exception from changing the state from : " + currentState + " to: " "UserStoreException exception from changing the state from : " + currentState + " to: "
+ nextState + " with username : " + username + " and tenant Id : " + tenantId, e); + nextState + " with username : " + username + " and tenant Id : " + tenantId, e);
} }
}else{ } else {
throw new LifecycleManagementException( 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) { private State getMatchingState(String currentState) {
Iterator it = lifecycleStates.entrySet().iterator(); Iterator it = lifecycleStates.entrySet().iterator();
while (it.hasNext()) { 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()); return lifecycleStates.get(pair.getKey().toString());
} }
it.remove(); it.remove();
@ -97,7 +132,7 @@ public class LifecycleStateManger {
private boolean getMatchingNextState(Set<String> proceedingStates, String nextState) { private boolean getMatchingNextState(Set<String> proceedingStates, String nextState) {
for (String state: proceedingStates) { for (String state : proceedingStates) {
if (state.equalsIgnoreCase(nextState)) { if (state.equalsIgnoreCase(nextState)) {
return true; return true;
} }
@ -105,12 +140,12 @@ public class LifecycleStateManger {
return false; return false;
} }
private String getPermissionForStateChange(String nextState){ private String getPermissionForStateChange(String nextState) {
Iterator it = lifecycleStates.entrySet().iterator(); Iterator it = lifecycleStates.entrySet().iterator();
State nextLifecycleState; State nextLifecycleState;
while (it.hasNext()) { 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); nextLifecycleState = lifecycleStates.get(nextState);
return nextLifecycleState.getPermission(); return nextLifecycleState.getPermission();
} }

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

@ -37,35 +37,49 @@ public class LifecycleState {
this.proceedingStates = proceedingStates; 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;
}
public void setPermission(String permission){ @XmlElement(name = "IsAppInstallable")
this.permission=permission; public boolean isAppInstallable() {
return isAppInstallable;
} }
@XmlElement(name="IsAppInstallable") public void setAppInstallable(boolean isAppInstallable) {
public boolean isAppInstallable(){ this.isAppInstallable = isAppInstallable;
return isAppInstallable;
} }
public void setAppInstallable(boolean isAppInstallable){ this.isAppInstallable =isAppInstallable;}
@XmlElement(name="IsAppUpdatable") @XmlElement(name = "IsAppUpdatable")
public boolean isAppUpdatable(){ public boolean isAppUpdatable() {
return 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; 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; return isEndState;
} }
public void setEndState(boolean isEndState){ this.isEndState=isEndState;}
public void setEndState(boolean isEndState) {
this.isEndState = isEndState;
}
} }

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

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

Write Preview
Loading…
Cancel
Save