All Downloads are FREE. Search and download functionalities are using the official Maven repository.

org.apache.cxf.jaxrs.JAXRSServiceFactoryBean Maven / Gradle / Ivy

There is a newer version: 4.1.0
Show newest version
/**
 * 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.cxf.jaxrs;

import java.lang.reflect.Method;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import java.util.concurrent.Executor;

import javax.ws.rs.Path;

import org.apache.cxf.common.util.ClassHelper;
import org.apache.cxf.jaxrs.lifecycle.PerRequestResourceProvider;
import org.apache.cxf.jaxrs.lifecycle.ResourceProvider;
import org.apache.cxf.jaxrs.model.ClassResourceInfo;
import org.apache.cxf.jaxrs.model.MethodDispatcher;
import org.apache.cxf.jaxrs.model.OperationResourceInfo;
import org.apache.cxf.jaxrs.model.URITemplate;
import org.apache.cxf.service.Service;
import org.apache.cxf.service.factory.AbstractServiceFactoryBean;
import org.apache.cxf.service.invoker.Invoker;


/**
 * Build a JAX-RS service model from resource classes.
 */
public class JAXRSServiceFactoryBean extends AbstractServiceFactoryBean {
    
    //private static final Logger LOG = Logger.getLogger(JAXRSServiceFactoryBean.class.getName());
    //private static final ResourceBundle BUNDLE = BundleUtils.getBundle(JAXRSServiceFactoryBean.class);

    protected List classResourceInfos = 
        new ArrayList();
    protected Map resourceProviders = new HashMap();
    
    private Invoker invoker;
    private Executor executor;
    private Map properties;

    public JAXRSServiceFactoryBean() {
    }

    @Override
    public Service create() {
        initializeServiceModel();

        initializeDefaultInterceptors();

        if (invoker != null) {
            getService().setInvoker(getInvoker());
        } else {
            getService().setInvoker(createInvoker());
        }

        if (getExecutor() != null) {
            getService().setExecutor(getExecutor());
        }
        if (getDataBinding() != null) {
            getService().setDataBinding(getDataBinding());
        }

        return getService();
    }

    public Executor getExecutor() {
        return executor;
    }

    public void setExecutor(Executor executor) {
        this.executor = executor;
    }

    public Invoker getInvoker() {
        return invoker;
    }

    public void setInvoker(Invoker invoker) {
        this.invoker = invoker;
    }

    public List getResourceClasses() {
        List resourceClasses = new ArrayList();
        for (ClassResourceInfo cri : classResourceInfos) {
            resourceClasses.add(cri.getResourceClass());
        }
        return resourceClasses;
    }

    public void setResourceClasses(List classes) {
        for (Class resourceClass : classes) {
            ClassResourceInfo classResourceInfo = 
                createClassResourceInfo(resourceClass, resourceClass, true);
            classResourceInfos.add(classResourceInfo);
        }
    }

    public void setResourceClasses(Class... classes) {
        setResourceClasses(Arrays.asList(classes));
    }
    
    public void setResourceClassesFromBeans(List beans) {
        for (Object bean : beans) {
            
            ClassResourceInfo classResourceInfo = 
                createClassResourceInfo(bean.getClass(), 
                                        ClassHelper.getRealClass(bean),
                                            true);
            classResourceInfos.add(classResourceInfo);
        }
    }
    
    public void setResourceProvider(Class c, ResourceProvider rp) {
        resourceProviders.put(c, rp);
        updateClassResourceProviders();
    }
    
    protected void initializeServiceModel() {
        
        updateClassResourceProviders();
        
        JAXRSServiceImpl service = new JAXRSServiceImpl(classResourceInfos);

        setService(service);

        if (properties != null) {
            service.putAll(properties);
        }
    }

    private void updateClassResourceProviders() {
        for (ClassResourceInfo cri : classResourceInfos) {
            //TODO: Using information from annotation to determine which lifecycle provider to use
            ResourceProvider rp = resourceProviders.get(cri.getResourceClass());
            if (rp != null) {
                cri.setResourceProvider(rp);
            } else {
                //default lifecycle is per-request
                rp = new PerRequestResourceProvider(cri.getResourceClass());
                cri.setResourceProvider(rp);  
            }
        }
    }
    
    protected ClassResourceInfo createClassResourceInfo(
        final Class rClass, final Class sClass, boolean root) {
        ClassResourceInfo cri  = new ClassResourceInfo(rClass, sClass, root);

        if (root) {
            URITemplate t = URITemplate.createTemplate(cri, cri.getPath());
            cri.setURITemplate(t);
        }
        
        MethodDispatcher md = createOperation(cri);
        cri.setMethodDispatcher(md);
        return cri;
    }

    protected MethodDispatcher createOperation(ClassResourceInfo cri) {
        MethodDispatcher md = new MethodDispatcher();
        for (Method m : cri.getServiceClass().getMethods()) {
            
                       
            String httpMethod = JAXRSUtils.getHttpMethodValue(m);
            Path path = (Path)JAXRSUtils.getMethodAnnotation(m, Path.class);
            if (httpMethod != null && path != null) {
                /*
                 * Sub-resource method, URI template created by concatenating
                 * the URI template of the resource class with the URI template
                 * of the method
                 */
                OperationResourceInfo ori = new OperationResourceInfo(m, cri);
                URITemplate t = 
                    URITemplate.createTemplate(cri, path);
                ori.setURITemplate(t);
                ori.setHttpMethod(httpMethod);
                md.bind(ori, m);
            } else if (path != null) {
                // sub-resource locator
                OperationResourceInfo ori = new OperationResourceInfo(m, cri);
                URITemplate t = 
                    URITemplate.createTemplate(cri, path);
                ori.setURITemplate(t);
                md.bind(ori, m);     
                Class subResourceClass = m.getReturnType();
                ClassResourceInfo subCri = createClassResourceInfo(
                     subResourceClass, subResourceClass, false);
                cri.addSubClassResourceInfo(subCri);
            } else if (httpMethod != null) {
                OperationResourceInfo ori = new OperationResourceInfo(m, cri);
                URITemplate t = 
                    URITemplate.createTemplate(cri, null);
                ori.setURITemplate(t);
                ori.setHttpMethod(httpMethod);
                md.bind(ori, m);
            }
        }

        return md;
    }
    
    
    
    protected Invoker createInvoker() {
        return new JAXRSInvoker();
    }

}