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