All Downloads are FREE. Search and download functionalities are using the official Maven repository.

org.glassfish.jersey.server.monitoring.ResourceMethodStatistics Maven / Gradle / Ivy

Go to download

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.8
Show newest version
/*
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
 *
 * Copyright (c) 2013 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.server.monitoring;

import org.glassfish.jersey.server.model.ResourceMethod;

/**
 * Monitoring statistics an of an execution of the resource method. The {@link #snapshot()}
 * method returns an immutable snapshot with consistent data. The principles of using statistics
 * is similar to principles of using {@link MonitoringStatistics}.
 * 

* Statistics contain two {@link ExecutionStatistics} where {@link #getMethodStatistics()} contains * statistics for execution of the code of resource method and {@link #getRequestStatistics()} contains * statistics for complete processing of requests that were matched to the resource method. This implies that * {@link #getRequestStatistics()} will tend to contain higher time measurements as they measure total request * processing time and not only execution of the resource method. *

* Statistics retrieved from Jersey runtime might be mutable and thanks to it might provide inconsistent data * as not all statistics are updated in the same time. To retrieve the immutable and consistent * statistics data the method {@link #snapshot()} should be used. * * @author Miroslav Fuksa (miroslav.fuksa at oracle.com) * @see MonitoringStatistics See monitoring statistics for more details. */ public interface ResourceMethodStatistics { /** * Get {@link ExecutionStatistics execution statistics} that contain measurements of times only for * execution of resource method. Durations average time, minimum time and maximum time * measure only time of execution of resource method code. It does not involve other request processing * phases. * * @return Execution statistics of one resource method. */ public ExecutionStatistics getMethodStatistics(); /** * Get {@link ExecutionStatistics execution statistics} that contain measurements of times for * whole processing from time when request comes into the Jersey application until the response * is written to the underlying IO container. The statistics involves only requests that were matched * to resource method defined by {@link #getResourceMethod()}. * * @return Execution statistics of entire request processing for one resource method. */ public ExecutionStatistics getRequestStatistics(); /** * Get a {@link ResourceMethod resource method} for which this {@link ResourceMethodStatistics} are calculated. * * @return Resource method. */ public ResourceMethod getResourceMethod(); /** * Get the immutable and consistent snapshot of the monitoring statistics. Working with snapshots might * have negative performance impact as snapshot must be created but ensures consistency of data over time. * However, the usage of snapshot is encouraged to avoid working with inconsistent data. Not all statistics * must be updated in the same time on mutable version of statistics. * * @return Snapshot of resource method statistics. */ public ResourceMethodStatistics snapshot(); }





© 2015 - 2024 Weber Informatics LLC | Privacy Policy