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.CreateServiceForm;
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.Service;
026import com.echothree.model.data.user.common.pk.UserVisitPK;
027import com.echothree.util.common.command.BaseResult;
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.server.control.BaseSimpleCommand;
032import com.echothree.util.server.control.CommandSecurityDefinition;
033import com.echothree.util.server.control.PartyTypeDefinition;
034import com.echothree.util.server.control.SecurityRoleDefinition;
035import java.util.List;
036import javax.enterprise.context.Dependent;
037import javax.inject.Inject;
038
039@Dependent
040public class CreateServiceCommand
041        extends BaseSimpleCommand<CreateServiceForm> {
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(List.of(
048                new PartyTypeDefinition(PartyTypes.UTILITY.name(), null),
049                new PartyTypeDefinition(PartyTypes.EMPLOYEE.name(), List.of(
050                        new SecurityRoleDefinition(SecurityRoleGroups.Service.name(), SecurityRoles.Create.name())
051                ))
052        ));
053        
054        FORM_FIELD_DEFINITIONS = List.of(
055                new FieldDefinition("ServiceName", FieldType.ENTITY_NAME, true, null, null),
056                new FieldDefinition("Port", FieldType.UNSIGNED_INTEGER, true, 1L, 65535L),
057                new FieldDefinition("ProtocolName", FieldType.ENTITY_NAME, true, null, null),
058                new FieldDefinition("IsDefault", FieldType.BOOLEAN, true, null, null),
059                new FieldDefinition("SortOrder", FieldType.SIGNED_INTEGER, true, null, null),
060                new FieldDefinition("Description", FieldType.STRING, false, 1L, 132L)
061        );
062    }
063
064    @Inject
065    ServerControl serverControl;
066
067    
068    /** Creates a new instance of CreateServiceCommand */
069    public CreateServiceCommand() {
070        super(COMMAND_SECURITY_DEFINITION, FORM_FIELD_DEFINITIONS, false);
071    }
072    
073    @Override
074    protected BaseResult execute() {
075        var result = CoreResultFactory.getCreateServiceResult();
076        var serviceName = form.getServiceName();
077        var service = serverControl.getServiceByName(serviceName);
078        
079        if(service == null) {
080            var protocolName = form.getProtocolName();
081            var protocol = serverControl.getProtocolByName(protocolName);
082
083            if(protocol != null) {
084                var partyPK = getPartyPK();
085                var port = Integer.valueOf(form.getPort());
086                var isDefault = Boolean.valueOf(form.getIsDefault());
087                var sortOrder = Integer.valueOf(form.getSortOrder());
088                var description = form.getDescription();
089
090                service = serverControl.createService(serviceName, port, protocol, isDefault, sortOrder, partyPK);
091
092                if(description != null) {
093                    serverControl.createServiceDescription(service, getPreferredLanguage(), description, partyPK);
094                }
095            } else {
096                addExecutionError(ExecutionErrors.UnknownProtocolName.name(), protocolName);
097            }
098        } else {
099            addExecutionError(ExecutionErrors.DuplicateServiceName.name(), serviceName);
100        }
101        
102        if(service != null) {
103            result.setEntityRef(service.getPrimaryKey().getEntityRef());
104            result.setServiceName(service.getLastDetail().getServiceName());
105        }
106
107        return result;
108    }
109    
110}