001/*
002 * Copyright 2002-2012 the original author or authors.
003 *
004 * Licensed under the Apache License, Version 2.0 (the "License");
005 * you may not use this file except in compliance with the License.
006 * You may obtain a copy of the License at
007 *
008 *      https://www.apache.org/licenses/LICENSE-2.0
009 *
010 * Unless required by applicable law or agreed to in writing, software
011 * distributed under the License is distributed on an "AS IS" BASIS,
012 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
013 * See the License for the specific language governing permissions and
014 * limitations under the License.
015 */
016
017package org.springframework.web.portlet.mvc;
018
019import javax.portlet.ResourceRequest;
020import javax.portlet.ResourceResponse;
021
022import org.springframework.web.portlet.ModelAndView;
023
024/**
025 * Extension of the Portlet {@link Controller} interface that allows
026 * for handling Portlet 2.0 resource requests as well. Can also be
027 * implemented by {@link AbstractController} subclasses.
028 *
029 * @author Juergen Hoeller
030 * @since 3.0
031 * @see javax.portlet.ResourceServingPortlet
032 * @see Controller
033 * @see EventAwareController
034 */
035public interface ResourceAwareController {
036
037        /**
038         * Process the resource request and return a ModelAndView object which the DispatcherPortlet
039         * will render. A {@code null} return value is not an error: It indicates that this
040         * object completed request processing itself, thus there is no ModelAndView to render.
041         * @param request current portlet resource request
042         * @param response current portlet resource response
043         * @return a ModelAndView to render, or null if handled directly
044         * @throws Exception in case of errors
045         */
046        ModelAndView handleResourceRequest(ResourceRequest request, ResourceResponse response) throws Exception;
047
048}