001// --------------------------------------------------------------------------------
002// Copyright 2002-2025 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    protected SecurityRoleGroupLogic() {
048        super();
049    }
050
051    public static SecurityRoleGroupLogic getInstance() {
052        return CDI.current().select(SecurityRoleGroupLogic.class).get();
053    }
054
055    public SecurityRoleGroup createSecurityRoleGroup(final ExecutionErrorAccumulator eea, final String securityRoleGroupName,
056            final SecurityRoleGroup parentSecurityRoleGroup, final Boolean isDefault, final Integer sortOrder,
057            final Language language, final String description, final BasePK createdBy) {
058        var securityRoleGroup = securityControl.getSecurityRoleGroupByName(securityRoleGroupName);
059
060        if(securityRoleGroup == null) {
061            securityRoleGroup = securityControl.createSecurityRoleGroup(securityRoleGroupName, parentSecurityRoleGroup,
062                    isDefault, sortOrder, createdBy);
063
064            if(description != null) {
065                securityControl.createSecurityRoleGroupDescription(securityRoleGroup, language, description, createdBy);
066            }
067        } else {
068            handleExecutionError(DuplicateSecurityRoleGroupNameException.class, eea, ExecutionErrors.DuplicateSecurityRoleGroupName.name(), securityRoleGroupName);
069        }
070
071        return securityRoleGroup;
072    }
073
074    public SecurityRoleGroup getSecurityRoleGroupByName(final Class<? extends BaseException> unknownException, final ExecutionErrors unknownExecutionError,
075            final ExecutionErrorAccumulator eea, final String securityRoleGroupName, final EntityPermission entityPermission) {
076        var securityRoleGroup = securityControl.getSecurityRoleGroupByName(securityRoleGroupName, entityPermission);
077
078        if(securityRoleGroup == null) {
079            handleExecutionError(unknownException, eea, unknownExecutionError.name(), securityRoleGroupName);
080        }
081
082        return securityRoleGroup;
083    }
084
085    public SecurityRoleGroup getSecurityRoleGroupByName(final ExecutionErrorAccumulator eea, final String securityRoleGroupName,
086            final EntityPermission entityPermission) {
087        return getSecurityRoleGroupByName(UnknownSecurityRoleGroupNameException.class, ExecutionErrors.UnknownSecurityRoleGroupName, eea,
088                securityRoleGroupName, entityPermission);
089    }
090
091    public SecurityRoleGroup getSecurityRoleGroupByName(final ExecutionErrorAccumulator eea, final String securityRoleGroupName) {
092        return getSecurityRoleGroupByName(eea, securityRoleGroupName, EntityPermission.READ_ONLY);
093    }
094
095    public SecurityRoleGroup getSecurityRoleGroupByNameForUpdate(final ExecutionErrorAccumulator eea, final String securityRoleGroupName) {
096        return getSecurityRoleGroupByName(eea, securityRoleGroupName, EntityPermission.READ_WRITE);
097    }
098
099    public SecurityRoleGroup getSecurityRoleGroupByUniversalSpec(final ExecutionErrorAccumulator eea,
100            final SecurityRoleGroupUniversalSpec universalSpec, boolean allowDefault, final EntityPermission entityPermission) {
101        SecurityRoleGroup securityRoleGroup = null;
102        var securityRoleGroupName = universalSpec.getSecurityRoleGroupName();
103        var parameterCount = (securityRoleGroupName == null ? 0 : 1) + EntityInstanceLogic.getInstance().countPossibleEntitySpecs(universalSpec);
104
105        switch(parameterCount) {
106            case 0 -> {
107                if(allowDefault) {
108                    securityRoleGroup = securityControl.getDefaultSecurityRoleGroup(entityPermission);
109
110                    if(securityRoleGroup == null) {
111                        handleExecutionError(UnknownDefaultSecurityRoleGroupException.class, eea, ExecutionErrors.UnknownDefaultSecurityRoleGroup.name());
112                    }
113                } else {
114                    handleExecutionError(InvalidParameterCountException.class, eea, ExecutionErrors.InvalidParameterCount.name());
115                }
116            }
117            case 1 -> {
118                if(securityRoleGroupName == null) {
119                    var entityInstance = EntityInstanceLogic.getInstance().getEntityInstance(eea, universalSpec,
120                            ComponentVendors.ECHO_THREE.name(), EntityTypes.SecurityRoleGroup.name());
121
122                    if(!eea.hasExecutionErrors()) {
123                        securityRoleGroup = securityControl.getSecurityRoleGroupByEntityInstance(entityInstance, entityPermission);
124                    }
125                } else {
126                    securityRoleGroup = getSecurityRoleGroupByName(eea, securityRoleGroupName, entityPermission);
127                }
128            }
129            default ->
130                    handleExecutionError(InvalidParameterCountException.class, eea, ExecutionErrors.InvalidParameterCount.name());
131        }
132
133        return securityRoleGroup;
134    }
135
136    public SecurityRoleGroup getSecurityRoleGroupByUniversalSpec(final ExecutionErrorAccumulator eea,
137            final SecurityRoleGroupUniversalSpec universalSpec, boolean allowDefault) {
138        return getSecurityRoleGroupByUniversalSpec(eea, universalSpec, allowDefault, EntityPermission.READ_ONLY);
139    }
140
141    public SecurityRoleGroup getSecurityRoleGroupByUniversalSpecForUpdate(final ExecutionErrorAccumulator eea,
142            final SecurityRoleGroupUniversalSpec universalSpec, boolean allowDefault) {
143        return getSecurityRoleGroupByUniversalSpec(eea, universalSpec, allowDefault, EntityPermission.READ_WRITE);
144    }
145
146    public void deleteSecurityRoleGroup(final ExecutionErrorAccumulator eea, final SecurityRoleGroup securityRoleGroup,
147            final BasePK deletedBy) {
148        securityControl.deleteSecurityRoleGroup(securityRoleGroup, deletedBy);
149    }
150
151}