org.apache.juneau.rest.arg.AttributeArg Maven / Gradle / Ivy

Go to download
// ***************************************************************************************************************************
// * Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements.  See the NOTICE file *
// * distributed with this work for additional information regarding copyright ownership.  The ASF licenses this file        *
// * to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance            *
// * with the License.  You may obtain a copy of the License at                                                              *
// *                                                                                                                         *
// *  http://www.apache.org/licenses/LICENSE-2.0                                                                             *
// *                                                                                                                         *
// * Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an  *
// * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.  See the License for the        *
// * specific language governing permissions and limitations under the License.                                              *
// ***************************************************************************************************************************
package org.apache.juneau.rest.arg;

import static org.apache.juneau.common.internal.StringUtils.*;

import org.apache.juneau.*;
import org.apache.juneau.reflect.*;
import org.apache.juneau.rest.*;
import org.apache.juneau.rest.annotation.*;
import org.apache.juneau.rest.httppart.*;

/**
 * Resolves method parameters and parameter types annotated with {@link Attr} on {@link RestOp}-annotated Java methods.
 *
 * 
 * The parameter value is resolved using:
 * 

 * 	opSession
 * 		.{@link RestOpSession#getRequest() getRequest}()
 * 		.{@link RestRequest#getAttributes() getAttributes}()
 * 		.{@link RequestAttributes#get(String) get}(name)
 * 		.{@link RequestAttribute#as(Class) as}(type);
 * 
 *
 * See Also:

 * 	Java Method Parameters
 * 
 */
public class AttributeArg implements RestOpArg {

	private final String name;
	private final Class type;

	/**
	 * Static creator.
	 *
	 * @param paramInfo The Java method parameter being resolved.
	 * @return A new {@link AttributeArg}, or null if the parameter is not annotated with {@link Attr}.
	 */
	public static AttributeArg create(ParamInfo paramInfo) {
		if (paramInfo.hasAnnotation(Attr.class) || paramInfo.getParameterType().hasAnnotation(Attr.class))
			return new AttributeArg(paramInfo);
		return null;
	}

	/**
	 * Constructor.
	 *
	 * @param paramInfo The Java method parameter being resolved.
	 */
	protected AttributeArg(ParamInfo paramInfo) {
		this.name = getName(paramInfo);
		this.type = paramInfo.getParameterType().inner();
	}

	private String getName(ParamInfo paramInfo) {
		Value n = Value.empty();
		paramInfo.forEachAnnotation(Attr.class, x -> isNotEmpty(x.name()), x -> n.set(x.name()));
		paramInfo.forEachAnnotation(Attr.class, x -> isNotEmpty(x.value()), x -> n.set(x.value()));
		if (n.isEmpty())
			throw new ArgException(paramInfo, "@Attr used without name or value");
		return n.get();
	}

	@Override /* RestOpArg */
	public Object resolve(RestOpSession opSession) throws Exception {
		return opSession.getRequest().getAttribute(name).as(type).orElse(null);
	}
}