/*
* 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.uri.rules;
import com.sun.jersey.api.container.ContainerException;
import com.sun.jersey.api.container.MappableContainerException;
import com.sun.jersey.api.model.AbstractSubResourceLocator;
import com.sun.jersey.api.uri.UriTemplate;
import com.sun.jersey.core.reflection.ReflectionHelper;
import com.sun.jersey.server.impl.inject.AbstractHttpContextInjectable;
import com.sun.jersey.server.probes.UriRuleProbeProvider;
import com.sun.jersey.spi.container.ContainerRequest;
import com.sun.jersey.spi.container.ContainerRequestFilter;
import com.sun.jersey.spi.container.ContainerResponseFilter;
import com.sun.jersey.spi.container.SubjectSecurityContext;
import com.sun.jersey.spi.inject.Injectable;
import com.sun.jersey.spi.monitoring.DispatchingListener;
import com.sun.jersey.spi.uri.rules.UriRule;
import com.sun.jersey.spi.uri.rules.UriRuleContext;
import javax.ws.rs.WebApplicationException;
import java.lang.reflect.InvocationTargetException;
import java.lang.reflect.Method;
import java.security.PrivilegedAction;
import java.util.Iterator;
import java.util.List;
import javax.ws.rs.core.SecurityContext;
/**
* The rule for accepting a sub-locator method.
*
* @author Paul.Sandoz@Sun.Com
*/
public final class SubLocatorRule extends BaseRule {
private final List<AbstractHttpContextInjectable> is;
private final Method m;
private final List<ContainerRequestFilter> requestFilters;
private final List<ContainerResponseFilter> responseFilters;
private final DispatchingListener dispatchingListener;
private final AbstractSubResourceLocator locator;
public SubLocatorRule(UriTemplate template,
List<Injectable> is,
List<ContainerRequestFilter> requestFilters,
List<ContainerResponseFilter> responseFilters,
DispatchingListener dispatchingListener,
AbstractSubResourceLocator locator) {
super(template);
this.is = AbstractHttpContextInjectable.transform(is);
this.requestFilters = requestFilters;
this.responseFilters = responseFilters;
this.dispatchingListener = dispatchingListener;
this.locator = locator;
this.m = locator.getMethod();
}
@Override
public boolean accept(CharSequence path, Object resource, UriRuleContext context) {
UriRuleProbeProvider.ruleAccept(SubLocatorRule.class.getSimpleName(), path,
resource);
// Set the template values
pushMatch(context);
// Invoke the sub-locator to get the sub-resource
Object subResource = invokeSubLocator(resource, context);
// If null then no match
if (subResource == null) {
if (context.isTracingEnabled()) {
trace(resource, subResource, context);
}
return false;
}
// Check if instance is a class
if (subResource instanceof Class) {
// If so then get the instance of that class
subResource = context.getResource((Class)subResource);
}
dispatchingListener.onSubResource(Thread.currentThread().getId(), subResource.getClass());
context.pushResource(subResource);
if (context.isTracingEnabled()) {
trace(resource, subResource, context);
}
// Match sub-rules on the returned resource class
final Iterator<UriRule> matches = context.getRules(subResource.getClass()).
match(path, context);
while(matches.hasNext())
if(matches.next().accept(path, subResource, context))
return true;
return false;
}
private void trace(Object resource, Object subResource, UriRuleContext context) {
final String prevPath = context.getUriInfo().getMatchedURIs().get(1);
final String currentPath = context.getUriInfo().getMatchedURIs().get(0);
context.trace(
String.format("accept sub-resource locator: \"%s\" : \"%s\" -> @Path(\"%s\") " +
"%s = %s",
prevPath,
currentPath.substring(prevPath.length()),
getTemplate().getTemplate(),
ReflectionHelper.methodInstanceToString(resource, m),
subResource));
}
private Object invokeSubLocator(final Object resource, final UriRuleContext context) {
// Push the response filters
context.pushContainerResponseFilters(responseFilters);
ContainerRequest containerRequest = context.getContainerRequest();
// Process the request filter
if (!requestFilters.isEmpty()) {
for (ContainerRequestFilter f : requestFilters) {
containerRequest = f.filter(containerRequest);
context.setContainerRequest(containerRequest);
}
}
// Invoke the sub-locator method
dispatchingListener.onSubResourceLocator(Thread.currentThread().getId(), locator);
SecurityContext sc = containerRequest.getSecurityContext();
if (sc instanceof SubjectSecurityContext) {
return ((SubjectSecurityContext) sc).doAsSubject(new PrivilegedAction() {
@Override
public Object run() {
return dispatch(resource, context);
}
});
} else {
return dispatch(resource, context);
}
}
private Object dispatch(Object resource, UriRuleContext context) {
try {
if (is.isEmpty()) {
return m.invoke(resource);
} else {
final Object[] params = new Object[is.size()];
int index = 0;
for (AbstractHttpContextInjectable i : is) {
params[index++] = i.getValue(context);
}
return m.invoke(resource, params);
}
} catch (InvocationTargetException e) {
// Propagate the target exception so it may be mapped to a response
throw new MappableContainerException(e.getTargetException());
} catch (IllegalAccessException e) {
throw new ContainerException(e);
} catch (WebApplicationException e) {
throw e;
} catch (RuntimeException e) {
throw new ContainerException("Exception injecting parameters for sub-locator method: " + m, e);
}
}
}