New major version without Xerces #8

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged

kuniss merged 49 commits into master from pr-for-4.0-improvements+xerces-removal

Sep 13, 2024

CHANGELOG.md

-Original file line number
+Diff line change
@@ -1,5 +1,24 @@
     # Change Log for javapos-config-loader
+    ## 4.0.0
+    - jpos.config.DefaultCompositeRegPopulator.load() is throwing more specific IllegalArgument exception instead of RuntimeException
+    - added Javax XML parser based XML registry populator implementation (contributed by @mjpcger)
+    - removed Xerces based XML registry populator implementations, mainly
+        - `jpos.config.simple.xml.XercesRegPopulator`
+        - `jpos.config.simple.xml.Xerces2RegPopulator`
+    - removed Xerces dependency at all, thus, it does not appear as transitive dependency in the Maven POM anymore
+    - added JavaPOS XML node name, attribute name, and fixed file names as constants to `jpos.config.simple.xml.JavaxRegPopulator` making them available for all (proprietary) XML implementations
+    - restricted XML parser's DTD and XSD resources access for security reasons
+    - renamed `jpos.profile.XercesProfileFactory` to `jpos.profile.DefaultProfileFactory`
+    - ensure all resources are well closed by stringent use of try-with-resource clauses
+    - fixing a NPE in case multi-propo definition is missing
+    - removed deprecated constructors at
+        - `jpos.config.simple.SimpleEntryRegistry`, and
+        - `jpos.loader.simple.SimpleServiceManager`
+    - removed deprecated class `jpos.util.Tracer`
+    - ensure compatibility to webstart environments by using standard class-loader instead of the system class-loader (solves issue #1)
     ## 3.1.0
     - Added missing devices to XML schema/DTD files and as DevCat interfaces (contribution by [@dougberkland](https://github.com/dougberkland))
@@ Expand Down @@

build.gradle

-Original file line number
+Diff line change
@@ Expand Up / @@ -27,7 +27,7 @@ wrapper { @@
     def artifactName = 'javapos-config-loader'
     group='org.javapos'
-    version='3.1.0' // if version is going to be changed, first add "-SNAPSHOT" to test publishing to MavenCentral's Snapshot repo
+    version='4.0.0-SNAPSHOT' // if version is going to be changed, first add "-SNAPSHOT" to test publishing to MavenCentral's Snapshot repo
     ///////////////////////////////////////////////////////////////////////////////
@@ Expand Down Expand Up @@
     def testResourceDir = file("${System.properties['java.io.tmpdir']}/javapos-config-loader-test/resources")
     dependencies {
-    	api 'xerces:xerces:1.2.3'
     	api 'org.javapos:javapos-contracts:1.6.0'
     	testImplementation("junit:junit:4.13.2")
@@ Expand Down @@

src/main/java/jpos/config/CompositeRegPopulator.java

-Original file line number
+Diff line change
@@ Expand Up @@
     	public void remove( JposRegPopulator populator );
     	/** @return an iterator over all populators in this composite */
+    	@SuppressWarnings("rawtypes")
     	public Iterator getPopulators();
     	/**
@@ Expand Down @@

src/main/java/jpos/config/DefaultCompositeRegPopulator.java

            
                      Original file line number
                      Diff line number
                      Diff line change
                  
    @@ -32,8 +32,7 @@
  
     * @since 1.3 (Washington DC 2001 meeting)

     * @author E. Michael Maximilien (maxim@us.ibm.com)

     */

    public class DefaultCompositeRegPopulator extends Object 

    										   implements CompositeRegPopulator

    public class DefaultCompositeRegPopulator implements CompositeRegPopulator

    {

        //-------------------------------------------------------------------------

        // Ctor(s)

    @@ -73,19 +72,19 @@ private JposRegPopulator createPopulator( String popName, String className )
  
    		try

    		{

    			Class popClass = Class.forName( className );

    			Class<?> popClass = Class.forName( className );

    			try

    			{

    				Class[] ctorParamTypes = { String.class };

    				Constructor ctor = popClass.getConstructor( ctorParamTypes );

    				Class<?>[] ctorParamTypes = { String.class };

    				Constructor<?> ctor = popClass.getConstructor( ctorParamTypes );

    				Object[] args = { popName };

    				populator = (JposRegPopulator)ctor.newInstance( args );

    			}

    			catch( NoSuchMethodException nsme )

    			{

    				Constructor ctor = popClass.getConstructor( new Class[ 0 ] );

    				Constructor<?> ctor = popClass.getConstructor( new Class[ 0 ] );

    				populator = (JposRegPopulator)ctor.newInstance( new Object[ 0 ] );

    			}

    @@ -164,34 +163,28 @@ public String getClassName()
  
         * @param entries an enumeration of JposEntry objects

         * @throws java.lang.Exception if any error occurs while saving

         */

        public void save( Enumeration entries ) throws Exception

        public void save( @SuppressWarnings("rawtypes") Enumeration entries ) throws Exception

    	{

    		HashMap popEntriesMap = new HashMap();

    		HashMap<String, List<JposEntry>>popEntriesMap = new HashMap<>();

    		Iterator popIterator = popMap.values().iterator();

    		Iterator<JposRegPopulator> popIterator = popMap.values().iterator();

    		while( popIterator.hasNext() )

    			popEntriesMap.put( ( (JposRegPopulator)popIterator.next() ).

    			                   getUniqueId(),

    							   new ArrayList() );

    			popEntriesMap.put( ( popIterator.next() ).getUniqueId(), new ArrayList<>() );

    		while( entries.hasMoreElements() )

    		{

    			JposEntry entry = (JposEntry)entries.nextElement();

    			JposRegPopulator populator = (JposRegPopulator)entry.

    			                             getRegPopulator();

    			JposRegPopulator populator = entry.getRegPopulator();

    			if( populator == null )

    			{

    				Collection defaultEntryList = (Collection)popEntriesMap.

    				                              get( getDefaultPopulator().

    				                              getUniqueId() );

    				List<JposEntry> defaultEntryList = popEntriesMap.get( getDefaultPopulator().getUniqueId() );

    				defaultEntryList.add( entry );

    			}

    			else

    			{

    				Collection entryList = (Collection)popEntriesMap.

    				                       get( populator.getUniqueId() );

    				List<JposEntry> entryList = popEntriesMap.get( populator.getUniqueId() );

    				if( entryList == null )

    					tracer.println( "Trying to save entry with logicalName = " +

    @@ -206,17 +199,17 @@ public void save( Enumeration entries ) throws Exception
  
    		popIterator = popMap.values().iterator();

    		while( popIterator.hasNext() )

    		{

    			JposRegPopulator populator = (JposRegPopulator)popIterator.next();

    			JposRegPopulator populator = popIterator.next();

    			String popUniqueId = populator.getUniqueId();

    			Collection entryList = (Collection)popEntriesMap.get( popUniqueId );

    			List<JposEntry> entryList = popEntriesMap.get( popUniqueId );

    			try

    			{

    				if( popFileMap.get( populator.getUniqueId() ) != null )

    					populator.save( new Vector( entryList ).elements(),

    									(String)popFileMap.get( populator.getUniqueId() ) );

    					populator.save( Collections.enumeration(entryList),

    									popFileMap.get( populator.getUniqueId() ) );

    				else

    					populator.save( new Vector( entryList ).elements() );

    					populator.save( Collections.enumeration(entryList) );

    			}

    			catch( Exception e )

    			{

    @@ -236,7 +229,7 @@ public void save( Enumeration entries ) throws Exception
  
         * @param fileName the file name to save entries

         * @throws java.lang.Exception if any error occurs while saving

         */

        public void save( Enumeration entries, String fileName ) throws Exception

        public void save( @SuppressWarnings("rawtypes") Enumeration entries, String fileName ) throws Exception

    	{

    		getDefaultPopulator().save( entries, fileName );

    	}

    @@ -254,57 +247,60 @@ public void load()
  
            JposProperties jposProperties = JposServiceLoader.getManager().getProperties();

    		JposProperties.MultiProperty populatorClassMultiProp = 

    		jposProperties.getMultiProperty( JposProperties.JPOS_CONFIG_POPULATOR_CLASS_MULTIPROP_NAME );

    		jposProperties.getMultiProperty( JposPropertiesConst.JPOS_CONFIG_POPULATOR_CLASS_MULTIPROP_NAME );

    		JposProperties.MultiProperty populatorFileMultiProp = 

    		jposProperties.getMultiProperty( JposProperties.JPOS_CONFIG_POPULATOR_FILE_MULTIPROP_NAME );

    		jposProperties.getMultiProperty( JposPropertiesConst.JPOS_CONFIG_POPULATOR_FILE_MULTIPROP_NAME );

    		if( populatorClassMultiProp.getNumberOfProperties() == 0 )

    		if( populatorClassMultiProp == null || populatorClassMultiProp.getNumberOfProperties() == 0 )

    		{

    			tracer.println( "CompositeRegPopulator.load() w/o any defined multi-property" );

    			throw new RuntimeException( "CompositeRegPopulator.load() w/o any defined multi-property" );

    			throw new IllegalArgumentException( "CompositeRegPopulator.load() w/o any defined multi-property" );

    		}

    		Iterator popClasses = populatorClassMultiProp.getSortedPropertyNames();

    		@SuppressWarnings("unchecked")

    		Iterator<String> popClasses = populatorClassMultiProp.getSortedPropertyNames();

    		String defaultPopName = (String)popClasses.next();

    		String defaultPopName = popClasses.next();

    		String defaultPopClass = populatorClassMultiProp.getPropertyString( defaultPopName );

    		int defaultPopClassNumber = populatorClassMultiProp.propertyNumber( defaultPopName );

    		JposRegPopulator defaultPopulator = createPopulator( defaultPopName, defaultPopClass );

    		if( populatorFileMultiProp != null && populatorFileMultiProp.getNumberOfProperties() > 0 )

    		{

    			String defaultPopFile = (String)populatorFileMultiProp.getPropertyString( defaultPopClassNumber );

    			if( defaultPopFile != null )

    		if( defaultPopulator != null ) {

    			if( populatorFileMultiProp != null && populatorFileMultiProp.getNumberOfProperties() > 0 )

    			{

    				defaultPopulator.load( defaultPopFile );

    				lastLoadException = defaultPopulator.getLastLoadException();

    				popFileMap.put( defaultPopulator.getUniqueId(), defaultPopFile );

    				String defaultPopFile = populatorFileMultiProp.getPropertyString( defaultPopClassNumber );

    				if( defaultPopFile != null )

    				{

    					defaultPopulator.load( defaultPopFile );

    					lastLoadException = defaultPopulator.getLastLoadException();

    					popFileMap.put( defaultPopulator.getUniqueId(), defaultPopFile );

    				}

    				else

    				{

    					tracer.println( "Created default populator with name = " + defaultPopName + 

    												  " OK but populator file is null" );

    					defaultPopulator.load();

    					lastLoadException = defaultPopulator.getLastLoadException();

    				}

    			}

    			else

    			{

    				tracer.println( "Created default populator with name = " + defaultPopName + 

    											  " OK but populator file is null" );

    				defaultPopulator.load();

    				lastLoadException = defaultPopulator.getLastLoadException();

    			}

    		}

    		else

    		{

    			defaultPopulator.load();

    			lastLoadException = defaultPopulator.getLastLoadException();

    		}

    		if( defaultPopulator != null )

    			setDefaultPopulator( defaultPopulator );

    		}

    		else

    			tracer.println( "Did not add default populator by <name, className>: " +

    										  "<" + defaultPopName + ", " + defaultPopClass + ">" );

    		while( popClasses.hasNext() )

    		{

    			String popName = (String)popClasses.next();

    			String popName = popClasses.next();

    			String popClass = populatorClassMultiProp.getPropertyString( popName );

    			int popClassNumber = populatorClassMultiProp.propertyNumber( popName );

    @@ -314,7 +310,7 @@ public void load()
  
    			{

    				if( populatorFileMultiProp != null && populatorFileMultiProp.getNumberOfProperties() > 0 )

    				{

    					String popFile = (String)populatorFileMultiProp.getPropertyString( popClassNumber );

    					String popFile = populatorFileMultiProp.getPropertyString( popClassNumber );

    					populator.load( popFile );

    					popFileMap.put( populator.getUniqueId(), popFile );

    				}

    @@ -349,21 +345,24 @@ public void load()
  
    	 * number of entries in populator.  Could do better by keeping more data structure

    	 * but not worth it if n and m are small (as expected in typical system)

    	 */

        public Enumeration getEntries()

        @SuppressWarnings("rawtypes")

    	public Enumeration getEntries()

    	{

    		Vector entryVector = new Vector();

    		Iterator populators = getPopulators();

    		List<JposEntry> entryList = new ArrayList<>();

    		@SuppressWarnings("unchecked")

    		Iterator<JposRegPopulator> populators = getPopulators();

    		while( populators.hasNext() )

    		{

    			JposRegPopulator pop = (JposRegPopulator)populators.next();

    			JposRegPopulator pop = populators.next();

    			Enumeration entries = pop.getEntries();

    			@SuppressWarnings("unchecked")

    			Enumeration<JposEntry> entries = pop.getEntries();

    			while( entries.hasMoreElements() )

    				entryVector.add( entries.nextElement() );

    				entryList.add( entries.nextElement() );

    		}

    		return entryVector.elements();

    		return Collections.enumeration(entryList);

    	}

    	/**

    @@ -411,6 +410,7 @@ public Enumeration getEntries()
  
    	public void remove( JposRegPopulator populator ) { popMap.remove( populator.getUniqueId() ); }

    	/** @return an iterator over all populators in this composite */

    	@SuppressWarnings("rawtypes")

    	public Iterator getPopulators() { return popMap.values().iterator(); }

    	/** 

    @@ -419,7 +419,7 @@ public Enumeration getEntries()
  
    	 * @see jpos.config.JposRegPopulator#getUniqueId()

    	 */

    	public JposRegPopulator getPopulator( String uniqueId ) 

    	{ return (JposRegPopulator)popMap.get( uniqueId ); }

    	{ return popMap.get( uniqueId ); }

    	/** @return the number of populator in this composite */

    	public int size() { return popMap.size(); }

    @@ -428,8 +428,8 @@ public JposRegPopulator getPopulator( String uniqueId )
  
        // Instance variables

        //

    	private HashMap popMap = new HashMap();

    	private HashMap popFileMap = new HashMap();

    	private HashMap<String, JposRegPopulator> popMap = new HashMap<>();

    	private HashMap<String, String> popFileMap = new HashMap<>();

    	private JposRegPopulator defaultPop = null;

    	private Exception lastLoadException = null;

src/main/java/jpos/config/JposConfigException.java

-Original file line number
+Diff line change
@@ Expand Up / @@ -28,6 +28,8 @@ @@
      */
     public class JposConfigException extends JposException
     {
+    	private static final long serialVersionUID = 6080819630774250157L;
     	//-------------------------------------------------------------------------
     	// Ctor(s)
     	//
@@ Expand Down @@

src/main/java/jpos/config/JposEntry.java

-Original file line number
+Diff line change
@@ Expand Up / @@ -32,6 +32,7 @@ @@
      * @since 0.1 (Philly 99 meeting)
      * @author E. Michael Maximilien (maxim@us.ibm.com)
      */
+    @SuppressWarnings("rawtypes")
     public interface JposEntry extends Serializable, Comparable
     {
         /**
@@ Expand Down Expand Up / @@ -90,6 +91,7 @@ public interface JposEntry extends Serializable, Comparable @@
          * NOTE: any property with the same name gets overlaid
          * @param propName the name of this property (should be unique per property)
          * @param propValue the properties value Object
+         * @return the property value object as passed as 2nd argument
          * @since 0.1 (Philly 99 meeting)
     	 * @throws java.lang.IllegalArgumentException if the propName or propValue is null
          */
@@ Expand All @@
         /**
          * Looks for a property with name specified and removes it
          * @param propName the name String of the property to remove
+         * @return the property object that has been removed
          * @since 0.1 (Philly 99 meeting)
          */
         public Object removeProperty( String propName );
         /**
+         * A {@link JposEntry} specific equal method. <br>
+         * This considered a design flow today as {@link Object} defines an {@link Object#equals(Object)} which never should be
+         * redefined. However, this interface is from the early days when Java was only 4 years old and that was unknown.
+         * For backward compatibility reasons ths will remain.
+         * @param otherEntry the other {@link JposEntry} object the comparison has to be done against
          * @return true if the two JposEntries have the same properties
          * @since 0.1 (Philly 99 meeting)
          */
@@ Expand Down @@

src/main/java/jpos/config/JposEntryConst.java

-Original file line number
+Diff line change
@@ Expand Up @@
     	//
     	/** The default JposEntry property type */
-    	public static final Class DEFAULT_PROP_TYPE = String.class;
+    	public static final Class<String> DEFAULT_PROP_TYPE = String.class;
     	/** Array of all the property types allowed for a JposEntry property */
-    	public static final Class[] PROP_TYPES =
+    	public static final Class<?>[] PROP_TYPES =
     								  {
     								  	String.class,
     								  	Boolean.class,
@@ Expand Down @@

src/main/java/jpos/config/JposEntryRegistry.java

-Original file line number
+Diff line change
@@ Expand Up / @@ -42,7 +42,8 @@ public interface JposEntryRegistry @@
          * @return an enumeration of JposEntry objects
          * @since 0.1 (Philly 99 meeting)
          */
-        public Enumeration getEntries();
+        @SuppressWarnings("rawtypes")
+    	public Enumeration getEntries();
         /**
          * @return the JposEntry for the logicalName specified
@@ Expand Down Expand Up / @@ -115,6 +116,7 @@ public interface JposEntryRegistry @@
          * Tell the JposEntryRegistry to save the current entries to the file
          * specified.  Depending on the current JposEntryPopulator the file might
          * be an XML or serialized or other file.
+         * @param file the {@link File} object the registry entries has to to be persisted to
          * @since 2.1.0
          * @throws java.lang.Exception if any error occurs while saving or if the
          * current populator does not support saving in a file
@@ Expand Down @@

src/main/java/jpos/config/JposEntryRegistryEvent.java

-Original file line number
+Diff line change
@@ Expand Up / @@ -27,7 +27,9 @@ @@
      */
     public class JposEntryRegistryEvent extends EventObject
     {
-        /**
+    	private static final long serialVersionUID = 8674029321997818382L;
+    	/**
          * Creates a new event
          * @param source the source of this event
          * @param entry the JposEntry associated with the event
@@ Expand Down @@

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

New major version without Xerces #8

Uh oh!

Diff view

Diff view

There are no files selected for viewing

Uh oh!