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.GetBaseEncryptionKeyForm;
020import com.echothree.control.user.core.common.result.CoreResultFactory;
021import com.echothree.model.control.core.server.control.EncryptionKeyControl;
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.util.common.command.BaseResult;
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.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.List;
034import javax.enterprise.context.Dependent;
035import javax.inject.Inject;
036
037@Dependent
038public class GetBaseEncryptionKeyCommand
039        extends BaseSimpleCommand<GetBaseEncryptionKeyForm> {
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(List.of(
046                new PartyTypeDefinition(PartyTypes.UTILITY.name(), null),
047                new PartyTypeDefinition(PartyTypes.EMPLOYEE.name(), List.of(
048                        new SecurityRoleDefinition(SecurityRoleGroups.BaseEncryptionKey.name(), SecurityRoles.Review.name())
049                ))
050        ));
051        
052        FORM_FIELD_DEFINITIONS = List.of(
053                new FieldDefinition("BaseEncryptionKeyName", FieldType.ENTITY_NAME, false, null, null)
054        );
055    }
056
057    @Inject
058    EncryptionKeyControl encryptionKeyControl;
059
060    
061    /** Creates a new instance of GetBaseEncryptionKeyCommand */
062    public GetBaseEncryptionKeyCommand() {
063        super(COMMAND_SECURITY_DEFINITION, FORM_FIELD_DEFINITIONS, false);
064    }
065    
066    @Override
067    protected BaseResult execute() {
068        var result = CoreResultFactory.getGetBaseEncryptionKeyResult();
069        var baseEncryptionKeyName = form.getBaseEncryptionKeyName();
070        var baseEncryptionKey = baseEncryptionKeyName == null? null: encryptionKeyControl.getBaseEncryptionKeyByName(baseEncryptionKeyName);
071        
072        if(baseEncryptionKeyName == null || baseEncryptionKey != null) {
073            var userVisit = getUserVisit();
074            
075            if(baseEncryptionKey == null) {
076                result.setBaseEncryptionKey(encryptionKeyControl.getActiveBaseEncryptionKeyTransfer(userVisit));
077            } else {
078                result.setBaseEncryptionKey(encryptionKeyControl.getBaseEncryptionKeyTransfer(userVisit, baseEncryptionKey));
079            }
080        } else {
081            addExecutionError(ExecutionErrors.UnknownBaseEncryptionKeyName.name(), baseEncryptionKeyName);
082        }
083        
084        return result;
085    }
086    
087}