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.CreatePartySecurityRoleTemplateForm;
020import com.echothree.model.control.party.common.PartyTypes;
021import com.echothree.model.control.security.common.SecurityRoleGroups;
022import com.echothree.model.control.security.common.SecurityRoles;
023import com.echothree.model.control.security.server.control.SecurityControl;
024import com.echothree.model.data.party.common.pk.PartyPK;
025import com.echothree.model.data.security.server.entity.PartySecurityRoleTemplate;
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;
039
040public class CreatePartySecurityRoleTemplateCommand
041        extends BaseSimpleCommand<CreatePartySecurityRoleTemplateForm> {
042    
043    private final static CommandSecurityDefinition COMMAND_SECURITY_DEFINITION;
044    private final static List<FieldDefinition> FORM_FIELD_DEFINITIONS;
045    
046    static {
047        COMMAND_SECURITY_DEFINITION = new CommandSecurityDefinition(Collections.unmodifiableList(Arrays.asList(
048                new PartyTypeDefinition(PartyTypes.UTILITY.name(), null),
049                new PartyTypeDefinition(PartyTypes.EMPLOYEE.name(), Collections.unmodifiableList(Arrays.asList(
050                        new SecurityRoleDefinition(SecurityRoleGroups.PartySecurityRoleTemplate.name(), SecurityRoles.Create.name())
051                        )))
052                )));
053        
054        FORM_FIELD_DEFINITIONS = Collections.unmodifiableList(Arrays.asList(
055                new FieldDefinition("PartySecurityRoleTemplateName", FieldType.ENTITY_NAME, true, null, null),
056                new FieldDefinition("IsDefault", FieldType.BOOLEAN, true, null, null),
057                new FieldDefinition("SortOrder", FieldType.SIGNED_INTEGER, true, null, null),
058                new FieldDefinition("Description", FieldType.STRING, false, 1L, 132L)
059                ));
060    }
061    
062    /** Creates a new instance of CreatePartySecurityRoleTemplateCommand */
063    public CreatePartySecurityRoleTemplateCommand(UserVisitPK userVisitPK, CreatePartySecurityRoleTemplateForm form) {
064        super(userVisitPK, form, COMMAND_SECURITY_DEFINITION, FORM_FIELD_DEFINITIONS, false);
065    }
066    
067    @Override
068    protected BaseResult execute() {
069        var securityControl = Session.getModelController(SecurityControl.class);
070        String partySecurityRoleTemplateName = form.getPartySecurityRoleTemplateName();
071        PartySecurityRoleTemplate partySecurityRoleTemplate = securityControl.getPartySecurityRoleTemplateByName(partySecurityRoleTemplateName);
072        
073        if(partySecurityRoleTemplate == null) {
074            PartyPK createdBy = getPartyPK();
075            var isDefault = Boolean.valueOf(form.getIsDefault());
076            var sortOrder = Integer.valueOf(form.getSortOrder());
077            var description = form.getDescription();
078            
079            partySecurityRoleTemplate = securityControl.createPartySecurityRoleTemplate(partySecurityRoleTemplateName, isDefault,
080                    sortOrder, createdBy);
081            
082            if(description != null) {
083                securityControl.createPartySecurityRoleTemplateDescription(partySecurityRoleTemplate, getPreferredLanguage(),
084                        description, createdBy);
085            }
086        } else {
087            addExecutionError(ExecutionErrors.DuplicatePartySecurityRoleTemplateName.name(), partySecurityRoleTemplateName);
088        }
089        
090        return null;
091    }
092    
093}