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.control.user.security.server.command;
018
019import com.echothree.control.user.security.common.form.GetSecurityRoleChoicesForm;
020import com.echothree.control.user.security.common.result.SecurityResultFactory;
021import com.echothree.model.control.party.common.PartyTypes;
022import com.echothree.model.control.security.common.SecurityRoleGroups;
023import com.echothree.model.control.security.common.SecurityRoles;
024import com.echothree.model.control.security.server.control.SecurityControl;
025import com.echothree.model.control.workflow.server.control.WorkflowControl;
026import com.echothree.model.data.security.server.entity.SecurityRoleGroup;
027import com.echothree.model.data.user.common.pk.UserVisitPK;
028import com.echothree.util.common.message.ExecutionErrors;
029import com.echothree.util.common.validation.FieldDefinition;
030import com.echothree.util.common.validation.FieldType;
031import com.echothree.util.common.command.BaseResult;
032import com.echothree.util.server.control.BaseSimpleCommand;
033import com.echothree.util.server.control.CommandSecurityDefinition;
034import com.echothree.util.server.control.PartyTypeDefinition;
035import com.echothree.util.server.control.SecurityRoleDefinition;
036import com.echothree.util.server.persistence.Session;
037import java.util.List;
038import javax.enterprise.context.Dependent;
039
040@Dependent
041public class GetSecurityRoleChoicesCommand
042        extends BaseSimpleCommand<GetSecurityRoleChoicesForm> {
043    
044    private final static CommandSecurityDefinition COMMAND_SECURITY_DEFINITION;
045    private final static List<FieldDefinition> FORM_FIELD_DEFINITIONS;
046    
047    static {
048        COMMAND_SECURITY_DEFINITION = new CommandSecurityDefinition(List.of(
049                new PartyTypeDefinition(PartyTypes.EMPLOYEE.name(), List.of(
050                    new SecurityRoleDefinition(SecurityRoleGroups.SecurityRole.name(), SecurityRoles.Choices.name())
051                    ))
052                ));
053        
054        FORM_FIELD_DEFINITIONS = List.of(
055                new FieldDefinition("SecurityRoleGroupName", FieldType.ENTITY_NAME, false, null, null),
056                new FieldDefinition("WorkflowName", FieldType.ENTITY_NAME, false, null, null),
057                new FieldDefinition("DefaultSecurityRoleChoice", FieldType.ENTITY_NAME, false, null, null),
058                new FieldDefinition("AllowNullChoice", FieldType.BOOLEAN, true, null, null)
059                );
060    }
061    
062    /** Creates a new instance of GetSecurityRoleChoicesCommand */
063    public GetSecurityRoleChoicesCommand() {
064        super(COMMAND_SECURITY_DEFINITION, FORM_FIELD_DEFINITIONS, false);
065    }
066    
067    @Override
068    protected BaseResult execute() {
069        var result = SecurityResultFactory.getGetSecurityRoleChoicesResult();
070        var securityRoleGroupName = form.getSecurityRoleGroupName();
071        var workflowName = form.getWorkflowName();
072        var parameterCount = (securityRoleGroupName == null ? 0 : 1) + (workflowName == null ? 0 : 1);
073        
074        if(parameterCount == 1) {
075            var securityControl = Session.getModelController(SecurityControl.class);
076            SecurityRoleGroup securityRoleGroup = null;
077            
078            if(securityRoleGroupName != null) {
079                securityRoleGroup = securityControl.getSecurityRoleGroupByName(securityRoleGroupName);
080
081                if(securityRoleGroup == null) {
082                    addExecutionError(ExecutionErrors.UnknownSecurityRoleGroupName.name(), securityRoleGroupName);
083                }
084            } else {
085                var workflowControl = Session.getModelController(WorkflowControl.class);
086                var workflow = workflowControl.getWorkflowByName(workflowName);
087
088                if(workflow != null) {
089                    securityRoleGroup = workflow.getLastDetail().getSecurityRoleGroup();
090                    
091                    if(securityRoleGroup == null) {
092                        addExecutionError(ExecutionErrors.WorkflowMissingSecurityRoleGroup.name(), workflowName);
093                    }
094                } else {
095                    addExecutionError(ExecutionErrors.UnknownWorkflowName.name(), workflowName);
096                }
097            }
098            
099            if(!hasExecutionErrors()) {
100                var defaultSecurityRoleChoice = form.getDefaultSecurityRoleChoice();
101                var allowNullChoice = Boolean.parseBoolean(form.getAllowNullChoice());
102
103                result.setSecurityRoleChoices(securityControl.getSecurityRoleChoices(defaultSecurityRoleChoice, getPreferredLanguage(), allowNullChoice,
104                        securityRoleGroup));
105            }
106        } else {
107            addExecutionError(ExecutionErrors.InvalidParameterCount.name());
108        }
109        
110        return result;
111    }
112    
113}