001// --------------------------------------------------------------------------------
002// Copyright 2002-2026 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.user.common.pk.UserVisitPK;
023import com.echothree.util.common.message.ExecutionErrors;
024import com.echothree.util.common.validation.FieldDefinition;
025import com.echothree.util.common.validation.FieldType;
026import com.echothree.util.common.command.BaseResult;
027import com.echothree.util.server.control.BaseSimpleCommand;
028import com.echothree.util.server.persistence.PersistenceUtils;
029import com.echothree.util.server.persistence.Session;
030import java.util.List;
031import javax.enterprise.context.Dependent;
032
033@Dependent
034public class UnlockEntityCommand
035        extends BaseSimpleCommand<UnlockEntityForm> {
036    
037    private final static List<FieldDefinition> FORM_FIELD_DEFINITIONS;
038    
039    static {
040        FORM_FIELD_DEFINITIONS = List.of(
041                new FieldDefinition("EntityRef", FieldType.ENTITY_REF, false, null, null),
042                new FieldDefinition("Uuid", FieldType.UUID, false, null, null)
043                );
044    }
045    
046    /** Creates a new instance of UnlockEntityCommand */
047    public UnlockEntityCommand() {
048        super(null, FORM_FIELD_DEFINITIONS, false);
049    }
050    
051    @Override
052    protected BaseResult execute() {
053        var entityInstance = EntityInstanceLogic.getInstance().getEntityInstance(this, form, null);
054
055        if(!hasExecutionErrors()) {
056            var partyPK = getPartyPK();
057            
058            if(partyPK != null) {
059                var entityLockControl = Session.getModelController(EntityLockControl.class);
060                var basePK = PersistenceUtils.getInstance().getBasePKFromEntityInstance(entityInstance);
061
062                if(entityLockControl.lockEntityForUpdate(basePK, getPartyPK())) {
063                    entityLockControl.unlockEntity(basePK, partyPK);
064                } else {
065                    addExecutionError(ExecutionErrors.EntityLockStale.name());
066                }
067            } else {
068                addExecutionError(ExecutionErrors.UserVisitHasNoParty.name());
069            }
070        }
071
072        return null;
073    }
074    
075}