Merge "JERSEY-1708: Implement sub-resource runtime model caching."

Author: Marek Potociar

core-common/src/main/java/org/glassfish/jersey/internal/util/collection/Values.java

@@ -1,7 +1,7 @@
 /*
  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
  *
- * Copyright (c) 2012-2013 Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 2012-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
@@ -45,6 +45,7 @@
  * @author Marek Potociar (marek.potociar at oracle.com)
  */
 public final class Values {
+
     private static final LazyValue EMPTY = new LazyValue() {
         @Override
         public Object get() {
@@ -100,7 +101,7 @@ public static <T, E extends Throwable> UnsafeValue<T, E> emptyUnsafe() {
     /**
      * Get a new constant {@link Value value provider} whose {@link Value#get() get()}
      * method always returns the instance supplied to the {@code value} parameter.
-     *
+     * <p/>
      * In case the supplied value constant is {@code null}, an {@link #empty() empty} value
      * provider is returned.
      *
@@ -113,6 +114,7 @@ public static <T> Value<T> of(final T value) {
     }
 
     private static class InstanceValue<T> implements Value<T> {
+
         private final T value;
 
         public InstanceValue(final T value) {
@@ -125,9 +127,13 @@ public T get() {
         }
 
         @Override
-        public boolean equals(Object o) {
-            if (this == o) return true;
-            if (o == null || getClass() != o.getClass()) return false;
+        public boolean equals(final Object o) {
+            if (this == o) {
+                return true;
+            }
+            if (o == null || getClass() != o.getClass()) {
+                return false;
+            }
 
             return value.equals(((InstanceValue) o).value);
         }
@@ -146,7 +152,7 @@ public String toString() {
     /**
      * Get a new constant {@link UnsafeValue value provider} whose {@link UnsafeValue#get() get()}
      * method always returns the instance supplied to the {@code value} parameter.
-     *
+     * <p/>
      * In case the supplied value constant is {@code null}, an {@link #emptyUnsafe() empty} value
      * provider is returned.
      *
@@ -159,6 +165,7 @@ public static <T, E extends Throwable> UnsafeValue<T, E> unsafe(final T value) {
     }
 
     private static class InstanceUnsafeValue<T, E extends Throwable> implements UnsafeValue<T, E> {
+
         private final T value;
 
         public InstanceUnsafeValue(final T value) {
@@ -171,9 +178,13 @@ public T get() {
         }
 
         @Override
-        public boolean equals(Object o) {
-            if (this == o) return true;
-            if (o == null || getClass() != o.getClass()) return false;
+        public boolean equals(final Object o) {
+            if (this == o) {
+                return true;
+            }
+            if (o == null || getClass() != o.getClass()) {
+                return false;
+            }
 
             return value.equals(((InstanceUnsafeValue) o).value);
         }
@@ -192,11 +203,11 @@ public String toString() {
     /**
      * Get a new "throwing" {@link UnsafeValue unsafe value provider} whose {@link UnsafeValue#get() get()}
      * method always throws the exception supplied to the {@code throwable} parameter.
-     *
+     * <p/>
      * In case the supplied throwable is {@code null}, an {@link NullPointerException} is thrown.
      *
-     * @param <T> value type.
-     * @param <E> exception type.
+     * @param <T>       value type.
+     * @param <E>       exception type.
      * @param throwable throwable instance to be thrown.
      * @return "throwing" unsafe value provider.
      * @throws NullPointerException in case the supplied throwable instance is {@code null}.
@@ -210,6 +221,7 @@ public static <T, E extends Throwable> UnsafeValue<T, E> throwing(final E throwa
     }
 
     private static class ExceptionValue<T, E extends Throwable> implements UnsafeValue<T, E> {
+
         private final E throwable;
 
         public ExceptionValue(final E throwable) {
@@ -222,9 +234,13 @@ public T get() throws E {
         }
 
         @Override
-        public boolean equals(Object o) {
-            if (this == o) return true;
-            if (o == null || getClass() != o.getClass()) return false;
+        public boolean equals(final Object o) {
+            if (this == o) {
+                return true;
+            }
+            if (o == null || getClass() != o.getClass()) {
+                return false;
+            }
 
             return throwable.equals(((ExceptionValue) o).throwable);
         }
@@ -242,7 +258,7 @@ public String toString() {
 
     /**
      * Get a new lazily initialized {@link Value value provider}.
-     *
+     * <p/>
      * The value returned by its {@link Value#get() get()} method is lazily retrieved during a first
      * call to the method from the supplied {@code delegate} value provider and is then cached for
      * a subsequent retrieval.
@@ -267,7 +283,7 @@ public static <T> LazyValue<T> lazy(final Value<T> delegate) {
 
     /**
      * Get a new eagerly initialized {@link Value value provider}.
-     *
+     * <p/>
      * The value returned by its {@link Value#get() get()} method is eagerly computed from the supplied
      * {@code delegate} value provider and is then stored in a final field for a subsequent retrieval.
      * <p>
@@ -289,9 +305,10 @@ public static <T> Value<T> eager(final Value<T> delegate) {
     }
 
     private static class EagerValue<T> implements Value<T> {
+
         private final T result;
 
-        private EagerValue(Value<T> value) {
+        private EagerValue(final Value<T> value) {
             this.result = value.get();
         }
 
@@ -302,6 +319,7 @@ public T get() {
     }
 
     private static class LazyValueImpl<T> implements LazyValue<T> {
+
         private final Object lock;
         private final Value<T> delegate;
 
@@ -332,9 +350,13 @@ public boolean isInitialized() {
         }
 
         @Override
-        public boolean equals(Object o) {
-            if (this == o) return true;
-            if (o == null || getClass() != o.getClass()) return false;
+        public boolean equals(final Object o) {
+            if (this == o) {
+                return true;
+            }
+            if (o == null || getClass() != o.getClass()) {
+                return false;
+            }
 
             return delegate.equals(((LazyValueImpl) o).delegate);
         }
@@ -352,7 +374,7 @@ public String toString() {
 
     /**
      * Get a new lazily initialized {@link UnsafeValue unsafe value provider}.
-     *
+     * <p/>
      * The value returned by its {@link UnsafeValue#get() get()} method is lazily retrieved during a first
      * call to the method from the supplied {@code delegate} value provider and is then cached for
      * a subsequent retrieval.
@@ -380,6 +402,7 @@ public static <T, E extends Throwable> LazyUnsafeValue<T, E> lazy(final UnsafeVa
     }
 
     private static class LazyUnsafeValueImpl<T, E extends Throwable> implements LazyUnsafeValue<T, E> {
+
         private final Object lock;
         private final UnsafeValue<T, E> delegate;
 
@@ -400,7 +423,7 @@ public T get() throws E {
                     if (result == null) {
                         try {
                             result = Values.unsafe(delegate.get());
-                        } catch (Throwable e) {
+                        } catch (final Throwable e) {
                             //noinspection unchecked
                             result = Values.throwing((E) e);
                         }
@@ -417,9 +440,13 @@ public boolean isInitialized() {
         }
 
         @Override
-        public boolean equals(Object o) {
-            if (this == o) return true;
-            if (o == null || getClass() != o.getClass()) return false;
+        public boolean equals(final Object o) {
+            if (this == o) {
+                return true;
+            }
+            if (o == null || getClass() != o.getClass()) {
+                return false;
+            }
 
             return delegate.equals(((LazyUnsafeValueImpl) o).delegate);
         }

core-server/src/main/java/org/glassfish/jersey/server/ApplicationHandler.java

@@ -89,6 +89,7 @@
 import org.glassfish.jersey.internal.inject.Providers;
 import org.glassfish.jersey.internal.util.ReflectionHelper;
 import org.glassfish.jersey.internal.util.collection.Ref;
+import org.glassfish.jersey.message.MessageBodyWorkers;
 import org.glassfish.jersey.message.internal.NullOutputStream;
 import org.glassfish.jersey.model.ContractProvider;
 import org.glassfish.jersey.model.internal.ComponentBag;
@@ -115,6 +116,7 @@
 import org.glassfish.jersey.server.model.ModelProcessor;
 import org.glassfish.jersey.server.model.ModelValidationException;
 import org.glassfish.jersey.server.model.Resource;
+import org.glassfish.jersey.server.model.ResourceMethodInvoker;
 import org.glassfish.jersey.server.model.ResourceModel;
 import org.glassfish.jersey.server.model.internal.ModelErrors;
 import org.glassfish.jersey.server.monitoring.ApplicationEvent;
@@ -136,7 +138,6 @@
 import jersey.repackaged.com.google.common.collect.Lists;
 import jersey.repackaged.com.google.common.collect.Sets;
 import jersey.repackaged.com.google.common.util.concurrent.AbstractFuture;
-import org.glassfish.jersey.message.MessageBodyWorkers;
 
 /**
  * Jersey server-side application handler.
@@ -161,6 +162,7 @@
  * @author Jakub Podlesak (jakub.podlesak at oracle.com)
  * @author Marek Potociar (marek.potociar at oracle.com)
  * @author Libor Kramolis (libor.kramolis at oracle.com)
+ *
  * @see ResourceConfig
  * @see javax.ws.rs.core.Configuration
  * @see org.glassfish.jersey.server.spi.ContainerProvider
@@ -443,16 +445,16 @@ private void initialize() {
             boolean extScopesFound = false;
 
             if (extScopes.length == 1) {
-                for (ComponentProvider p : componentProviders) {
+                for (final ComponentProvider p : componentProviders) {
                     if (p.bind(extScopes[0], new HashSet<Class<?>>(){{add(ExternalRequestScope.class);}})) {
                         extScopesFound = true;
                         break;
                     }
                 }
             } else if (extScopes.length > 1) {
                 if (LOGGER.isLoggable(Level.WARNING)) {
-                    StringBuilder scopeList = new StringBuilder("\n");
-                    for (Class<ExternalRequestScope> ers : extScopes) {
+                    final StringBuilder scopeList = new StringBuilder("\n");
+                    for (final Class<ExternalRequestScope> ers : extScopes) {
                         scopeList.append("   ").append(ers.getTypeParameters()[0]).append('\n');
                     }
                     LOGGER.warning(LocalizationMessages.WARNING_TOO_MANY_EXTERNAL_REQ_SCOPES(scopeList.toString()));
@@ -516,9 +518,11 @@ private void initialize() {
         final JerseyResourceContext jerseyResourceContext = locator.getService(JerseyResourceContext.class);
         jerseyResourceContext.setResourceModel(resourceModel);
 
-        final RuntimeModelBuilder runtimeModelBuilder = locator.getService(RuntimeModelBuilder.class);
-        runtimeModelBuilder.setProcessingProviders(processingProviders);
+        msgBodyWorkers = locator.getService(MessageBodyWorkers.class);
 
+        final RuntimeModelBuilder runtimeModelBuilder = new RuntimeModelBuilder(locator, runtimeConfig, msgBodyWorkers,
+                locator.getService(ResourceMethodInvoker.Builder.class));
+        runtimeModelBuilder.setProcessingProviders(processingProviders);
 
         // assembly request processing chain
         /**
@@ -555,8 +559,6 @@ private void initialize() {
             locator.inject(instance);
         }
 
-        msgBodyWorkers = locator.getService(MessageBodyWorkers.class);
-
         logApplicationInitConfiguration(locator, resourceBag, processingProviders);
 
         if (compositeListener != null) {

core-server/src/main/java/org/glassfish/jersey/server/ServerProperties.java

@@ -1,7 +1,7 @@
 /*
  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
  *
- * Copyright (c) 2012-2014 Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 2012-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
@@ -53,8 +53,9 @@
  * Jersey server-side configuration properties.
  *
  * @author Marek Potociar (marek.potociar at oracle.com)
- * @author Martin Matula (martin.matula at oracle.com)
  * @author Libor Kramolis (libor.kramolis at oracle.com)
+ * @author Michal Gajdos (michal.gajdos at oracle.com)
+ * @author Martin Matula
  */
 @PropertiesClass
 public final class ServerProperties {
@@ -634,6 +635,62 @@ public final class ServerProperties {
      */
     public static final String PROCESSING_RESPONSE_ERRORS_ENABLED = "jersey.config.server.exception.processResponseErrors";
 
+    /**
+     * An integer value that defines the size of cache for sub-resource locator models. The cache is used to provide better
+     * performance for application that uses JAX-RS sub-resource locators.
+     * <p>
+     * The default value is {@value #SUBRESOURCE_LOCATOR_DEFAULT_CACHE_SIZE}.
+     * </p>
+     * <p>
+     * The name of the configuration property is <tt>{@value}</tt>.
+     * </p>
+     *
+     * @see #SUBRESOURCE_LOCATOR_DEFAULT_CACHE_SIZE
+     * @see #SUBRESOURCE_LOCATOR_CACHE_AGE
+     * @since 2.16
+     */
+    public static final String SUBRESOURCE_LOCATOR_CACHE_SIZE = "jersey.config.server.subresource.cache.size";
+
+    /**
+     * The default sub-resource locator cache size ({@value}).
+     *
+     * @see #SUBRESOURCE_LOCATOR_CACHE_SIZE
+     * @since 2.16
+     */
+    public static final int SUBRESOURCE_LOCATOR_DEFAULT_CACHE_SIZE = 64;
+
+    /**
+     * An integer value that defines the maximum age (in seconds) for cached for sub-resource locator models. The age of an cache
+     * entry is defined as the time since the last access (read) to the entry in the cache.
+     * <p>
+     * Entry aging is not enabled by default.
+     * </p>
+     * <p>
+     * The name of the configuration property is <tt>{@value}</tt>.
+     * </p>
+     *
+     * @see #SUBRESOURCE_LOCATOR_CACHE_SIZE
+     * @since 2.16
+     */
+    public static final String SUBRESOURCE_LOCATOR_CACHE_AGE = "jersey.config.server.subresource.cache.age";
+
+    /**
+     * If {@code true} then Jersey will cache {@link org.glassfish.jersey.server.model.Resource Jersey resources} in addition to
+     * caching sub-resource locator classes and instances (which are cached by default).
+     * <p/>
+     * To make sure the caching is effective in this case you need to return same Jersey Resource instances for same input
+     * parameters from resource method. This means that generating new Jersey Resource instances for same input parameters would
+     * not have any performance effect and it would only fill-up the cache.
+     * <p>
+     * The default value is {@code false}.
+     * </p>
+     * <p>
+     * The name of the configuration property is <tt>{@value}</tt>.
+     * </p>
+     */
+    public static final String SUBRESOURCE_LOCATOR_CACHE_JERSEY_RESOURCE_ENABLED =
+            "jersey.config.server.subresource.cache.jersey.resource.enabled";
+
     private ServerProperties() {
         // prevents instantiation
     }