/**
* 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.io.IOException;
import java.util.Arrays;
import java.util.List;
import java.util.Map;
import org.apache.cxf.BusException;
import org.apache.cxf.binding.BindingConfiguration;
import org.apache.cxf.binding.BindingFactory;
import org.apache.cxf.binding.BindingFactoryManager;
import org.apache.cxf.endpoint.AbstractEndpointFactory;
import org.apache.cxf.endpoint.Endpoint;
import org.apache.cxf.endpoint.EndpointException;
import org.apache.cxf.endpoint.EndpointImpl;
import org.apache.cxf.endpoint.Server;
import org.apache.cxf.endpoint.ServerImpl;
import org.apache.cxf.feature.AbstractFeature;
import org.apache.cxf.jaxrs.impl.RequestPreprocessor;
import org.apache.cxf.jaxrs.lifecycle.ResourceProvider;
import org.apache.cxf.jaxrs.provider.ProviderFactory;
import org.apache.cxf.service.Service;
import org.apache.cxf.service.factory.ServiceConstructionException;
import org.apache.cxf.service.invoker.Invoker;
import org.apache.cxf.service.model.BindingInfo;
import org.apache.cxf.service.model.EndpointInfo;
import org.apache.cxf.transport.DestinationFactory;
import org.apache.cxf.transport.DestinationFactoryManager;
/**
* Bean to help easily create Server endpoints for JAX-RS. Example:
* <pre>
* JAXRSServerFactoryBean sf = JAXRSServerFactoryBean();
* sf.setResourceClasses(Book.class);
* sf.setBindingId(JAXRSBindingFactory.JAXRS_BINDING_ID);
* sf.setAddress("http://localhost:9080/");
* sf.create();
* </pre>
* This will start a server for you and register it with the ServerManager.
*/
public class JAXRSServerFactoryBean extends AbstractEndpointFactory {
protected boolean doInit;
private Server server;
private Invoker invoker;
private boolean start = true;
private JAXRSServiceFactoryBean serviceFactory;
private List<Object> serviceBeans;
private List<?> entityProviders;
private Map<Object, Object> languageMappings;
private Map<Object, Object> extensionMappings;
private List<String> schemaLocations;
public JAXRSServerFactoryBean() {
this(new JAXRSServiceFactoryBean());
}
public JAXRSServerFactoryBean(JAXRSServiceFactoryBean sf) {
this.serviceFactory = sf;
doInit = true;
setBindingId(JAXRSBindingFactory.JAXRS_BINDING_ID);
}
public void setSchemaLocations(List<String> schemas) {
this.schemaLocations = schemas;
}
public Server create() {
try {
Endpoint ep = createEndpoint();
server = new ServerImpl(getBus(),
ep,
getDestinationFactory(),
getBindingFactory());
if (invoker == null) {
ep.getService().setInvoker(createInvoker());
} else {
ep.getService().setInvoker(invoker);
}
if (entityProviders != null) {
ProviderFactory.getInstance().setUserProviders(entityProviders);
}
ProviderFactory.getInstance().setRequestPreporcessor(
new RequestPreprocessor(languageMappings, extensionMappings));
if (schemaLocations != null) {
ProviderFactory.getInstance().setSchemaLocations(schemaLocations);
}
if (start) {
server.start();
}
} catch (EndpointException e) {
throw new ServiceConstructionException(e);
} catch (BusException e) {
throw new ServiceConstructionException(e);
} catch (IOException e) {
throw new ServiceConstructionException(e);
}
applyFeatures();
return server;
}
protected void applyFeatures() {
if (getFeatures() != null) {
for (AbstractFeature feature : getFeatures()) {
feature.initialize(server, getBus());
}
}
}
protected Invoker createInvoker() {
if (serviceBeans == null) {
return new JAXRSInvoker();
} else {
return new JAXRSInvoker(serviceBeans);
}
}
protected Endpoint createEndpoint() throws BusException, EndpointException {
Service service = serviceFactory.getService();
if (service == null) {
service = serviceFactory.create();
}
EndpointInfo ei = createEndpointInfo();
Endpoint ep = new EndpointImpl(getBus(), getServiceFactory().getService(), ei);
if (properties != null) {
ep.putAll(properties);
}
if (getInInterceptors() != null) {
ep.getInInterceptors().addAll(getInInterceptors());
}
if (getOutInterceptors() != null) {
ep.getOutInterceptors().addAll(getOutInterceptors());
}
if (getInFaultInterceptors() != null) {
ep.getInFaultInterceptors().addAll(getInFaultInterceptors());
}
if (getOutFaultInterceptors() != null) {
ep.getOutFaultInterceptors().addAll(getOutFaultInterceptors());
}
return ep;
}
/*
* EndpointInfo contains information form WSDL's physical part such as
* endpoint address, binding, transport etc. For JAX-RS based EndpointInfo,
* as there is no WSDL, these information are set manually, eg, default
* transport is http, binding is JAX-RS binding, endpoint address is from
* server mainline.
*/
protected EndpointInfo createEndpointInfo() throws BusException {
String transportId = getTransportId();
if (transportId == null && getAddress() != null) {
DestinationFactory df = getDestinationFactory();
if (df == null) {
DestinationFactoryManager dfm = getBus().getExtension(DestinationFactoryManager.class);
df = dfm.getDestinationFactoryForUri(getAddress());
}
if (df != null) {
transportId = df.getTransportIds().get(0);
}
}
//default to http transport
if (transportId == null) {
transportId = "http://schemas.xmlsoap.org/wsdl/soap/http";
}
setTransportId(transportId);
EndpointInfo ei = new EndpointInfo();
ei.setTransportId(transportId);
ei.setName(serviceFactory.getService().getName());
ei.setAddress(getAddress());
BindingInfo bindingInfo = createBindingInfo();
ei.setBinding(bindingInfo);
return ei;
}
protected BindingInfo createBindingInfo() {
BindingFactoryManager mgr = getBus().getExtension(BindingFactoryManager.class);
String binding = getBindingId();
BindingConfiguration bindingConfig = getBindingConfig();
if (binding == null && bindingConfig != null) {
binding = bindingConfig.getBindingId();
}
if (binding == null) {
binding = JAXRSBindingFactory.JAXRS_BINDING_ID;
}
try {
BindingFactory bindingFactory = mgr.getBindingFactory(binding);
setBindingFactory(bindingFactory);
return bindingFactory.createBindingInfo(serviceFactory.getService(),
binding, bindingConfig);
} catch (BusException ex) {
ex.printStackTrace();
//do nothing
}
return null;
}
public void setLanguageMappings(Map<Object, Object> lMaps) {
languageMappings = lMaps;
}
public void setExtensionMappings(Map<Object, Object> extMaps) {
extensionMappings = extMaps;
}
public JAXRSServiceFactoryBean getServiceFactory() {
return serviceFactory;
}
public void setServiceFactory(JAXRSServiceFactoryBean serviceFactory) {
this.serviceFactory = serviceFactory;
}
public List<Class> getResourceClasses() {
return serviceFactory.getResourceClasses();
}
public void setResourceClasses(List<Class> classes) {
serviceFactory.setResourceClasses(classes);
}
public void setResourceClasses(Class... classes) {
serviceFactory.setResourceClasses(classes);
}
/**
* Set the backing service bean. If this is set, JAX-RS runtime will not be
* responsible for the lifecycle of resource classes.
*
* @return
*/
public void setServiceBeans(Object... beans) {
setServiceBeans(Arrays.asList(beans));
}
public void setServiceBeans(List<Object> beans) {
this.serviceBeans = beans;
serviceFactory.setResourceClassesFromBeans(beans);
}
public void setResourceProvider(Class c, ResourceProvider rp) {
serviceFactory.setResourceProvider(c, rp);
}
/**
* @return the entityProviders
*/
public List<?> getProviders() {
return entityProviders;
}
/**
* @param entityProviders the entityProviders to set
*/
public void setProviders(List<? extends Object> providers) {
this.entityProviders = providers;
}
}