001// --------------------------------------------------------------------------------
002// Copyright 2002-2024 Echo Three, LLC
003//
004// Licensed under the Apache License, Version 2.0 (the "License");
005// you may not use this file except in compliance with the License.
006// You may obtain a copy of the License at
007//
008//     http://www.apache.org/licenses/LICENSE-2.0
009//
010// Unless required by applicable law or agreed to in writing, software
011// distributed under the License is distributed on an "AS IS" BASIS,
012// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
013// See the License for the specific language governing permissions and
014// limitations under the License.
015// --------------------------------------------------------------------------------
016
017package com.echothree.model.control.security.server.logic;
018
019import com.echothree.control.user.security.common.spec.SecurityRoleGroupUniversalSpec;
020import com.echothree.model.control.core.common.ComponentVendors;
021import com.echothree.model.control.core.common.EntityTypes;
022import com.echothree.model.control.core.common.exception.InvalidParameterCountException;
023import com.echothree.model.control.core.server.logic.EntityInstanceLogic;
024import com.echothree.model.control.security.common.exception.DuplicateSecurityRoleGroupNameException;
025import com.echothree.model.control.security.common.exception.UnknownDefaultSecurityRoleGroupException;
026import com.echothree.model.control.security.common.exception.UnknownSecurityRoleGroupNameException;
027import com.echothree.model.control.security.server.control.SecurityControl;
028import com.echothree.model.control.workflow.common.exception.UnknownWorkflowNameException;
029import com.echothree.model.control.workflow.server.control.WorkflowControl;
030import com.echothree.model.data.core.server.entity.EntityInstance;
031import com.echothree.model.data.party.server.entity.Language;
032import com.echothree.model.data.security.server.entity.SecurityRoleGroup;
033import com.echothree.model.data.workflow.server.entity.Workflow;
034import com.echothree.util.common.exception.BaseException;
035import com.echothree.util.common.message.ExecutionErrors;
036import com.echothree.util.common.persistence.BasePK;
037import com.echothree.util.server.control.BaseLogic;
038import com.echothree.util.server.message.ExecutionErrorAccumulator;
039import com.echothree.util.server.persistence.EntityPermission;
040import com.echothree.util.server.persistence.Session;
041
042public class SecurityRoleGroupLogic
043        extends BaseLogic {
044
045    private SecurityRoleGroupLogic() {
046        super();
047    }
048
049    private static class SecurityRoleGroupLogicHolder {
050        static SecurityRoleGroupLogic instance = new SecurityRoleGroupLogic();
051    }
052
053    public static SecurityRoleGroupLogic getInstance() {
054        return SecurityRoleGroupLogicHolder.instance;
055    }
056
057    public SecurityRoleGroup createSecurityRoleGroup(final ExecutionErrorAccumulator eea, final String securityRoleGroupName,
058            final SecurityRoleGroup parentSecurityRoleGroup, final Boolean isDefault, final Integer sortOrder,
059            final Language language, final String description, final BasePK createdBy) {
060        var securityControl = Session.getModelController(SecurityControl.class);
061        var securityRoleGroup = securityControl.getSecurityRoleGroupByName(securityRoleGroupName);
062
063        if(securityRoleGroup == null) {
064            securityRoleGroup = securityControl.createSecurityRoleGroup(securityRoleGroupName, parentSecurityRoleGroup,
065                    isDefault, sortOrder, createdBy);
066
067            if(description != null) {
068                securityControl.createSecurityRoleGroupDescription(securityRoleGroup, language, description, createdBy);
069            }
070        } else {
071            handleExecutionError(DuplicateSecurityRoleGroupNameException.class, eea, ExecutionErrors.DuplicateSecurityRoleGroupName.name(), securityRoleGroupName);
072        }
073
074        return securityRoleGroup;
075    }
076
077    public SecurityRoleGroup getSecurityRoleGroupByName(final Class<? extends BaseException> unknownException, final ExecutionErrors unknownExecutionError,
078            final ExecutionErrorAccumulator eea, final String securityRoleGroupName, final EntityPermission entityPermission) {
079        var securityControl = Session.getModelController(SecurityControl.class);
080        var securityRoleGroup = securityControl.getSecurityRoleGroupByName(securityRoleGroupName, entityPermission);
081
082        if(securityRoleGroup == null) {
083            handleExecutionError(unknownException, eea, unknownExecutionError.name(), securityRoleGroupName);
084        }
085
086        return securityRoleGroup;
087    }
088
089    public SecurityRoleGroup getSecurityRoleGroupByName(final ExecutionErrorAccumulator eea, final String securityRoleGroupName,
090            final EntityPermission entityPermission) {
091        return getSecurityRoleGroupByName(UnknownSecurityRoleGroupNameException.class, ExecutionErrors.UnknownSecurityRoleGroupName, eea,
092                securityRoleGroupName, entityPermission);
093    }
094
095    public SecurityRoleGroup getSecurityRoleGroupByName(final ExecutionErrorAccumulator eea, final String securityRoleGroupName) {
096        return getSecurityRoleGroupByName(eea, securityRoleGroupName, EntityPermission.READ_ONLY);
097    }
098
099    public SecurityRoleGroup getSecurityRoleGroupByNameForUpdate(final ExecutionErrorAccumulator eea, final String securityRoleGroupName) {
100        return getSecurityRoleGroupByName(eea, securityRoleGroupName, EntityPermission.READ_WRITE);
101    }
102
103    public SecurityRoleGroup getSecurityRoleGroupByUniversalSpec(final ExecutionErrorAccumulator eea,
104            final SecurityRoleGroupUniversalSpec universalSpec, boolean allowDefault, final EntityPermission entityPermission) {
105        SecurityRoleGroup securityRoleGroup = null;
106        var securityControl = Session.getModelController(SecurityControl.class);
107        var securityRoleGroupName = universalSpec.getSecurityRoleGroupName();
108        var parameterCount = (securityRoleGroupName == null ? 0 : 1) + EntityInstanceLogic.getInstance().countPossibleEntitySpecs(universalSpec);
109
110        switch(parameterCount) {
111            case 0:
112                if(allowDefault) {
113                    securityRoleGroup = securityControl.getDefaultSecurityRoleGroup(entityPermission);
114
115                    if(securityRoleGroup == null) {
116                        handleExecutionError(UnknownDefaultSecurityRoleGroupException.class, eea, ExecutionErrors.UnknownDefaultSecurityRoleGroup.name());
117                    }
118                } else {
119                    handleExecutionError(InvalidParameterCountException.class, eea, ExecutionErrors.InvalidParameterCount.name());
120                }
121                break;
122            case 1:
123                if(securityRoleGroupName == null) {
124                    var entityInstance = EntityInstanceLogic.getInstance().getEntityInstance(eea, universalSpec,
125                            ComponentVendors.ECHO_THREE.name(), EntityTypes.SecurityRoleGroup.name());
126
127                    if(!eea.hasExecutionErrors()) {
128                        securityRoleGroup = securityControl.getSecurityRoleGroupByEntityInstance(entityInstance, entityPermission);
129                    }
130                } else {
131                    securityRoleGroup = getSecurityRoleGroupByName(eea, securityRoleGroupName, entityPermission);
132                }
133                break;
134            default:
135                handleExecutionError(InvalidParameterCountException.class, eea, ExecutionErrors.InvalidParameterCount.name());
136                break;
137        }
138
139        return securityRoleGroup;
140    }
141
142    public SecurityRoleGroup getSecurityRoleGroupByUniversalSpec(final ExecutionErrorAccumulator eea,
143            final SecurityRoleGroupUniversalSpec universalSpec, boolean allowDefault) {
144        return getSecurityRoleGroupByUniversalSpec(eea, universalSpec, allowDefault, EntityPermission.READ_ONLY);
145    }
146
147    public SecurityRoleGroup getSecurityRoleGroupByUniversalSpecForUpdate(final ExecutionErrorAccumulator eea,
148            final SecurityRoleGroupUniversalSpec universalSpec, boolean allowDefault) {
149        return getSecurityRoleGroupByUniversalSpec(eea, universalSpec, allowDefault, EntityPermission.READ_WRITE);
150    }
151
152    public void deleteSecurityRoleGroup(final ExecutionErrorAccumulator eea, final SecurityRoleGroup securityRoleGroup,
153            final BasePK deletedBy) {
154        var securityControl = Session.getModelController(SecurityControl.class);
155
156        securityControl.deleteSecurityRoleGroup(securityRoleGroup, deletedBy);
157    }
158
159}