EntityProcessor.java

/*
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
 *
 * Copyright (c) 2013-2015 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.message.filtering.spi;

import org.glassfish.jersey.spi.Contract;

/**
 * Contract supposed to process entity classes for Entity Data Filtering. Implementations will be given a
 * {@link EntityProcessorContext context} providing necessary information to process particular
 * {@link EntityProcessorContext.Type context type}. Contexts are created for: class / properties / accessors.
 *
 * @author Michal Gajdos
 */
@Contract
public interface EntityProcessor {

    /**
     * Result type of processing an context.
     */
    public enum Result {

        /**
         * Processing of an context resulted in modification of the provided entity graph.
         */
        APPLY,

        /**
         * Entity processor didn't modify the provided entity graph.
         */
        SKIP,

        /**
         * Rollback every entity graph modification done in current context.
         */
        ROLLBACK
    }

    /**
     * Process given (class/property/accessor) {@link EntityProcessorContext context} by modifying provided {@link EntityGraph}.
     *
     * @param context context to be processed.
     * @return result of processing a context.
     */
    public Result process(final EntityProcessorContext context);
}