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.GetCacheEntryDependenciesForm;
020import com.echothree.control.user.core.common.result.CoreResultFactory;
021import com.echothree.control.user.core.common.result.GetCacheEntryDependenciesResult;
022import com.echothree.model.control.party.common.PartyTypes;
023import com.echothree.model.control.security.common.SecurityRoleGroups;
024import com.echothree.model.control.security.common.SecurityRoles;
025import com.echothree.model.data.core.server.entity.CacheEntry;
026import com.echothree.model.data.user.common.pk.UserVisitPK;
027import com.echothree.model.data.user.server.entity.UserVisit;
028import com.echothree.util.common.message.ExecutionErrors;
029import com.echothree.util.common.validation.FieldDefinition;
030import com.echothree.util.common.validation.FieldType;
031import com.echothree.util.common.command.BaseResult;
032import com.echothree.util.server.control.BaseSimpleCommand;
033import com.echothree.util.server.control.CommandSecurityDefinition;
034import com.echothree.util.server.control.PartyTypeDefinition;
035import com.echothree.util.server.control.SecurityRoleDefinition;
036import java.util.Arrays;
037import java.util.Collections;
038import java.util.List;
039
040public class GetCacheEntryDependenciesCommand
041        extends BaseSimpleCommand<GetCacheEntryDependenciesForm> {
042    
043    private final static CommandSecurityDefinition COMMAND_SECURITY_DEFINITION;
044    private final static List<FieldDefinition> FORM_FIELD_DEFINITIONS;
045    
046    static {
047        COMMAND_SECURITY_DEFINITION = new CommandSecurityDefinition(Collections.unmodifiableList(Arrays.asList(
048                new PartyTypeDefinition(PartyTypes.UTILITY.name(), null),
049                new PartyTypeDefinition(PartyTypes.EMPLOYEE.name(), Collections.unmodifiableList(Arrays.asList(
050                        new SecurityRoleDefinition(SecurityRoleGroups.CacheEntryDependency.name(), SecurityRoles.List.name())
051                        )))
052                )));
053
054        FORM_FIELD_DEFINITIONS = Collections.unmodifiableList(Arrays.asList(
055                new FieldDefinition("CacheEntryKey", FieldType.STRING, true, 1L, 200L)
056                ));
057    }
058    
059    /** Creates a new instance of GetCacheEntryDependenciesCommand */
060    public GetCacheEntryDependenciesCommand(UserVisitPK userVisitPK, GetCacheEntryDependenciesForm form) {
061        super(userVisitPK, form, COMMAND_SECURITY_DEFINITION, FORM_FIELD_DEFINITIONS, true);
062    }
063    
064    @Override
065    protected BaseResult execute() {
066        var coreControl = getCoreControl();
067        GetCacheEntryDependenciesResult result = CoreResultFactory.getGetCacheEntryDependenciesResult();
068        String cacheEntryKey = form.getCacheEntryKey();
069        CacheEntry cacheEntry = coreControl.getCacheEntryByCacheEntryKey(cacheEntryKey);
070
071        if(cacheEntry != null) {
072            UserVisit userVisit = getUserVisit();
073            
074            result.setCacheEntry(coreControl.getCacheEntryTransfer(userVisit, cacheEntry));
075            result.setCacheEntryDependencies(coreControl.getCacheEntryDependencyTransfersByCacheEntry(userVisit, cacheEntry));
076        } else {
077            addExecutionError(ExecutionErrors.UnknownCacheEntryKey.name(), cacheEntryKey);
078        }
079        
080        return result;
081    }
082    
083}