001/**
002 * Copyright 2015 DuraSpace, Inc.
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 *     http://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 */
016package org.fcrepo.http.commons.api;
017
018import javax.ws.rs.core.UriInfo;
019
020import org.fcrepo.kernel.api.models.FedoraResource;
021
022import com.google.common.collect.Multimap;
023
024/**
025 * Helper interface to inject Http Headers from external modules.
026 *
027 * @author whikloj
028 * @since 2015-11-01
029 */
030public interface UriAwareHttpHeaderFactory {
031
032    /**
033     * Given a resource and session, update the JAX-RS response with any additional headers.
034     *
035     * @param uriInfo contextual information for building URLs
036     * @param resource the resource from the request
037     * @return Multimap of HTTP Header field names and field values
038     */
039    Multimap<String, String> createHttpHeadersForResource(UriInfo uriInfo, FedoraResource resource);
040
041}