Uploaded image for project: 'Seam 2'
  1. Seam 2
  2. JBSEAM-4861

Component.java uses application wide factoryLock too often

    XMLWordPrintable

    Details

    • Type: Patch
    • Status: Closed (View Workflow)
    • Priority: Major
    • Resolution: Done
    • Affects Version/s: 2.2.2.Final, 2.3.0.ALPHA, 2.3.0.BETA1, 2.3.0.BETA2
    • Fix Version/s: 2.3.0.CR1
    • Component/s: Core
    • Labels:
      None

      Description

      Whenever getInstanceFromFactory() is called and a factory is used, a (application wide) lock is used: factoryLock.

      In my environments the Factory uses expensive calls to the backend to create an object, and during this time no other Factory method is allowed to be called. This is a severe bottleneck in a multiuser environment.

      This lock is important for APPLICATION scoped components, but other components that are i.e. CONVERSATION scoped, Seam already ensures that only one Thread has access to the current conversation. The same should be true for PAGE and EVENT. In this cases no lock should be acquired. UPDATE: Factories that use injection should not be called multithreaded, therefore an updated condition.

      See the follwing code snippet. I also attach a patch.

      I tested the patch for Seam 2.2.2.Final - I would be most happy to have this included in 2.2 and 2.3 branch.

      Br Alexander.

      Component.java
              ScopeType scopeResult = getOutScope(factoryMethod.getScope(),
                  factoryMethod.getComponent());
              ScopeType scopeFactory = factoryMethod.getComponent().getScope();
              boolean lockingNeeded = false;
              /*
               * we need this lock in the following cases: (1) the target scope is
               * accessed by more than one thread (as we don't want to create the same
               * object by two threads at the same time for the same scope) OR (2) the
               * factory is accessed by more than one thread and is using interceptors
               * (as accessing a factory multiple times might mess up interceptors).
               * This assumes that (1) the scopes CONVERSATION, EVENT and PAGE can't
               * be accessed by more than one thread anyway due to CONVERSATION being
               * locked for the current thread anyway, and EVENT and PAGE being only
               * short-lived anyway. (2) a factory that doesn't use injection can be
               * accessed multi threaded. See JBSEAM-4669/JBSEAM-2419 for the original
               * discussion.
               */
              if ((scopeResult != ScopeType.CONVERSATION
                  && scopeResult != ScopeType.EVENT && scopeResult != ScopeType.PAGE)
                  || (scopeFactory != ScopeType.CONVERSATION
                      && scopeFactory != ScopeType.EVENT
                      && scopeFactory != ScopeType.PAGE && factoryMethod
                      .getComponent().interceptionEnabled)) {
                lockingNeeded = true;
              }
              if (lockingNeeded) {
                /*
                 * Only this factory instance can access result scope 
                 * CONVERSATION / EVENT / PAGE anyway due to 
                 * the locking of the conversation.
                 */
                if (scopeResult == ScopeType.CONVERSATION
                  || scopeResult == ScopeType.EVENT || scopeResult == ScopeType.PAGE) {
                  synchronized (factory) {
                    return createInstanceFromFactory(name, scope, factoryMethod,
                        factory);
                  }
                }
                /*
                 * synchronize all instances of this factory as they might outject to the 
                 * same scope (i.e. factory in EVENT scope, outjecting to APPLICATION scope).
                 */
                else {
                  synchronized (factory.getClass()) {
                    return createInstanceFromFactory(name, scope, factoryMethod,
                        factory);
                  }
                }
              } else {
                return createInstanceFromFactory(name, scope, factoryMethod, factory);
              }
      
      [...]
      
        private static Object createInstanceFromFactory(String name, ScopeType scope,
            Init.FactoryMethod factoryMethod, Object factory) {
          // check whether there has been created an instance by another thread
          // while waiting for this function's lock
          if (scope != STATELESS) {
            Object value = (scope == null) ? Contexts.lookupInStatefulContexts(name)
                : scope.getContext().get(name);
            if (value != null) {
              return value;
            }
          }
          
          if (factory == null) {
            return null;
          } else {
            Object result = factoryMethod.getComponent().callComponentMethod(factory,
                factoryMethod.getMethod());
            return handleFactoryMethodResult(name, factoryMethod.getComponent(),
                result, factoryMethod.getScope());
          }
        }
      
      
      

        Gliffy Diagrams

          Attachments

          1. Component.patch
            6 kB
          2. Component.patch
            5 kB
          3. Component.patch
            5 kB
          4. Component.patch
            2 kB
          5. Component.patch
            1 kB

            Issue Links

              Activity

                People

                • Assignee:
                  manaRH Marek Novotny
                  Reporter:
                  ahus1 Alexander Schwartz
                • Votes:
                  4 Vote for this issue
                  Watchers:
                  6 Start watching this issue

                  Dates

                  • Created:
                    Updated:
                    Resolved:

                    Time Tracking

                    Estimated:
                    Original Estimate - 1 day
                    1d
                    Remaining:
                    Remaining Estimate - 1 day
                    1d
                    Logged:
                    Time Spent - Not Specified
                    Not Specified