summaryrefslogtreecommitdiffstats
path: root/sca-java-1.x/tags/java-stable-20060304/sca/core/src/main/java/org/apache/tuscany/core/system/builder/SystemComponentContextBuilder.java
blob: ac65a3de4914e62abb06de7c1aa25650b09f3125 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
/**
 * 
 * Copyright 2005 The Apache Software Foundation or its licensors, as applicable.
 * 
 * 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.apache.tuscany.core.system.builder;

import java.lang.reflect.Constructor;
import java.lang.reflect.Field;
import java.lang.reflect.Method;
import java.util.ArrayList;
import java.util.List;
import java.util.Set;

import org.apache.tuscany.common.monitor.MonitorFactory;
import org.apache.tuscany.core.builder.BuilderConfigException;
import org.apache.tuscany.core.builder.BuilderException;
import org.apache.tuscany.core.builder.NoAccessorException;
import org.apache.tuscany.core.builder.RuntimeConfigurationBuilder;
import org.apache.tuscany.core.builder.UnknownTypeException;
import org.apache.tuscany.core.config.JavaIntrospectionHelper;
import org.apache.tuscany.core.context.AggregateContext;
import org.apache.tuscany.core.context.AutowireContext;
import org.apache.tuscany.core.context.ConfigurationContext;
import org.apache.tuscany.core.context.SystemAggregateContext;
import org.apache.tuscany.core.context.impl.AggregateContextImpl;
import org.apache.tuscany.core.injection.EventInvoker;
import org.apache.tuscany.core.injection.FieldInjector;
import org.apache.tuscany.core.injection.Injector;
import org.apache.tuscany.core.injection.MethodEventInvoker;
import org.apache.tuscany.core.injection.MethodInjector;
import org.apache.tuscany.core.injection.ObjectCreationException;
import org.apache.tuscany.core.injection.ReferenceTargetFactory;
import org.apache.tuscany.core.injection.SDOObjectFactory;
import org.apache.tuscany.core.injection.SingletonObjectFactory;
import org.apache.tuscany.core.runtime.RuntimeContext;
import org.apache.tuscany.core.system.annotation.Autowire;
import org.apache.tuscany.core.system.annotation.ParentContext;
import org.apache.tuscany.core.system.assembly.SystemImplementation;
import org.apache.tuscany.core.system.config.SystemComponentRuntimeConfiguration;
import org.apache.tuscany.core.system.context.SystemAggregateContextImpl;
import org.apache.tuscany.model.assembly.AssemblyModelObject;
import org.apache.tuscany.model.assembly.Component;
import org.apache.tuscany.model.assembly.ComponentImplementation;
import org.apache.tuscany.model.assembly.ConfiguredProperty;
import org.apache.tuscany.model.assembly.ConfiguredReference;
import org.apache.tuscany.model.assembly.ConfiguredService;
import org.apache.tuscany.model.assembly.Module;
import org.apache.tuscany.model.assembly.Scope;
import org.osoa.sca.annotations.ComponentName;
import org.osoa.sca.annotations.Context;
import org.osoa.sca.annotations.Destroy;
import org.osoa.sca.annotations.Init;

import commonj.sdo.DataObject;

/**
 * Decorates components whose implementation type is a
 * {@link org.apache.tuscany.core.system.assembly.SystemImplementation} with the appropriate runtime configuration.
 * System components are not proxied.
 * 
 * @version $Rev$ $Date$
 */
public class SystemComponentContextBuilder implements RuntimeConfigurationBuilder<AggregateContext> {
    // ----------------------------------
    // Constructors
    // ----------------------------------

    public SystemComponentContextBuilder() {
    }

    // ----------------------------------
    // Methods
    // ----------------------------------

    public void build(AssemblyModelObject modelObject, AggregateContext parentContext) throws BuilderException {
        if (!(modelObject instanceof Component)) {
            return;
        }
        Component component = (Component) modelObject;
        
        Class implClass = null;
        Scope scope = null;
        
        // Get the component implementation
        ComponentImplementation componentImplementation = component.getComponentImplementation();
        if (componentImplementation instanceof SystemImplementation
                && componentImplementation.getRuntimeConfiguration() == null) {
            
            // The component is a system component, implemented by a Java class
            SystemImplementation javaImpl = (SystemImplementation) componentImplementation;
            scope = componentImplementation.getComponentType().getServices().get(0).getServiceContract().getScope();
            implClass = javaImpl.getImplementationClass();
            
        } else if (componentImplementation instanceof Module) { 
            if (((Module)componentImplementation).getName().startsWith("org.apache.tuscany.core.system")) {
                
                // The component is a system module component, fix the implementation class to our implementation
                // of system module component context
               implClass=SystemAggregateContextImpl.class;
               scope = Scope.AGGREGATE;
               
            } else {
                
                // The component is an app module component, fix the implementation class to our implementation
                // of app module component context
               implClass=AggregateContextImpl.class;
               scope = Scope.AGGREGATE;
               
            }
            
        } else {
            return;
        }

        // FIXME scope
        Set<Field> fields;
        Set<Method> methods;
        try {
            fields = JavaIntrospectionHelper.getAllFields(implClass);
            methods = JavaIntrospectionHelper.getAllUniqueMethods(implClass);
            String name = component.getName();
            Constructor ctr = implClass.getConstructor((Class[]) null);

            List<Injector> injectors = new ArrayList();

            // handle properties
            List<ConfiguredProperty> configuredProperties = component.getConfiguredProperties();
            if (configuredProperties != null) {
                for (ConfiguredProperty property : configuredProperties) {
                    Injector injector = createPropertyInjector(property, fields, methods);
                    injectors.add(injector);
                }
            }

            //FIXME do not inject references on an application module yet
            if (implClass!=AggregateContextImpl.class) {
                // handle references
                List<ConfiguredReference> configuredReferences = component.getConfiguredReferences();
                if (configuredReferences != null) {
                    for (ConfiguredReference reference : configuredReferences) {
                        Injector injector = createReferenceInjector(parentContext.getName(), component.getName(), parentContext,
                                reference, fields, methods);
                        injectors.add(injector);
                    }
                }
            }

            // create factory for the component implementation type
            EventInvoker initInvoker = null;
            boolean eagerInit = false;
            EventInvoker destroyInvoker = null;
            for (Field field : fields) {
                ComponentName compName = field.getAnnotation(ComponentName.class);
                if (compName != null) {
                    Injector injector = new FieldInjector(field, new SingletonObjectFactory(name));
                    injectors.add(injector);
                }
                Context context = field.getAnnotation(Context.class);
                if (context != null) {
                    Injector injector = new FieldInjector(field, new SingletonObjectFactory(parentContext));
                    injectors.add(injector);
                }
                ParentContext parentField = field.getAnnotation(ParentContext.class);
                if (parentField != null) {
                    if (!(parentContext instanceof AggregateContext)) {
                        BuilderConfigException e = new BuilderConfigException("Component must be a child of");
                        e.setIdentifier(AggregateContext.class.getName());
                        throw e;
                    }
                    Injector injector = new FieldInjector(field, new SingletonObjectFactory((parentContext)));
                    injectors.add(injector);
                }
                Autowire autowire = field.getAnnotation(Autowire.class);
                if (autowire != null) {
                    if (!(parentContext instanceof AutowireContext)) {
                        BuilderConfigException e = new BuilderConfigException("Parent context must implement");
                        e.setIdentifier(AutowireContext.class.getName());
                        throw e;
                    }
                    AutowireContext ctx = (AutowireContext) parentContext;
                    // for system aggregate context types, only allow autowire of certain types, otherwise we have a
                    // chicken-and-egg problem
                    if (SystemAggregateContext.class.isAssignableFrom(implClass)
                            && !(field.getType().equals(ConfigurationContext.class)
                                    || field.getType().equals(MonitorFactory.class)
                                    || field.getType().equals(RuntimeContext.class) || field.getType().equals(
                                    AutowireContext.class))) {
                        BuilderConfigException e = new BuilderConfigException("Illegal autowire type for system context");
                        e.setIdentifier(field.getType().getName());
                        throw e;
                    }

                    Object o = ctx.resolveInstance(field.getType());
                    if (autowire.required() && o == null) {
                        BuilderConfigException e = new BuilderConfigException("No autowire found for field");
                        e.setIdentifier(field.getName());
                        throw e;
                    }
                    Injector injector = new FieldInjector(field, new SingletonObjectFactory(o));
                    injectors.add(injector);
                }
            }
            for (Method method : methods) {
                Init init = method.getAnnotation(Init.class);
                if (init != null && initInvoker == null) {
                    initInvoker = new MethodEventInvoker(method);
                    eagerInit = init.eager();
                    continue;
                }
                Destroy destroy = method.getAnnotation(Destroy.class);
                if (destroy != null && destroyInvoker == null) {
                    destroyInvoker = new MethodEventInvoker(method);
                    continue;
                }
                ComponentName compName = method.getAnnotation(ComponentName.class);
                if (compName != null) {
                    Injector injector = new MethodInjector(method, new SingletonObjectFactory(name));
                    injectors.add(injector);
                }
                Context context = method.getAnnotation(Context.class);
                if (context != null) {
                    Injector injector = new MethodInjector(method, new SingletonObjectFactory(parentContext));
                    injectors.add(injector);
                }
                ParentContext parentMethod = method.getAnnotation(ParentContext.class);
                if (parentMethod != null) {
                    if (!(parentContext instanceof AggregateContext)) {
                        BuilderConfigException e = new BuilderConfigException("Component must be a child of ");
                        e.setIdentifier(AggregateContext.class.getName());
                        throw e;
                    }
                    Injector injector = new MethodInjector(method, new SingletonObjectFactory((parentContext)));
                    injectors.add(injector);
                }
                Autowire autowire = method.getAnnotation(Autowire.class);
                if (autowire != null) {
                    if (!(parentContext instanceof AutowireContext)) {
                        BuilderConfigException e = new BuilderConfigException("Parent context must implement)");
                        e.setIdentifier(AutowireContext.class.getName());
                        throw e;
                    }
                    if (method.getParameterTypes() == null || method.getParameterTypes().length != 1) {
                        BuilderConfigException e = new BuilderConfigException(
                                "Autowire setter methods must take one parameter");
                        e.setIdentifier(method.getName());
                        throw e;
                    }
                    AutowireContext ctx = (AutowireContext) parentContext;
                    Class paramType = method.getParameterTypes()[0];
                    // for system aggregate context types, only allow autowire of certain types, otherwise we have a
                    // chicken-and-egg problem
                    if (SystemAggregateContext.class.isAssignableFrom(implClass)
                            && !(paramType.equals(ConfigurationContext.class) || paramType.equals(MonitorFactory.class)
                                    || paramType.equals(RuntimeContext.class) || paramType.equals(AutowireContext.class))) {
                        BuilderConfigException e = new BuilderConfigException("Illegal autowire type for system context");
                        e.setIdentifier(paramType.getName());
                        throw e;
                    }
                    Object o = ctx.resolveInstance(paramType);
                    if (autowire.required() && o == null) {
                        BuilderConfigException e = new BuilderConfigException("No autowire found for method ");
                        e.setIdentifier(method.getName());
                        throw e;
                    }

                    Injector injector = new MethodInjector(method, new SingletonObjectFactory(o));
                    injectors.add(injector);
                }
            }
            // decorate the logical model
            SystemComponentRuntimeConfiguration config = new SystemComponentRuntimeConfiguration(name,
                    JavaIntrospectionHelper.getDefaultConstructor(implClass), injectors, eagerInit, initInvoker,
                    destroyInvoker, scope);
            componentImplementation.setRuntimeConfiguration(config);
        } catch (BuilderConfigException e) {
            e.addContextName(component.getName());
            e.addContextName(parentContext.getName());
            throw e;
        } catch (NoSuchMethodException e) {
            BuilderConfigException ce = new BuilderConfigException("Class does not have a no-arg constructor", e);
            ce.setIdentifier(implClass.getName());
            throw ce;
        }
    }

    // ----------------------------------
    // Private methods
    // ----------------------------------

    /**
     * Creates an <code>Injector</code> for component properties
     */
    private Injector createPropertyInjector(ConfiguredProperty property, Set<Field> fields, Set<Method> methods)
            throws NoAccessorException {
        Object value = property.getValue();
        String propName = property.getProperty().getName();
        // @FIXME is this how to get property type of object
        Class type = value.getClass();

        // There is no efficient way to do this
        Method method = null;
        Field field = JavaIntrospectionHelper.findClosestMatchingField(propName, type, fields);
        if (field == null) {
            method = JavaIntrospectionHelper.findClosestMatchingMethod(propName, new Class[] { type }, methods);
            if (method == null) {
                throw new NoAccessorException(propName);
            }
        }
        Injector injector = null;
        // FIXME support types other than String
        if (value instanceof DataObject) {
            if (field != null) {
                injector = new FieldInjector(field, new SDOObjectFactory((DataObject) value));
            } else {
                injector = new MethodInjector(method, new SDOObjectFactory((DataObject) value));
            }
        } else if (JavaIntrospectionHelper.isImmutable(type)) {
            if (field != null) {
                injector = new FieldInjector(field, new SingletonObjectFactory(value));
            } else {
                injector = new MethodInjector(method, new SingletonObjectFactory(value));
            }
        } else {
            if (field != null) {
                throw new UnknownTypeException(field.getName());
            } else {
                throw new UnknownTypeException(method.getName());
            }
        }
        return injector;

    }

    /**
     * Creates an <code>Injector</code> for service references
     */
    private Injector createReferenceInjector(String moduleName, String componentName, AggregateContext parentContext,
            ConfiguredReference reference, Set<Field> fields, Set<Method> methods) throws NoAccessorException,
            BuilderConfigException {
        String refName = reference.getReference().getName();
        List<ConfiguredService> services = reference.getTargetConfiguredServices();
        Class type;
        if (services.size() == 1) {
            // get the interface
            type = reference.getReference().getServiceContract().getInterface();
        } else {
            // FIXME do we support arrays?
            type = List.class;
        }
        Method method = null;
        Field field = JavaIntrospectionHelper.findClosestMatchingField(refName, type, fields);
        if (field == null) {
            method = JavaIntrospectionHelper.findClosestMatchingMethod(refName, new Class[] { type }, methods);
            if (method == null) {
                throw new NoAccessorException(refName);
            }
        }
        Injector injector;
        try {
            if (field != null) {
                injector = new FieldInjector(field, new ReferenceTargetFactory(reference, parentContext));
            } else {
                injector = new MethodInjector(method, new ReferenceTargetFactory(reference, parentContext));
            }
        } catch (ObjectCreationException e) {
            BuilderConfigException ce = new BuilderConfigException("Error configuring reference", e);
            ce.setIdentifier(refName);
            throw ce;
        }
        return injector;

    }

}