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.model.data.core.server.entity.BaseEncryptionKey;
026import com.echothree.util.common.command.BaseResult;
027import com.echothree.util.common.message.ExecutionErrors;
028import com.echothree.util.common.validation.FieldDefinition;
029import com.echothree.util.common.validation.FieldType;
030import com.echothree.util.server.control.BaseSingleEntityCommand;
031import com.echothree.util.server.control.CommandSecurityDefinition;
032import com.echothree.util.server.control.PartyTypeDefinition;
033import com.echothree.util.server.control.SecurityRoleDefinition;
034import java.util.List;
035import javax.enterprise.context.Dependent;
036import javax.inject.Inject;
037
038@Dependent
039public class GetBaseEncryptionKeyCommand
040        extends BaseSingleEntityCommand<BaseEncryptionKey, GetBaseEncryptionKeyForm> {
041    
042    private final static CommandSecurityDefinition COMMAND_SECURITY_DEFINITION;
043    private final static List<FieldDefinition> FORM_FIELD_DEFINITIONS;
044    
045    static {
046        COMMAND_SECURITY_DEFINITION = new CommandSecurityDefinition(List.of(
047                new PartyTypeDefinition(PartyTypes.UTILITY.name(), null),
048                new PartyTypeDefinition(PartyTypes.EMPLOYEE.name(), List.of(
049                        new SecurityRoleDefinition(SecurityRoleGroups.BaseEncryptionKey.name(), SecurityRoles.Review.name())
050                ))
051        ));
052        
053        FORM_FIELD_DEFINITIONS = List.of(
054                new FieldDefinition("BaseEncryptionKeyName", FieldType.ENTITY_NAME, false, null, null)
055        );
056    }
057
058    @Inject
059    EncryptionKeyControl encryptionKeyControl;
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 BaseEncryptionKey getEntity() {
068        var baseEncryptionKeyName = form.getBaseEncryptionKeyName();
069        var baseEncryptionKey = baseEncryptionKeyName == null ? encryptionKeyControl.getActiveBaseEncryptionKey()
070                : encryptionKeyControl.getBaseEncryptionKeyByName(baseEncryptionKeyName);
071
072        if(baseEncryptionKeyName != null && baseEncryptionKey == null) {
073            addExecutionError(ExecutionErrors.UnknownBaseEncryptionKeyName.name(), baseEncryptionKeyName);
074        }
075
076        return baseEncryptionKey;
077    }
078
079    @Override
080    protected BaseResult getResult(BaseEncryptionKey baseEncryptionKey) {
081        var result = CoreResultFactory.getGetBaseEncryptionKeyResult();
082
083        if(baseEncryptionKey != null) {
084            result.setBaseEncryptionKey(encryptionKeyControl.getBaseEncryptionKeyTransfer(getUserVisit(), baseEncryptionKey));
085        }
086
087        return result;
088    }
089    
090}