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.user.common.pk.UserVisitPK;
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.BaseSimpleCommand;
028import com.echothree.util.server.persistence.Session;
029import java.util.List;
030import javax.enterprise.context.Dependent;
031
032@Dependent
033public class GetCacheEntryCommand
034        extends BaseSimpleCommand<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    /** Creates a new instance of GetCacheEntryCommand */
045    public GetCacheEntryCommand() {
046        super(null, FORM_FIELD_DEFINITIONS, true);
047    }
048    
049    @Override
050    protected BaseResult execute() {
051        var cacheEntryControl = Session.getModelController(CacheEntryControl.class);
052        var result = CoreResultFactory.getGetCacheEntryResult();
053        var cacheEntryKey = form.getCacheEntryKey();
054        var cacheEntryTransfer = cacheEntryControl.getCacheEntryTransferByCacheEntryKey(getUserVisit(), cacheEntryKey);
055
056        if(cacheEntryTransfer != null) {
057            result.setCacheEntry(cacheEntryTransfer);
058        } else {
059            addExecutionError(ExecutionErrors.UnknownCacheEntryKey.name(), cacheEntryKey);
060        }
061        
062        return result;
063    }
064    
065}