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.GetServerServicesForm;
020import com.echothree.control.user.core.common.result.CoreResultFactory;
021import com.echothree.model.control.core.server.control.ServerControl;
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.Server;
026import com.echothree.model.data.core.server.entity.ServerService;
027import com.echothree.model.data.core.server.factory.ServerServiceFactory;
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 GetServerServicesCommand
043        extends BasePaginatedMultipleEntitiesCommand<ServerService, GetServerServicesForm> {
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.ServerService.name(), SecurityRoles.List.name())
053                ))
054        ));
055        
056        FORM_FIELD_DEFINITIONS = List.of(
057                new FieldDefinition("ServerName", FieldType.HOST_NAME, true, null, null)
058        );
059    }
060    
061    @Inject
062    ServerControl serverControl;
063
064    /** Creates a new instance of GetServerServicesCommand */
065    public GetServerServicesCommand() {
066        super(COMMAND_SECURITY_DEFINITION, FORM_FIELD_DEFINITIONS, false);
067    }
068    
069    Server server;
070
071    @Override
072    protected void handleForm() {
073        var serverName = form.getServerName();
074
075        server = serverControl.getServerByName(serverName);
076
077        if(server == null) {
078            addExecutionError(ExecutionErrors.UnknownServerName.name(), serverName);
079        }
080    }
081
082    @Override
083    protected Long getTotalEntities() {
084        return server == null ? null : serverControl.countServerServicesByServer(server);
085    }
086
087    @Override
088    protected Collection<ServerService> getEntities() {
089        return server == null ? null : serverControl.getServerServicesByServer(server);
090    }
091
092    @Override
093    protected BaseResult getResult(Collection<ServerService> entities) {
094        var result = CoreResultFactory.getGetServerServicesResult();
095        
096        if(server != null) {
097            var userVisit = getUserVisit();
098
099            result.setServer(serverControl.getServerTransfer(userVisit, server));
100
101            if(session.hasLimit(ServerServiceFactory.class)) {
102                result.setServerServicesCount(getTotalEntities());
103            }
104
105            result.setServerServices(serverControl.getServerServiceTransfersByServer(userVisit, server));
106        }
107        
108        return result;
109    }
110    
111}