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.GetPartySecurityRoleTemplateRoleForm;
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.security.server.logic.PartySecurityRoleTemplateLogic;
026import com.echothree.model.data.security.server.entity.PartySecurityRoleTemplateRole;
027import com.echothree.util.common.command.BaseResult;
028import com.echothree.util.common.validation.FieldDefinition;
029import com.echothree.util.common.validation.FieldType;
030import com.echothree.util.server.control.BaseSingleEntityCommand;
031import com.echothree.util.server.control.CommandSecurityDefinition;
032import com.echothree.util.server.control.PartyTypeDefinition;
033import com.echothree.util.server.control.SecurityRoleDefinition;
034import java.util.List;
035import javax.enterprise.context.Dependent;
036import javax.inject.Inject;
037
038@Dependent
039public class GetPartySecurityRoleTemplateRoleCommand
040        extends BaseSingleEntityCommand<PartySecurityRoleTemplateRole, GetPartySecurityRoleTemplateRoleForm> {
041    
042    private final static CommandSecurityDefinition COMMAND_SECURITY_DEFINITION;
043    private final static List<FieldDefinition> FORM_FIELD_DEFINITIONS;
044    
045    static {
046        COMMAND_SECURITY_DEFINITION = new CommandSecurityDefinition(List.of(
047                new PartyTypeDefinition(PartyTypes.UTILITY.name(), null),
048                new PartyTypeDefinition(PartyTypes.EMPLOYEE.name(), List.of(
049                        new SecurityRoleDefinition(SecurityRoleGroups.PartySecurityRoleTemplateRole.name(), SecurityRoles.Review.name())
050                ))
051        ));
052        
053        FORM_FIELD_DEFINITIONS = List.of(
054                new FieldDefinition("PartySecurityRoleTemplateName", FieldType.ENTITY_NAME, true, null, null),
055                new FieldDefinition("SecurityRoleGroupName", FieldType.ENTITY_NAME, true, null, null),
056                new FieldDefinition("SecurityRoleName", FieldType.ENTITY_NAME, true, null, null)
057        );
058    }
059
060    @Inject
061    SecurityControl securityControl;
062
063    @Inject
064    PartySecurityRoleTemplateLogic partySecurityRoleTemplateLogic;
065
066
067    /** Creates a new instance of GetPartySecurityRoleTemplateRoleCommand */
068    public GetPartySecurityRoleTemplateRoleCommand() {
069        super(COMMAND_SECURITY_DEFINITION, FORM_FIELD_DEFINITIONS, false);
070    }
071    
072    @Override
073    protected PartySecurityRoleTemplateRole getEntity() {
074        var partySecurityRoleTemplate = partySecurityRoleTemplateLogic.getPartySecurityRoleTemplateByName(this, form.getPartySecurityRoleTemplateName());
075        PartySecurityRoleTemplateRole partySecurityRoleTemplateRole = null;
076
077        if(!hasExecutionErrors()) {
078            var securityRole = securityRoleLogic.getSecurityRoleByName(this, form.getSecurityRoleGroupName(), form.getSecurityRoleName());
079
080            if(!hasExecutionErrors()) {
081                partySecurityRoleTemplateRole = securityControl.getPartySecurityRoleTemplateRole(partySecurityRoleTemplate, securityRole);
082
083                if(partySecurityRoleTemplateRole == null) {
084                    addExecutionError(com.echothree.util.common.message.ExecutionErrors.UnknownPartySecurityRoleTemplateRole.name(),
085                            partySecurityRoleTemplate.getLastDetail().getPartySecurityRoleTemplateName(),
086                            securityRole.getLastDetail().getSecurityRoleGroup().getLastDetail().getSecurityRoleGroupName(),
087                            securityRole.getLastDetail().getSecurityRoleName());
088                }
089            }
090        }
091
092        return partySecurityRoleTemplateRole;
093    }
094
095    @Override
096    protected BaseResult getResult(PartySecurityRoleTemplateRole partySecurityRoleTemplateRole) {
097        var result = SecurityResultFactory.getGetPartySecurityRoleTemplateRoleResult();
098
099        if(partySecurityRoleTemplateRole != null) {
100            result.setPartySecurityRoleTemplateRole(securityControl.getPartySecurityRoleTemplateRoleTransfer(getUserVisit(), partySecurityRoleTemplateRole));
101        }
102
103        return result;
104    }
105    
106}