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.GetCacheEntryDependenciesForm;
020import com.echothree.control.user.core.common.result.CoreResultFactory;
021import com.echothree.model.control.core.server.control.CacheEntryControl;
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.core.server.entity.CacheEntryDependency;
027import com.echothree.model.data.core.server.factory.CacheEntryDependencyFactory;
028import com.echothree.util.common.command.BaseResult;
029import com.echothree.util.common.message.ExecutionErrors;
030import com.echothree.util.common.validation.FieldDefinition;
031import com.echothree.util.common.validation.FieldType;
032import com.echothree.util.server.control.BasePaginatedMultipleEntitiesCommand;
033import com.echothree.util.server.control.CommandSecurityDefinition;
034import com.echothree.util.server.control.PartyTypeDefinition;
035import com.echothree.util.server.control.SecurityRoleDefinition;
036import java.util.Collection;
037import java.util.List;
038import javax.enterprise.context.Dependent;
039import javax.inject.Inject;
040
041@Dependent
042public class GetCacheEntryDependenciesCommand
043        extends BasePaginatedMultipleEntitiesCommand<CacheEntryDependency, GetCacheEntryDependenciesForm> {
044    
045    private final static CommandSecurityDefinition COMMAND_SECURITY_DEFINITION;
046    private final static List<FieldDefinition> FORM_FIELD_DEFINITIONS;
047    
048    static {
049        COMMAND_SECURITY_DEFINITION = new CommandSecurityDefinition(List.of(
050                new PartyTypeDefinition(PartyTypes.UTILITY.name(), null),
051                new PartyTypeDefinition(PartyTypes.EMPLOYEE.name(), List.of(
052                        new SecurityRoleDefinition(SecurityRoleGroups.CacheEntryDependency.name(), SecurityRoles.List.name())
053                ))
054        ));
055
056        FORM_FIELD_DEFINITIONS = List.of(
057                new FieldDefinition("CacheEntryKey", FieldType.STRING, true, 1L, 200L)
058        );
059    }
060
061    @Inject
062    CacheEntryControl cacheEntryControl;
063
064
065    /** Creates a new instance of GetCacheEntryDependenciesCommand */
066    public GetCacheEntryDependenciesCommand() {
067        super(COMMAND_SECURITY_DEFINITION, FORM_FIELD_DEFINITIONS, true);
068    }
069
070    CacheEntry cacheEntry;
071
072    @Override
073    protected void handleForm() {
074        var cacheEntryKey = form.getCacheEntryKey();
075
076        cacheEntry = cacheEntryControl.getCacheEntryByCacheEntryKey(cacheEntryKey);
077
078        if(cacheEntry == null) {
079            addExecutionError(ExecutionErrors.UnknownCacheEntryKey.name(), cacheEntryKey);
080        }
081    }
082
083    @Override
084    protected Long getTotalEntities() {
085        return hasExecutionErrors() ? null : cacheEntryControl.countCacheEntryDependenciesByCacheEntry(cacheEntry);
086    }
087
088    @Override
089    protected Collection<CacheEntryDependency> getEntities() {
090        return hasExecutionErrors() ? null : cacheEntryControl.getCacheEntryDependenciesByCacheEntry(cacheEntry);
091    }
092
093    @Override
094    protected BaseResult getResult(Collection<CacheEntryDependency> entities) {
095        var result = CoreResultFactory.getGetCacheEntryDependenciesResult();
096
097        if(entities != null) {
098            var userVisit = getUserVisit();
099
100            result.setCacheEntry(cacheEntryControl.getCacheEntryTransfer(userVisit, cacheEntry));
101
102            if(session.hasLimit(CacheEntryDependencyFactory.class)) {
103                result.setCacheEntryDependencyCount(getTotalEntities());
104            }
105
106            result.setCacheEntryDependencies(cacheEntryControl.getCacheEntryDependencyTransfers(userVisit, entities));
107        }
108
109        return result;
110    }
111    
112}