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.model.control.security.server.indexer;
018
019import com.echothree.model.control.index.common.IndexConstants;
020import com.echothree.model.control.index.common.IndexFieldVariations;
021import com.echothree.model.control.index.common.IndexFields;
022import com.echothree.model.control.index.server.indexer.BaseIndexer;
023import com.echothree.model.control.index.server.indexer.FieldTypes;
024import com.echothree.model.control.security.server.analyzer.SecurityRoleAnalyzer;
025import com.echothree.model.control.security.server.control.SecurityControl;
026import com.echothree.model.data.core.server.entity.EntityInstance;
027import com.echothree.model.data.index.server.entity.Index;
028import com.echothree.model.data.security.server.entity.SecurityRole;
029import com.echothree.util.server.message.ExecutionErrorAccumulator;
030import javax.enterprise.context.Dependent;
031import javax.inject.Inject;
032import org.apache.lucene.analysis.Analyzer;
033import org.apache.lucene.document.Document;
034import org.apache.lucene.document.Field;
035import org.apache.lucene.document.SortedDocValuesField;
036import org.apache.lucene.util.BytesRef;
037
038@Dependent
039public class SecurityRoleIndexer
040        extends BaseIndexer<SecurityRole> {
041
042    @Inject
043    SecurityControl securityControl;
044
045    @Override
046    public BaseIndexer<SecurityRole> setup(final ExecutionErrorAccumulator eea, final Index index) {
047        return super.setup(eea, index);
048    }
049
050    @Override
051    protected Analyzer getAnalyzer() {
052        return new SecurityRoleAnalyzer(eea, language, entityType, entityAliasTypes, entityAttributes, tagScopes);
053    }
054    
055    @Override
056    protected SecurityRole getEntity(final EntityInstance entityInstance) {
057        return securityControl.getSecurityRoleByEntityInstance(entityInstance);
058    }
059    
060    @Override
061    protected Document convertToDocument(final EntityInstance entityInstance, final SecurityRole securityRole) {
062        var securityRoleDetail = securityRole.getLastDetail();
063        var description = securityControl.getBestSecurityRoleDescription(securityRole, language);
064
065        var document = newDocumentWithEntityInstanceFields(entityInstance, securityRole.getPrimaryKey());
066
067        document.add(new Field(IndexFields.securityRoleGroupName.name(), securityRoleDetail.getSecurityRoleGroup().getLastDetail().getSecurityRoleGroupName(),
068                FieldTypes.NOT_STORED_TOKENIZED));
069        document.add(new SortedDocValuesField(IndexFields.securityRoleGroupName.name() + IndexConstants.INDEX_FIELD_VARIATION_SEPARATOR + IndexFieldVariations.sortable.name(),
070                new BytesRef(securityRoleDetail.getSecurityRoleGroup().getLastDetail().getSecurityRoleGroupName())));
071        document.add(new Field(IndexFields.securityRoleName.name(), securityRoleDetail.getSecurityRoleName(), FieldTypes.NOT_STORED_TOKENIZED));
072        document.add(new SortedDocValuesField(IndexFields.securityRoleName.name() + IndexConstants.INDEX_FIELD_VARIATION_SEPARATOR + IndexFieldVariations.sortable.name(),
073                new BytesRef(securityRoleDetail.getSecurityRoleName())));
074
075        if(description != null) {
076            document.add(new Field(IndexFields.description.name(), description, FieldTypes.NOT_STORED_TOKENIZED));
077            document.add(new SortedDocValuesField(IndexFields.description.name() + IndexConstants.INDEX_FIELD_VARIATION_SEPARATOR + IndexFieldVariations.sortable.name(),
078                    new BytesRef(description)));
079        }
080
081        return document;
082    }
083
084}