org.glassfish.jersey.server.wadl.internal.generators.resourcedoc.ResourceDocAccessor Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of jersey-server Show documentation
Show all versions of jersey-server Show documentation
Jersey core server implementation
/*
* 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.server.wadl.internal.generators.resourcedoc;
import java.lang.annotation.Annotation;
import java.lang.reflect.Method;
import java.util.logging.Level;
import java.util.logging.Logger;
import org.glassfish.jersey.server.internal.LocalizationMessages;
import org.glassfish.jersey.server.model.Parameter;
import org.glassfish.jersey.server.wadl.internal.generators.resourcedoc.model.AnnotationDocType;
import org.glassfish.jersey.server.wadl.internal.generators.resourcedoc.model.ClassDocType;
import org.glassfish.jersey.server.wadl.internal.generators.resourcedoc.model.MethodDocType;
import org.glassfish.jersey.server.wadl.internal.generators.resourcedoc.model.NamedValueType;
import org.glassfish.jersey.server.wadl.internal.generators.resourcedoc.model.ParamDocType;
import org.glassfish.jersey.server.wadl.internal.generators.resourcedoc.model.RepresentationDocType;
import org.glassfish.jersey.server.wadl.internal.generators.resourcedoc.model.ResourceDocType;
import org.glassfish.jersey.server.wadl.internal.generators.resourcedoc.model.ResponseDocType;
/**
* A class providing access to information stored in a {@link ResourceDocType}.
* Created on: Jun 16, 2008
*
* @author Martin Grotzke (martin.grotzke at freiheit.com)
*/
public class ResourceDocAccessor {
private static final Logger LOGGER = Logger.getLogger(ResourceDocAccessor.class.getName());
private ResourceDocType _resourceDoc;
public ResourceDocAccessor(ResourceDocType resourceDoc) {
_resourceDoc = resourceDoc;
}
public ClassDocType getClassDoc(Class resourceClass) {
if (resourceClass == null) {
return null;
}
for (ClassDocType classDocType : _resourceDoc.getDocs()) {
if (resourceClass.getName().equals(classDocType.getClassName())) {
return classDocType;
}
}
return null;
}
public MethodDocType getMethodDoc(Class resourceClass, Method method) {
if (resourceClass == null || method == null) {
return null;
}
final ClassDocType classDoc = getClassDoc(resourceClass);
if (classDoc == null) {
return null;
}
MethodDocType candidate = null;
int candidateCount = 0;
final String methodName = method.getName();
final String methodSignature = computeSignature(method);
for (MethodDocType methodDocType : classDoc.getMethodDocs()) {
if (methodName.equals(methodDocType.getMethodName())) {
candidateCount++;
if (candidate == null) {
candidate = methodDocType;
}
final String docMethodSignature = methodDocType.getMethodSignature();
if (docMethodSignature != null && docMethodSignature.equals(methodSignature)) {
return methodDocType;
}
}
}
if (candidate != null && candidateCount > 1 && LOGGER.isLoggable(Level.CONFIG)) {
LOGGER.config(LocalizationMessages.WADL_RESOURCEDOC_AMBIGUOUS_METHOD_ENTRIES(
resourceClass.getName(),
methodName,
methodSignature,
candidateCount));
}
return candidate;
}
private String computeSignature(final Method method) {
final String methodAsString = method.toGenericString();
return methodAsString.substring(methodAsString.indexOf('('), methodAsString.lastIndexOf(')') + 1);
}
/**
* @param resourceClass
* @param method
* @param p
* @return param doc type
*/
public ParamDocType getParamDoc(Class resourceClass, Method method,
Parameter p) {
final MethodDocType methodDoc = getMethodDoc(resourceClass, method);
if (methodDoc != null) {
for (ParamDocType paramDocType : methodDoc.getParamDocs()) {
for (AnnotationDocType annotationDocType : paramDocType.getAnnotationDocs()) {
final Class annotationType = p.getSourceAnnotation().annotationType();
if (annotationType != null) {
final String sourceName = getSourceName(annotationDocType);
if (sourceName != null && sourceName.equals(p.getSourceName())) {
return paramDocType;
}
}
}
}
}
return null;
}
public RepresentationDocType getRequestRepresentation(Class resourceClass, Method method, String mediaType) {
if (mediaType == null) {
return null;
}
final MethodDocType methodDoc = getMethodDoc(resourceClass, method);
return methodDoc != null
&& methodDoc.getRequestDoc() != null
&& methodDoc.getRequestDoc().getRepresentationDoc() != null
// && mediaType.equals( methodDoc.getRequestDoc().getRepresentationDoc().getMediaType() )
? methodDoc.getRequestDoc().getRepresentationDoc() : null;
}
public ResponseDocType getResponse(Class resourceClass, Method method) {
final MethodDocType methodDoc = getMethodDoc(resourceClass, method);
return methodDoc != null && methodDoc.getResponseDoc() != null
? methodDoc.getResponseDoc() : null;
}
private String getSourceName(AnnotationDocType annotationDocType) {
if (annotationDocType.hasAttributeDocs()) {
for (NamedValueType namedValueType : annotationDocType.getAttributeDocs()) {
/* the value of the "value"-attribute is the param.sourceName...
*/
if ("value".equals(namedValueType.getName())) {
return namedValueType.getValue();
}
}
}
return null;
}
}