001// --------------------------------------------------------------------------------
002// Copyright 2002-2026 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.data.party.server.entity.Language;
029import com.echothree.model.data.security.server.entity.SecurityRoleGroup;
030import com.echothree.util.common.exception.BaseException;
031import com.echothree.util.common.message.ExecutionErrors;
032import com.echothree.util.common.persistence.BasePK;
033import com.echothree.util.server.control.BaseLogic;
034import com.echothree.util.server.message.ExecutionErrorAccumulator;
035import com.echothree.util.server.persistence.EntityPermission;
036import javax.enterprise.context.ApplicationScoped;
037import javax.enterprise.inject.spi.CDI;
038import javax.inject.Inject;
039
040@ApplicationScoped
041public class SecurityRoleGroupLogic
042        extends BaseLogic {
043
044    @Inject
045    protected SecurityControl securityControl;
046
047    @Inject
048    EntityInstanceLogic entityInstanceLogic;
049
050    protected SecurityRoleGroupLogic() {
051        super();
052    }
053
054    public static SecurityRoleGroupLogic getInstance() {
055        return CDI.current().select(SecurityRoleGroupLogic.class).get();
056    }
057
058    public SecurityRoleGroup createSecurityRoleGroup(final ExecutionErrorAccumulator eea, final String securityRoleGroupName,
059            final SecurityRoleGroup parentSecurityRoleGroup, final Boolean isDefault, final Integer sortOrder,
060            final Language language, final String description, final BasePK createdBy) {
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 securityRoleGroup = securityControl.getSecurityRoleGroupByName(securityRoleGroupName, entityPermission);
080
081        if(securityRoleGroup == null) {
082            handleExecutionError(unknownException, eea, unknownExecutionError.name(), securityRoleGroupName);
083        }
084
085        return securityRoleGroup;
086    }
087
088    public SecurityRoleGroup getSecurityRoleGroupByName(final ExecutionErrorAccumulator eea, final String securityRoleGroupName,
089            final EntityPermission entityPermission) {
090        return getSecurityRoleGroupByName(UnknownSecurityRoleGroupNameException.class, ExecutionErrors.UnknownSecurityRoleGroupName, eea,
091                securityRoleGroupName, entityPermission);
092    }
093
094    public SecurityRoleGroup getSecurityRoleGroupByName(final ExecutionErrorAccumulator eea, final String securityRoleGroupName) {
095        return getSecurityRoleGroupByName(eea, securityRoleGroupName, EntityPermission.READ_ONLY);
096    }
097
098    public SecurityRoleGroup getSecurityRoleGroupByNameForUpdate(final ExecutionErrorAccumulator eea, final String securityRoleGroupName) {
099        return getSecurityRoleGroupByName(eea, securityRoleGroupName, EntityPermission.READ_WRITE);
100    }
101
102    public SecurityRoleGroup getSecurityRoleGroupByUniversalSpec(final ExecutionErrorAccumulator eea,
103            final SecurityRoleGroupUniversalSpec universalSpec, boolean allowDefault, final EntityPermission entityPermission) {
104        SecurityRoleGroup securityRoleGroup = null;
105        var securityRoleGroupName = universalSpec.getSecurityRoleGroupName();
106        var parameterCount = (securityRoleGroupName == null ? 0 : 1) + entityInstanceLogic.countPossibleEntitySpecs(universalSpec);
107
108        switch(parameterCount) {
109            case 0 -> {
110                if(allowDefault) {
111                    securityRoleGroup = securityControl.getDefaultSecurityRoleGroup(entityPermission);
112
113                    if(securityRoleGroup == null) {
114                        handleExecutionError(UnknownDefaultSecurityRoleGroupException.class, eea, ExecutionErrors.UnknownDefaultSecurityRoleGroup.name());
115                    }
116                } else {
117                    handleExecutionError(InvalidParameterCountException.class, eea, ExecutionErrors.InvalidParameterCount.name());
118                }
119            }
120            case 1 -> {
121                if(securityRoleGroupName == null) {
122                    var entityInstance = entityInstanceLogic.getEntityInstance(eea, universalSpec,
123                            ComponentVendors.ECHO_THREE.name(), EntityTypes.SecurityRoleGroup.name());
124
125                    if(eea == null || !eea.hasExecutionErrors()) {
126                        securityRoleGroup = securityControl.getSecurityRoleGroupByEntityInstance(entityInstance, entityPermission);
127                    }
128                } else {
129                    securityRoleGroup = getSecurityRoleGroupByName(eea, securityRoleGroupName, entityPermission);
130                }
131            }
132            default ->
133                    handleExecutionError(InvalidParameterCountException.class, eea, ExecutionErrors.InvalidParameterCount.name());
134        }
135
136        return securityRoleGroup;
137    }
138
139    public SecurityRoleGroup getSecurityRoleGroupByUniversalSpec(final ExecutionErrorAccumulator eea,
140            final SecurityRoleGroupUniversalSpec universalSpec, boolean allowDefault) {
141        return getSecurityRoleGroupByUniversalSpec(eea, universalSpec, allowDefault, EntityPermission.READ_ONLY);
142    }
143
144    public SecurityRoleGroup getSecurityRoleGroupByUniversalSpecForUpdate(final ExecutionErrorAccumulator eea,
145            final SecurityRoleGroupUniversalSpec universalSpec, boolean allowDefault) {
146        return getSecurityRoleGroupByUniversalSpec(eea, universalSpec, allowDefault, EntityPermission.READ_WRITE);
147    }
148
149    public void deleteSecurityRoleGroup(final ExecutionErrorAccumulator eea, final SecurityRoleGroup securityRoleGroup,
150            final BasePK deletedBy) {
151        securityControl.deleteSecurityRoleGroup(securityRoleGroup, deletedBy);
152    }
153
154}