001// --------------------------------------------------------------------------------
002// Copyright 2002-2025 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.security.server.analyzer.SecurityRoleGroupAnalyzer;
023import com.echothree.model.control.index.server.indexer.BaseIndexer;
024import com.echothree.model.control.index.server.indexer.FieldTypes;
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.SecurityRoleGroup;
029import com.echothree.util.server.message.ExecutionErrorAccumulator;
030import com.echothree.util.server.persistence.Session;
031import org.apache.lucene.analysis.Analyzer;
032import org.apache.lucene.document.Document;
033import org.apache.lucene.document.Field;
034import org.apache.lucene.document.SortedDocValuesField;
035import org.apache.lucene.util.BytesRef;
036
037public class SecurityRoleGroupIndexer
038        extends BaseIndexer<SecurityRoleGroup> {
039    
040    SecurityControl securityControl = Session.getModelController(SecurityControl.class);
041
042    /** Creates a new instance of SecurityRoleGroupIndexer */
043    public SecurityRoleGroupIndexer(final ExecutionErrorAccumulator eea, final Index index) {
044        super(eea, index);
045    }
046
047    @Override
048    protected Analyzer getAnalyzer() {
049        return new SecurityRoleGroupAnalyzer(eea, language, entityType, entityAliasTypes, entityAttributes, tagScopes);
050    }
051    
052    @Override
053    protected SecurityRoleGroup getEntity(final EntityInstance entityInstance) {
054        return securityControl.getSecurityRoleGroupByEntityInstance(entityInstance);
055    }
056    
057    @Override
058    protected Document convertToDocument(final EntityInstance entityInstance, final SecurityRoleGroup securityRoleGroup) {
059        var securityRoleGroupDetail = securityRoleGroup.getLastDetail();
060        var parentSecurityRoleGroup = securityRoleGroupDetail.getParentSecurityRoleGroup();
061        var description = securityControl.getBestSecurityRoleGroupDescription(securityRoleGroup, language);
062
063        var document = newDocumentWithEntityInstanceFields(entityInstance, securityRoleGroup.getPrimaryKey());
064
065        document.add(new Field(IndexFields.securityRoleGroupName.name(), securityRoleGroupDetail.getSecurityRoleGroupName(), FieldTypes.NOT_STORED_TOKENIZED));
066        document.add(new SortedDocValuesField(IndexFields.securityRoleGroupName.name() + IndexConstants.INDEX_FIELD_VARIATION_SEPARATOR + IndexFieldVariations.sortable.name(),
067                new BytesRef(securityRoleGroupDetail.getSecurityRoleGroupName())));
068        if(parentSecurityRoleGroup != null) {
069            document.add(new Field(IndexFields.parentSecurityRoleGroupName.name(), parentSecurityRoleGroup.getLastDetail().getSecurityRoleGroupName(),
070                    FieldTypes.NOT_STORED_TOKENIZED));
071        }
072        
073        if(description != null) {
074            document.add(new Field(IndexFields.description.name(), description, FieldTypes.NOT_STORED_TOKENIZED));
075            document.add(new SortedDocValuesField(IndexFields.description.name() + IndexConstants.INDEX_FIELD_VARIATION_SEPARATOR + IndexFieldVariations.sortable.name(),
076                    new BytesRef(description)));
077        }
078
079        return document;
080    }
081
082}