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.GetSecurityRoleDescriptionForm;
020import com.echothree.control.user.security.common.result.GetSecurityRoleDescriptionResult;
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.SecurityRole;
029import com.echothree.model.data.security.server.entity.SecurityRoleDescription;
030import com.echothree.model.data.security.server.entity.SecurityRoleGroup;
031import com.echothree.model.data.user.common.pk.UserVisitPK;
032import com.echothree.util.common.message.ExecutionErrors;
033import com.echothree.util.common.validation.FieldDefinition;
034import com.echothree.util.common.validation.FieldType;
035import com.echothree.util.common.command.BaseResult;
036import com.echothree.util.server.control.BaseSimpleCommand;
037import com.echothree.util.server.control.CommandSecurityDefinition;
038import com.echothree.util.server.control.PartyTypeDefinition;
039import com.echothree.util.server.control.SecurityRoleDefinition;
040import com.echothree.util.server.persistence.Session;
041import java.util.Arrays;
042import java.util.Collections;
043import java.util.List;
044
045public class GetSecurityRoleDescriptionCommand
046        extends BaseSimpleCommand<GetSecurityRoleDescriptionForm> {
047    
048    private final static CommandSecurityDefinition COMMAND_SECURITY_DEFINITION;
049    private final static List<FieldDefinition> FORM_FIELD_DEFINITIONS;
050    
051    static {
052        COMMAND_SECURITY_DEFINITION = new CommandSecurityDefinition(Collections.unmodifiableList(Arrays.asList(
053                new PartyTypeDefinition(PartyTypes.UTILITY.name(), null),
054                new PartyTypeDefinition(PartyTypes.EMPLOYEE.name(), Collections.unmodifiableList(Arrays.asList(
055                        new SecurityRoleDefinition(SecurityRoleGroups.SecurityRoleGroup.name(), SecurityRoles.Description.name())
056                        )))
057                )));
058        
059        FORM_FIELD_DEFINITIONS = Collections.unmodifiableList(Arrays.asList(
060                new FieldDefinition("SecurityRoleGroupName", FieldType.ENTITY_NAME, true, null, null),
061                new FieldDefinition("SecurityRoleName", FieldType.ENTITY_NAME, true, null, null),
062                new FieldDefinition("LanguageIsoName", FieldType.ENTITY_NAME, true, null, null)
063                ));
064    }
065    
066    /** Creates a new instance of GetSecurityRoleDescriptionCommand */
067    public GetSecurityRoleDescriptionCommand(UserVisitPK userVisitPK, GetSecurityRoleDescriptionForm form) {
068        super(userVisitPK, form, COMMAND_SECURITY_DEFINITION, FORM_FIELD_DEFINITIONS, false);
069    }
070    
071    @Override
072    protected BaseResult execute() {
073        var securityControl = Session.getModelController(SecurityControl.class);
074        GetSecurityRoleDescriptionResult result = SecurityResultFactory.getGetSecurityRoleDescriptionResult();
075        String securityRoleGroupName = form.getSecurityRoleGroupName();
076        SecurityRoleGroup securityRoleGroup = securityControl.getSecurityRoleGroupByName(securityRoleGroupName);
077        
078        if(securityRoleGroup != null) {
079            String securityRoleName = form.getSecurityRoleName();
080            SecurityRole securityRole = securityControl.getSecurityRoleByName(securityRoleGroup, securityRoleName);
081            
082            if(securityRole != null) {
083                var partyControl = Session.getModelController(PartyControl.class);
084                String languageIsoName = form.getLanguageIsoName();
085                Language language = partyControl.getLanguageByIsoName(languageIsoName);
086                
087                if(language != null) {
088                    SecurityRoleDescription securityRoleDescription = securityControl.getSecurityRoleDescription(securityRole, language);
089                    
090                    if(securityRoleDescription != null) {
091                        result.setSecurityRoleDescription(securityControl.getSecurityRoleDescriptionTransfer(getUserVisit(), securityRoleDescription));
092                    } else {
093                        addExecutionError(ExecutionErrors.UnknownSecurityRoleDescription.name(), securityRoleGroupName, securityRoleName, languageIsoName);
094                    }
095                } else {
096                    addExecutionError(ExecutionErrors.UnknownLanguageIsoName.name(), languageIsoName);
097                }
098            } else {
099                addExecutionError(ExecutionErrors.UnknownSecurityRoleName.name(), securityRoleGroupName, securityRoleName);
100            }
101        } else {
102            addExecutionError(ExecutionErrors.UnknownSecurityRoleGroupName.name(), securityRoleGroupName);
103        }
104        
105        return result;
106    }
107    
108}