Author: tv
Date: Wed Sep 11 19:17:02 2013
New Revision: 1521994
URL: http://svn.apache.org/r1521994
Log:
- Rename Annotation @InjectService to @TurbineService to inject Turbine service
instance into objects.
- Refactor handling of annotated fields into AnnotationProcessor
- Add Annotation @TurbineConfiguration to inject a configuration instance into
objects
Added:
turbine/core/trunk/src/java/org/apache/turbine/annotation/AnnotationProcessor.java
(with props)
turbine/core/trunk/src/java/org/apache/turbine/annotation/TurbineConfiguration.java
(with props)
turbine/core/trunk/src/java/org/apache/turbine/annotation/TurbineService.java
(contents, props changed)
- copied, changed from r1521098,
turbine/core/trunk/src/java/org/apache/turbine/annotation/InjectService.java
Removed:
turbine/core/trunk/src/java/org/apache/turbine/annotation/InjectService.java
Added:
turbine/core/trunk/src/java/org/apache/turbine/annotation/AnnotationProcessor.java
URL:
http://svn.apache.org/viewvc/turbine/core/trunk/src/java/org/apache/turbine/annotation/AnnotationProcessor.java?rev=1521994&view=auto
==============================================================================
---
turbine/core/trunk/src/java/org/apache/turbine/annotation/AnnotationProcessor.java
(added)
+++
turbine/core/trunk/src/java/org/apache/turbine/annotation/AnnotationProcessor.java
Wed Sep 11 19:17:02 2013
@@ -0,0 +1,167 @@
+package org.apache.turbine.annotation;
+
+
+/*
+ * 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.
+ */
+
+
+import java.lang.reflect.Field;
+
+import org.apache.commons.configuration.Configuration;
+import org.apache.commons.lang.StringUtils;
+import org.apache.commons.logging.Log;
+import org.apache.commons.logging.LogFactory;
+import org.apache.turbine.Turbine;
+import org.apache.turbine.services.ServiceManager;
+import org.apache.turbine.services.TurbineServices;
+import org.apache.turbine.util.TurbineException;
+
+/**
+ * AnnotationProcessor contains static helper methods that handle the
+ * Turbine annotations for objects
+ *
+ * @author <a href="mailto:[email protected]";>Thomas Vandahl</a>
+ * @version $Id: TurbineAssemblerBrokerService.java 1521103 2013-09-09
13:38:07Z tv $
+ */
+public class AnnotationProcessor
+{
+ /** Logging */
+ private static Log log
+ = LogFactory.getLog(AnnotationProcessor.class);
+
+ /**
+ * Search for annotated fields of the object and provide them with the
+ * appropriate TurbineService
+ *
+ * @param object the object
+ * @throws TurbineException if the service could not be injected
+ */
+ public static void process(Object object) throws TurbineException
+ {
+ ServiceManager manager = TurbineServices.getInstance();
+ Field[] fields = object.getClass().getDeclaredFields();
+
+ for (Field field : fields)
+ {
+ if (field.isAnnotationPresent(TurbineService.class))
+ {
+ TurbineService sa = field.getAnnotation(TurbineService.class);
+ String serviceName = null;
+ // Check for annotation value
+ if (StringUtils.isNotEmpty(sa.value()))
+ {
+ serviceName = sa.value();
+ }
+ // Check for fields SERVICE_NAME and ROLE
+ else
+ {
+ Field[] typeFields = field.getType().getFields();
+ for (Field f : typeFields)
+ {
+ if (TurbineService.SERVICE_NAME.equals(f.getName()))
+ {
+ try
+ {
+ serviceName = (String)f.get(null);
+ }
+ catch (Exception e)
+ {
+ continue;
+ }
+ break;
+ }
+ else if (TurbineService.ROLE.equals(f.getName()))
+ {
+ try
+ {
+ serviceName = (String)f.get(null);
+ }
+ catch (Exception e)
+ {
+ continue;
+ }
+ break;
+ }
+ }
+ }
+
+ if (StringUtils.isEmpty(serviceName))
+ {
+ // Try interface class name
+ serviceName = field.getType().getName();
+ }
+
+ if (log.isDebugEnabled())
+ {
+ log.debug("Looking up service for injection: " +
serviceName + " for object " + object);
+ }
+
+ Object service = manager.getService(serviceName); // throws
Exception on unknown service
+ field.setAccessible(true);
+
+ try
+ {
+ field.set(object, service);
+ }
+ catch (IllegalArgumentException e)
+ {
+ throw new TurbineException("Could not inject service "
+ + serviceName + " into object " + object, e);
+ }
+ catch (IllegalAccessException e)
+ {
+ throw new TurbineException("Could not inject service "
+ + serviceName + " into object " + object, e);
+ }
+ }
+ else if (field.isAnnotationPresent(TurbineConfiguration.class))
+ {
+ TurbineConfiguration ca =
field.getAnnotation(TurbineConfiguration.class);
+ Configuration conf = null;
+
+ // Check for annotation value
+ if (StringUtils.isNotEmpty(ca.value()))
+ {
+ conf = Turbine.getConfiguration().subset(ca.value());
+ }
+ else
+ {
+ conf = Turbine.getConfiguration();
+ }
+
+ field.setAccessible(true);
+
+ try
+ {
+ field.set(object, conf);
+ }
+ catch (IllegalArgumentException e)
+ {
+ throw new TurbineException("Could not inject configuration
"
+ + conf + " into object " + object, e);
+ }
+ catch (IllegalAccessException e)
+ {
+ throw new TurbineException("Could not inject configuration
"
+ + conf + " into object " + object, e);
+ }
+ }
+ }
+ }
+}
Propchange:
turbine/core/trunk/src/java/org/apache/turbine/annotation/AnnotationProcessor.java
------------------------------------------------------------------------------
svn:mime-type = text/plain
Added:
turbine/core/trunk/src/java/org/apache/turbine/annotation/TurbineConfiguration.java
URL:
http://svn.apache.org/viewvc/turbine/core/trunk/src/java/org/apache/turbine/annotation/TurbineConfiguration.java?rev=1521994&view=auto
==============================================================================
---
turbine/core/trunk/src/java/org/apache/turbine/annotation/TurbineConfiguration.java
(added)
+++
turbine/core/trunk/src/java/org/apache/turbine/annotation/TurbineConfiguration.java
Wed Sep 11 19:17:02 2013
@@ -0,0 +1,40 @@
+package org.apache.turbine.annotation;
+
+import java.lang.annotation.ElementType;
+import java.lang.annotation.Retention;
+import java.lang.annotation.RetentionPolicy;
+import java.lang.annotation.Target;
+
+/*
+ * 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.
+ */
+
+/**
+ * Annotation to mark fields in modules that require a configuration to be
injected
+ */
+@Retention( RetentionPolicy.RUNTIME )
+@Target( ElementType.FIELD )
+public @interface TurbineConfiguration
+{
+ /**
+ * Optional prefix for a configuration subset
+ *
+ * @return the configuration prefix
+ */
+ String value() default "";
+}
Propchange:
turbine/core/trunk/src/java/org/apache/turbine/annotation/TurbineConfiguration.java
------------------------------------------------------------------------------
svn:mime-type = text/plain
Copied:
turbine/core/trunk/src/java/org/apache/turbine/annotation/TurbineService.java
(from r1521098,
turbine/core/trunk/src/java/org/apache/turbine/annotation/InjectService.java)
URL:
http://svn.apache.org/viewvc/turbine/core/trunk/src/java/org/apache/turbine/annotation/TurbineService.java?p2=turbine/core/trunk/src/java/org/apache/turbine/annotation/TurbineService.java&p1=turbine/core/trunk/src/java/org/apache/turbine/annotation/InjectService.java&r1=1521098&r2=1521994&rev=1521994&view=diff
==============================================================================
---
turbine/core/trunk/src/java/org/apache/turbine/annotation/InjectService.java
(original)
+++
turbine/core/trunk/src/java/org/apache/turbine/annotation/TurbineService.java
Wed Sep 11 19:17:02 2013
@@ -29,12 +29,22 @@ import java.lang.annotation.Target;
*/
@Retention( RetentionPolicy.RUNTIME )
@Target( ElementType.FIELD )
-public @interface InjectService
+public @interface TurbineService
{
/**
* Get the name of the service to inject
*
* @return the service name or role
*/
- String value();
+ String value() default "";
+
+ /**
+ * A constant defining the field name for the service name
+ */
+ String SERVICE_NAME = "SERVICE_NAME";
+
+ /**
+ * A constant defining the field name for the role
+ */
+ String ROLE = "ROLE";
}
Propchange:
turbine/core/trunk/src/java/org/apache/turbine/annotation/TurbineService.java
------------------------------------------------------------------------------
svn:mime-type = text/plain
