juneau-rest/juneau-rest-server/src/main/java/org/apache/juneau/rest/RestMethods.java

// ***************************************************************************************************************************
// * 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;

import java.util.*;

import org.apache.juneau.collections.*;
import org.apache.juneau.http.exception.*;
import org.apache.juneau.rest.annotation.*;

/**
 * Encapsulates the set of {@link RestMethod}-annotated methods within a single {@link Rest}-annotated object.
 */
public class RestMethods {

	private final Map<String,List<RestMethodContext>> map;
	private List<RestMethodContext> list;

	/**
	 * Creates a new builder.
	 *
	 * @return A new builder.
	 */
	public static RestMethodsBuilder create() {
		return new RestMethodsBuilder();
	}

	RestMethods(RestMethodsBuilder builder) {
		AMap<String,List<RestMethodContext>> m = AMap.create();
		for (Map.Entry<String,TreeSet<RestMethodContext>> e : builder.map.entrySet())
			m.put(e.getKey(), AList.of(e.getValue()));
		this.map = m;
		this.list = AList.of(builder.set);
	}

	/**
	 * Finds the method that should handle the specified call.
	 *
	 * @param call The HTTP call.
	 * @return The method that should handle the specified call.
	 * @throws MethodNotAllowed If no methods implement the requested HTTP method.
	 * @throws PreconditionFailed At least one method was found but it didn't match one or more matchers.
	 * @throws NotFound HTTP method match was found but matching path was not.
	 */
	public RestMethodContext findMethod(RestCall call) throws MethodNotAllowed, PreconditionFailed, NotFound {
		String m = call.getMethod();

		int rc = 0;
		if (map.containsKey(m)) {
			for (RestMethodContext mc : map.get(m)) {
				int mrc = mc.match(call);
				if (mrc == 2)
					return mc;
				rc = Math.max(rc, mrc);
			}
		}

		if (map.containsKey("*")) {
			for (RestMethodContext mc : map.get("*")) {
				int mrc = mc.match(call);
				if (mrc == 2)
					return mc;
				rc = Math.max(rc, mrc);
			}
		}

		// If no paths matched, see if the path matches any other methods.
		// Note that we don't want to match against "/*" patterns such as getOptions().
		if (rc == 0) {
			for (RestMethodContext mc : list) {
				if (! mc.getPathPattern().endsWith("/*")) {
					int mrc = mc.match(call);
					if (mrc == 2)
						throw new MethodNotAllowed();
				}
			}
		}

		if (rc == 1)
			throw new PreconditionFailed("Method ''{0}'' not found on resource on path ''{1}'' with matching matcher.", m, call.getPathInfo());

		throw new NotFound("Java method matching path ''{0}'' not found on resource ''{1}''.", call.getPathInfo(), call.getResource().getClass().getName());
	}


	/**
	 * Returns the list of method contexts in this object.
	 *
	 * @return An unmodifiable list of method contexts in this object.
	 */
	public List<RestMethodContext> getMethodContexts() {
		return Collections.unmodifiableList(list);
	}
}