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 java.util.List;
030import javax.enterprise.context.Dependent;
031import javax.inject.Inject;
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    @Inject
047    EntityLockControl entityLockControl;
048
049    @Inject
050    EntityInstanceLogic entityInstanceLogic;
051
052    
053    /** Creates a new instance of UnlockEntityCommand */
054    public UnlockEntityCommand() {
055        super(null, FORM_FIELD_DEFINITIONS, false);
056    }
057    
058    @Override
059    protected BaseResult execute() {
060        var entityInstance = entityInstanceLogic.getEntityInstance(this, form, null);
061
062        if(!hasExecutionErrors()) {
063            var partyPK = getPartyPK();
064            
065            if(partyPK != null) {
066                var basePK = PersistenceUtils.getInstance().getBasePKFromEntityInstance(entityInstance);
067
068                if(entityLockControl.lockEntityForUpdate(basePK, getPartyPK())) {
069                    entityLockControl.unlockEntity(basePK, partyPK);
070                } else {
071                    addExecutionError(ExecutionErrors.EntityLockStale.name());
072                }
073            } else {
074                addExecutionError(ExecutionErrors.UserVisitHasNoParty.name());
075            }
076        }
077
078        return null;
079    }
080    
081}