summaryrefslogtreecommitdiffstats
path: root/sandbox/event/modules/implementation-java/src/main/java/org/apache/tuscany/sca/implementation/java/introspect/impl/ConsumerProcessor.java
blob: dbabfd78dab0ef64bcd29be6239f658f4a7e822e (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
/*
 * 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.tuscany.sca.implementation.java.introspect.impl;

import java.lang.reflect.Method;
import java.lang.reflect.Modifier;
import java.util.logging.Logger;
import org.apache.tuscany.sca.assembly.AssemblyFactory;
import org.apache.tuscany.sca.assembly.Service;
import org.apache.tuscany.sca.implementation.java.IntrospectionException;
import org.apache.tuscany.sca.implementation.java.JavaImplementation;
import org.apache.tuscany.sca.implementation.java.impl.JavaElementImpl;
import org.apache.tuscany.sca.interfacedef.InvalidInterfaceException;
import org.apache.tuscany.sca.interfacedef.java.JavaInterface;
import org.apache.tuscany.sca.interfacedef.java.JavaInterfaceContract;
import org.apache.tuscany.sca.interfacedef.java.JavaInterfaceFactory;

/**
 * Processes an {@link org.osoa.sca.annotations.Service} annotation and updates
 * the component type with corresponding {@link Service}s. Also processes
 * related {@link org.osoa.sca.annotations.Callback} annotations.
 * 
 * @version $$
 */
public class ConsumerProcessor extends BaseJavaClassVisitor {
	@SuppressWarnings("unused")
    private static final Logger logger = Logger.getLogger(ConsumerProcessor.class.getName());

    private JavaInterfaceFactory javaFactory;
    
    public ConsumerProcessor(AssemblyFactory assemblyFactory, JavaInterfaceFactory javaFactory) {
        super(assemblyFactory);
        this.javaFactory = javaFactory;
    }
    
    @Override
    public void visitMethod(Method method, JavaImplementation type) throws IntrospectionException {

    	org.osoa.sca.annotations.Consumer annotation = method.getAnnotation(org.osoa.sca.annotations.Consumer.class);
        if (annotation == null) {
            return;
        }
        if(Modifier.isPrivate(method.getModifiers())) {
            throw new IllegalConsumerException("Illegal annotation @Consumer found on "+method, method);
        }
        if (method.getParameterTypes().length != 1) {
            throw new IllegalConsumerException("Consumer must have one parameter", method);
        }
        JavaElementImpl element = new JavaElementImpl(method.getDeclaringClass());
        try {
			createConsumer(type, element, annotation.name(), method);
		} catch (InvalidInterfaceException e) {
			throw new IntrospectionException(e);
		}
    }

    /**
     * Creates or updates a Consumer 
     * @param type - the JavaImplementation to which the consumer applies
     * @param element - the Java class implementing the consumer
     * @param consumerName - the Name of the consumer
     * @param operationName - the Name of the operation (ie Method) annotated with @Consumer
     * @throws IllegalConsumerException
     */
    private void createConsumer(JavaImplementation type, JavaElementImpl element, 
    		                    String consumerName, Method method )
        throws IllegalConsumerException, InvalidInterfaceException {
    	
    	// First, see if the Consumer already exists
    	org.apache.tuscany.sca.assembly.Consumer consumer = findConsumerByName( type, consumerName ); 
    	
    	if( consumer == null ) {
    		// Create the consumer object and add it to the JavaImplementation
	        Class<?> consumerClass = element.getType();
	        
	        consumer = assemblyFactory.createConsumer();
	        JavaInterfaceContract interfaceContract = javaFactory.createJavaInterfaceContract();
	        consumer.setInterfaceContract(interfaceContract);
	        consumer.setName(consumerName);       
	        JavaInterface consumerInterface = javaFactory.createJavaInterface();
	        consumerInterface.setRemotable(true);
	        javaFactory.createJavaInterface(consumerInterface, consumerClass);
	        consumer.getInterfaceContract().setInterface(consumerInterface);

	        type.getConsumers().add(consumer);
    	} // end if 
    	
    	// Add the operation to the consumer
    	consumer.addOperation(method.getName(), getOperationEventTypes(method) );
    	
    } // end method createConsumer
    
    private static String getOperationEventTypes( Method method ) {
    	// 1) If the method is annotated with @EventTypes, extract the supported event types from the annotation
    	org.osoa.sca.annotations.EventTypes annotation = method.getAnnotation(org.osoa.sca.annotations.EventTypes.class);
        if (annotation != null) {
            return annotation.value();
        } // end if 

    	// 2) If the method has a parameter that is NOT java.lang.Object, return its event type or its base Java type
        Class<?> parameter = method.getParameterTypes()[0];
        String className = parameter.getCanonicalName();
        if( !className.equals("java.lang.Object")) {
        	org.osoa.sca.annotations.EventType eventType = parameter.getAnnotation(org.osoa.sca.annotations.EventType.class);
            if (eventType != null) {
                return eventType.name();
            } else { 
            	return className;
            }// end if 
        } // end if
        
    	// 3) Else, return "null" meaning that the method supports "any event type"
    	return null;
    } // end getOperationEventTypes
    
    /**
     * Finds a Consumer within a Java implementation by the name of the consumer
     * @param impl - the Java implementation
     * @param name - the consumer name
     * @return - the Consumer with the specified name, or null if it does not exist
     */
    private static org.apache.tuscany.sca.assembly.Consumer findConsumerByName( JavaImplementation impl, String name ) {
    	for( org.apache.tuscany.sca.assembly.Consumer consumer : impl.getConsumers() ) {
    		if( name.equals(consumer.getName()) ) return consumer;
    	} // end for
    	return null;
    } // end method findConsumerByName
    

}