/*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
*
* Copyright (c) 2007-2011 Oracle and/or its affiliates. All rights reserved.
*
* The contents of this file are subject to the terms of either the GNU
* General Public License Version 2 only ("GPL") or the Common Development
* and Distribution License("CDDL") (collectively, the "License"). You
* may not use this file except in compliance with the License. You can
* obtain a copy of the License at
* https://glassfish.dev.java.net/public/CDDL+GPL_1_1.html
* or packager/legal/LICENSE.txt. See the License for the specific
* language governing permissions and limitations under the License.
*
* When distributing the software, include this License Header Notice in each
* file and include the License file at packager/legal/LICENSE.txt.
*
* GPL Classpath Exception:
* Oracle designates this particular file as subject to the "Classpath"
* exception as provided by Oracle in the GPL Version 2 section of the License
* file that accompanied this code.
*
* Modifications:
* If applicable, add the following below the License Header, with the fields
* enclosed by brackets [] replaced by your own identifying information:
* "Portions Copyright [year] [name of copyright owner]"
*
* Contributor(s):
* If you wish your version of this file to be governed by only the CDDL or
* only the GPL Version 2, indicate your decision by adding "[Contributor]
* elects to include this software in this distribution under the [CDDL or GPL
* Version 2] license." If you don't indicate a single choice of license, a
* recipient has the option to distribute your version of this file under
* either the CDDL, the GPL Version 2 or to extend the choice of license to
* its licensees as provided above. However, if you add GPL Version 2 code
* and therefore, elected the GPL Version 2 license, then the option applies
* only if the new code is made subject to such option by the copyright
* holder.
*/
package com.sun.hk2.component;
import org.jvnet.hk2.component.Habitat;
import org.jvnet.hk2.component.Inhabitant;
import java.io.IOException;
import java.util.Collections;
import java.util.HashMap;
import java.util.HashSet;
import java.util.Iterator;
import java.util.Map;
import java.util.Set;
import java.util.logging.Level;
import java.util.logging.Logger;
/**
* Parses <tt>/META-INF/inhabitants</tt> and populate {@link Habitat}.
*
* <p>
* This class can be subclasses to customize the parsing behavior, which is useful
* for ignoring some components.
*
* @author Kohsuke Kawaguchi
* @author Jerome Dochez
*/
public class InhabitantsParser {
private final Logger logger = Logger.getLogger(InhabitantsParser.class.getCanonicalName());
public final Habitat habitat;
/**
* Fully qualified class names of components to be replaced, to {@link Class} that replaces them.
* If the value is null, that means just drops it without a replacement.
*
* @see #drop(Class)
* @see #replace(Class, Class)
*/
// Whether this feature should belong to this base class is arguable --- perhaps a better
// approach is to create a sub class that does it?
private final Map<String,Class<?>> replacements = new HashMap<String,Class<?>>();
public InhabitantsParser(Habitat habitat) {
this.habitat = habitat;
}
/**
* Tells {@link InhabitantsParser} that if it encounters the specified component
* while parsing inhabitants file,
* simply drop it and pretend that such an inhabitant had never existed.
*
* <p>
* This is useful when the application that's hosting an HK2 environment
* wants to tweak the inhabitant population at sub-module level.
*/
public void drop(Class<?> component) {
drop(component.getName());
}
public void drop(String fullyQualifiedClassName) {
replace(fullyQualifiedClassName,null);
}
/**
* Tells {@link InhabitantsParser} that if it encounters the specified component
* while parsing inhabitants file,
* ignore the one in the inhabitants file and instead insert the specified 'new' component.
*
* <p>
* This is useful when the application that's hosting an HK2 environment
* wants to tweak the inhabitant population at sub-module level.
*/
public void replace(Class<?> oldComponent, Class<?> newComponent) {
replace(oldComponent.getName(),newComponent);
}
public void replace(String oldComponentFullyQualifiedClassName, Class<?> newComponent) {
replacements.put(oldComponentFullyQualifiedClassName,newComponent);
}
/**
* Parses the inhabitants file (which is represented by {@link InhabitantsScanner}.
*
* <p>
* All the earlier drop/replace commands will be honored during this process.
*/
@SuppressWarnings("unchecked")
public void parse(Iterable<InhabitantParser> scanner, Holder<ClassLoader> classLoader) throws IOException {
if (scanner==null)
return;
for( InhabitantParser inhabitantParser : scanner) {
if (isFilteredInhabitant(inhabitantParser)) {
continue;
}
String typeName = inhabitantParser.getImplName();
if (isFilteredInhabitant(typeName)) {
continue;
}
if (replacements.containsKey(typeName)) {
// create a replacement instead
Class<?> target = replacements.get(typeName);
if(target!=null) {
inhabitantParser.setImplName(target.getName());
Inhabitant i = null;
try {
i = Inhabitants.create(target,habitat,inhabitantParser.getMetaData());
} catch (Exception e) {
log(typeName, e);
}
if (null != i) {
add(i, inhabitantParser);
// add index so that the new component can be looked up by the name of the old component.
addIndex(i, typeName, null);
}
}
} else {
Set<String> indicies = new HashSet<String>();
Iterator<String> iter = inhabitantParser.getIndexes().iterator();
while (iter.hasNext()) {
indicies.add(iter.next());
}
Inhabitant<?> i = null;
try {
i = com.sun.hk2.component.Inhabitants.
createInhabitant(habitat, classLoader, typeName,
inhabitantParser.getMetaData(), null,
Collections.unmodifiableSet(indicies));
} catch (Exception e) {
log(typeName, e);
}
if (null != i) {
add(i, inhabitantParser);
}
}
}
}
private void log(String typeName, Exception e) {
logger.log(Level.FINE, "Warning: unable to create inhabitant for {0} - and therefore ignoring it; check classpath; re: {1}",
new Object[] {typeName, e.getMessage()});
logger.log(Level.FINER, "", e);
}
/**
* Returns true if this inhabitant should be ignored.
*
* @param inhabitantParser
* @return
*/
protected boolean isFilteredInhabitant(InhabitantParser inhabitantParser) {
return false;
}
/**
* Returns true if this inhabitant should be ignored.
*
* @param typeName
* @return
*/
protected boolean isFilteredInhabitant(String typeName) {
return false;
}
/**
* Adds the given inhabitant to the habitat, with all its indices.
*/
protected void add(Inhabitant<?> i, InhabitantParser parser) {
add(i);
for (String v : parser.getIndexes()) {
// register inhabitant to the index
int idx = v.indexOf(':');
if(idx==-1) {
// no name
addIndex(i,v,null);
} else {
// v=contract:name
String contract = v.substring(0, idx);
String name = v.substring(idx + 1);
addIndex(i, contract, name);
}
}
}
/**
* Adds the given inhabitant to the habitat
* @param i
*/
protected void add(Inhabitant<?> i) {
logger.log(Level.FINE, "adding inhabitant: {0} to habitat {1}",
new Object[] {i, habitat});
habitat.add(i);
}
/**
* Adds the given inhabitant index to the habitat
*/
protected void addIndex(Inhabitant<?> i, String typeName, String name) {
logger.log(Level.FINE, "adding index for inhabitant: {0} with typeName {1} and name {2} to habitat {3}",
new Object[] {i, typeName, name, habitat});
habitat.addIndex(i, typeName, name);
}
}