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.GetCacheEntriesForm;
020import com.echothree.control.user.core.common.result.CoreResultFactory;
021import com.echothree.control.user.core.common.result.GetCacheEntriesResult;
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.factory.CacheEntryFactory;
026import com.echothree.model.data.user.common.pk.UserVisitPK;
027import com.echothree.util.common.validation.FieldDefinition;
028import com.echothree.util.common.command.BaseResult;
029import com.echothree.util.server.control.BaseSimpleCommand;
030import com.echothree.util.server.control.CommandSecurityDefinition;
031import com.echothree.util.server.control.PartyTypeDefinition;
032import com.echothree.util.server.control.SecurityRoleDefinition;
033import java.util.Arrays;
034import java.util.Collections;
035import java.util.List;
036
037public class GetCacheEntriesCommand
038        extends BaseSimpleCommand<GetCacheEntriesForm> {
039    
040    private final static CommandSecurityDefinition COMMAND_SECURITY_DEFINITION;
041    private final static List<FieldDefinition> FORM_FIELD_DEFINITIONS;
042
043    static {
044        COMMAND_SECURITY_DEFINITION = new CommandSecurityDefinition(Collections.unmodifiableList(Arrays.asList(
045                new PartyTypeDefinition(PartyTypes.UTILITY.name(), null),
046                new PartyTypeDefinition(PartyTypes.EMPLOYEE.name(), Collections.unmodifiableList(Arrays.asList(
047                        new SecurityRoleDefinition(SecurityRoleGroups.CacheEntry.name(), SecurityRoles.List.name())
048                        )))
049                )));
050
051        FORM_FIELD_DEFINITIONS = Collections.unmodifiableList(Arrays.asList(
052                ));
053    }
054
055    /** Creates a new instance of GetCacheEntriesCommand */
056    public GetCacheEntriesCommand(UserVisitPK userVisitPK, GetCacheEntriesForm form) {
057        super(userVisitPK, form, COMMAND_SECURITY_DEFINITION, FORM_FIELD_DEFINITIONS, true);
058    }
059    
060    @Override
061    protected BaseResult execute() {
062        var coreControl = getCoreControl();
063        GetCacheEntriesResult result = CoreResultFactory.getGetCacheEntriesResult();
064
065        if(session.hasLimit(CacheEntryFactory.class)) {
066            result.setCacheEntryCount(coreControl.countCacheEntries());
067        }
068
069        result.setCacheEntries(coreControl.getCacheEntryTransfers(getUserVisit()));
070        
071        return result;
072    }
073    
074}