org.glassfish.jersey.server.ResourceFinder Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of jaxrs-ri Show documentation

A bundle project producing JAX-RS RI bundles. The primary artifact is an "all-in-one" OSGi-fied JAX-RS RI bundle (jaxrs-ri.jar). Attached to that are two compressed JAX-RS RI archives. The first archive (jaxrs-ri.zip) consists of binary RI bits and contains the API jar (under "api" directory), RI libraries (under "lib" directory) as well as all external RI dependencies (under "ext" directory). The secondary archive (jaxrs-ri-src.zip) contains buildable JAX-RS RI source bundle and contains the API jar (under "api" directory), RI sources (under "src" directory) as well as all external RI dependencies (under "ext" directory). The second archive also contains "build.xml" ANT script that builds the RI sources. To build the JAX-RS RI simply unzip the archive, cd to the created jaxrs-ri directory and invoke "ant" from the command line.

There is a newer version: 3.1.9

Show newest version

/*
 * Copyright (c) 2012, 2019 Oracle and/or its affiliates. All rights reserved.
 *
 * This program and the accompanying materials are made available under the
 * terms of the Eclipse Public License v. 2.0, which is available at
 * http://www.eclipse.org/legal/epl-2.0.
 *
 * This Source Code may also be made available under the following Secondary
 * Licenses when the conditions for such availability set forth in the
 * Eclipse Public License v. 2.0 are satisfied: GNU General Public License,
 * version 2 with the GNU Classpath Exception, which is available at
 * https://www.gnu.org/software/classpath/license.html.
 *
 * SPDX-License-Identifier: EPL-2.0 OR GPL-2.0 WITH Classpath-exception-2.0
 */

package org.glassfish.jersey.server;

import java.io.InputStream;
import java.util.Iterator;

/**
 * An interface used for finding and opening (loading) new resources.
 * 
 * {@link ResourceConfig} will use all registered finders to obtain classes
 * to be used as resource classes and/or providers. Method {@link #open()} doesn't
 * need to be called on all returned resource names, {@link ResourceConfig} can ignore
 * some of them.
 * 

 * Currently, all resource names ending with ".class" will be accepted and processed (opened).
 * 

 * Extends {@link AutoCloseable} since version 2.19. The {@link #close()} method is used to release
 * allocated/opened resources (such as streams). When a resource finder is closed no other method should be
 * invoked on it.
 *
 * @author Pavel Bucek
 */
public interface ResourceFinder extends Iterator, AutoCloseable {

    /**
     * Open current resource.
     *
     * @return input stream from which current resource can be loaded.
     */
    public InputStream open();

    /**
     * {@inheritDoc}
     * 

     * Release allocated/opened resources (such as streams). When the resource finder is closed
     * no other method should be invoked on it.
     *
     * @since 2.19
     */
    public void close();

    /**
     * Reset the {@link ResourceFinder} instance.
     * 

     * Upon calling this method the implementing class MUST reset its internal state to the initial state.
     */
    public void reset();

    /**
     * {@inheritDoc}
     * 
     * This operation is not supported by {@link ResourceFinder} & throws {@link UnsupportedOperationException}
     * when invoked.
     */
    @Override
    public void remove();
}