001/*
002 * (C) Copyright 2009 Nuxeo SA (http://nuxeo.com/) and others.
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 * Contributors:
017 *     Anahide Tchertchian
018 */
019package org.nuxeo.ecm.directory.ldap;
020
021import javax.naming.directory.SearchControls;
022
023/**
024 * Helper for translating ldap search scope from string to integer
025 *
026 * @author Anahide Tchertchian
027 */
028public class LdapScope {
029
030    /**
031     * Returns the associated integer for scope, comparing lower case. Returns null if not one of "object", "onelevel"
032     * or "subtree".
033     */
034    public static Integer getIntegerScope(String scopeString) {
035        if (scopeString != null) {
036            scopeString = scopeString.toLowerCase();
037            if ("object".equals(scopeString)) {
038                return Integer.valueOf(SearchControls.OBJECT_SCOPE);
039            } else if ("onelevel".equals(scopeString)) {
040                return Integer.valueOf(SearchControls.ONELEVEL_SCOPE);
041            } else if ("subtree".equals(scopeString)) {
042                return SearchControls.SUBTREE_SCOPE;
043            }
044        }
045        return null;
046    }
047
048}