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.shipment.server.command;
018
019import com.echothree.control.user.shipment.common.form.CreateShipmentAliasForm;
020import com.echothree.control.user.shipment.server.command.util.ShipmentAliasUtil;
021import com.echothree.model.control.party.common.PartyTypes;
022import com.echothree.model.control.security.common.SecurityRoles;
023import com.echothree.model.control.shipment.server.control.ShipmentControl;
024import com.echothree.util.common.command.BaseResult;
025import com.echothree.util.common.message.ExecutionErrors;
026import com.echothree.util.common.validation.FieldDefinition;
027import com.echothree.util.common.validation.FieldType;
028import com.echothree.util.server.control.BaseSimpleCommand;
029import com.echothree.util.server.control.CommandSecurityDefinition;
030import com.echothree.util.server.control.PartyTypeDefinition;
031import com.echothree.util.server.control.SecurityRoleDefinition;
032import com.echothree.util.server.persistence.Session;
033import java.util.List;
034import java.util.regex.Pattern;
035import javax.enterprise.context.Dependent;
036
037@Dependent
038public class CreateShipmentAliasCommand
039        extends BaseSimpleCommand<CreateShipmentAliasForm> {
040    
041    private final static List<FieldDefinition> FORM_FIELD_DEFINITIONS;
042    
043    static {
044        FORM_FIELD_DEFINITIONS = List.of(
045                new FieldDefinition("ShipmentTypeName", FieldType.ENTITY_NAME, true, null, null),
046                new FieldDefinition("ShipmentName", FieldType.ENTITY_NAME, true, null, null),
047                new FieldDefinition("ShipmentAliasTypeName", FieldType.ENTITY_NAME, true, null, null),
048                new FieldDefinition("Alias", FieldType.ENTITY_NAME, true, null, null)
049                );
050    }
051    
052    /** Creates a new instance of CreateShipmentAliasCommand */
053    public CreateShipmentAliasCommand() {
054        super(null, FORM_FIELD_DEFINITIONS, false);
055    }
056
057    @Override
058    protected CommandSecurityDefinition getCommandSecurityDefinition() {
059        return new CommandSecurityDefinition(List.of(
060                new PartyTypeDefinition(PartyTypes.UTILITY.name(), null),
061                new PartyTypeDefinition(PartyTypes.EMPLOYEE.name(), List.of(
062                        new SecurityRoleDefinition(ShipmentAliasUtil.getInstance().getSecurityRoleGroupNameByShipmentTypeSpec(form), SecurityRoles.Create.name())
063                ))
064        ));
065    }
066
067    @Override
068    protected BaseResult execute() {
069        var shipmentControl = Session.getModelController(ShipmentControl.class);
070        var shipmentTypeName = form.getShipmentTypeName();
071        var shipmentType = shipmentControl.getShipmentTypeByName(shipmentTypeName);
072
073        if(shipmentType != null) {
074            var shipmentName = form.getShipmentName();
075            var shipment = shipmentControl.getShipmentByName(shipmentType, shipmentName);
076
077            if(shipment != null) {
078                var shipmentAliasTypeName = form.getShipmentAliasTypeName();
079                var shipmentAliasType = shipmentControl.getShipmentAliasTypeByName(shipmentType, shipmentAliasTypeName);
080
081                if(shipmentAliasType != null) {
082                    var shipmentAliasTypeDetail = shipmentAliasType.getLastDetail();
083                    var validationPattern = shipmentAliasTypeDetail.getValidationPattern();
084                    var alias = form.getAlias();
085
086                    if(validationPattern != null) {
087                        var pattern = Pattern.compile(validationPattern);
088                        var m = pattern.matcher(alias);
089
090                        if(!m.matches()) {
091                            addExecutionError(ExecutionErrors.InvalidAlias.name(), alias);
092                        }
093                    }
094
095                    if(!hasExecutionErrors()) {
096                        if(shipmentControl.getShipmentAlias(shipment, shipmentAliasType) == null && shipmentControl.getShipmentAliasByAlias(shipmentAliasType, alias) == null) {
097                            shipmentControl.createShipmentAlias(shipment, shipmentAliasType, alias, getPartyPK());
098                        } else {
099                            addExecutionError(ExecutionErrors.DuplicateShipmentAlias.name(), shipmentTypeName, shipmentName, shipmentAliasTypeName, alias);
100                        }
101                    }
102                } else {
103                    addExecutionError(ExecutionErrors.UnknownShipmentAliasTypeName.name(), shipmentTypeName, shipmentAliasTypeName);
104                }
105            } else {
106                addExecutionError(ExecutionErrors.UnknownShipmentName.name(), shipmentTypeName, shipmentName);
107            }
108        } else {
109            addExecutionError(ExecutionErrors.UnknownShipmentTypeName.name(), shipmentTypeName);
110        }
111
112        return null;
113    }
114    
115}