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.RemoveCacheEntryForm;
020import com.echothree.model.control.core.server.control.CacheEntryControl;
021import com.echothree.model.data.user.common.pk.UserVisitPK;
022import com.echothree.util.common.command.BaseResult;
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.server.control.BaseSimpleCommand;
027import com.echothree.util.server.persistence.Session;
028import java.util.List;
029import javax.enterprise.context.Dependent;
030
031@Dependent
032public class RemoveCacheEntryCommand
033        extends BaseSimpleCommand<RemoveCacheEntryForm> {
034    
035    private final static List<FieldDefinition> FORM_FIELD_DEFINITIONS;
036    
037    static {
038        FORM_FIELD_DEFINITIONS = List.of(
039                new FieldDefinition("CacheEntryKey", FieldType.STRING, false, 1L, 200L)
040                );
041    }
042    
043    /** Creates a new instance of RemoveCacheEntryCommand */
044    public RemoveCacheEntryCommand() {
045        super(null, FORM_FIELD_DEFINITIONS, false);
046    }
047    
048    @Override
049    protected BaseResult execute() {
050        var cacheEntryControl = Session.getModelController(CacheEntryControl.class);
051        var cacheEntryKey = form.getCacheEntryKey();
052        
053        if(cacheEntryKey == null) {
054            cacheEntryControl.removeCacheEntries();
055        } else {
056            var cacheEntry = cacheEntryControl.getCacheEntryByCacheEntryKeyForUpdate(cacheEntryKey);
057
058            if(cacheEntry != null) {
059                cacheEntryControl.removeCacheEntry(cacheEntry);
060            } else {
061                addExecutionError(ExecutionErrors.UnknownCacheEntryKey.name(), cacheEntryKey);
062            }
063        }
064        
065        return null;
066    }
067    
068}