Add Automatic-Module-Name manifest entry to Java jar files

[dkkopp]

What language and solver does this apply to?
Java

Describe the problem you are trying to solve.
The current Linux jar file cannot be used with the Java module system because it’s file name cannot be converted into an automatic module name. Adding this additional manifest entry will fix this.

Describe the solution you'd like
Add
Automatic-Module-Name: com.google.ortools
to the ortools-java-xxx.jar file

Add
Automatic-Module-Name: com.google.ortools.linux
to the ortools-linux-xxx-xxxx.jar file.

Similar automatic module names should be added to the other os specific jar files (i.e .windows, .mac)

[Mizux]

Do you have sample and maven documentation related to this field ? since the jar is generated by our pom.xml ....

[dkkopp]

You can add it via the maven jar plugin:

      <plugin>
        <groupId>org.apache.maven.plugins</groupId>
        <artifactId>maven-jar-plugin</artifactId>
        <version>3.2.0</version>
        <configuration>
          <archive>
            <manifestEntries>
              <Automatic-Module-Name>com.google.ortools</Automatic-Module-Name>
            </manifestEntries>
          </archive>
        </configuration>
      </plugin>

[Mizux]

http://branchandbound.net/blog/java/2017/12/automatic-module-name/

[Mizux]

Will postpone it after release since I need to change our pom.xml runtime template to add a new variable then adapt cmake and makefile to change it.

DevNote add

1. to all pom.xml in https://github.com/google/or-tools/tree/stable/ortools/java add

 <plugin>
        <groupId>org.apache.maven.plugins</groupId>
        <artifactId>maven-jar-plugin</artifactId>
        <version>3.2.0</version>
        <configuration>
          <archive>
            <manifestEntries>
              <Automatic-Module-Name>@JAVA_PACKAGE@</Automatic-Module-Name>
            </manifestEntries>
          </archive>
        </configuration>
      </plugin>

2. For pom-native.xml.in need to use:

              <Automatic-Module-Name>@JAVA_PACKAGE@.@JAVA_PLATFORM_OS@</Automatic-Module-Name>

rework:

or-tools/cmake/java.cmake

Lines 44 to 52 in 86d4c54

	if(APPLE)
	set(NATIVE_IDENTIFIER darwin-x86-64)
	elseif(UNIX)
	set(NATIVE_IDENTIFIER linux-x86-64)
	elseif(WIN32)
	set(NATIVE_IDENTIFIER win32-x86-64)
	else()
	message(FATAL_ERROR "Unsupported system !")
	endif()

to introduce
JAVA_PLATFORM_OS and JAVA_PLATFORM_ARCH
so NATIVE_IDENTIFIER become

set(NATIVE_IDENTIFIER "${JAVA_PLATFORM_OS}-${JAVA_PLATFORM_ARCH}")

todo(mizux): Add JAVA_ prefix to NATIVE_IDENTIFIER
todo(mizux): Rename NATIVE_IDENTIFIER to PLATFORM_IDENTIFIER ?

3. also fix Makefile.java
   

   or-tools/makefiles/Makefile.java.mk

   Lines 67 to 80 in 86d4c54

   	# Detect RuntimeIDentifier
   	ifeq ($(OS),Windows)
   	JAVA_NATIVE_IDENTIFIER=win32-x86-64
   	else
   	ifeq ($(OS),Linux)
   	JAVA_NATIVE_IDENTIFIER=linux-x86-64
   	else
   	ifeq ($(OS),Darwin)
   	JAVA_NATIVE_IDENTIFIER=darwin-x86-64
   	else
   	$(error OS unknown !)
   	endif
   	endif
   	endif

   
   and
   

   or-tools/makefiles/Makefile.java.mk

   Lines 424 to 435 in 8d692f3

   	$(TEMP_JAVA_DIR)/$(JAVA_ORTOOLS_NATIVE_PROJECT)/pom.xml: \
   	${SRC_DIR}/ortools/java/pom-native.xml.in \
   	| $(TEMP_JAVA_DIR)/$(JAVA_ORTOOLS_NATIVE_PROJECT)
   	$(SED) -e "s/@PROJECT_VERSION@/$(OR_TOOLS_VERSION)/" \
   	ortools$Sjava$Spom-native.xml.in \
   	> $(TEMP_JAVA_DIR)$S$(JAVA_ORTOOLS_NATIVE_PROJECT)$Spom.xml
   	$(SED) -i -e 's/@JAVA_PACKAGE@/$(JAVA_ORTOOLS_PACKAGE)/' \
   	$(TEMP_JAVA_DIR)$S$(JAVA_ORTOOLS_NATIVE_PROJECT)$Spom.xml
   	$(SED) -i -e 's/@JAVA_NATIVE_PROJECT@/$(JAVA_ORTOOLS_NATIVE_PROJECT)/' \
   	$(TEMP_JAVA_DIR)$S$(JAVA_ORTOOLS_NATIVE_PROJECT)$Spom.xml
   	$(SED) -i -e 's;@GPG_ARGS@;$(GPG_ARGS);' \
   	$(TEMP_JAVA_DIR)$S$(JAVA_ORTOOLS_NATIVE_PROJECT)$Spom.xml

   
   need to add

	$(SED) -i -e 's;@JAVA_PLATFORM_OS@;$(JAVA_PLATFORM_OS);' \
 $(TEMP_JAVA_DIR)$S$(JAVA_ORTOOLS_NATIVE_PROJECT)$Spom.xml

see:

or-tools/ortools/java/com/google/ortools/Loader.java

Line 34 in 8d692f3

private static final String RESOURCE_PATH = "ortools-" + Platform.RESOURCE_PREFIX + "/";

ref: http://java-native-access.github.io/jna/5.10.0/javadoc/com/sun/jna/Platform.html#RESOURCE_PREFIX