ResponseLinkFilter.java

/*
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
 *
 * Copyright (c) 2010-2014 Oracle and/or its affiliates. All rights reserved.
 *
 * The contents of this file are subject to the terms of either the GNU
 * General Public License Version 2 only ("GPL") or the Common Development
 * and Distribution License("CDDL") (collectively, the "License").  You
 * may not use this file except in compliance with the License.  You can
 * obtain a copy of the License at
 * http://glassfish.java.net/public/CDDL+GPL_1_1.html
 * or packager/legal/LICENSE.txt.  See the License for the specific
 * language governing permissions and limitations under the License.
 *
 * When distributing the software, include this License Header Notice in each
 * file and include the License file at packager/legal/LICENSE.txt.
 *
 * GPL Classpath Exception:
 * Oracle designates this particular file as subject to the "Classpath"
 * exception as provided by Oracle in the GPL Version 2 section of the License
 * file that accompanied this code.
 *
 * Modifications:
 * If applicable, add the following below the License Header, with the fields
 * enclosed by brackets [] replaced by your own identifying information:
 * "Portions Copyright [year] [name of copyright owner]"
 *
 * Contributor(s):
 * If you wish your version of this file to be governed by only the CDDL or
 * only the GPL Version 2, indicate your decision by adding "[Contributor]
 * elects to include this software in this distribution under the [CDDL or GPL
 * Version 2] license."  If you don't indicate a single choice of license, a
 * recipient has the option to distribute your version of this file under
 * either the CDDL, the GPL Version 2 or to extend the choice of license to
 * its licensees as provided above.  However, if you add GPL Version 2 code
 * and therefore, elected the GPL Version 2 license, then the option applies
 * only if the new code is made subject to such option by the copyright
 * holder.
 */
package org.glassfish.jersey.linking;

import javax.ws.rs.container.ContainerRequestContext;
import javax.ws.rs.container.ContainerResponseContext;
import javax.ws.rs.container.ContainerResponseFilter;
import javax.ws.rs.core.Context;
import javax.ws.rs.core.Link;
import javax.ws.rs.core.UriInfo;

import org.glassfish.jersey.linking.mapping.ResourceMappingContext;

/**
 * Filter that processes {@link Link} annotated fields in returned response
 * entities.
 * <p/>
 * When an application is deployed as a Servlet or Filter this filter can be
 * registered using the following initialization parameters:
 * <blockquote><pre>
 *     <init-param>
 *         <param-name>com.sun.jersey.spi.container.ContainerResponseFilters</param-name>
 *         <param-value>com.sun.jersey.server.linking.ResponseLinkFilter</param-value>
 *     </init-param>
 * </pre></blockquote>
 * <p/>
 *
 * @author Mark Hadley
 * @author Gerard Davison (gerard.davison at oracle.com)
 * @see Link
 */

class ResponseLinkFilter implements ContainerResponseFilter {

    @Context
    private UriInfo uriInfo;

    @Context
    private ResourceMappingContext rmc;

    @Override
    @SuppressWarnings("unchecked")
    public void filter(ContainerRequestContext request, ContainerResponseContext response) {
        final Object entity = response.getEntity();

        if (entity != null && !uriInfo.getMatchedResources().isEmpty()) {
            Class<?> entityClass = entity.getClass();
            HeaderProcessor lhp = new HeaderProcessor(entityClass);
            lhp.processLinkHeaders(entity, uriInfo, rmc, response.getHeaders());
            FieldProcessor lp = new FieldProcessor(entityClass);
            lp.processLinks(entity, uriInfo, rmc);
        }

    }
}