Bugno34600318

[vavishal]

The faultstring in the SOAPFault contains the exception message if any which is the default current behavior

The customer has a requirement where they do not want any exception messages to be displayed in the faultstring for security concerns of exposing class

Therefore, we are adding a new system property -Dcom.sun.xml.ws.fault.doNotPrintExpMsg=true
to implement the behavior requested by the customer

Added testcase at
./jaxws-ri/runtime/rt/src/test/java/com/sun/xml/ws/fault/SOAPFaultBuilderTest.java

[lukasj]

the property needs to follow the pattern used on other places, so it should be sth like fqClassName.propertyName - I'd suggest ie com.sun.xml.ws.fault.SOAPFaultBuilder.captureExceptionMessage

the initialization of the property value should follow the pattern used by the captureStackTrace property (the field should probably be private)

the newly added property also has to be documented:

• add a note to the jaxws-ri/docs/release-documentation/src/main/docbook/changelog.xml
• check jaxws-ri/docs/release-documentation/src/main/docbook/jax-ws-ri-extensions.xml to see if it makes sense to document the property there as well

[vavishal]

I have tried to create the private variable as follows in SOAPFaultBuilder.java

private static final boolean captureExceptionMessage = getBooleanSystemProperty();

private static boolean getBooleanSystemProperty() {
final String propertyString = System.getProperty("com.sun.xml.ws.fault.SOAPFaultBuilder.captureExceptionMessage");
if (propertyString == null) {
//default value
return true;
} else {
return Boolean.getBoolean(propertyString);
}
}

But the above change is causing the testcase at SOAPFaultBuilderTest.java to fail always since while executing the ExceptionBeanTest.java it calls the SOAPFaultBuilder which initialized the property captureExceptionMessage with default value and also its value is not getting changed in SOAPFaultBuilderTest.java as captureExceptionMessage is a static variable

[lukasj]

would non-final field with package private/public access or having public getter/setter for the field to toggle the value help the test?

[vavishal]

The following piece of code and then calling SOAPFaultBuilder.setCaptureExceptionMessage(); from the testcase helped

private static boolean captureExceptionMessage = getBooleanSystemProperty();

private static boolean getBooleanSystemProperty() {
final String propertyString = System.getProperty("com.sun.xml.ws.fault.SOAPFaultBuilder.captureExceptionMessage");
if (propertyString == null) {
default value
return true;
} else {
return Boolean.getBoolean(propertyString);
}
}
public static boolean getCaptureExceptionMessage() {
return captureExceptionMessage;
}
public static void setCaptureExceptionMessage() {
captureExceptionMessage = getBooleanSystemProperty();
}

[vavishal]

Gentle reminder to review this change

[lukasj]

setter needs an argument, so one can call it and change the value from a test (for example); take a look at the dump and similar fields in HttpAdapter, the way they are being initialized and set and follow that pattern. Also note that if the method is to return boolean value, then its name should not start with get but rather with is, should or something implying yes/no answer

[lukasj]

LGTM, thanks!