JndiHelper.java

/**
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements. See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership. The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License. You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied. See the License for the
 * specific language governing permissions and limitations
 * under the License.
 */
package org.apache.cxf.transport.jms.util;

import java.util.ArrayList;
import java.util.Arrays;
import java.util.Collections;
import java.util.List;
import java.util.Properties;
import java.util.function.Predicate;

import javax.naming.Context;
import javax.naming.InitialContext;
import javax.naming.NameNotFoundException;
import javax.naming.NamingException;

import org.apache.cxf.common.util.StringUtils;
import org.apache.cxf.common.util.SystemPropertyAction;

public class JndiHelper {

    /**
     * JVM/System property name holding allowed jms protocols.
     */
    private static final String CONFIGURED_JMS_PROTOCOLS = "jms.protocols";
    /**
     * Constant holding default allowed jms protocols.
     */
    private static final String DEFAULT_JMS_PROTOCOLS = "vm,tcp,nio,ssl,http,https,ws,wss";
    private static final List<String> ALLOWED_PROTOCOLS;
    private Properties environment;

    static {
        final String jmsProtocols = SystemPropertyAction.getProperty(CONFIGURED_JMS_PROTOCOLS, DEFAULT_JMS_PROTOCOLS);
        if (StringUtils.isEmpty(jmsProtocols)) {
            ALLOWED_PROTOCOLS = Collections.emptyList();
        } else {
            final List<String> allowedProtocols = new ArrayList<>();
            Arrays
                .stream(jmsProtocols.split(","))
                .map(String::trim)
                .filter(Predicate.not(String::isEmpty))
                .map(s -> s + "://")
                .forEach(allowedProtocols::add);
            ALLOWED_PROTOCOLS = Collections.unmodifiableList(allowedProtocols);
        }
    }

    /**
     * Create a new JndiTemplate instance, using the given environment.
     */
    public JndiHelper(Properties environment) {
        this.environment = environment;

        // Avoid unsafe protocols if they are somehow misconfigured
        String providerUrl = environment.getProperty(Context.PROVIDER_URL);
        if (providerUrl != null && !providerUrl.isEmpty()
            && !ALLOWED_PROTOCOLS.stream().anyMatch(providerUrl::startsWith)) {
            throw new IllegalArgumentException("Unsafe protocol in JNDI URL: " + providerUrl);
        }
    }

    @SuppressWarnings("unchecked")
    public <T> T lookup(final String name, Class<T> requiredType) throws NamingException {
        Context ctx = new InitialContext(this.environment);
        try {
            Object located = ctx.lookup(name);
            if (located == null) {
                throw new NameNotFoundException("JNDI object with [" + name + "] not found");
            }
            return (T)located;
        } finally {
            ResourceCloser.close(ctx);
        }
    }

}