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.UnlockEntityForm;
020import com.echothree.model.control.core.server.control.EntityLockControl;
021import com.echothree.model.control.core.server.logic.EntityInstanceLogic;
022import com.echothree.model.data.core.server.entity.EntityInstance;
023import com.echothree.model.data.user.common.pk.UserVisitPK;
024import com.echothree.util.common.message.ExecutionErrors;
025import com.echothree.util.common.validation.FieldDefinition;
026import com.echothree.util.common.validation.FieldType;
027import com.echothree.util.common.command.BaseResult;
028import com.echothree.util.common.persistence.BasePK;
029import com.echothree.util.server.control.BaseSimpleCommand;
030import com.echothree.util.server.persistence.PersistenceUtils;
031import com.echothree.util.server.persistence.Session;
032import java.util.Arrays;
033import java.util.Collections;
034import java.util.List;
035
036public class UnlockEntityCommand
037        extends BaseSimpleCommand<UnlockEntityForm> {
038    
039    private final static List<FieldDefinition> FORM_FIELD_DEFINITIONS;
040    
041    static {
042        FORM_FIELD_DEFINITIONS = Collections.unmodifiableList(Arrays.asList(
043                new FieldDefinition("EntityRef", FieldType.ENTITY_REF, false, null, null),
044                new FieldDefinition("Key", FieldType.KEY, false, null, null),
045                new FieldDefinition("Guid", FieldType.GUID, false, null, null),
046                new FieldDefinition("Ulid", FieldType.ULID, false, null, null)
047                ));
048    }
049    
050    /** Creates a new instance of UnlockEntityCommand */
051    public UnlockEntityCommand(UserVisitPK userVisitPK, UnlockEntityForm form) {
052        super(userVisitPK, form, null, FORM_FIELD_DEFINITIONS, false);
053    }
054    
055    @Override
056    protected BaseResult execute() {
057        var entityInstance = EntityInstanceLogic.getInstance().getEntityInstance(this, form, null);
058
059        if(!hasExecutionErrors()) {
060            var partyPK = getPartyPK();
061            
062            if(partyPK != null) {
063                var entityLockControl = Session.getModelController(EntityLockControl.class);
064                BasePK basePK = PersistenceUtils.getInstance().getBasePKFromEntityInstance(entityInstance);
065
066                if(entityLockControl.lockEntityForUpdate(basePK, getPartyPK())) {
067                    entityLockControl.unlockEntity(basePK, partyPK);
068                } else {
069                    addExecutionError(ExecutionErrors.EntityLockStale.name());
070                }
071            } else {
072                addExecutionError(ExecutionErrors.UserVisitHasNoParty.name());
073            }
074        }
075
076        return null;
077    }
078    
079}