org.apache.juneau.rest.RestResourceResolver Maven / Gradle / Ivy
// ***************************************************************************************************************************
// * 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 org.apache.juneau.rest.annotation.*;
/**
* Class used to resolve {@link Class} objects to instances.
*
*
* Used to convert classes defined via {@link RestResource#children() @RestResource.children()} into child instances.
*
*
* Subclasses can be created to provide customized resource resolution.
* These can be associated with REST resources in one of the following ways:
*
* - {@link RestResource#resourceResolver() @RestResource.resourceResolver()} annotation.
*
- {@link RestConfig#setResourceResolver(Class)}/{@link RestConfig#setResourceResolver(RestResourceResolver)}
* methods.
*
*
*
* An instance of this class can also be passed in through the servlet context as the context attribute
* {@link RestResource#resourceResolver()}.
*/
public interface RestResourceResolver {
/**
* Resolves the specified class to a resource object.
*
*
* Subclasses can override this method to provide their own custom resolution.
*
*
* The default implementation simply creates a new class instance using {@link Class#newInstance()}.
*
* @param c The class to resolve.
* @param config The initialization configuration for the resource.
* @return The instance of that class.
* @throws Exception If class could not be resolved.
*/
Object resolve(Class c, RestConfig config) throws Exception;
}