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.core.server.command;
018
019import com.echothree.control.user.core.common.form.GenerateKeyForm;
020import com.echothree.control.user.core.common.result.CoreResultFactory;
021import com.echothree.model.control.core.server.logic.EntityInstanceLogic;
022import com.echothree.model.control.party.common.PartyTypes;
023import com.echothree.model.data.user.common.pk.UserVisitPK;
024import com.echothree.util.common.command.BaseResult;
025import com.echothree.util.common.validation.FieldDefinition;
026import com.echothree.util.common.validation.FieldType;
027import com.echothree.util.server.control.BaseSimpleCommand;
028import com.echothree.util.server.control.CommandSecurityDefinition;
029import com.echothree.util.server.control.PartyTypeDefinition;
030import java.util.Arrays;
031import java.util.Collections;
032import java.util.List;
033
034public class GenerateKeyCommand
035        extends BaseSimpleCommand<GenerateKeyForm> {
036    
037    private final static CommandSecurityDefinition COMMAND_SECURITY_DEFINITION;
038    private final static List<FieldDefinition> FORM_FIELD_DEFINITIONS;
039    
040    static {
041        COMMAND_SECURITY_DEFINITION = new CommandSecurityDefinition(Collections.unmodifiableList(Arrays.asList(
042                new PartyTypeDefinition(PartyTypes.UTILITY.name(), null),
043                new PartyTypeDefinition(PartyTypes.EMPLOYEE.name(), null)
044                )));
045        
046        FORM_FIELD_DEFINITIONS = Collections.unmodifiableList(Arrays.asList(
047                new FieldDefinition("EntityRef", FieldType.ENTITY_REF, false, null, null),
048                new FieldDefinition("Key", FieldType.KEY, false, null, null),
049                new FieldDefinition("Guid", FieldType.GUID, false, null, null),
050                new FieldDefinition("Ulid", FieldType.ULID, false, null, null),
051                new FieldDefinition("ForceRegeneration", FieldType.BOOLEAN, false, null, null)
052                ));
053    }
054    
055    /** Creates a new instance of GenerateKeyCommand */
056    public GenerateKeyCommand(UserVisitPK userVisitPK, GenerateKeyForm form) {
057        super(userVisitPK, form, COMMAND_SECURITY_DEFINITION, FORM_FIELD_DEFINITIONS, true);
058    }
059    
060    @Override
061    protected BaseResult execute() {
062        var result = CoreResultFactory.getGenerateKeyResult();
063        var entityInstance = EntityInstanceLogic.getInstance().getEntityInstance(this, form, null);
064        
065        if(!hasExecutionErrors()) {
066            result.setKey(getCoreControl().ensureKeyForEntityInstance(entityInstance, Boolean.valueOf(form.getForceRegeneration())).getKey());
067        }
068        
069        return result;
070    }
071    
072}