001/*
002 *  Copyright 2015 Anyware Services
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 */
016package org.ametys.core.util.ldap;
017
018import java.util.Collections;
019import java.util.HashMap;
020import java.util.LinkedHashMap;
021import java.util.Map;
022
023import org.ametys.runtime.i18n.I18nizableText;
024import org.ametys.runtime.model.Enumerator;
025
026/**
027 * {@link Enumerator} for listing alias dereferencing modes supported in a LDAP query.
028 */
029public class AliasDerefEnumerator implements Enumerator<String>, org.ametys.runtime.parameter.Enumerator
030{
031    private static final String __CORE_CATALOGUE = "plugin.core";
032    private static final Map<String, I18nizableText> __ALIAS_DEREF_MODES;
033    
034    static
035    {
036        __ALIAS_DEREF_MODES = new LinkedHashMap<>(4);
037        __ALIAS_DEREF_MODES.put("always", new I18nizableText(__CORE_CATALOGUE, "PLUGINS_CORE_DATASOURCE_CORE_LDAP_CONFIG_ALIAS_DEREF_ENUM_ALWAYS"));
038        __ALIAS_DEREF_MODES.put("never", new I18nizableText(__CORE_CATALOGUE, "PLUGINS_CORE_DATASOURCE_CORE_LDAP_CONFIG_ALIAS_DEREF_ENUM_NEVER"));
039        __ALIAS_DEREF_MODES.put("finding", new I18nizableText(__CORE_CATALOGUE, "PLUGINS_CORE_DATASOURCE_CORE_LDAP_CONFIG_ALIAS_DEREF_ENUM_FINDING"));
040        __ALIAS_DEREF_MODES.put("searching", new I18nizableText(__CORE_CATALOGUE, "PLUGINS_CORE_DATASOURCE_CORE_LDAP_CONFIG_ALIAS_DEREF_ENUM_SEARCHING"));
041    }
042    
043    @Override
044    public I18nizableText getEntry(String value)
045    {
046        return __ALIAS_DEREF_MODES.get(value);
047    }
048    
049    @Override
050    public Map<String, I18nizableText> getTypedEntries()
051    {
052        return Collections.unmodifiableMap(__ALIAS_DEREF_MODES);
053    }
054    
055    // TODO NEWATTRIBUTEAPI: remove this method when org.ametys.runtime.parameter.Enumerator will be removed
056    public Map<Object, I18nizableText> getEntries()
057    {
058        Map<Object, I18nizableText> result = new HashMap<>();
059        for (Map.Entry<String, I18nizableText> entry : __ALIAS_DEREF_MODES.entrySet())
060        {
061            result.put(entry.getKey(), entry.getValue());
062        }
063        return Collections.unmodifiableMap(result);
064    }
065    
066    @Override
067    // TODO NEWATTRIBUTEAPI: remove this method when org.ametys.runtime.parameter.Enumerator will be removed
068    public Map<String, Object> getConfiguration()
069    {
070        return Collections.EMPTY_MAP;
071    }
072}