org.wildfly.naming.client.NamingContextFactory Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of wildfly-client-all

This artifact provides a single jar that contains all classes required to use remote EJB and JMS, including all dependencies. It is intended for use by those not using maven, maven users should just import the EJB and JMS BOM's instead (shaded JAR's cause lots of problems with maven, as it is very easy to inadvertently end up with different versions on classes on the class path).

The newest version!

/*
 * JBoss, Home of Professional Open Source.
 * Copyright 2017 Red Hat, Inc., and individual contributors
 * as indicated by the @author tags.
 *
 * Licensed 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.wildfly.naming.client;

import javax.naming.Context;
import javax.naming.NamingException;

import org.wildfly.naming.client.util.FastHashtable;

/**
 * A context factory which maps naming providers and name schemes to actual naming contexts.
 *
 * @author David M. Lloyd
 */
public interface NamingContextFactory {
    /**
     * Determine if this factory supports the given provider and name scheme.  This method is called
     * when a JNDI operation is executed on an initial context to determine which provider should handle the operation.
     * 
     * A context factory should evaluate the provider's type to determine if the provider is compatible with the naming
     * scheme, and should not support producing contexts for unknown providers.
     *
     * @param namingProvider the naming provider which is handling this request, or {@code null} if it is local
     * @param nameScheme the JNDI name scheme, or {@code null} if no name scheme was given
     * @return {@code true} if this factory supports the given scheme, {@code false} otherwise
     */
    boolean supportsUriScheme(NamingProvider namingProvider, String nameScheme);

    /**
     * Create the root context for this naming scheme.  The context should capture any locally relevant information,
     * such as the relevant local security or authentication context.
     *
     * @param namingProvider the naming provider which is handling this request, or {@code null} if it is local
     * @param nameScheme the scheme in the name, or {@code null} if there is no name URL scheme
     * @param env a copy of the environment which may be consumed directly by the provider (not {@code null})
     * @param providerEnvironment the provider environment (not {@code null})
     * @return the root context (must not be {@code null})
     * @throws NamingException if the root context creation failed for some reason
     */
    Context createRootContext(NamingProvider namingProvider, String nameScheme, FastHashtable env, ProviderEnvironment providerEnvironment) throws NamingException;
}