Changeset 5517

Timestamp:

Mar 31, 2020, 4:20:48 AM (5 years ago)

Author:

Christian Schulte

Message:

o Merged changes up to 5516 from 'trunk' into branch 'jomc-modlet-1.x'.

Closes #151

Location:

jomc-modlet/branches/jomc-modlet-1.x

Files:

• . (modified) (1 prop)
• src/main/java/org/jomc/modlet/DefaultModletValidator.java (modified) (1 diff)
• src/main/java/org/jomc/modlet/DefaultServiceFactory.java (modified) (3 diffs)
• src/main/java/org/jomc/modlet/ModelProcessor.java (modified) (1 diff)
• src/main/java/org/jomc/modlet/ModelProvider.java (modified) (1 diff)
• src/main/java/org/jomc/modlet/ModelValidationReport.java (modified) (1 diff)
• src/main/java/org/jomc/modlet/ModelValidator.java (modified) (1 diff)
• src/main/java/org/jomc/modlet/ModletProcessor.java (modified) (1 diff)
• src/main/java/org/jomc/modlet/ModletProvider.java (modified) (1 diff)
• src/main/java/org/jomc/modlet/ModletValidator.java (modified) (1 diff)
• src/main/java/org/jomc/modlet/ServiceFactory.java (modified) (1 diff)
• src/main/resources/org/jomc/modlet/DefaultServiceFactory.properties (modified) (1 diff)
• src/main/resources/org/jomc/modlet/DefaultServiceFactory_de.properties (modified) (1 diff)
• src/main/resources/org/jomc/modlet/DefaultServiceFactory_en.properties (modified) (1 diff)
• src/site/apt/system-properties.apt (modified) (1 diff)

jomc-modlet/branches/jomc-modlet-1.x/src/main/java/org/jomc/modlet/DefaultModletValidator.java ¶

@@ -253 +253 @@
     @Override
     public ModelValidationReport validateModlets( final ModelContext context, final Modlets modlets )
-        throws NullPointerException, ModelException
+        throws ModelException
     {
         if ( context == null )

jomc-modlet/branches/jomc-modlet-1.x/src/main/java/org/jomc/modlet/DefaultServiceFactory.java ¶

@@ -57 +57 @@
 
     /**
+     * Constant for the name of the system property controlling property {@code defaultEnabled}.
+     *
+     * @see #isDefaultEnabled()
+     * @since 1.11.0
+     */
+    private static final String DEFAULT_ENABLED_PROPERTY_NAME =
+        "org.jomc.modlet.DefaultServiceFactory.defaultEnabled";
+
+    /**
+     * Default value of the flag indicating the factory is enabled by default.
+     *
+     * @see #isDefaultEnabled()
+     * @since 1.11.0
+     */
+    private static final Boolean DEFAULT_ENABLED = Boolean.TRUE;
+
+    /**
+     * Flag indicating the factory is enabled by default.
+     * @since 1.11.0
+     */
+    private static volatile Boolean defaultEnabled;
+
+    /**
+     * Flag indicating the factory is enabled.
+     * @since 1.11.0
+     */
+    private volatile Boolean enabled;
+
+    /**
      * Constant for the name of the system property controlling property {@code defaultOrdinal}.
      *
@@ -87 +116 @@
     {
         super();
+    }
+
+    /**
+     * Gets a flag indicating the factory is enabled by default.
+     * <p>
+     * The default enabled flag is controlled by system property
+     * {@code org.jomc.modlet.DefaultServiceFactory.defaultEnabled} holding a value indicating the factory is
+     * enabled by default. If that property is not set, the {@code true} default is returned.
+     * </p>
+     *
+     * @return {@code true}, if the factory is enabled by default; {@code false}, if the factory is disabled by
+     * default.
+     *
+     * @see #isEnabled()
+     * @see #setDefaultEnabled(java.lang.Boolean)
+     * @since 1.11.0
+     */
+    public static boolean isDefaultEnabled()
+    {
+        if ( defaultEnabled == null )
+        {
+            defaultEnabled = Boolean.valueOf( System.getProperty(
+                DEFAULT_ENABLED_PROPERTY_NAME, Boolean.toString( DEFAULT_ENABLED ) ) );
+
+        }
+
+        return defaultEnabled;
+    }
+
+    /**
+     * Sets the flag indicating the factory is enabled by default.
+     *
+     * @param value The new value of the flag indicating the factory is enabled by default or {@code null}.
+     *
+     * @see #isDefaultEnabled()
+     * @since 1.11.0
+     */
+    public static void setDefaultEnabled( final Boolean value )
+    {
+        defaultEnabled = value;
+    }
+
+    /**
+     * Gets a flag indicating the factory is enabled.
+     *
+     * @return {@code true}, if the factory is enabled; {@code false}, if the factory is disabled.
+     *
+     * @see #isDefaultEnabled()
+     * @see #setEnabled(java.lang.Boolean)
+     * @since 1.11.0
+     */
+    public final boolean isEnabled()
+    {
+        if ( this.enabled == null )
+        {
+            this.enabled = isDefaultEnabled();
+        }
+
+        return this.enabled;
+    }
+
+    /**
+     * Sets the flag indicating the factory is enabled.
+     *
+     * @param value The new value of the flag indicating the factory is enabled or {@code null}.
+     *
+     * @see #isEnabled()
+     * @since 1.11.0
+     */
+    public final void setEnabled( final Boolean value )
+    {
+        this.enabled = value;
     }
 
@@ -171 +272 @@
         try
         {
-            final Class<?> clazz = context.findClass( service.getClazz() );
-
-            if ( clazz == null )
-            {
-                throw new ModelException( getMessage( "serviceNotFound", service.getOrdinal(), service.
-                                                      getIdentifier(),
-                                                      service.getClazz() ) );
-
-            }
-
-            if ( !type.isAssignableFrom( clazz ) )
-            {
-                throw new ModelException( getMessage( "illegalService", service.getOrdinal(), service.
-                                                      getIdentifier(),
-                                                      service.getClazz(), type.getName() ) );
-
-            }
-
-            final T serviceObject = clazz.asSubclass( type ).newInstance();
-
-            if ( !service.getProperty().isEmpty() )
-            {
-                if ( context.getExecutorService() != null && service.getProperty().size() > 1 )
-                {
-                    final List<Callable<Void>> tasks =
-                        new ArrayList<Callable<Void>>( service.getProperty().size() );
-
-                    for ( int i = 0, s0 = service.getProperty().size(); i < s0; i++ )
-                    {
-                        final Property p = service.getProperty().get( i );
-
-                        tasks.add( new Callable<Void>()
+            final T serviceObject;
+            if ( this.isEnabled() )
+            {
+                final Class<?> clazz = context.findClass( service.getClazz() );
+
+                if ( clazz == null )
+                {
+                    throw new ModelException( getMessage( "serviceNotFound", service.getOrdinal(),
+                                                          service.getIdentifier(), service.getClazz() ) );
+
+                }
+
+                if ( !type.isAssignableFrom( clazz ) )
+                {
+                    throw new ModelException( getMessage( "illegalService", service.getOrdinal(),
+                                                          service.getIdentifier(), service.getClazz(),
+                                                          type.getName() ) );
+
+                }
+
+                serviceObject = clazz.asSubclass( type ).newInstance();
+
+                if ( !service.getProperty().isEmpty() )
+                {
+                    if ( context.getExecutorService() != null && service.getProperty().size() > 1 )
+                    {
+                        final List<Callable<Void>> tasks =
+                            new ArrayList<Callable<Void>>( service.getProperty().size() );
+
+                        for ( int i = 0, s0 = service.getProperty().size(); i < s0; i++ )
                         {
-
-                            public Void call() throws ModelException
+                            final Property p = service.getProperty().get( i );
+
+                            tasks.add( new Callable<Void>()
                             {
-                                initProperty( context, serviceObject, p.getName(), p.getValue() );
-                                return null;
-                            }
-
-                        } );
-                    }
-
-                    for ( final Future<Void> task : context.getExecutorService().invokeAll( tasks ) )
-                    {
-                        task.get();
-                    }
-                }
-                else
-                {
-                    for ( int i = 0, s0 = service.getProperty().size(); i < s0; i++ )
-                    {
-                        final Property p = service.getProperty().get( i );
-                        this.initProperty( context, serviceObject, p.getName(), p.getValue() );
-                    }
+
+                                public Void call() throws ModelException
+                                {
+                                    initProperty( context, serviceObject, p.getName(), p.getValue() );
+                                    return null;
+                                }
+
+                            } );
+                        }
+
+                        for ( final Future<Void> task : context.getExecutorService().invokeAll( tasks ) )
+                        {
+                            task.get();
+                        }
+                    }
+                    else
+                    {
+                        for ( int i = 0, s0 = service.getProperty().size(); i < s0; i++ )
+                        {
+                            final Property p = service.getProperty().get( i );
+                            this.initProperty( context, serviceObject, p.getName(), p.getValue() );
+                        }
+                    }
+                }
+            }
+            else
+            {
+                serviceObject = null;
+
+                if ( context.isLoggable( Level.FINER ) )
+                {
+                    context.log( Level.FINER, getMessage( "disabled", this.getClass().getSimpleName() ), null );
                 }
             }

jomc-modlet/branches/jomc-modlet-1.x/src/main/java/org/jomc/modlet/ModelProcessor.java ¶

@@ -52 +52 @@
      * @throws ModelException if processing fails.
      */
-    Model processModel( ModelContext context, Model model ) throws NullPointerException, ModelException;
+    Model processModel( ModelContext context, Model model ) throws ModelException;
 
 }

jomc-modlet/branches/jomc-modlet-1.x/src/main/java/org/jomc/modlet/ModelProvider.java ¶

@@ -52 +52 @@
      * @throws ModelException if searching the context fails.
      */
-    Model findModel( ModelContext context, Model model ) throws NullPointerException, ModelException;
+    Model findModel( ModelContext context, Model model ) throws ModelException;
 
 }

jomc-modlet/branches/jomc-modlet-1.x/src/main/java/org/jomc/modlet/ModelValidationReport.java ¶

@@ -152 +152 @@
             return new StringBuilder( 200 ).append( '{' ).
                 append( "identifier=" ).append( this.getIdentifier() ).
-                append( ", level=" ).append( this.getLevel().getLocalizedName() ).
+                append( ", level=" ).append( this.getLevel() ).
                 append( ", message=" ).append( this.getMessage() ).
                 append( ", element=" ).append( this.getElement() ).append( '}' ).toString();

jomc-modlet/branches/jomc-modlet-1.x/src/main/java/org/jomc/modlet/ModelValidator.java ¶

@@ -55 +55 @@
      */
     ModelValidationReport validateModel( ModelContext context, Model model )
-        throws NullPointerException, ModelException;
+        throws ModelException;
 
 }

jomc-modlet/branches/jomc-modlet-1.x/src/main/java/org/jomc/modlet/ModletProcessor.java ¶

@@ -60 +60 @@
      * @throws ModelException if processing {@code Modlets} fails.
      */
-    Modlets processModlets( ModelContext context, Modlets modlets ) throws NullPointerException, ModelException;
+    Modlets processModlets( ModelContext context, Modlets modlets ) throws ModelException;
 
 }

jomc-modlet/branches/jomc-modlet-1.x/src/main/java/org/jomc/modlet/ModletProvider.java ¶

@@ -77 +77 @@
      * @since 1.6
      */
-    Modlets findModlets( ModelContext context, Modlets modlets ) throws NullPointerException, ModelException;
+    Modlets findModlets( ModelContext context, Modlets modlets ) throws ModelException;
 
 }

jomc-modlet/branches/jomc-modlet-1.x/src/main/java/org/jomc/modlet/ModletValidator.java ¶

@@ -63 +63 @@
      */
     ModelValidationReport validateModlets( ModelContext context, Modlets modlets )
-        throws NullPointerException, ModelException;
+        throws ModelException;
 
 }

jomc-modlet/branches/jomc-modlet-1.x/src/main/java/org/jomc/modlet/ServiceFactory.java ¶

@@ -64 +64 @@
      */
     <T> T createServiceObject( ModelContext context, Service service, Class<T> type )
-        throws NullPointerException, ModelException;
+        throws ModelException;
 
 }

jomc-modlet/branches/jomc-modlet-1.x/src/main/resources/org/jomc/modlet/DefaultServiceFactory.properties ¶

@@ -8 +8 @@
 unsupportedCharacterValue=Unsupported character value for property ''{1}'' of class ''{0}''.
 unsupportedPropertyType=Unsupported property type ''{2}'' setting property ''{1}'' of class ''{0}''.
+disabled={0} - Not producing service objects. Disabled.

jomc-modlet/branches/jomc-modlet-1.x/src/main/resources/org/jomc/modlet/DefaultServiceFactory_de.properties ¶

@@ -8 +8 @@
 unsupportedCharacterValue=Nicht unterst\u00fctztes Zeichen f\u00fcr Eigenschaft ''{1}'' der Klasse ''{0}''.
 unsupportedPropertyType=Unsupported property type ''{2}'' setting property ''{1}'' of class ''{0}''.
+disabled={0} - Keine Erstellung von Serviceobjekten. Deaktiviert.

jomc-modlet/branches/jomc-modlet-1.x/src/main/resources/org/jomc/modlet/DefaultServiceFactory_en.properties ¶

@@ -8 +8 @@
 unsupportedCharacterValue=Unsupported character value for property ''{1}'' of class ''{0}''.
 unsupportedPropertyType=Unsupported property type ''{2}'' setting property ''{1}'' of class ''{0}''.
+disabled={0} - Not producing service objects. Disabled.

jomc-modlet/branches/jomc-modlet-1.x/src/site/apt/system-properties.apt ¶

@@ -70 +70 @@
 | <<<org.jomc.modlet.ModelContextFactory>>> | <<<java.lang.String>>> | <<<org.jomc.modlet.DefaultModelContextFactory>>> |
 *---------------------------------------------*-------------------------------*----------------------------------------*
+| <<<org.jomc.modlet.DefaultServiceFactory.defaultEnabled>>> | <<<java.lang.Boolean>>> | <<<true>>> |
+*---------------------------------------------*-------------------------------*----------------------------------------*