001/*
002 * Licensed to the Apache Software Foundation (ASF) under one or more
003 * contributor license agreements. See the NOTICE file distributed with
004 * this work for additional information regarding copyright ownership.
005 * The ASF licenses this file to You under the Apache license, Version 2.0
006 * (the "License"); you may not use this file except in compliance with
007 * the License. You may obtain a copy of the License at
008 *
009 *      http://www.apache.org/licenses/LICENSE-2.0
010 *
011 * Unless required by applicable law or agreed to in writing, software
012 * distributed under the License is distributed on an "AS IS" BASIS,
013 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
014 * See the license for the specific language governing permissions and
015 * limitations under the license.
016 */
017
018package org.apache.logging.log4j.core.util;
019
020import javax.naming.Context;
021import javax.naming.NamingException;
022
023/**
024 * Helper class for closing JNDI resources.
025 *
026 * This class is separate from {@link Closer} because JNDI is not in Android.
027 */
028public final class JndiCloser {
029
030    private JndiCloser() {
031    }
032
033    /**
034     * Closes the specified {@code Context}.
035     *
036     * @param context the JNDI Context to close, may be {@code null}
037     * @throws NamingException if a problem occurred closing the specified JNDI Context
038     * @see Context#close()
039     */
040    public static void close(final Context context) throws NamingException {
041        if (context != null) {
042            context.close();
043        }
044    }
045
046    /**
047     * Closes the specified {@code Context}, ignoring any exceptions thrown by the close operation.
048     *
049     * @param context the JNDI Context to close, may be {@code null}
050     * @return Whether closing succeeded
051     * @see Context#close()
052     */
053    public static boolean closeSilently(final Context context) {
054        try {
055            close(context);
056            return true;
057        } catch (final NamingException ignored) {
058            // ignored
059            return false;
060        }
061    }
062
063}