001/*
002 * Licensed to DuraSpace under one or more contributor license agreements.
003 * See the NOTICE file distributed with this work for additional information
004 * regarding copyright ownership.
005 *
006 * DuraSpace licenses this file to you under the Apache License,
007 * Version 2.0 (the "License"); you may not use this file except in
008 * compliance with the License.  You may obtain a copy of the License at
009 *
010 *     http://www.apache.org/licenses/LICENSE-2.0
011 *
012 * Unless required by applicable law or agreed to in writing, software
013 * distributed under the License is distributed on an "AS IS" BASIS,
014 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
015 * See the License for the specific language governing permissions and
016 * limitations under the License.
017 */
018package org.fcrepo.http.commons.api;
019
020import javax.ws.rs.core.UriInfo;
021
022import org.fcrepo.kernel.api.models.FedoraResource;
023
024import com.google.common.collect.Multimap;
025
026/**
027 * Helper interface to inject Http Headers from external modules.
028 *
029 * @author whikloj
030 * @since 2015-11-01
031 */
032public interface UriAwareHttpHeaderFactory {
033
034    /**
035     * Given a resource and session, update the JAX-RS response with any additional headers.
036     *
037     * @param uriInfo contextual information for building URLs
038     * @param resource the resource from the request
039     * @return Multimap of HTTP Header field names and field values
040     */
041    Multimap<String, String> createHttpHeadersForResource(UriInfo uriInfo, FedoraResource resource);
042
043}