/*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
*
* Copyright (c) 2010-2011 Oracle and/or its affiliates. All rights reserved.
*
* The contents of this file are subject to the terms of either the GNU
* General Public License Version 2 only ("GPL") or the Common Development
* and Distribution License("CDDL") (collectively, the "License"). You
* may not use this file except in compliance with the License. You can
* obtain a copy of the License at
* http://glassfish.java.net/public/CDDL+GPL_1_1.html
* or packager/legal/LICENSE.txt. See the License for the specific
* language governing permissions and limitations under the License.
*
* When distributing the software, include this License Header Notice in each
* file and include the License file at packager/legal/LICENSE.txt.
*
* GPL Classpath Exception:
* Oracle designates this particular file as subject to the "Classpath"
* exception as provided by Oracle in the GPL Version 2 section of the License
* file that accompanied this code.
*
* Modifications:
* If applicable, add the following below the License Header, with the fields
* enclosed by brackets [] replaced by your own identifying information:
* "Portions Copyright [year] [name of copyright owner]"
*
* Contributor(s):
* If you wish your version of this file to be governed by only the CDDL or
* only the GPL Version 2, indicate your decision by adding "[Contributor]
* elects to include this software in this distribution under the [CDDL or GPL
* Version 2] license." If you don't indicate a single choice of license, a
* recipient has the option to distribute your version of this file under
* either the CDDL, the GPL Version 2 or to extend the choice of license to
* its licensees as provided above. However, if you add GPL Version 2 code
* and therefore, elected the GPL Version 2 license, then the option applies
* only if the new code is made subject to such option by the copyright
* holder.
*/
package com.sun.jersey.server.impl.application;
import com.sun.jersey.api.container.ContainerException;
import com.sun.jersey.api.core.HttpRequestContext;
import com.sun.jersey.api.core.HttpResponseContext;
import com.sun.jersey.api.core.ExtendedUriInfo;
import com.sun.jersey.api.core.TraceInformation;
import com.sun.jersey.api.model.AbstractResourceMethod;
import com.sun.jersey.api.uri.UriComponent;
import com.sun.jersey.api.uri.UriTemplate;
import com.sun.jersey.core.header.InBoundHeaders;
import com.sun.jersey.core.util.MultivaluedMapImpl;
import com.sun.jersey.spi.container.ContainerRequest;
import com.sun.jersey.spi.container.ContainerResponse;
import com.sun.jersey.spi.container.ContainerResponseFilter;
import com.sun.jersey.spi.uri.rules.UriRule;
import com.sun.jersey.spi.uri.rules.UriRuleContext;
import com.sun.jersey.spi.uri.rules.UriRules;
import java.io.ByteArrayInputStream;
import java.net.URI;
import java.util.ArrayList;
import java.util.Collections;
import java.util.Iterator;
import java.util.LinkedList;
import java.util.List;
import java.util.Map;
import java.util.regex.MatchResult;
import javax.ws.rs.core.MultivaluedMap;
import javax.ws.rs.core.PathSegment;
import javax.ws.rs.core.UriBuilder;
/**
*
* @author Paul.Sandoz@Sun.Com
*/
public final class WebApplicationContext implements UriRuleContext, ExtendedUriInfo {
public static final String HTTP_METHOD_MATCH_RESOURCE = "com.sun.jersey.MATCH_RESOURCE";
private final WebApplicationImpl app;
private final boolean isTraceEnabled;
private ContainerRequest request;
private ContainerResponse response;
private List<ContainerResponseFilter> responseFilters;
public WebApplicationContext(WebApplicationImpl app,
ContainerRequest request, ContainerResponse response) {
this.app = app;
this.isTraceEnabled = app.isTracingEnabled();
this.request = request;
this.response = response;
this.responseFilters = Collections.EMPTY_LIST;
if (isTracingEnabled()) {
getProperties().put(TraceInformation.class.getName(),
new TraceInformation(this));
}
}
public WebApplicationContext createMatchResourceContext(URI u) {
final URI base = request.getBaseUri();
if (u.isAbsolute()) {
// TODO check if base is a base of u
URI r = base.relativize(u);
if (r == u) {
throw new ContainerException("The URI " + u + " is not relative to the base URI " + base);
}
} else {
u = UriBuilder.fromUri(base).
path(u.getRawPath()).
replaceQuery(u.getRawQuery()).
fragment(u.getRawFragment()).
build();
}
final ContainerRequest _request = new ContainerRequest(app,
HTTP_METHOD_MATCH_RESOURCE,
base, u,
new InBoundHeaders(), new ByteArrayInputStream(new byte[0]));
_request.setSecurityContext(request);
// Propagate security context
final ContainerResponse _response = new ContainerResponse(app,
_request, null);
return new WebApplicationContext(app,
_request,
_response);
}
public List<ContainerResponseFilter> getResponseFilters() {
return responseFilters;
}
// HttpContext
@Override
public HttpRequestContext getRequest() {
return request;
}
@Override
public HttpResponseContext getResponse() {
return response;
}
@Override
public ExtendedUriInfo getUriInfo() {
return this;
}
@Override
public Map<String, Object> getProperties() {
return request.getProperties();
}
// Traceable
@Override
public boolean isTracingEnabled() {
return isTraceEnabled;
}
@Override
public void trace(String message) {
if (!isTracingEnabled())
return;
request.trace(message);
}
// UriMatchResultContext
private MatchResult matchResult;
@Override
public MatchResult getMatchResult() {
return matchResult;
}
@Override
public void setMatchResult(MatchResult matchResult) {
this.matchResult = matchResult;
}
// UriRuleContext
private final LinkedList<Object> resources = new LinkedList<Object>();
private final LinkedList<MatchResult> matchResults = new LinkedList<MatchResult>();
private final LinkedList<String> paths = new LinkedList<String>();
private final LinkedList<UriTemplate> templates = new LinkedList<UriTemplate>();
private AbstractResourceMethod arm;
@Override
public ContainerRequest getContainerRequest() {
return request;
}
@Override
public void setContainerRequest(ContainerRequest request) {
this.request = request;
this.response.setContainerRequest(request);
}
@Override
public ContainerResponse getContainerResponse() {
return response;
}
@Override
public void setContainerResponse(ContainerResponse response) {
this.response = response;
}
@Override
public void pushContainerResponseFilters(List<ContainerResponseFilter> filters) {
if (filters.isEmpty())
return;
if (responseFilters == Collections.EMPTY_LIST)
responseFilters = new LinkedList<ContainerResponseFilter>();
for (ContainerResponseFilter f : filters) {
responseFilters.add(0, f);
}
}
@Override
public Object getResource(Class resourceClass) {
return app.getResourceComponentProvider(resourceClass).getInstance(this);
}
@Override
public UriRules<UriRule> getRules(Class resourceClass) {
return app.getUriRules(resourceClass);
}
@Override
public void pushMatch(UriTemplate template, List<String> names) {
matchResults.addFirst(matchResult);
templates.addFirst(template);
if (encodedTemplateValues == null) {
encodedTemplateValues = new MultivaluedMapImpl();
}
int i = 1;
for (String name : names) {
final String value = matchResult.group(i++);
encodedTemplateValues.addFirst(name, value);
if (decodedTemplateValues != null) {
decodedTemplateValues.addFirst(
UriComponent.decode(name, UriComponent.Type.PATH_SEGMENT),
UriComponent.decode(value, UriComponent.Type.PATH));
}
}
}
@Override
public void pushResource(Object resource) {
resources.addFirst(resource);
}
@Override
public void pushMethod(AbstractResourceMethod arm) {
this.arm = arm;
}
@Override
public void pushRightHandPathLength(int rhpathlen) {
final String ep = request.getPath(false);
paths.addFirst(ep.substring(0,
ep.length() - rhpathlen));
}
// UriInfo, defer to HttpRequestContext
private MultivaluedMapImpl encodedTemplateValues;
private MultivaluedMapImpl decodedTemplateValues;
@Override
public URI getBaseUri() {
return request.getBaseUri();
}
@Override
public UriBuilder getBaseUriBuilder() {
return request.getBaseUriBuilder();
}
@Override
public URI getAbsolutePath() {
return request.getAbsolutePath();
}
@Override
public UriBuilder getAbsolutePathBuilder() {
return request.getAbsolutePathBuilder();
}
@Override
public URI getRequestUri() {
return request.getRequestUri();
}
@Override
public UriBuilder getRequestUriBuilder() {
return request.getRequestUriBuilder();
}
@Override
public String getPath() {
return request.getPath(true);
}
@Override
public String getPath(boolean decode) {
return request.getPath(decode);
}
@Override
public List<PathSegment> getPathSegments() {
return request.getPathSegments(true);
}
@Override
public List<PathSegment> getPathSegments(boolean decode) {
return request.getPathSegments(decode);
}
@Override
public MultivaluedMap<String, String> getQueryParameters() {
return request.getQueryParameters(true);
}
@Override
public MultivaluedMap<String, String> getQueryParameters(boolean decode) {
return request.getQueryParameters(decode);
}
// UriInfo, matching specific functionality
@Override
public MultivaluedMap<String, String> getPathParameters() {
return getPathParameters(true);
}
@Override
public MultivaluedMap<String, String> getPathParameters(boolean decode) {
if (decode) {
if (decodedTemplateValues != null) {
return decodedTemplateValues;
}
decodedTemplateValues = new MultivaluedMapImpl();
for (Map.Entry<String, List<String>> e : encodedTemplateValues.entrySet()) {
List<String> l = new ArrayList<String>();
for (String v : e.getValue()) {
l.add(UriComponent.decode(v, UriComponent.Type.PATH));
}
decodedTemplateValues.put(
UriComponent.decode(e.getKey(), UriComponent.Type.PATH_SEGMENT),
l);
}
return decodedTemplateValues;
} else {
return encodedTemplateValues;
}
}
@Override
public List<String> getMatchedURIs() {
return getMatchedURIs(true);
}
@Override
public List<String> getMatchedURIs(boolean decode) {
List<String> result;
if (decode) {
result = new ArrayList<String>(paths.size());
for (String path : paths) {
result.add(UriComponent.decode(
path,
UriComponent.Type.PATH));
}
} else {
result = paths;
}
return Collections.unmodifiableList(result);
}
@Override
public List<Object> getMatchedResources() {
return resources;
}
// ExtendedUriInfo
@Override
public AbstractResourceMethod getMatchedMethod() {
return arm;
}
@Override
public Throwable getMappedThrowable() {
return response.getMappedThrowable();
}
@Override
public List<MatchResult> getMatchedResults() {
return matchResults;
}
@Override
public List<UriTemplate> getMatchedTemplates() {
return templates;
}
@Override
public List<PathSegment> getPathSegments(String name) {
return getPathSegments(name, true);
}
@Override
public List<PathSegment> getPathSegments(String name, boolean decode) {
int[] bounds = getPathParameterBounds(name);
if (bounds != null) {
String path = matchResults.getLast().group();
// Work out how many path segments are up to the start
// and end position of the matching path parameter value
// This assumes that the path always starts with a '/'
int segmentsStart = 0;
for (int x = 0; x < bounds[0]; x++) {
if (path.charAt(x) == '/') {
segmentsStart++;
}
}
int segmentsEnd = segmentsStart;
for (int x = bounds[0]; x < bounds[1]; x++) {
if (path.charAt(x) == '/') {
segmentsEnd++;
}
}
return getPathSegments(decode).subList(segmentsStart - 1, segmentsEnd);
} else
return Collections.emptyList();
}
private int[] getPathParameterBounds(String name) {
Iterator<UriTemplate> iTemplate = templates.iterator();
Iterator<MatchResult> iMatchResult = matchResults.iterator();
while (iTemplate.hasNext()) {
MatchResult mr = iMatchResult.next();
// Find the index of path parameter
int pIndex = getLastPathParameterIndex(name, iTemplate.next());
if (pIndex != -1) {
int pathLength = mr.group().length();
int segmentIndex = mr.end(pIndex + 1);
int groupLength = segmentIndex - mr.start(pIndex + 1);
// Find the absolute position of the end of the
// capturing group in the request path
while (iMatchResult.hasNext()) {
mr = iMatchResult.next();
segmentIndex += mr.group().length() - pathLength;
pathLength = mr.group().length();
}
int[] bounds = {segmentIndex - groupLength, segmentIndex};
return bounds;
}
}
return null;
}
private int getLastPathParameterIndex(String name, UriTemplate t) {
int i = 0;
int pIndex = -1;
for (String parameterName : t.getTemplateVariables()) {
if (parameterName.equals(name)) {
pIndex = i;
}
i++;
}
return pIndex;
}
}