uimafit-core/src/main/java/org/apache/uima/fit/util/SimpleNamedResourceManager.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.uima.fit.util;

import java.lang.reflect.Constructor;
import java.lang.reflect.Field;
import java.util.ArrayList;
import java.util.List;
import java.util.Map;
import java.util.Map.Entry;

import org.apache.uima.UIMAFramework;
import org.apache.uima.resource.ResourceInitializationException;
import org.apache.uima.resource.ResourceManager;
import org.apache.uima.resource.impl.ResourceManager_impl;
import org.apache.uima.resource.metadata.ResourceManagerConfiguration;
import org.apache.uima.util.Level;

/**
 * <b>EXPERIMENTAL CODE</b>
 * <p>
 * Simple {@link ResourceManager} allowing for direct injection of Java objects into UIMA components
 * as external resources.
 * </p>
 * <p>
 * This implementation uses a simple map to look up an Java object by key. If any component using
 * this resource manager declares an external resource by the given key, the Java object will be
 * bound to that external resource.
 * <p>
 * Example:
 * </p>
 * <blockquote>
 * 
 * <pre>
 * class MyComponent extends JCasAnnotator_ImplBase {
 *   static final String RES_INJECTED_POJO = "InjectedPojo";
 *   {@code @ExternalResource(key = RES_INJECTED_POJO)}
 *   private String injectedString;
 * 
 *   public void process(JCas aJCas) throws AnalysisEngineProcessException {
 *     ...
 *   }
 * }
 * </pre>
 * 
 * </blockquote>
 * 
 * Per default it is necessary to explicitly bind a objects from the external context to external
 * resource keys used by the UIMA component: <blockquote>
 * 
 * <pre>
 * Map&lt;String, Object&gt; context = new HashMap&lt;String, Object&gt;();
 * context(&quot;myString&quot;, &quot;Just an injected POJO&quot;);
 * 
 * SimpleNamedResourceManager resMgr = new SimpleNamedResourceManager();
 * resMgr.setExternalContext(externalContext);
 * 
 * AnalysisEngineDescription desc = createPrimitiveDescription(MyComponent.class);
 * bindExternalResource(desc, MyComponent.RES_INJECTED_POJO, &quot;myString&quot;);
 * AnalysisEngine ae = UIMAFramework.produceAnalysisEngine(desc, resMgr, null);
 * </pre>
 * 
 * </blockquote>
 * 
 * With autowireing enabled, an explicit binding is not necessary: <blockquote>
 * 
 * <pre>
 * Map&lt;String, Object&gt; context = new HashMap&lt;String, Object&gt;();
 * context(MyComponent.RES_INJECTED_POJO, &quot;Just an injected POJO&quot;);
 * 
 * SimpleNamedResourceManager resMgr = new SimpleNamedResourceManager();
 * resMgr.setAutoWireEnabled(true);
 * resMgr.setExternalContext(externalContext);
 * 
 * AnalysisEngineDescription desc = createPrimitiveDescription(MyComponent.class);
 * AnalysisEngine ae = UIMAFramework.produceAnalysisEngine(desc, resMgr, null);
 * </pre>
 * 
 * </blockquote>
 * 
 */
public class SimpleNamedResourceManager extends ResourceManager_impl {
  private Map<String, Object> externalContext;

  private boolean autoWireEnabled = false;

  @SuppressWarnings({ "rawtypes", "unchecked" })
  @Override
  public void initializeExternalResources(ResourceManagerConfiguration aConfiguration,
          String aQualifiedContextName, java.util.Map<String, Object> aAdditionalParams)
          throws ResourceInitializationException {

    for (Entry<String, Object> e : externalContext.entrySet()) {
      ResourceRegistration registration = mInternalResourceRegistrationMap.get(e.getKey());

      if (registration == null) {
        try {
          // Register resource
          ResourceRegistration reg = new ResourceRegistration(e.getValue(), null,
                  aQualifiedContextName);
          ((Map) mInternalResourceRegistrationMap).put(e.getKey(), reg);

          // Perform binding
          if (isAutoWireEnabled()) {
            mResourceMap.put(aQualifiedContextName + e.getKey(), e.getValue());
          }
        } catch (Exception e1) {
          throw new ResourceInitializationException(e1);
        }
      } else {
        try {
          Object desc = getFieldValue(registration, "description");

          if (desc != null) {
            String definingContext = getFieldValue(registration, "definingContext");

            if (aQualifiedContextName.startsWith(definingContext)) {
              UIMAFramework.getLogger().logrb(Level.CONFIG, ResourceManager_impl.class.getName(),
                      "initializeExternalResources", LOG_RESOURCE_BUNDLE,
                      "UIMA_overridden_resource__CONFIG",
                      new Object[] { e.getKey(), aQualifiedContextName, definingContext });
            } else {
              UIMAFramework.getLogger().logrb(Level.WARNING, ResourceManager_impl.class.getName(),
                      "initializeExternalResources", LOG_RESOURCE_BUNDLE,
                      "UIMA_duplicate_resource_name__WARNING",
                      new Object[] { e.getKey(), definingContext, aQualifiedContextName });
            }
          }
        } catch (Exception e1) {
          throw new ResourceInitializationException(e1);
        }
      }
    }

    super.initializeExternalResources(aConfiguration, aQualifiedContextName, aAdditionalParams);
  }

  public void setExternalContext(Map<String, Object> aExternalContext) {
    externalContext = aExternalContext;
  }

  public void setAutoWireEnabled(boolean aAutoWireEnabled) {
    autoWireEnabled = aAutoWireEnabled;
  }

  public boolean isAutoWireEnabled() {
    return autoWireEnabled;
  }

  /**
   * Instantiate a non-visible class.
   */
  @SuppressWarnings({ "unchecked", "rawtypes" })
  private static <T> T newInstance(String aClassName, Object... aArgs)
          throws ResourceInitializationException {
    Constructor constr = null;
    try {
      Class<?> cl = Class.forName(aClassName);

      List<Class> types = new ArrayList<Class>();
      List<Object> values = new ArrayList<Object>();
      for (int i = 0; i < aArgs.length; i += 2) {
        types.add((Class) aArgs[i]);
        values.add(aArgs[i + 1]);
      }

      constr = cl.getDeclaredConstructor(types.toArray(new Class[types.size()]));
      constr.setAccessible(true);
      return (T) constr.newInstance(values.toArray(new Object[values.size()]));
    } catch (Exception e) {
      throw new ResourceInitializationException(e);
    } finally {
      if (constr != null) {
        constr.setAccessible(false);
      }
    }
  }

  /**
   * Get a field value from a non-visible field.
   */
  @SuppressWarnings("unchecked")
  private static <T> T getFieldValue(Object aObject, String aFieldName)
          throws ResourceInitializationException {
    Field f = null;
    try {
      f = aObject.getClass().getDeclaredField(aFieldName);
      f.setAccessible(true);
      return (T) f.get(aObject);
    } catch (Exception e) {
      throw new ResourceInitializationException(e);
    } finally {
      if (f != null) {
        f.setAccessible(false);
      }
    }
  }
}