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