Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance.
Project price only 1 $
You can buy this project and download/modify it how often you want.
org.apache.cxf.jaxrs.provider.RequestDispatcherProvider Maven / Gradle / Ivy
/**
* 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.provider;
import java.io.IOException;
import java.io.OutputStream;
import java.lang.annotation.Annotation;
import java.lang.reflect.Type;
import java.util.Collections;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import java.util.ResourceBundle;
import java.util.logging.Level;
import java.util.logging.Logger;
import javax.servlet.RequestDispatcher;
import javax.servlet.ServletContext;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletRequestWrapper;
import javax.ws.rs.Produces;
import javax.ws.rs.WebApplicationException;
import javax.ws.rs.core.Context;
import javax.ws.rs.core.MediaType;
import javax.ws.rs.core.MultivaluedMap;
import javax.ws.rs.core.PathSegment;
import javax.ws.rs.core.UriInfo;
import javax.ws.rs.ext.MessageBodyWriter;
import javax.ws.rs.ext.Provider;
import org.apache.cxf.common.i18n.BundleUtils;
import org.apache.cxf.common.logging.LogUtils;
import org.apache.cxf.jaxrs.ext.MessageContext;
import org.apache.cxf.jaxrs.utils.ResourceUtils;
import org.apache.cxf.message.Message;
import org.apache.cxf.phase.PhaseInterceptorChain;
import org.apache.cxf.transport.http.AbstractHTTPDestination;
@Produces("text/html")
@Provider
public class RequestDispatcherProvider extends AbstractConfigurableProvider
implements MessageBodyWriter {
private static final ResourceBundle BUNDLE = BundleUtils.getBundle(RequestDispatcherProvider.class);
private static final Logger LOG = LogUtils.getL7dLogger(RequestDispatcherProvider.class);
private static final String ABSOLUTE_PATH_PARAMETER = "absolute.path";
private static final String BASE_PATH_PARAMETER = "base.path";
private static final String WEBAPP_BASE_PATH_PARAMETER = "webapp.base.path";
private static final String RELATIVE_PATH_PARAMETER = "relative.path";
private static final String REQUEST_SCOPE = "request";
private static final String SESSION_SCOPE = "session";
private static final String MESSAGE_RESOURCE_PATH_PROPERTY = "redirect.resource.path";
private static final String DEFAULT_RESOURCE_EXTENSION = ".jsp";
private static final String DEFAULT_LOCATION_PREFIX = "/WEB-INF/";
private String servletContextPath;
private String resourcePath;
private Map resourcePaths = Collections.emptyMap();
private Map classResources = Collections.emptyMap();
private Map, String> enumResources = Collections.emptyMap();
private boolean useClassNames;
private String scope = REQUEST_SCOPE;
private Map beanNames = Collections.emptyMap();
private String beanName;
private String dispatcherName;
private String servletPath;
private boolean saveParametersAsAttributes;
private boolean logRedirects;
private boolean strictPathCheck;
private MessageContext mc;
@Context
public void setMessageContext(MessageContext context) {
this.mc = context;
}
public void setStrictPathCheck(boolean use) {
strictPathCheck = use;
}
public void setUseClassNames(boolean use) {
useClassNames = use;
}
public long getSize(Object t, Class type, Type genericType, Annotation[] annotations, MediaType mt) {
return -1;
}
private String getClassResourceName(Class type) {
String simpleName = type.getSimpleName();
StringBuilder sb = new StringBuilder();
sb.append(Character.toLowerCase(simpleName.charAt(0)));
if (simpleName.length() > 1) {
sb.append(simpleName.substring(1));
}
return DEFAULT_LOCATION_PREFIX + sb.toString() + DEFAULT_RESOURCE_EXTENSION;
}
public boolean isWriteable(Class type, Type genericType, Annotation[] annotations, MediaType mt) {
if (useClassNames
&& ResourceUtils.getClasspathResourceURL(getClassResourceName(type),
RequestDispatcherProvider.class,
getBus()) != null) {
return true;
}
if (resourcePath != null || classResourceSupported(type)) {
return true;
}
if (!resourcePaths.isEmpty()) {
String path = getRequestPath();
for (String requestPath : resourcePaths.keySet()) {
boolean result = strictPathCheck ? path.endsWith(requestPath) : path.contains(requestPath);
if (result) {
return true;
}
}
}
if (mc != null && mc.get(MESSAGE_RESOURCE_PATH_PROPERTY) != null) {
return true;
}
return false;
}
private boolean classResourceSupported(Class type) {
String typeName = type.getName();
if (type.isEnum()) {
for (Object o : enumResources.keySet()) {
if (o.getClass().getName().equals(typeName)) {
return true;
}
}
for (String name : classResources.keySet()) {
if (name.startsWith(typeName)) {
return true;
}
}
return false;
} else {
return classResources.containsKey(typeName);
}
}
public void writeTo(Object o, Class clazz, Type genericType, Annotation[] annotations,
MediaType type, MultivaluedMap headers, OutputStream os)
throws IOException {
ServletContext sc = getServletContext();
String path = getResourcePath(clazz, o);
RequestDispatcher rd = getRequestDispatcher(sc, clazz, path);
try {
mc.put(AbstractHTTPDestination.REQUEST_REDIRECTED, Boolean.TRUE);
String theServletPath = servletPath == null ? "/" : servletPath;
HttpServletRequestFilter servletRequest =
new HttpServletRequestFilter(mc.getHttpServletRequest(), path,
theServletPath, saveParametersAsAttributes);
String attributeName = getBeanName(o);
if (REQUEST_SCOPE.equals(scope)) {
servletRequest.setAttribute(attributeName, o);
} else if (SESSION_SCOPE.equals(scope)) {
servletRequest.getSession(true).setAttribute(attributeName, o);
}
setRequestParameters(servletRequest);
logRedirection(path, attributeName, o);
rd.forward(servletRequest, mc.getHttpServletResponse());
} catch (Throwable ex) {
mc.put(AbstractHTTPDestination.REQUEST_REDIRECTED, Boolean.FALSE);
ex.printStackTrace();
throw new WebApplicationException(ex);
}
}
private void logRedirection(String path, String attributeName, Object o) {
Level level = logRedirects ? Level.INFO : Level.FINE;
if (LOG.isLoggable(level)) {
String message =
new org.apache.cxf.common.i18n.Message("RESPONSE_REDIRECTED_TO",
BUNDLE, o.getClass().getName(), attributeName, path).toString();
LOG.log(level, message);
}
}
String getResourcePath(Class cls, Object o) {
if (useClassNames) {
return getClassResourceName(cls);
}
String name = cls.getName();
if (cls.isEnum()) {
String enumResource = enumResources.get(o);
if (enumResource != null) {
return enumResource;
}
name += "." + o.toString();
}
String clsResourcePath = classResources.get(name);
if (clsResourcePath != null) {
return clsResourcePath;
}
if (resourcePath != null) {
return resourcePath;
}
String path = getRequestPath();
for (String requestPath : resourcePaths.keySet()) {
if (path.endsWith(requestPath)) {
return resourcePaths.get(requestPath);
}
}
Object resourcePathProp = (String)mc.get(MESSAGE_RESOURCE_PATH_PROPERTY);
return resourcePathProp != null ? resourcePathProp.toString() : null;
}
private String getRequestPath() {
Message inMessage = PhaseInterceptorChain.getCurrentMessage().getExchange().getInMessage();
return (String)inMessage.get(Message.REQUEST_URI);
}
protected ServletContext getServletContext() {
ServletContext sc = mc.getServletContext();
if (servletContextPath != null) {
sc = sc.getContext(servletContextPath);
if (sc == null) {
String message =
new org.apache.cxf.common.i18n.Message("RESOURCE_DISPATCH_NOT_FOUND",
BUNDLE, servletContextPath).toString();
LOG.severe(message);
throw new WebApplicationException();
}
}
return sc;
}
protected RequestDispatcher getRequestDispatcher(ServletContext sc, Class clazz, String path) {
RequestDispatcher rd = dispatcherName != null ? sc.getNamedDispatcher(dispatcherName)
: sc.getRequestDispatcher(path);
if (rd == null) {
String message =
new org.apache.cxf.common.i18n.Message("RESOURCE_PATH_NOT_FOUND",
BUNDLE, path).toString();
LOG.severe(message);
throw new WebApplicationException();
}
return rd;
}
public void setResourcePath(String resourcePath) {
this.resourcePath = resourcePath;
}
public void setServletContextPath(String servletContextPath) {
this.servletContextPath = servletContextPath;
}
public void setScope(String scope) {
this.scope = scope;
}
public void setBeanNames(Map beanNames) {
this.beanNames = beanNames;
}
public void setBeanName(String beanName) {
this.beanName = beanName;
}
public void setLogRedirects(String value) {
this.logRedirects = Boolean.valueOf(value);
}
protected String getBeanName(Object bean) {
if (beanName != null) {
return beanName;
}
String name = beanNames.get(bean.getClass().getName());
return name != null ? name : bean.getClass().getSimpleName().toLowerCase();
}
protected void setRequestParameters(HttpServletRequestFilter request) {
if (mc != null) {
UriInfo ui = mc.getUriInfo();
MultivaluedMap params = ui.getPathParameters();
for (Map.Entry> entry : params.entrySet()) {
String value = entry.getValue().get(0);
int ind = value.indexOf(";");
if (ind > 0) {
value = value.substring(0, ind);
}
request.setParameter(entry.getKey(), value);
}
List segments = ui.getPathSegments();
if (segments.size() > 0) {
doSetRequestParameters(request, segments.get(segments.size() - 1).getMatrixParameters());
}
doSetRequestParameters(request, ui.getQueryParameters());
request.setParameter(ABSOLUTE_PATH_PARAMETER, ui.getAbsolutePath().toString());
request.setParameter(RELATIVE_PATH_PARAMETER, ui.getPath());
request.setParameter(BASE_PATH_PARAMETER, ui.getBaseUri().toString());
request.setParameter(WEBAPP_BASE_PATH_PARAMETER, (String)mc.get("http.base.path"));
}
}
protected void doSetRequestParameters(HttpServletRequestFilter req,
MultivaluedMap params) {
for (Map.Entry> entry : params.entrySet()) {
req.setParameters(entry.getKey(), entry.getValue());
}
}
public void setDispatcherName(String name) {
this.dispatcherName = name;
}
public void setServletPath(String path) {
this.servletPath = path;
}
public void setResourcePaths(Map resourcePaths) {
this.resourcePaths = resourcePaths;
}
public void setClassResources(Map resources) {
this.classResources = resources;
}
public void setSaveParametersAsAttributes(boolean saveParametersAsAttributes) {
this.saveParametersAsAttributes = saveParametersAsAttributes;
}
public void setEnumResources(Map, String> enumResources) {
this.enumResources = enumResources;
}
protected static class HttpServletRequestFilter extends HttpServletRequestWrapper {
private Map params;
private String path;
private String servletPath;
private boolean saveParamsAsAttributes;
public HttpServletRequestFilter(HttpServletRequest request,
String path,
String servletPath,
boolean saveParamsAsAttributes) {
super(request);
this.path = path;
this.servletPath = servletPath;
this.saveParamsAsAttributes = saveParamsAsAttributes;
params = new HashMap(request.getParameterMap());
}
@Override
public String getServletPath() {
return servletPath;
}
@Override
public String getPathInfo() {
return path;
}
@Override
public String getRequestURI() {
return path;
}
public void setParameter(String name, String value) {
doSetParameters(name, new String[]{value});
}
public void setParameters(String name, List values) {
doSetParameters(name, values.toArray(new String[]{}));
}
private void doSetParameters(String name, String[] values) {
if (saveParamsAsAttributes) {
super.setAttribute(name, values);
} else {
params.put(name, values);
}
}
@Override
public String getParameter(String name) {
String[] values = params.get(name);
if (values == null || values.length == 0) {
return null;
}
return values[0];
}
@Override
public Map getParameterMap() {
return params;
}
}
}
