Use default value for .publish

[pzygielo]

The only other explicit publish I've found is (setting to the non-default):

glassfish/appserver/connectors/work-management/src/main/java/com/sun/enterprise/connectors/work/OneWork.java

Lines 33 to 37 in a51f9c4

	@LogMessageInfo(
	message = "The Work named [ {0} ], progress [ {1} ].",
	comment = "Print Work status",
	level = "INFO",
	publish = false)

OTOH - this publish flag does not seem to be used by GF at all.

Maybe it could be used or - dropped from @LogMessageInfo? 🤔

[dmatej]

My question is what exactly the publish argument does?
Relates to eclipse-ee4j/glassfish-logging-annotation-processor#107

[pzygielo]

My question is what exactly the publish argument does?

• Good question that I also ask myself. But as this property was not placed in properties - it was also not used so far on GF side (At least I failed to locate such usage).
  Per https://github.com/eclipse-ee4j/glassfish-logging-annotation-processor/blob/d2c1831ea651b9bbf6c2813dec30748e4b4e1cb2/src/main/java/org/glassfish/logging/annotation/LogMessageInfo.java#L33 it is described as:

publish: Boolean value indicates whether this log message should be
         published in the Error Reference guide. (default: true)

(a bit similar to https://github.com/eclipse-ee4j/glassfish-logging-annotation-processor/blob/d2c1831ea651b9bbf6c2813dec30748e4b4e1cb2/src/main/java/org/glassfish/logging/annotation/LoggerInfo.java#L29).

• My initial thought was: "Maybe it is or could be used by glassfish-doc-maven-plugin". I could not confirm this to be the case. I also do not think java sources (out of /docs) or binaries are used for documentation preparation, but I'm not 100% sure about that.
• Also coming from Store LogMessageInfo.publish flag glassfish-logging-annotation-processor#107
  • that whole _details properties with action, cause and level (and possibly publish) - what are they used for? Were they used in GF ever before (i.e. before migration to JUL)? Perhaps we could drop (first from glassfish-logging-annotation-processor) ALL attributes that land in _details and not produce _details? I'm slowly exploring this.
  • I'm also learning how files generated into META-INF
    • loggerinfo/LoggerInfoMetadata.properties
    • logmessages/LogMessagesMetadata.properties
      are (or are not) being used.
      (And this feels like I've already done that few summers ago (the commit in Store LogMessageInfo.publish flag glassfish-logging-annotation-processor#107 was waiting since 2022, but I remember nothing now...)

But - by using default for publish - it will leave only one place to modify if publish is removed from @. 😁

OR GF could use _details in logging. (Or I could find that is does.)

[dmatej]

Aha, I believe around 2003 there was a trend to create multilanguage applications including logging (JUL was added in Java 1.4.2 if I remember well), so at some point they tried to integrate everything to the Ant build, later to Maven, but never finished.
I think some man pages are generated somehow (different story), I am also quite sure somewhere was a list of those "id based" log messages.

At some point there was a ML distribution of GlassFish, surprisingly some versions differed in behavior between ML and SL, so I remember far far in the past we were switching between them with SJAS9.

However now we slowly remove these things, logs are in plain english, UI too, so this doesn't make much sense. Perhaps with AI, however AI can read logs without a need of IDs and translations, so ... no.

[pzygielo]

Error Message Reference lists some IDs but they seem to come from checked-in docs/error-messages-reference/src/main/asciidoc/error-messages.adoc. (And they have cause and action.) That's why I suspected glassfish-doc-maven-plugin to play a part.

I'm yet to learn the level of consistency there. 😄