/*
* Copyright 2009 JBoss, a divison Red Hat, Inc
*
* 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.jboss.errai.cdi.server;
import org.jboss.errai.bus.client.api.Message;
import org.jboss.errai.bus.client.api.MessageCallback;
import org.jboss.errai.bus.client.api.builder.DefaultRemoteCallBuilder;
import org.jboss.errai.bus.client.framework.MessageBus;
import org.jboss.errai.bus.client.framework.ProxyProvider;
import org.jboss.errai.bus.client.framework.RequestDispatcher;
import org.jboss.errai.bus.client.util.ErrorHelper;
import org.jboss.errai.bus.rebind.RebindUtils;
import org.jboss.errai.bus.server.AsyncDispatcher;
import org.jboss.errai.bus.server.ErraiBootstrapFailure;
import org.jboss.errai.bus.server.ServerMessageBusImpl;
import org.jboss.errai.bus.server.SimpleDispatcher;
import org.jboss.errai.bus.server.annotations.Command;
import org.jboss.errai.bus.server.annotations.Remote;
import org.jboss.errai.bus.server.annotations.Service;
import org.jboss.errai.bus.server.io.ConversationalEndpointCallback;
import org.jboss.errai.bus.server.io.RemoteServiceCallback;
import org.jboss.errai.bus.server.io.ServiceInstanceProvider;
import org.jboss.errai.bus.server.service.ErraiService;
import org.jboss.errai.cdi.server.events.ConversationalEvent;
import org.jboss.errai.cdi.server.events.ConversationalEventBean;
import org.jboss.errai.cdi.server.events.ConversationalEventObserverMethod;
import org.jboss.errai.cdi.server.events.EventDispatcher;
import org.jboss.errai.cdi.server.events.EventObserverMethod;
import org.jboss.errai.cdi.server.events.ShutdownEventObserver;
import org.jboss.errai.common.client.api.annotations.Portable;
import org.jboss.errai.common.client.framework.Assert;
import org.jboss.errai.common.client.types.TypeHandlerFactory;
import org.jboss.errai.enterprise.client.cdi.CDIProtocol;
import org.jboss.errai.enterprise.client.cdi.api.CDI;
import org.jboss.errai.enterprise.client.cdi.api.Conversational;
import org.jboss.errai.ioc.client.api.Sender;
import org.jboss.weld.manager.BeanManagerImpl;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import javax.enterprise.context.ApplicationScoped;
import javax.enterprise.event.Event;
import javax.enterprise.event.Observes;
import javax.enterprise.inject.Default;
import javax.enterprise.inject.spi.AfterBeanDiscovery;
import javax.enterprise.inject.spi.AnnotatedMethod;
import javax.enterprise.inject.spi.AnnotatedType;
import javax.enterprise.inject.spi.BeanManager;
import javax.enterprise.inject.spi.BeforeBeanDiscovery;
import javax.enterprise.inject.spi.Extension;
import javax.enterprise.inject.spi.ProcessAnnotatedType;
import javax.enterprise.inject.spi.ProcessObserverMethod;
import javax.inject.Inject;
import javax.inject.Qualifier;
import java.lang.annotation.Annotation;
import java.lang.reflect.Field;
import java.lang.reflect.Method;
import java.lang.reflect.ParameterizedType;
import java.lang.reflect.Type;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Collections;
import java.util.HashMap;
import java.util.HashSet;
import java.util.LinkedHashSet;
import java.util.List;
import java.util.Map;
import java.util.ResourceBundle;
import java.util.Set;
import java.util.UUID;
import static java.util.ResourceBundle.getBundle;
/**
* Extension points to the CDI container.
* Makes Errai components available as CDI beans (i.e. the message bus)
* and registers CDI components as services with Errai.
*
* @author Heiko Braun <hbraun@redhat.com>
* @author Mike Brock <cbrock@redhat.com>
* @author Christian Sadilek <csadilek@redhat.com>
*/
@ApplicationScoped
public class CDIExtensionPoints implements Extension {
private static final Logger log = LoggerFactory.getLogger(CDIExtensionPoints.class);
private TypeRegistry managedTypes = null;
private String uuid = null;
// private ContextManager contextManager;
private ErraiService service;
private Set<EventConsumer> eventConsumers = new LinkedHashSet<EventConsumer>();
private Set<MessageSender> messageSenders = new LinkedHashSet<MessageSender>();
private Map<String, Annotation> eventQualifiers = new HashMap<String, Annotation>();
private Map<String, Annotation> beanQualifiers = new HashMap<String, Annotation>();
private Set<String> observableEvents = new HashSet<String>();
private static final Set<String> vetoClasses;
private static final String ERRAI_CDI_STANDALONE = "errai.cdi.standalone";
private boolean standalone = Boolean.getBoolean(ERRAI_CDI_STANDALONE);
static {
Set<String> veto = new HashSet<String>();
veto.add(ServerMessageBusImpl.class.getName());
veto.add(RequestDispatcher.class.getName());
veto.add(ErraiService.class.getName());
vetoClasses = Collections.unmodifiableSet(veto);
}
public void beforeBeanDiscovery(@Observes BeforeBeanDiscovery bbd) {
this.uuid = UUID.randomUUID().toString();
this.managedTypes = new TypeRegistry();
try {
log.info("configuring Errai CDI");
ResourceBundle erraiServiceConfig = getBundle("ErraiService");
if (erraiServiceConfig.containsKey(ERRAI_CDI_STANDALONE)) {
standalone = "true".equals(erraiServiceConfig.getString(ERRAI_CDI_STANDALONE).trim());
if (standalone) {
log.info("Errai CDI running in standalone mode.");
}
else {
log.info("Errai CDI running in add-on mode.");
}
}
final String dispatchImplKey = "errai.dispatcher_implementation";
if (erraiServiceConfig.containsKey(dispatchImplKey)) {
if (AsyncDispatcher.class.getName().equals(erraiServiceConfig.getString(dispatchImplKey))) {
throw new ErraiBootstrapFailure("Cannot start Errai CDI. You have have configured the service to use the " +
AsyncDispatcher.class.getName() + " dispatcher implementation. Due to limitations of Weld, you must use the " +
SimpleDispatcher.class.getName() + " in order to use this module.");
}
}
}
catch (ErraiBootstrapFailure e) {
throw e;
}
catch (Exception e) {
throw new ErraiBootstrapFailure("Error reading from configuration. Did you include ErraiService.properties?", e);
}
log.info("Created Errai-CDI context: " + uuid);
}
/**
* Register managed beans as Errai services
*
* @param event -
* @param <T> -
*/
public <T> void observeResources(@Observes ProcessAnnotatedType<T> event) {
final AnnotatedType<T> type = event.getAnnotatedType();
for (Annotation a : type.getJavaClass().getAnnotations()) {
if (a.annotationType().isAnnotationPresent(Qualifier.class)) {
beanQualifiers.put(a.annotationType().getName(), a);
}
}
// services
if (type.isAnnotationPresent(Service.class)) {
log.debug("Discovered Errai annotation on type: " + type);
boolean isRpc = false;
Class<T> javaClass = type.getJavaClass();
for (Class<?> intf : javaClass.getInterfaces()) {
isRpc = intf.isAnnotationPresent(Remote.class);
if (isRpc) {
log.debug("Identified Errai RPC interface: " + intf + " on " + type);
managedTypes.addRPCEndpoint(intf, type);
}
}
if (!isRpc) {
managedTypes.addServiceEndpoint(type);
}
}
else {
for (AnnotatedMethod method : type.getMethods()) {
if (method.isAnnotationPresent(Service.class)) {
managedTypes.addServiceMethod(type, method);
}
}
}
// veto on client side implementations that contain CDI annotations
// (i.e. @Observes) Otherwise Weld might try to invoke on them
if (vetoClasses.contains(type.getJavaClass().getName())
|| (type.getJavaClass().getPackage().getName().contains("client") && !type.getJavaClass().isInterface())) {
event.veto();
}
/**
* We must scan for Event consumer injection points to build the tables
*/
Class clazz = type.getJavaClass();
for (Field f : clazz.getDeclaredFields()) {
if (f.isAnnotationPresent(Inject.class)) {
if (Event.class.isAssignableFrom(f.getType())) {
ParameterizedType pType = (ParameterizedType) f.getGenericType();
Class eventType = (Class) pType.getActualTypeArguments()[0];
if (isExposedEntityType(eventType)) {
List<Annotation> qualifiers = new ArrayList<Annotation>();
/**
* Collect Qualifier types for the Event consumer.
*/
for (Annotation annotation : f.getAnnotations()) {
if (annotation.annotationType().isAnnotationPresent(Qualifier.class)) {
qualifiers.add(annotation);
eventQualifiers.put(annotation.annotationType().getName(), annotation);
}
}
eventConsumers.add(new EventConsumer(eventType.isAnnotationPresent(Conversational.class),
null, eventType, qualifiers.toArray(new Annotation[qualifiers.size()])));
}
}
else if (ConversationalEvent.class.isAssignableFrom(f.getType())) {
ParameterizedType pType = (ParameterizedType) f.getGenericType();
Class eventType = (Class) pType.getActualTypeArguments()[0];
if (isExposedEntityType(eventType)) {
List<Annotation> qualifiers = new ArrayList<Annotation>();
/**
* Collect Qualifier types for the Event consumer.
*/
for (Annotation annotation : f.getAnnotations()) {
if (annotation.annotationType().isAnnotationPresent(Qualifier.class)) {
qualifiers.add(annotation);
eventQualifiers.put(annotation.annotationType().getName(), annotation);
}
}
eventConsumers.add(new EventConsumer(true, f.getGenericType(), eventType,
qualifiers.toArray(new Annotation[qualifiers.size()])));
}
}
else if (Sender.class.isAssignableFrom(f.getType())) {
ParameterizedType pType = (ParameterizedType) f.getGenericType();
Class sendType = (Class) pType.getActualTypeArguments()[0];
Set<Annotation> qualifiers = new HashSet<Annotation>();
/**
* Collect Qualifier types for the Event consumer.
*/
for (Annotation annotation : f.getAnnotations()) {
if (annotation.annotationType().isAnnotationPresent(Qualifier.class)) {
qualifiers.add(annotation);
eventQualifiers.put(annotation.annotationType().getName(), annotation);
}
}
if (isExposedEntityType(sendType)) {
messageSenders.add(new MessageSender(f.getGenericType(), qualifiers));
}
}
}
}
}
private boolean isExposedEntityType(Class type) {
if (type.isAnnotationPresent(Portable.class)) {
return true;
}
else {
if (String.class.equals(type) || TypeHandlerFactory.getHandler(type) != null) {
return true;
}
}
return false;
}
public void processObserverMethod(@Observes ProcessObserverMethod processObserverMethod) {
Type t = processObserverMethod.getObserverMethod().getObservedType();
Class type = null;
if (t instanceof Class) {
type = (Class) t;
}
if (type != null && isExposedEntityType(type)) {
Annotation[] methodQualifiers = (Annotation[]) processObserverMethod.getObserverMethod().getObservedQualifiers()
.toArray(new Annotation[0]);
for (Annotation qualifier : methodQualifiers) {
eventQualifiers.put(qualifier.annotationType().getName(), qualifier);
}
observableEvents.add(type.getName());
}
}
public void afterBeanDiscovery(@Observes AfterBeanDiscovery abd, BeanManager bm) {
// Errai Service wrapper
this.service = CDIServerUtil.lookupErraiService();
final MessageBus bus = service.getBus();
if (bus.isSubscribed(CDI.DISPATCHER_SUBJECT)) {
return;
}
abd.addBean(new ErraiServiceBean(bm, this.service));
// event dispatcher
EventDispatcher eventDispatcher = new EventDispatcher(bm, observableEvents, eventQualifiers);
for (EventConsumer ec : eventConsumers) {
if (ec.getEventBeanType() != null) {
abd.addBean(new ConversationalEventBean(ec.getEventBeanType(), (BeanManagerImpl) bm, bus));
}
if (ec.isConversational()) {
abd.addObserverMethod(new ConversationalEventObserverMethod(ec.getRawType(), bus, ec.getQualifiers()));
}
else {
abd.addObserverMethod(new EventObserverMethod(ec.getRawType(), bus, ec.getQualifiers()));
}
}
for (MessageSender ms : messageSenders) {
abd.addBean(new SenderBean(ms.getSenderType(), ms.getQualifiers(), bus));
}
// Errai bus injection
abd.addBean(new MessageBusBean(bm, bus));
// Support to inject the request dispatcher.
abd.addBean(new RequestDispatcherMetaData(bm, service.getDispatcher()));
// abd.addBean(new SenderBean((BeanManagerImpl) bm, service.getDispatcher()));
// Register observers
abd.addObserverMethod(new ShutdownEventObserver(managedTypes, bus, uuid));
// subscribe service and rpc endpoints
subscribeServices(bm, bus);
// subscribe event dispatcher
bus.subscribe(CDI.DISPATCHER_SUBJECT, eventDispatcher);
}
private void subscribeServices(final BeanManager beanManager, final MessageBus bus) {
for (Map.Entry<AnnotatedType, List<AnnotatedMethod>> entry : managedTypes.getServiceMethods().entrySet()) {
final Class<?> type = entry.getKey().getJavaClass();
for (final AnnotatedMethod method : entry.getValue()) {
Service svc = method.getAnnotation(Service.class);
String svcName = svc.value().equals("") ? method.getJavaMember().getName() : svc.value();
final Method callMethod = method.getJavaMember();
bus.subscribe(svcName, new MessageCallback() {
@Override
public void callback(Message message) {
Object targetBean = CDIServerUtil.lookupBean(beanManager, type);
try {
callMethod.invoke(targetBean, message);
}
catch (Exception e) {
ErrorHelper.sendClientError(bus, message, "Error dispatching service", e);
}
}
});
}
}
for (final AnnotatedType<?> type : managedTypes.getServiceEndpoints()) {
// Discriminate on @Command
Map<String, Method> commandPoints = new HashMap<String, Method>();
for (final AnnotatedMethod method : type.getMethods()) {
if (method.isAnnotationPresent(Command.class)) {
Command command = method.getAnnotation(Command.class);
for (String cmdName : command.value()) {
if (cmdName.equals(""))
cmdName = method.getJavaMember().getName();
commandPoints.put(cmdName, method.getJavaMember());
}
}
}
log.info("Register MessageCallback: " + type);
final String subjectName = CDIServerUtil.resolveServiceName(type.getJavaClass());
bus.subscribe(subjectName, new MessageCallback() {
@Override
public void callback(final Message message) {
MessageCallback callback = (MessageCallback) CDIServerUtil.lookupBean(beanManager,
type.getJavaClass());
callback.callback(message);
}
});
}
//todo: needs to be rewritten to support @SessionScoped
for (final Class<?> rpcIntf : managedTypes.getRpcEndpoints().keySet()) {
final AnnotatedType type = managedTypes.getRpcEndpoints().get(rpcIntf);
final Class beanClass = type.getJavaClass();
log.info("Register RPC Endpoint: " + type + "(" + rpcIntf + ")");
// TODO: Copied from errai internals, refactor at some point
createRPCScaffolding(rpcIntf, beanClass, bus, beanManager);
}
}
private void createRPCScaffolding(final Class remoteIface, final Class<?> type, final MessageBus bus,
final BeanManager beanManager) {
Map<String, MessageCallback> epts = new HashMap<String, MessageCallback>();
// beware of classloading issues. better reflect on the actual instance
for (Class<?> intf : type.getInterfaces()) {
for (final Method method : intf.getDeclaredMethods()) {
if (RebindUtils.isMethodInInterface(remoteIface, method)) {
epts.put(RebindUtils.createCallSignature(method), new ConversationalEndpointCallback(new ServiceInstanceProvider() {
@Override
public Object get(Message message) {
if (message.hasPart(CDIProtocol.Qualifiers)) {
List<String> quals = message.get(List.class, CDIProtocol.Qualifiers);
Annotation[] qualAnnos = new Annotation[quals.size()];
for (int i = 0; i < quals.size(); i++) {
qualAnnos[i] = beanQualifiers.get(quals.get(i));
}
return CDIServerUtil.lookupRPCBean(beanManager, remoteIface, remoteIface, qualAnnos);
}
else {
return CDIServerUtil.lookupRPCBean(beanManager, remoteIface, type, null);
}
}
}, method, bus));
}
}
}
final RemoteServiceCallback delegate = new RemoteServiceCallback(epts);
bus.subscribe(remoteIface.getName() + ":RPC", new MessageCallback() {
@Override
public void callback(Message message) {
delegate.callback(message);
}
});
// note: this method just exists because we want AbstractRemoteCallBuilder to be package private.
DefaultRemoteCallBuilder.setProxyFactory(Assert.notNull(new ProxyProvider() {
@Override
public <T> T getRemoteProxy(Class<T> proxyType) {
throw new RuntimeException("There is not yet an available Errai RPC implementation for the server-side environment.");
}
}));
}
private static boolean isApplicationScoped(AnnotatedType type) {
return type.isAnnotationPresent(ApplicationScoped.class);
}
static class EventConsumer {
private boolean conversational;
private Type eventBeanType;
private Type eventType;
private Annotation[] qualifiers;
EventConsumer(boolean conversational, Type eventBeanType, Type type, Annotation[] qualifiers) {
this.conversational = conversational;
this.eventBeanType = eventBeanType;
this.eventType = type;
this.qualifiers = qualifiers;
}
public boolean isConversational() {
return conversational;
}
public Class<?> getRawType() {
if (eventType instanceof Class) {
return (Class) eventType;
}
else if (eventType instanceof ParameterizedType) {
return (Class) ((ParameterizedType) eventType).getRawType();
}
else {
throw new RuntimeException("bad type: " + eventType);
}
}
public Type getEventBeanType() {
return eventBeanType;
}
public Type getEventType() {
return eventType;
}
public Annotation[] getQualifiers() {
return qualifiers;
}
@Override
public String toString() {
return "EventConsumer " + eventType + " " + Arrays.toString(qualifiers);
}
@Override
public boolean equals(Object o) {
if (this == o) return true;
if (!(o instanceof EventConsumer)) return false;
EventConsumer that = (EventConsumer) o;
return that.toString().equals(toString());
}
@Override
public int hashCode() {
return toString().hashCode();
}
}
static class MessageSender {
private Type senderType;
private Set<Annotation> qualifiers;
MessageSender(Type senderType, Set<Annotation> qualifiers) {
this.senderType = senderType;
this.qualifiers = qualifiers;
}
public Type getSenderType() {
return senderType;
}
public Set<Annotation> getQualifiers() {
return qualifiers;
}
}
private static Annotation[] getQualifiersFromField(Field field) {
List<Annotation> qualifiers = new ArrayList<Annotation>();
for (Annotation a : field.getDeclaredAnnotations()) {
if (!a.getClass().isAnnotationPresent(Qualifier.class)
|| a instanceof Default)
continue;
qualifiers.add(a);
}
return qualifiers.toArray(new Annotation[qualifiers.size()]);
}
private static Annotation[] getQualifiersFromObserverMethod(Method method) {
for (Annotation[] annotations : method.getParameterAnnotations()) {
boolean isObserverType = false;
for (Annotation a : annotations) {
if (a instanceof Observes) {
isObserverType = true;
break;
}
}
if (isObserverType) {
List<Annotation> qualifiers = new ArrayList<Annotation>();
for (Annotation a : annotations) {
if (!a.annotationType().isAnnotationPresent(Qualifier.class)
|| a instanceof Default) continue;
qualifiers.add(a);
}
return qualifiers.toArray(new Annotation[qualifiers.size()]);
}
}
return new Annotation[0];
}
}