[java-opensaml] branch main updated: OSJ-354: Suffix the PROTOCOL_MESSAGE category with .SAML
Brent Putman
putmanb at georgetown.edu
Fri Aug 4 00:39:48 UTC 2023
This is an automated email from the git hooks/post-receive script.
putmanb pushed a commit to branch main
in repository java-opensaml.
View the commit online:
http://git.shibboleth.net/view/?p=java-opensaml.git;a=commit;h=c0522eb6a06a301f718155ad0dffcaa8d167b219
The following commit(s) were added to refs/heads/main by this push:
new c0522eb6a OSJ-354: Suffix the PROTOCOL_MESSAGE category with .SAML
c0522eb6a is described below
commit c0522eb6a06a301f718155ad0dffcaa8d167b219
Author: Brent Putman <putmanb at georgetown.edu>
AuthorDate: Thu Aug 3 20:28:21 2023 -0400
OSJ-354: Suffix the PROTOCOL_MESSAGE category with .SAML
Change API so that subclasses supply the logging sub-category,
rather than the full category.
---
.../messaging/decoder/AbstractMessageDecoder.java | 36 ++++++++++-----------
.../messaging/encoder/AbstractMessageEncoder.java | 37 ++++++++++------------
.../impl/BaseSAMLHttpServletRequestDecoder.java | 2 +-
.../impl/BaseSAMLHttpServletResponseEncoder.java | 2 +-
.../binding/decoding/impl/HTTPSOAP11Decoder.java | 2 +-
.../impl/HttpClientResponseSOAP11Decoder.java | 2 +-
.../binding/encoding/impl/HTTPSOAP11Encoder.java | 2 +-
.../impl/HttpClientRequestSOAP11Encoder.java | 2 +-
.../binding/decoding/impl/HTTPSOAP11Decoder.java | 2 +-
.../impl/HttpClientResponseSOAP11Decoder.java | 2 +-
.../binding/encoding/impl/HTTPSOAP11Encoder.java | 2 +-
.../impl/HttpClientRequestSOAP11Encoder.java | 2 +-
.../http/impl/HttpClientResponseSOAP11Decoder.java | 2 +-
.../http/impl/HttpClientRequestSOAP11Encoder.java | 2 +-
.../decoder/http/impl/HTTPSOAP11Decoder.java | 2 +-
.../encoder/http/impl/HTTPSOAP11Encoder.java | 2 +-
16 files changed, 46 insertions(+), 55 deletions(-)
diff --git a/opensaml-messaging-api/src/main/java/org/opensaml/messaging/decoder/AbstractMessageDecoder.java b/opensaml-messaging-api/src/main/java/org/opensaml/messaging/decoder/AbstractMessageDecoder.java
index 5c406e73e..ee3d7f844 100644
--- a/opensaml-messaging-api/src/main/java/org/opensaml/messaging/decoder/AbstractMessageDecoder.java
+++ b/opensaml-messaging-api/src/main/java/org/opensaml/messaging/decoder/AbstractMessageDecoder.java
@@ -42,8 +42,8 @@ public abstract class AbstractMessageDecoder extends AbstractInitializableCompon
/** Message context. */
@Nullable private MessageContext messageContext;
- /** The configured logging category for protocol messages. */
- @Nonnull private String protocolMessageLoggerCategory = BASE_PROTOCOL_MESSAGE_LOGGER_CATEGORY;
+ /** The configured logging sub-category for protocol messages. */
+ @Nonnull private String protocolMessageLoggerSubCategory;
/** {@inheritDoc} */
@Nullable public MessageContext getMessageContext() {
@@ -76,31 +76,27 @@ public abstract class AbstractMessageDecoder extends AbstractInitializableCompon
}
/**
- * Get the configured logging category for protocol messages.
+ * Get the configured logging sub-category for protocol messages.
*
- * @return the logging category
+ * @return the logging sub-category
*/
- @Nonnull protected String getProtocolMessageLoggerCategory() {
- return protocolMessageLoggerCategory;
+ @Nonnull protected String getProtocolMessageLoggerSubCategory() {
+ return protocolMessageLoggerSubCategory;
}
/**
- * Set the configured logging category for protocol messages.
+ * Set the configured logging sub-category for protocol messages.
*
- * <p>
- * If null, {@link AbstractMessageDecoder#BASE_PROTOCOL_MESSAGE_LOGGER_CATEGORY} will be used.
- * </p>
- *
- * @param category the logging category
+ * @param category the logging sub-category
*/
- protected void setProtocolMessageLoggerCategory(@Nullable final String category) {
- final String trimmed = StringSupport.trimOrNull(category);
- if (trimmed != null) {
- protocolMessageLoggerCategory = trimmed;
- } else {
- protocolMessageLoggerCategory = BASE_PROTOCOL_MESSAGE_LOGGER_CATEGORY;
- }
- protocolMessageLog = LoggerFactory.getLogger(protocolMessageLoggerCategory);
+ protected void setProtocolMessageLoggerSubCategory(@Nullable final String category) {
+ protocolMessageLoggerSubCategory = StringSupport.trimOrNull(category);
+ if (protocolMessageLoggerSubCategory != null) {
+ protocolMessageLog = LoggerFactory.getLogger(BASE_PROTOCOL_MESSAGE_LOGGER_CATEGORY + "."
+ + protocolMessageLoggerSubCategory);
+ } else {
+ protocolMessageLog = LoggerFactory.getLogger(BASE_PROTOCOL_MESSAGE_LOGGER_CATEGORY);
+ }
}
/**
diff --git a/opensaml-messaging-api/src/main/java/org/opensaml/messaging/encoder/AbstractMessageEncoder.java b/opensaml-messaging-api/src/main/java/org/opensaml/messaging/encoder/AbstractMessageEncoder.java
index ada6cebd6..88456225a 100644
--- a/opensaml-messaging-api/src/main/java/org/opensaml/messaging/encoder/AbstractMessageEncoder.java
+++ b/opensaml-messaging-api/src/main/java/org/opensaml/messaging/encoder/AbstractMessageEncoder.java
@@ -18,7 +18,6 @@ import javax.annotation.Nonnull;
import javax.annotation.Nullable;
import org.opensaml.messaging.context.MessageContext;
-import org.opensaml.messaging.decoder.AbstractMessageDecoder;
import org.slf4j.Logger;
import net.shibboleth.shared.annotation.constraint.NonnullAfterInit;
@@ -45,8 +44,8 @@ public abstract class AbstractMessageEncoder extends AbstractInitializableCompon
/** The message context. */
@NonnullAfterInit private MessageContext messageContext;
- /** The configured logging category for protocol messages. */
- @Nonnull private String protocolMessageLoggerCategory = BASE_PROTOCOL_MESSAGE_LOGGER_CATEGORY;
+ /** The configured logging sub-category for protocol messages. */
+ @Nonnull private String protocolMessageLoggerSubCategory;
/** {@inheritDoc} */
public synchronized void setMessageContext(@Nullable final MessageContext context) {
@@ -98,31 +97,27 @@ public abstract class AbstractMessageEncoder extends AbstractInitializableCompon
}
/**
- * Get the configured logging category for protocol messages.
+ * Get the configured logging sub-category for protocol messages.
*
- * @return the logging category
+ * @return the logging sub-category
*/
- @Nonnull protected String getProtocolMessageLoggerCategory() {
- return protocolMessageLoggerCategory;
+ @Nonnull protected String getProtocolMessageLoggerSubCategory() {
+ return protocolMessageLoggerSubCategory;
}
/**
- * Set the configured logging category for protocol messages.
+ * Set the configured logging sub-category for protocol messages.
*
- * <p>
- * If null, {@link AbstractMessageDecoder#BASE_PROTOCOL_MESSAGE_LOGGER_CATEGORY} will be used.
- * </p>
- *
- * @param category the logging category
+ * @param category the logging sub-category
*/
- protected void setProtocolMessageLoggerCategory(@Nullable final String category) {
- final String trimmed = StringSupport.trimOrNull(category);
- if (trimmed != null) {
- protocolMessageLoggerCategory = trimmed;
- } else {
- protocolMessageLoggerCategory = BASE_PROTOCOL_MESSAGE_LOGGER_CATEGORY;
- }
- protocolMessageLog = LoggerFactory.getLogger(protocolMessageLoggerCategory);
+ protected void setProtocolMessageLoggerSubCategory(@Nullable final String category) {
+ protocolMessageLoggerSubCategory = StringSupport.trimOrNull(category);
+ if (protocolMessageLoggerSubCategory != null) {
+ protocolMessageLog = LoggerFactory.getLogger(BASE_PROTOCOL_MESSAGE_LOGGER_CATEGORY + "."
+ + protocolMessageLoggerSubCategory);
+ } else {
+ protocolMessageLog = LoggerFactory.getLogger(BASE_PROTOCOL_MESSAGE_LOGGER_CATEGORY);
+ }
}
/**
diff --git a/opensaml-saml-impl/src/main/java/org/opensaml/saml/common/binding/impl/BaseSAMLHttpServletRequestDecoder.java b/opensaml-saml-impl/src/main/java/org/opensaml/saml/common/binding/impl/BaseSAMLHttpServletRequestDecoder.java
index 224fce999..57fd3d8bf 100644
--- a/opensaml-saml-impl/src/main/java/org/opensaml/saml/common/binding/impl/BaseSAMLHttpServletRequestDecoder.java
+++ b/opensaml-saml-impl/src/main/java/org/opensaml/saml/common/binding/impl/BaseSAMLHttpServletRequestDecoder.java
@@ -24,7 +24,7 @@ public abstract class BaseSAMLHttpServletRequestDecoder extends BaseHttpServletR
/** Constructor. */
public BaseSAMLHttpServletRequestDecoder() {
super();
- setProtocolMessageLoggerCategory(BASE_PROTOCOL_MESSAGE_LOGGER_CATEGORY + ".SAML");
+ setProtocolMessageLoggerSubCategory("SAML");
}
}
diff --git a/opensaml-saml-impl/src/main/java/org/opensaml/saml/common/binding/impl/BaseSAMLHttpServletResponseEncoder.java b/opensaml-saml-impl/src/main/java/org/opensaml/saml/common/binding/impl/BaseSAMLHttpServletResponseEncoder.java
index bf7c4e7a3..e0ac88af1 100644
--- a/opensaml-saml-impl/src/main/java/org/opensaml/saml/common/binding/impl/BaseSAMLHttpServletResponseEncoder.java
+++ b/opensaml-saml-impl/src/main/java/org/opensaml/saml/common/binding/impl/BaseSAMLHttpServletResponseEncoder.java
@@ -24,7 +24,7 @@ public abstract class BaseSAMLHttpServletResponseEncoder extends BaseHttpServlet
/** Constructor. */
public BaseSAMLHttpServletResponseEncoder() {
super();
- setProtocolMessageLoggerCategory(BASE_PROTOCOL_MESSAGE_LOGGER_CATEGORY + ".SAML");
+ setProtocolMessageLoggerSubCategory("SAML");
}
}
diff --git a/opensaml-saml-impl/src/main/java/org/opensaml/saml/saml1/binding/decoding/impl/HTTPSOAP11Decoder.java b/opensaml-saml-impl/src/main/java/org/opensaml/saml/saml1/binding/decoding/impl/HTTPSOAP11Decoder.java
index c4c709dfb..f41fc7f58 100644
--- a/opensaml-saml-impl/src/main/java/org/opensaml/saml/saml1/binding/decoding/impl/HTTPSOAP11Decoder.java
+++ b/opensaml-saml-impl/src/main/java/org/opensaml/saml/saml1/binding/decoding/impl/HTTPSOAP11Decoder.java
@@ -50,7 +50,7 @@ public class HTTPSOAP11Decoder extends org.opensaml.soap.soap11.decoder.http.imp
*/
public HTTPSOAP11Decoder() {
super();
- setProtocolMessageLoggerCategory(BASE_PROTOCOL_MESSAGE_LOGGER_CATEGORY + ".SAML");
+ setProtocolMessageLoggerSubCategory("SAML");
}
/** {@inheritDoc} */
diff --git a/opensaml-saml-impl/src/main/java/org/opensaml/saml/saml1/binding/decoding/impl/HttpClientResponseSOAP11Decoder.java b/opensaml-saml-impl/src/main/java/org/opensaml/saml/saml1/binding/decoding/impl/HttpClientResponseSOAP11Decoder.java
index 7f0d8fb93..d62c87f42 100644
--- a/opensaml-saml-impl/src/main/java/org/opensaml/saml/saml1/binding/decoding/impl/HttpClientResponseSOAP11Decoder.java
+++ b/opensaml-saml-impl/src/main/java/org/opensaml/saml/saml1/binding/decoding/impl/HttpClientResponseSOAP11Decoder.java
@@ -48,7 +48,7 @@ public class HttpClientResponseSOAP11Decoder
*/
public HttpClientResponseSOAP11Decoder() {
setBodyHandler(new SAMLSOAPDecoderBodyHandler());
- setProtocolMessageLoggerCategory(BASE_PROTOCOL_MESSAGE_LOGGER_CATEGORY + ".SAML");
+ setProtocolMessageLoggerSubCategory("SAML");
}
/** {@inheritDoc} */
diff --git a/opensaml-saml-impl/src/main/java/org/opensaml/saml/saml1/binding/encoding/impl/HTTPSOAP11Encoder.java b/opensaml-saml-impl/src/main/java/org/opensaml/saml/saml1/binding/encoding/impl/HTTPSOAP11Encoder.java
index 83755c97d..3b0e21350 100644
--- a/opensaml-saml-impl/src/main/java/org/opensaml/saml/saml1/binding/encoding/impl/HTTPSOAP11Encoder.java
+++ b/opensaml-saml-impl/src/main/java/org/opensaml/saml/saml1/binding/encoding/impl/HTTPSOAP11Encoder.java
@@ -31,7 +31,7 @@ public class HTTPSOAP11Encoder extends org.opensaml.soap.soap11.encoder.http.imp
/** Constructor. */
public HTTPSOAP11Encoder() {
super();
- setProtocolMessageLoggerCategory(BASE_PROTOCOL_MESSAGE_LOGGER_CATEGORY + ".SAML");
+ setProtocolMessageLoggerSubCategory("SAML");
}
/** {@inheritDoc} */
diff --git a/opensaml-saml-impl/src/main/java/org/opensaml/saml/saml1/binding/encoding/impl/HttpClientRequestSOAP11Encoder.java b/opensaml-saml-impl/src/main/java/org/opensaml/saml/saml1/binding/encoding/impl/HttpClientRequestSOAP11Encoder.java
index e4cd88006..497098509 100644
--- a/opensaml-saml-impl/src/main/java/org/opensaml/saml/saml1/binding/encoding/impl/HttpClientRequestSOAP11Encoder.java
+++ b/opensaml-saml-impl/src/main/java/org/opensaml/saml/saml1/binding/encoding/impl/HttpClientRequestSOAP11Encoder.java
@@ -30,7 +30,7 @@ public class HttpClientRequestSOAP11Encoder
/** Constructor. */
public HttpClientRequestSOAP11Encoder() {
super();
- setProtocolMessageLoggerCategory(BASE_PROTOCOL_MESSAGE_LOGGER_CATEGORY + ".SAML");
+ setProtocolMessageLoggerSubCategory("SAML");
}
/** {@inheritDoc} */
diff --git a/opensaml-saml-impl/src/main/java/org/opensaml/saml/saml2/binding/decoding/impl/HTTPSOAP11Decoder.java b/opensaml-saml-impl/src/main/java/org/opensaml/saml/saml2/binding/decoding/impl/HTTPSOAP11Decoder.java
index 1bee20cd5..adbab966a 100644
--- a/opensaml-saml-impl/src/main/java/org/opensaml/saml/saml2/binding/decoding/impl/HTTPSOAP11Decoder.java
+++ b/opensaml-saml-impl/src/main/java/org/opensaml/saml/saml2/binding/decoding/impl/HTTPSOAP11Decoder.java
@@ -47,7 +47,7 @@ public class HTTPSOAP11Decoder extends org.opensaml.soap.soap11.decoder.http.imp
/** Constructor. */
public HTTPSOAP11Decoder() {
super();
- setProtocolMessageLoggerCategory(BASE_PROTOCOL_MESSAGE_LOGGER_CATEGORY + ".SAML");
+ setProtocolMessageLoggerSubCategory("SAML");
}
/** {@inheritDoc} */
diff --git a/opensaml-saml-impl/src/main/java/org/opensaml/saml/saml2/binding/decoding/impl/HttpClientResponseSOAP11Decoder.java b/opensaml-saml-impl/src/main/java/org/opensaml/saml/saml2/binding/decoding/impl/HttpClientResponseSOAP11Decoder.java
index 7931d33fa..097cb00e9 100644
--- a/opensaml-saml-impl/src/main/java/org/opensaml/saml/saml2/binding/decoding/impl/HttpClientResponseSOAP11Decoder.java
+++ b/opensaml-saml-impl/src/main/java/org/opensaml/saml/saml2/binding/decoding/impl/HttpClientResponseSOAP11Decoder.java
@@ -48,7 +48,7 @@ public class HttpClientResponseSOAP11Decoder
*/
public HttpClientResponseSOAP11Decoder() {
setBodyHandler(new SAMLSOAPDecoderBodyHandler());
- setProtocolMessageLoggerCategory(BASE_PROTOCOL_MESSAGE_LOGGER_CATEGORY + ".SAML");
+ setProtocolMessageLoggerSubCategory("SAML");
}
/** {@inheritDoc} */
diff --git a/opensaml-saml-impl/src/main/java/org/opensaml/saml/saml2/binding/encoding/impl/HTTPSOAP11Encoder.java b/opensaml-saml-impl/src/main/java/org/opensaml/saml/saml2/binding/encoding/impl/HTTPSOAP11Encoder.java
index 5e83a5fd2..e32c37ceb 100644
--- a/opensaml-saml-impl/src/main/java/org/opensaml/saml/saml2/binding/encoding/impl/HTTPSOAP11Encoder.java
+++ b/opensaml-saml-impl/src/main/java/org/opensaml/saml/saml2/binding/encoding/impl/HTTPSOAP11Encoder.java
@@ -31,7 +31,7 @@ public class HTTPSOAP11Encoder extends org.opensaml.soap.soap11.encoder.http.imp
/** Constructor. */
public HTTPSOAP11Encoder() {
super();
- setProtocolMessageLoggerCategory(BASE_PROTOCOL_MESSAGE_LOGGER_CATEGORY + ".SAML");
+ setProtocolMessageLoggerSubCategory("SAML");
}
/** {@inheritDoc} */
diff --git a/opensaml-saml-impl/src/main/java/org/opensaml/saml/saml2/binding/encoding/impl/HttpClientRequestSOAP11Encoder.java b/opensaml-saml-impl/src/main/java/org/opensaml/saml/saml2/binding/encoding/impl/HttpClientRequestSOAP11Encoder.java
index 7ba79efc7..28e3a8438 100644
--- a/opensaml-saml-impl/src/main/java/org/opensaml/saml/saml2/binding/encoding/impl/HttpClientRequestSOAP11Encoder.java
+++ b/opensaml-saml-impl/src/main/java/org/opensaml/saml/saml2/binding/encoding/impl/HttpClientRequestSOAP11Encoder.java
@@ -32,7 +32,7 @@ public class HttpClientRequestSOAP11Encoder
/** Constructor. */
public HttpClientRequestSOAP11Encoder() {
super();
- setProtocolMessageLoggerCategory(BASE_PROTOCOL_MESSAGE_LOGGER_CATEGORY + ".SAML");
+ setProtocolMessageLoggerSubCategory("SAML");
}
/** {@inheritDoc} */
diff --git a/opensaml-soap-impl/src/main/java/org/opensaml/soap/client/soap11/decoder/http/impl/HttpClientResponseSOAP11Decoder.java b/opensaml-soap-impl/src/main/java/org/opensaml/soap/client/soap11/decoder/http/impl/HttpClientResponseSOAP11Decoder.java
index 1b33e7afc..b605369a0 100644
--- a/opensaml-soap-impl/src/main/java/org/opensaml/soap/client/soap11/decoder/http/impl/HttpClientResponseSOAP11Decoder.java
+++ b/opensaml-soap-impl/src/main/java/org/opensaml/soap/client/soap11/decoder/http/impl/HttpClientResponseSOAP11Decoder.java
@@ -69,7 +69,7 @@ public class HttpClientResponseSOAP11Decoder extends BaseHttpClientResponseXMLMe
/** Constructor. */
public HttpClientResponseSOAP11Decoder() {
super();
- setProtocolMessageLoggerCategory(BASE_PROTOCOL_MESSAGE_LOGGER_CATEGORY + ".SOAP");
+ setProtocolMessageLoggerSubCategory("SOAP");
}
/**
diff --git a/opensaml-soap-impl/src/main/java/org/opensaml/soap/client/soap11/encoder/http/impl/HttpClientRequestSOAP11Encoder.java b/opensaml-soap-impl/src/main/java/org/opensaml/soap/client/soap11/encoder/http/impl/HttpClientRequestSOAP11Encoder.java
index 45d013065..07a8db75d 100644
--- a/opensaml-soap-impl/src/main/java/org/opensaml/soap/client/soap11/encoder/http/impl/HttpClientRequestSOAP11Encoder.java
+++ b/opensaml-soap-impl/src/main/java/org/opensaml/soap/client/soap11/encoder/http/impl/HttpClientRequestSOAP11Encoder.java
@@ -67,7 +67,7 @@ public class HttpClientRequestSOAP11Encoder extends BaseHttpClientRequestXMLMess
envBuilder = (SOAPObjectBuilder<Envelope>) builderFactory.<Envelope>ensureBuilder(
Envelope.DEFAULT_ELEMENT_NAME);
bodyBuilder = (SOAPObjectBuilder<Body>) builderFactory.<Body>ensureBuilder(Body.DEFAULT_ELEMENT_NAME);
- setProtocolMessageLoggerCategory(BASE_PROTOCOL_MESSAGE_LOGGER_CATEGORY + ".SOAP");
+ setProtocolMessageLoggerSubCategory("SOAP");
}
/** {@inheritDoc}
diff --git a/opensaml-soap-impl/src/main/java/org/opensaml/soap/soap11/decoder/http/impl/HTTPSOAP11Decoder.java b/opensaml-soap-impl/src/main/java/org/opensaml/soap/soap11/decoder/http/impl/HTTPSOAP11Decoder.java
index 485dcd1d4..ec336e48e 100644
--- a/opensaml-soap-impl/src/main/java/org/opensaml/soap/soap11/decoder/http/impl/HTTPSOAP11Decoder.java
+++ b/opensaml-soap-impl/src/main/java/org/opensaml/soap/soap11/decoder/http/impl/HTTPSOAP11Decoder.java
@@ -71,7 +71,7 @@ public class HTTPSOAP11Decoder extends BaseHttpServletRequestXMLMessageDecoder {
/** Constructor. */
public HTTPSOAP11Decoder() {
super();
- setProtocolMessageLoggerCategory(BASE_PROTOCOL_MESSAGE_LOGGER_CATEGORY + ".SOAP");
+ setProtocolMessageLoggerSubCategory("SOAP");
}
/**
diff --git a/opensaml-soap-impl/src/main/java/org/opensaml/soap/soap11/encoder/http/impl/HTTPSOAP11Encoder.java b/opensaml-soap-impl/src/main/java/org/opensaml/soap/soap11/encoder/http/impl/HTTPSOAP11Encoder.java
index 771376d22..8b7e8a8d4 100644
--- a/opensaml-soap-impl/src/main/java/org/opensaml/soap/soap11/encoder/http/impl/HTTPSOAP11Encoder.java
+++ b/opensaml-soap-impl/src/main/java/org/opensaml/soap/soap11/encoder/http/impl/HTTPSOAP11Encoder.java
@@ -64,7 +64,7 @@ public class HTTPSOAP11Encoder extends BaseHttpServletResponseXMLMessageEncoder
envBuilder = (SOAPObjectBuilder<Envelope>) builderFactory.<Envelope>ensureBuilder(
Envelope.DEFAULT_ELEMENT_NAME);
bodyBuilder = (SOAPObjectBuilder<Body>) builderFactory.<Body>ensureBuilder(Body.DEFAULT_ELEMENT_NAME);
- setProtocolMessageLoggerCategory(BASE_PROTOCOL_MESSAGE_LOGGER_CATEGORY + ".SOAP");
+ setProtocolMessageLoggerSubCategory("SOAP");
}
/** {@inheritDoc} */
--
To stop receiving notification emails like this one, please contact
the administrator of this repository.
More information about the commits
mailing list