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.GetCacheEntryForm;
020import com.echothree.control.user.core.common.result.CoreResultFactory;
021import com.echothree.model.control.core.server.control.CacheEntryControl;
022import com.echothree.model.data.core.server.entity.CacheEntry;
023import com.echothree.util.common.command.BaseResult;
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.server.control.BaseSingleEntityCommand;
028import java.util.List;
029import javax.enterprise.context.Dependent;
030import javax.inject.Inject;
031
032@Dependent
033public class GetCacheEntryCommand
034        extends BaseSingleEntityCommand<CacheEntry, GetCacheEntryForm> {
035    
036    private final static List<FieldDefinition> FORM_FIELD_DEFINITIONS;
037    
038    static {
039        FORM_FIELD_DEFINITIONS = List.of(
040                new FieldDefinition("CacheEntryKey", FieldType.STRING, true, 1L, 200L)
041        );
042    }
043
044    @Inject
045    CacheEntryControl cacheEntryControl;
046
047    /** Creates a new instance of GetCacheEntryCommand */
048    public GetCacheEntryCommand() {
049        super(null, FORM_FIELD_DEFINITIONS, true);
050    }
051    
052    @Override
053    protected CacheEntry getEntity() {
054        var cacheEntryKey = form.getCacheEntryKey();
055        var cacheEntry = cacheEntryControl.getCacheEntryByCacheEntryKey(cacheEntryKey);
056
057        if(cacheEntry != null) {
058            var validUntilTime = cacheEntry.getValidUntilTime();
059
060            if(validUntilTime != null && validUntilTime < session.getStartTime()) {
061                cacheEntryControl.removeCacheEntry(cacheEntry);
062                cacheEntry = null;
063            }
064        }
065
066        if(cacheEntry == null) {
067            addExecutionError(ExecutionErrors.UnknownCacheEntryKey.name(), cacheEntryKey);
068        }
069
070        return cacheEntry;
071    }
072
073    @Override
074    protected BaseResult getResult(CacheEntry cacheEntry) {
075        var result = CoreResultFactory.getGetCacheEntryResult();
076
077        if(cacheEntry != null) {
078            result.setCacheEntry(cacheEntryControl.getCacheEntryTransfer(getUserVisit(), cacheEntry));
079        }
080
081        return result;
082    }
083    
084}