org.glassfish.jersey.client.internal.ConnectorExtension 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) 2020, 2023 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.client.internal;

import org.glassfish.jersey.client.ClientRequest;

/**
 * Connector extension interface to extend existing connector's functionality.
 *
 * @param  type of connection to be extended/processed
 * @param  type of exception which can be thrown while processing/handling exeption
 *
 * @since 2.33
 */
public interface ConnectorExtension {

    /**
     * Main function which allows extension of connector's functionality
     *
     * @param request request instance to work with (shall contain all required settings/params to be used in extension)
     * @param extensionParam connector's instance which is being extended
     */
    void invoke(ClientRequest request, T extensionParam);

    /**
     * After connection is done some additional work may be done
     *
     * @param extensionParam connector's instance which is being extended
     */
    void postConnectionProcessing(T extensionParam);

    /**
     * Exception handling method
     *
     * @param request request instance to work with (shall contain all required settings/params to be used in extension)
     * @param ex exception instance which comes from connector
     * @param extensionParam connector's instance which is being extended
     * @return true if exception was handled by this method, false otherwise
     * @throws E can thor exception if required by handling
     */
    boolean handleException(ClientRequest request, T extensionParam, E ex) throws E;

}