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.control.user.security.server.command;
018
019import com.echothree.control.user.security.common.form.GetPartySecurityRoleTemplateDescriptionForm;
020import com.echothree.control.user.security.common.result.SecurityResultFactory;
021import com.echothree.model.control.party.common.PartyTypes;
022import com.echothree.model.control.party.server.control.PartyControl;
023import com.echothree.model.control.security.common.SecurityRoleGroups;
024import com.echothree.model.control.security.common.SecurityRoles;
025import com.echothree.model.control.security.server.control.SecurityControl;
026import com.echothree.model.data.user.common.pk.UserVisitPK;
027import com.echothree.util.common.message.ExecutionErrors;
028import com.echothree.util.common.validation.FieldDefinition;
029import com.echothree.util.common.validation.FieldType;
030import com.echothree.util.common.command.BaseResult;
031import com.echothree.util.server.control.BaseSimpleCommand;
032import com.echothree.util.server.control.CommandSecurityDefinition;
033import com.echothree.util.server.control.PartyTypeDefinition;
034import com.echothree.util.server.control.SecurityRoleDefinition;
035import com.echothree.util.server.persistence.Session;
036import java.util.Arrays;
037import java.util.Collections;
038import java.util.List;
039import javax.enterprise.context.RequestScoped;
040
041@RequestScoped
042public class GetPartySecurityRoleTemplateDescriptionCommand
043        extends BaseSimpleCommand<GetPartySecurityRoleTemplateDescriptionForm> {
044    
045    private final static CommandSecurityDefinition COMMAND_SECURITY_DEFINITION;
046    private final static List<FieldDefinition> FORM_FIELD_DEFINITIONS;
047    
048    static {
049        COMMAND_SECURITY_DEFINITION = new CommandSecurityDefinition(Collections.unmodifiableList(Arrays.asList(
050                new PartyTypeDefinition(PartyTypes.UTILITY.name(), null),
051                new PartyTypeDefinition(PartyTypes.EMPLOYEE.name(), Collections.unmodifiableList(Arrays.asList(
052                        new SecurityRoleDefinition(SecurityRoleGroups.PartySecurityRoleTemplate.name(), SecurityRoles.Description.name())
053                        )))
054                )));
055        
056        FORM_FIELD_DEFINITIONS = Collections.unmodifiableList(Arrays.asList(
057                new FieldDefinition("PartySecurityRoleTemplateName", FieldType.ENTITY_NAME, true, null, null),
058                new FieldDefinition("LanguageIsoName", FieldType.ENTITY_NAME, true, null, null)
059                ));
060    }
061    
062    /** Creates a new instance of GetPartySecurityRoleTemplateDescriptionCommand */
063    public GetPartySecurityRoleTemplateDescriptionCommand() {
064        super(COMMAND_SECURITY_DEFINITION, FORM_FIELD_DEFINITIONS, false);
065    }
066    
067    @Override
068    protected BaseResult execute() {
069        var securityControl = Session.getModelController(SecurityControl.class);
070        var result = SecurityResultFactory.getGetPartySecurityRoleTemplateDescriptionResult();
071        var partySecurityRoleTemplateName = form.getPartySecurityRoleTemplateName();
072        var partySecurityRoleTemplate = securityControl.getPartySecurityRoleTemplateByName(partySecurityRoleTemplateName);
073        
074        if(partySecurityRoleTemplate != null) {
075            var partyControl = Session.getModelController(PartyControl.class);
076            var languageIsoName = form.getLanguageIsoName();
077            var language = partyControl.getLanguageByIsoName(languageIsoName);
078            
079            if(language != null) {
080                var partySecurityRoleTemplateDescription = securityControl.getPartySecurityRoleTemplateDescription(partySecurityRoleTemplate,
081                        language);
082                
083                if(partySecurityRoleTemplateDescription != null) {
084                    result.setPartySecurityRoleTemplateDescription(securityControl.getPartySecurityRoleTemplateDescriptionTransfer(getUserVisit(),
085                            partySecurityRoleTemplateDescription));
086                } else {
087                    addExecutionError(ExecutionErrors.UnknownPartySecurityRoleTemplateDescription.name(), partySecurityRoleTemplateName, languageIsoName);
088                }
089            } else {
090                addExecutionError(ExecutionErrors.UnknownLanguageIsoName.name(), languageIsoName);
091            }
092        } else {
093            addExecutionError(ExecutionErrors.UnknownPartySecurityRoleTemplateName.name(), partySecurityRoleTemplateName);
094        }
095        
096        return result;
097    }
098    
099}