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.CreateServiceForm;
020import com.echothree.model.control.party.common.PartyTypes;
021import com.echothree.model.control.security.common.SecurityRoleGroups;
022import com.echothree.model.control.security.common.SecurityRoles;
023import com.echothree.model.data.core.server.entity.Protocol;
024import com.echothree.model.data.core.server.entity.Service;
025import com.echothree.model.data.user.common.pk.UserVisitPK;
026import com.echothree.util.common.message.ExecutionErrors;
027import com.echothree.util.common.validation.FieldDefinition;
028import com.echothree.util.common.validation.FieldType;
029import com.echothree.util.common.command.BaseResult;
030import com.echothree.util.server.control.BaseSimpleCommand;
031import com.echothree.util.server.control.CommandSecurityDefinition;
032import com.echothree.util.server.control.PartyTypeDefinition;
033import com.echothree.util.server.control.SecurityRoleDefinition;
034import java.util.Arrays;
035import java.util.Collections;
036import java.util.List;
037
038public class CreateServiceCommand
039        extends BaseSimpleCommand<CreateServiceForm> {
040    
041    private final static CommandSecurityDefinition COMMAND_SECURITY_DEFINITION;
042    private final static List<FieldDefinition> FORM_FIELD_DEFINITIONS;
043    
044    static {
045        COMMAND_SECURITY_DEFINITION = new CommandSecurityDefinition(Collections.unmodifiableList(Arrays.asList(
046                new PartyTypeDefinition(PartyTypes.UTILITY.name(), null),
047                new PartyTypeDefinition(PartyTypes.EMPLOYEE.name(), Collections.unmodifiableList(Arrays.asList(
048                        new SecurityRoleDefinition(SecurityRoleGroups.Service.name(), SecurityRoles.Create.name())
049                        )))
050                )));
051        
052        FORM_FIELD_DEFINITIONS = Collections.unmodifiableList(Arrays.asList(
053                new FieldDefinition("ServiceName", FieldType.ENTITY_NAME, true, null, null),
054                new FieldDefinition("Port", FieldType.UNSIGNED_INTEGER, true, 1L, 65535L),
055                new FieldDefinition("ProtocolName", FieldType.ENTITY_NAME, true, null, null),
056                new FieldDefinition("IsDefault", FieldType.BOOLEAN, true, null, null),
057                new FieldDefinition("SortOrder", FieldType.SIGNED_INTEGER, true, null, null),
058                new FieldDefinition("Description", FieldType.STRING, false, 1L, 132L)
059                ));
060    }
061    
062    /** Creates a new instance of CreateServiceCommand */
063    public CreateServiceCommand(UserVisitPK userVisitPK, CreateServiceForm form) {
064        super(userVisitPK, form, COMMAND_SECURITY_DEFINITION, FORM_FIELD_DEFINITIONS, false);
065    }
066    
067    @Override
068    protected BaseResult execute() {
069        var coreControl = getCoreControl();
070        String serviceName = form.getServiceName();
071        Service service = coreControl.getServiceByName(serviceName);
072        
073        if(service == null) {
074            String protocolName = form.getProtocolName();
075            Protocol protocol = coreControl.getProtocolByName(protocolName);
076
077            if(protocol != null) {
078                var partyPK = getPartyPK();
079                Integer port = Integer.valueOf(form.getPort());
080                var isDefault = Boolean.valueOf(form.getIsDefault());
081                var sortOrder = Integer.valueOf(form.getSortOrder());
082                var description = form.getDescription();
083
084                service = coreControl.createService(serviceName, port, protocol, isDefault, sortOrder, partyPK);
085
086                if(description != null) {
087                    coreControl.createServiceDescription(service, getPreferredLanguage(), description, partyPK);
088                }
089            } else {
090                addExecutionError(ExecutionErrors.UnknownProtocolName.name(), protocolName);
091            }
092        } else {
093            addExecutionError(ExecutionErrors.DuplicateServiceName.name(), serviceName);
094        }
095        
096        return null;
097    }
098    
099}