org.glassfish.jersey.linking.InjectLinkFieldDescriptor Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of jersey-declarative-linking Show documentation
Show all versions of jersey-declarative-linking Show documentation
Jersey support for declarative hyperlinking.
/*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
*
* Copyright (c) 2010-2015 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 org.glassfish.jersey.linking;
import java.lang.annotation.Annotation;
import java.lang.reflect.Field;
import java.lang.reflect.Method;
import java.net.URI;
import java.util.HashMap;
import java.util.Iterator;
import java.util.Map;
import java.util.logging.Level;
import java.util.logging.Logger;
import javax.ws.rs.HttpMethod;
import javax.ws.rs.Path;
import javax.ws.rs.QueryParam;
import javax.ws.rs.BeanParam;
import javax.ws.rs.core.Link;
import org.glassfish.jersey.linking.mapping.ResourceMappingContext;
import org.glassfish.jersey.server.model.AnnotatedMethod;
import org.glassfish.jersey.server.model.MethodList;
/**
* Utility class for working with {@link InjectLink} annotated fields.
*
* @author Mark Hadley
* @author Gerard Davison (gerard.davison at oracle.com)
*/
class InjectLinkFieldDescriptor extends FieldDescriptor implements InjectLinkDescriptor {
private InjectLink link;
private Class type;
private Map bindings;
/**
* TODO javadoc.
*/
public InjectLinkFieldDescriptor(Field f, InjectLink l, Class t) {
super(f);
link = l;
type = t;
bindings = new HashMap<>();
for (Binding binding : l.bindings()) {
bindings.put(binding.name(), binding.value());
}
}
/**
* TODO javadoc.
*/
public void setPropertyValue(Object instance, URI uri) {
setAccessibleField(field);
try {
Object value;
if (URI.class.equals(type)) {
value = uri;
} else if (Link.class.isAssignableFrom(type)) {
// Make a link with the correct bindings
value = getLink(uri);
} else if (String.class.equals(type)) {
value = uri.toString();
} else {
throw new IllegalArgumentException("Field type " + type + " not one of supported String,URI and Link");
}
field.set(instance, value);
} catch (IllegalArgumentException | IllegalAccessException ex) {
Logger.getLogger(InjectLinkFieldDescriptor.class.getName()).log(Level.SEVERE, null, ex);
}
}
/**
* TODO javadoc.
*/
public InjectLink.Style getLinkStyle() {
return link.style();
}
/**
* TODO javadoc.
*/
public String getLinkTemplate(ResourceMappingContext rmc) {
return getLinkTemplate(rmc, link);
}
/**
* TODO javadoc.
*/
public static String getLinkTemplate(ResourceMappingContext rmc, InjectLink link) {
String template = null;
if (!link.resource().equals(Class.class)) {
ResourceMappingContext.Mapping map = rmc.getMapping(link.resource());
if (map != null) {
template = map.getTemplate().getTemplate().toString();
} else {
// extract template from specified class' @Path annotation
Path path = link.resource().getAnnotation(Path.class);
template = path == null ? "" : path.value();
}
// extract template from specified class' @Path annotation
if (link.method().length() > 0) {
// append value of method's @Path annotation
MethodList methods = new MethodList(link.resource());
methods = methods.withMetaAnnotation(HttpMethod.class);
Iterator iterator = methods.iterator();
while (iterator.hasNext()) {
AnnotatedMethod method = iterator.next();
if (!method.getMethod().getName().equals(link.method())) {
continue;
}
StringBuilder builder = new StringBuilder();
builder.append(template);
Path methodPath = method.getAnnotation(Path.class);
if (methodPath != null) {
String methodTemplate = methodPath.value();
if (!(template.endsWith("/") || methodTemplate.startsWith("/"))) {
builder.append("/");
}
builder.append(methodTemplate);
}
CharSequence querySubString = extractQueryParams(method);
if (querySubString.length() > 0) {
builder.append("{?");
builder.append(querySubString);
builder.append("}");
}
template = builder.toString();
break;
}
}
} else {
template = link.value();
}
return template;
}
private static CharSequence extractQueryParams(AnnotatedMethod method) throws SecurityException {
// append query parameters
StringBuilder querySubString = new StringBuilder();
int parameterIndex = 0;
for (Annotation paramAnns[] : method.getParameterAnnotations()) {
for (Annotation ann : paramAnns) {
if (ann.annotationType() == QueryParam.class) {
querySubString.append(((QueryParam) ann).value());
querySubString.append(',');
}
if (ann.annotationType() == BeanParam.class) {
Class beanParamType = method.getParameterTypes()[parameterIndex];
Field fields[] = beanParamType.getFields();
for (Field field : fields) {
QueryParam queryParam = field.getAnnotation(QueryParam.class);
if (queryParam != null) {
querySubString.append(queryParam.value());
querySubString.append(',');
}
}
Method beanMethods[] = beanParamType.getMethods();
for (Method beanMethod : beanMethods) {
QueryParam queryParam = beanMethod.getAnnotation(QueryParam.class);
if (queryParam != null) {
querySubString.append(queryParam.value());
querySubString.append(',');
}
}
}
}
parameterIndex++;
}
CharSequence result = "";
if (querySubString.length() > 0) {
result = querySubString.subSequence(0, querySubString.length() - 1);
}
return result;
}
/**
* TODO javadoc.
*/
public Link getLink(URI uri) {
return InjectLink.Util.buildLinkFromUri(uri, link);
}
/**
* TODO javadoc.
*/
public String getBinding(String name) {
return bindings.get(name);
}
/**
* TODO javadoc.
*/
public String getCondition() {
return link.condition();
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy