Search in sources :

Example 1 with ActionParam

use of com.linkedin.restli.server.annotations.ActionParam in project rest.li by linkedin.

the class RestLiAnnotationReader method buildActionParam.

@SuppressWarnings({ "unchecked", "rawtypes" })
private static Parameter buildActionParam(final Method method, final AnnotationSet annotations, final Class<?> paramType) {
    ActionParam actionParam = annotations.get(ActionParam.class);
    Optional optional = annotations.get(Optional.class);
    String paramName = actionParam.value();
    Class<? extends TyperefInfo> typerefInfoClass = actionParam.typeref();
    try {
        Parameter param = new Parameter(paramName, paramType, getDataSchema(paramType, getSchemaFromTyperefInfo(typerefInfoClass)), optional != null, getDefaultValueData(optional), Parameter.ParamType.POST, true, annotations);
        return param;
    } catch (TemplateRuntimeException e) {
        throw new ResourceConfigException("DataSchema for parameter '" + paramName + "' of type " + paramType.getSimpleName() + " on " + buildMethodMessage(method) + "cannot be found; type is invalid or requires typeref", e);
    } catch (Exception e) {
        throw new ResourceConfigException("Typeref for parameter '" + paramName + "' on " + buildMethodMessage(method) + " cannot be instantiated, " + e.getMessage(), e);
    }
}
Also used : ActionParam(com.linkedin.restli.server.annotations.ActionParam) Optional(com.linkedin.restli.server.annotations.Optional) TemplateRuntimeException(com.linkedin.data.template.TemplateRuntimeException) ResourceConfigException(com.linkedin.restli.server.ResourceConfigException) TemplateRuntimeException(com.linkedin.data.template.TemplateRuntimeException) ResourceConfigException(com.linkedin.restli.server.ResourceConfigException) RestLiInternalException(com.linkedin.restli.internal.server.RestLiInternalException)

Example 2 with ActionParam

use of com.linkedin.restli.server.annotations.ActionParam in project rest.li by linkedin.

the class RestLiAnnotationReader method getParameters.

private static List<Parameter<?>> getParameters(final ResourceModel model, final Method method, final ResourceMethod methodType) {
    Set<String> paramNames = new HashSet<String>();
    List<Parameter<?>> queryParameters = new ArrayList<Parameter<?>>();
    Annotation[][] paramsAnnos = method.getParameterAnnotations();
    // Iterate over the method parameters.
    for (int idx = 0; idx < paramsAnnos.length; idx++) {
        AnnotationSet paramAnnotations = new AnnotationSet(paramsAnnos[idx]);
        Class<?> paramType = method.getParameterTypes()[idx];
        Parameter<?> param = getPositionalParameter(model, methodType, idx, paramAnnotations);
        // if no positional definition, look for custom annotated parameters
        if (param == null) {
            if (paramAnnotations.contains(QueryParam.class)) {
                param = buildQueryParam(method, paramAnnotations, paramType);
            } else if (paramAnnotations.contains(ActionParam.class)) {
                param = buildActionParam(method, paramAnnotations, paramType);
            } else if (paramAnnotations.contains(AssocKey.class)) {
                param = buildAssocKeyParam(model, method, paramAnnotations, paramType, AssocKey.class);
            } else if (paramAnnotations.contains(AssocKeyParam.class)) {
                param = buildAssocKeyParam(model, method, paramAnnotations, paramType, AssocKeyParam.class);
            } else if (paramAnnotations.contains(Context.class)) {
                param = buildPagingContextParam(paramAnnotations, paramType, Context.class);
            } else if (paramAnnotations.contains(PagingContextParam.class)) {
                param = buildPagingContextParam(paramAnnotations, paramType, PagingContextParam.class);
            } else if (paramAnnotations.contains(CallbackParam.class)) {
                param = buildCallbackParam(method, methodType, idx, paramType, paramAnnotations);
            } else if (paramAnnotations.contains(ParSeqContextParam.class)) {
                param = buildParSeqContextParam(method, methodType, idx, paramType, paramAnnotations, ParSeqContextParam.class);
            } else if (paramAnnotations.contains(ParSeqContext.class)) {
                param = buildParSeqContextParam(method, methodType, idx, paramType, paramAnnotations, ParSeqContext.class);
            } else if (paramAnnotations.contains(Projection.class)) {
                param = buildProjectionParam(paramAnnotations, paramType, Parameter.ParamType.PROJECTION);
            } else if (paramAnnotations.contains(ProjectionParam.class)) {
                param = buildProjectionParam(paramAnnotations, paramType, Parameter.ParamType.PROJECTION_PARAM);
            } else if (paramAnnotations.contains(MetadataProjectionParam.class)) {
                param = buildProjectionParam(paramAnnotations, paramType, Parameter.ParamType.METADATA_PROJECTION_PARAM);
            } else if (paramAnnotations.contains(PagingProjectionParam.class)) {
                param = buildProjectionParam(paramAnnotations, paramType, Parameter.ParamType.PAGING_PROJECTION_PARAM);
            } else if (paramAnnotations.contains(Keys.class)) {
                param = buildPathKeysParam(paramAnnotations, paramType, Keys.class);
            } else if (paramAnnotations.contains(PathKeysParam.class)) {
                param = buildPathKeysParam(paramAnnotations, paramType, PathKeysParam.class);
            } else if (paramAnnotations.contains(PathKeyParam.class)) {
                param = buildPathKeyParam(model, paramAnnotations, paramType, PathKeyParam.class);
            } else if (paramAnnotations.contains(HeaderParam.class)) {
                param = buildHeaderParam(paramAnnotations, paramType);
            } else if (paramAnnotations.contains(ResourceContextParam.class)) {
                param = buildResourceContextParam(paramAnnotations, paramType);
            } else if (paramAnnotations.contains(ValidatorParam.class)) {
                param = buildValidatorParam(paramAnnotations, paramType);
            } else if (paramAnnotations.contains(RestLiAttachmentsParam.class)) {
                param = buildRestLiAttachmentsParam(paramAnnotations, paramType);
            } else {
                throw new ResourceConfigException(buildMethodMessage(method) + " must annotate each parameter with @QueryParam, @ActionParam, @AssocKeyParam, @PagingContextParam, " + "@ProjectionParam, @MetadataProjectionParam, @PagingProjectionParam, @PathKeysParam, @PathKeyParam, " + "@HeaderParam, @CallbackParam, @ResourceContext, @ParSeqContextParam, @ValidatorParam, " + "@RestLiAttachmentsParam, or @ValidateParam");
            }
        }
        if (param != null) {
            validateParameter(method, methodType, paramNames, paramAnnotations, param, paramType);
            queryParameters.add(param);
        }
    }
    return queryParameters;
}
Also used : PagingContextParam(com.linkedin.restli.server.annotations.PagingContextParam) ArrayList(java.util.ArrayList) Projection(com.linkedin.restli.server.annotations.Projection) AssocKey(com.linkedin.restli.server.annotations.AssocKey) ParSeqContext(com.linkedin.restli.server.annotations.ParSeqContext) PathKeyParam(com.linkedin.restli.server.annotations.PathKeyParam) RestLiAttachmentsParam(com.linkedin.restli.server.annotations.RestLiAttachmentsParam) MetadataProjectionParam(com.linkedin.restli.server.annotations.MetadataProjectionParam) HashSet(java.util.HashSet) PagingContext(com.linkedin.restli.server.PagingContext) ResourceContext(com.linkedin.restli.server.ResourceContext) ParSeqContext(com.linkedin.restli.server.annotations.ParSeqContext) Context(com.linkedin.restli.server.annotations.Context) ActionParam(com.linkedin.restli.server.annotations.ActionParam) PathKeysParam(com.linkedin.restli.server.annotations.PathKeysParam) PathKeys(com.linkedin.restli.server.PathKeys) AlternativeKeys(com.linkedin.restli.server.annotations.AlternativeKeys) Keys(com.linkedin.restli.server.annotations.Keys) ParSeqContextParam(com.linkedin.restli.server.annotations.ParSeqContextParam) AssocKeyParam(com.linkedin.restli.server.annotations.AssocKeyParam) ResourceContextParam(com.linkedin.restli.server.annotations.ResourceContextParam) ResourceConfigException(com.linkedin.restli.server.ResourceConfigException)

Aggregations

ResourceConfigException (com.linkedin.restli.server.ResourceConfigException)2 ActionParam (com.linkedin.restli.server.annotations.ActionParam)2 TemplateRuntimeException (com.linkedin.data.template.TemplateRuntimeException)1 RestLiInternalException (com.linkedin.restli.internal.server.RestLiInternalException)1 PagingContext (com.linkedin.restli.server.PagingContext)1 PathKeys (com.linkedin.restli.server.PathKeys)1 ResourceContext (com.linkedin.restli.server.ResourceContext)1 AlternativeKeys (com.linkedin.restli.server.annotations.AlternativeKeys)1 AssocKey (com.linkedin.restli.server.annotations.AssocKey)1 AssocKeyParam (com.linkedin.restli.server.annotations.AssocKeyParam)1 Context (com.linkedin.restli.server.annotations.Context)1 Keys (com.linkedin.restli.server.annotations.Keys)1 MetadataProjectionParam (com.linkedin.restli.server.annotations.MetadataProjectionParam)1 Optional (com.linkedin.restli.server.annotations.Optional)1 PagingContextParam (com.linkedin.restli.server.annotations.PagingContextParam)1 ParSeqContext (com.linkedin.restli.server.annotations.ParSeqContext)1 ParSeqContextParam (com.linkedin.restli.server.annotations.ParSeqContextParam)1 PathKeyParam (com.linkedin.restli.server.annotations.PathKeyParam)1 PathKeysParam (com.linkedin.restli.server.annotations.PathKeysParam)1 Projection (com.linkedin.restli.server.annotations.Projection)1