io.muserver.rest.ResourceMethod Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of mu-server Show documentation
Show all versions of mu-server Show documentation
A simple but powerful web server framework
package io.muserver.rest;
import io.muserver.Method;
import io.muserver.openapi.OperationObjectBuilder;
import io.muserver.openapi.RequestBodyObject;
import io.muserver.openapi.ResponseObject;
import io.muserver.openapi.SchemaObjectBuilder;
import javax.ws.rs.HttpMethod;
import javax.ws.rs.core.MediaType;
import java.lang.annotation.Annotation;
import java.lang.reflect.InvocationTargetException;
import java.util.*;
import java.util.stream.Collectors;
import java.util.stream.Stream;
import static io.muserver.Mutils.nullOrEmpty;
import static io.muserver.openapi.HeaderObjectBuilder.headerObject;
import static io.muserver.openapi.MediaTypeObjectBuilder.mediaTypeObject;
import static io.muserver.openapi.OperationObjectBuilder.operationObject;
import static io.muserver.openapi.RequestBodyObjectBuilder.requestBodyObject;
import static io.muserver.openapi.ResponseObjectBuilder.responseObject;
import static io.muserver.openapi.ResponsesObjectBuilder.responsesObject;
import static io.muserver.openapi.SchemaObjectBuilder.schemaObject;
import static io.muserver.openapi.SchemaObjectBuilder.schemaObjectFrom;
import static io.muserver.rest.MethodMapping.jaxToMu;
import static java.util.Collections.singletonMap;
import static java.util.stream.Collectors.toMap;
class ResourceMethod {
final ResourceClass resourceClass;
final UriPattern pathPattern;
final java.lang.reflect.Method methodHandle;
final Method httpMethod;
final String pathTemplate;
final List effectiveConsumes;
final List directlyProduces;
final List effectiveProduces;
final List params;
final DescriptionData descriptionData;
final boolean isDeprecated;
private final List> nameBindingAnnotations;
ResourceMethod(ResourceClass resourceClass, UriPattern pathPattern, java.lang.reflect.Method methodHandle, List params, Method httpMethod, String pathTemplate, List produces, List consumes, DescriptionData descriptionData, boolean isDeprecated, List> nameBindingAnnotations) {
this.resourceClass = resourceClass;
this.pathPattern = pathPattern;
this.methodHandle = methodHandle;
this.params = params;
this.httpMethod = httpMethod;
this.pathTemplate = pathTemplate;
this.directlyProduces = produces;
this.descriptionData = descriptionData;
this.isDeprecated = isDeprecated;
this.nameBindingAnnotations = nameBindingAnnotations;
this.effectiveProduces = !produces.isEmpty() ? produces : (!resourceClass.produces.isEmpty() ? resourceClass.produces : RequestMatcher.WILDCARD_AS_LIST);
this.effectiveConsumes = !consumes.isEmpty() ? consumes : (!resourceClass.consumes.isEmpty() ? resourceClass.consumes : RequestMatcher.WILDCARD_AS_LIST);
}
boolean hasAll(List> annotations) {
for (Class annotation : annotations) {
if (!nameBindingAnnotations.contains(annotation) && !resourceClass.nameBindingAnnotations.contains(annotation)) {
return false;
}
}
return true;
}
boolean isSubResource() {
return pathPattern != null;
}
boolean isSubResourceLocator() {
return httpMethod == null;
}
Object invoke(Object... params) throws Exception {
try {
return methodHandle.invoke(resourceClass.resourceInstance, params);
} catch (InvocationTargetException e) {
Throwable cause = e.getCause();
if (cause instanceof Exception) {
throw (Exception)cause;
}
throw e;
}
}
OperationObjectBuilder createOperationBuilder() {
List apiResponseList = getApiResponses(methodHandle);
Map httpStatusCodes = new HashMap<>();
if (apiResponseList.isEmpty()) {
httpStatusCodes.put("200", responseObject()
.withDescription("Success")
.withContent(effectiveProduces.stream().collect(toMap(MediaType::toString,
mt -> mediaTypeObject()
.build()))
)
.build());
} else {
for (ApiResponse apiResponse : apiResponseList) {
Stream responseTypes = apiResponse.contentType().length == 0 ? effectiveProduces.stream() : Stream.of(apiResponse.contentType()).map(MediaType::valueOf);
httpStatusCodes.put(apiResponse.code(), responseObject()
.withContent(responseTypes.collect(toMap(MediaType::toString,
mt -> mediaTypeObject()
.build()))
)
.withDescription(apiResponse.message())
.withHeaders(Stream.of(apiResponse.responseHeaders()).collect(
toMap(ResponseHeader::name,
rh -> headerObject().withDescription(rh.description()).withDeprecated(rh.deprecated()).withExample(nullOrEmpty(rh.example()) ? null : rh.example()).build()
)))
.build());
}
}
RequestBodyObject requestBody = params.stream()
.filter(p -> p instanceof ResourceMethodParam.MessageBodyParam)
.map(ResourceMethodParam.MessageBodyParam.class::cast)
.map(messageBodyParam -> requestBodyObject()
.withContent(singletonMap(effectiveConsumes.get(0).toString(),
mediaTypeObject().withExample(descriptionData.example).build()))
.withDescription(messageBodyParam.descriptionData.description)
.withRequired(messageBodyParam.isRequired)
.build())
.findFirst().orElse(null);
if (requestBody == null) {
List formParams = params.stream()
.filter(p -> p instanceof ResourceMethodParam.RequestBasedParam)
.map(ResourceMethodParam.RequestBasedParam.class::cast)
.filter(p -> p.source == ResourceMethodParam.ValueSource.FORM_PARAM)
.collect(Collectors.toList());
if (!formParams.isEmpty()) {
List required = new ArrayList<>();
requestBody = requestBodyObject()
.withContent(Collections.singletonMap(effectiveConsumes.get(0).toString(),
mediaTypeObject()
.withSchema(
schemaObject()
.withType("object")
.withRequired(required)
.withProperties(
formParams.stream().collect(
toMap(n -> n.key,
n -> {
if (n.isRequired) {
required.add(n.key);
}
SchemaObjectBuilder schemaObjectBuilder = schemaObjectFrom(n.parameterHandle.getType())
.withNullable(!n.isRequired)
.withDeprecated(n.isDeprecated)
.withDefaultValue(n.defaultValue());
if (n.descriptionData != null) {
schemaObjectBuilder.withExample(n.descriptionData.example)
.withDescription(n.descriptionData.description);
}
return schemaObjectBuilder.build();
}))
)
.build()
)
.build()
))
.build();
}
}
return operationObject()
.withSummary(descriptionData.summary)
.withDescription(descriptionData.description)
.withExternalDocs(descriptionData.externalDocumentation)
.withDeprecated(isDeprecated)
.withRequestBody(requestBody)
.withResponses(
responsesObject()
.withHttpStatusCodes(httpStatusCodes)
.build())
;
}
private static List getApiResponses(java.lang.reflect.Method methodHandle) {
ApiResponses apiResponses = methodHandle.getDeclaredAnnotation(ApiResponses.class);
List apiResponseList;
if (apiResponses != null) {
apiResponseList = new ArrayList<>(Arrays.asList(apiResponses.value()));
} else {
apiResponseList = new ArrayList<>();
}
ApiResponse apiResponse = methodHandle.getDeclaredAnnotation(ApiResponse.class);
if (apiResponse != null) {
apiResponseList.add(apiResponse);
}
return apiResponseList;
}
static Method getMuMethod(java.lang.reflect.Method restMethod) {
Annotation[] annotations = restMethod.getAnnotations();
Method value = null;
for (Annotation annotation : annotations) {
Class anno = annotation.annotationType();
if (anno.getAnnotation(HttpMethod.class) != null) {
if (value != null) {
throw new IllegalArgumentException("The method " + restMethod + " has multiple HttpMethod annotations. Only one is allowed per method.");
}
value = jaxToMu(anno);
}
}
return value;
}
@Override
public String toString() {
return "ResourceMethod{" + resourceClass.resourceClassName() + "#" + methodHandle.getName() + "}";
}
boolean canProduceFor(List clientAccepts) {
return MediaTypeHeaderDelegate.atLeastOneCompatible(effectiveProduces, clientAccepts);
}
boolean canConsume(MediaType requestBodyMediaType) {
return MediaTypeHeaderDelegate.atLeastOneCompatible(effectiveConsumes, Collections.singletonList(requestBodyMediaType));
}
}