org.wicketstuff.javaee.naming.global.GlobalJndiNamingStrategy Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of wicketstuff-javaee-inject Show documentation
There is a newer version: 10.3.0
Show newest version
/*
 * 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.wicketstuff.javaee.naming.global;

import org.wicketstuff.javaee.naming.IJndiNamingStrategy;

/**
 * Simple Java EE 6 Global JNDI naming support for java:global prefixed JNDI names based on the EJB
 * 3.1 specification Section 4.4.1, page 83 

 * With this you can use JNDI names in the following format: 

 * java:global/[<appName>]/<moduleName>/<bean-name>[!<fully-qualified-interface-name>]
 * 

 * 
 * The appName only applies, if the application is packaged as an .ear file. It defaults to
 * the base name of the .ear file with no filename extension, unless specified by the
 * application.xml deployment descriptor.
 * 
 * 
 * The moduleName is the name of the module in which the session bean is packaged. In a
 * stand-alone ejb-jar file or .war file, the moduleName defaults to the base name of the
 * module with any filename extension removed. In an ear file, the moduleName defaults to the
 * pathname of the module with any filename extension removed, but with any directory names
 * included. The default moduleName can be overriden using the module-name element of
 * ejb-jar.xml (for ejb-jar files) or web.xml (for .war files).
 * 
 * 
 * @see  EJB 3.1
 *      specification
 * 
 * @author Peter Major
 */
public class GlobalJndiNamingStrategy implements IJndiNamingStrategy
{

	private static final long serialVersionUID = 1L;
	private String baseName;

	/**
	 * This naming strategy will use the java:global JNDI name format for lookups. Use this
	 * constructor, if the app-name is not defined.
	 * 
	 * @param moduleName
	 *            The name of the module
	 */
	public GlobalJndiNamingStrategy(String moduleName)
	{
		this(null, moduleName);
	}

	/**
	 * This naming strategy will use the java:global JNDI name format for lookups.
	 * 
	 * @param appName
	 *            The name of the application (defined in application.xml or name of the ear)
	 * @param moduleName
	 *            The name of the module (defined in ejb-jar.xml or name of the ejb-jar)
	 */
	public GlobalJndiNamingStrategy(String appName, String moduleName)
	{
		if (appName == null || appName.isEmpty())
		{
			baseName = "java:global/" + moduleName + "/";
		}
		else
		{
			baseName = "java:global/" + appName + "/" + moduleName + "/";
		}
	}

	/**
	 * {@inheritDoc}
	 */
	@Override
	public String calculateName(String ejbName, Class ejbType)
	{
        if (ejbName == null) {
            return baseName + ejbType.getName();
        }
        return baseName + ejbName + "!" + ejbType.getName();
	}
}