Bug ID: JDK-6818312 com.sun.awt.SecurityWarning.getSize() always reports (0, 0) on X11

Type: Bug
Component: client-libs
Sub-Component: java.awt
Affected Version: 6u12

Priority: P3
Status: Resolved
Resolution: Fixed
OS: generic
CPU: generic

Submitted: 2009-03-17
Updated: 2011-01-19
Resolved: 2009-08-18

JDK 6	JDK 7
6u18 b01Fixed	7Fixed

The CR 6749517 introduced an API to control the position of the AWT security warning. The com.sun.awt.SecurityWarning.getSize() method is supposed to return the current size of the warning for a given window. It's been noticed that the variables that hold the size of the warning get only updated on MS Windows platform. The X11 implementation of the enhanced security warning does not update the values which results in returning zero size all the time.

SUGGESTED FIX --- old/src/share/classes/java/awt/Window.java 2009-03-19 18:31:29.000000000 +0300 +++ new/src/share/classes/java/awt/Window.java 2009-03-19 18:31:29.000000000 +0300 @@ -281,7 +281,8 @@ transient boolean isTrayIconWindow = false; /** - * These fields are initialized in the native peer code. + * These fields are initialized in the native peer code + * or via AWTAccessor's WindowAccessor. */ private transient volatile int securityWarningWidth = 0; private transient volatile int securityWarningHeight = 0; @@ -3438,6 +3439,12 @@ window.securityWarningHeight); } + public void setSecurityWarningSize(Window window, int width, int height) + { + window.securityWarningWidth = width; + window.securityWarningHeight = height; + } + public void setSecurityWarningPosition(Window window, Point2D point, float alignmentX, float alignmentY) { --- old/src/share/classes/sun/awt/AWTAccessor.java 2009-03-19 18:31:29.000000000 +0300 +++ new/src/share/classes/sun/awt/AWTAccessor.java 2009-03-19 18:31:29.000000000 +0300 @@ -64,6 +64,11 @@ */ Dimension getSecurityWarningSize(Window w); + /** + * Set the size of the security warning. + */ + void setSecurityWarningSize(Window w, int width, int height); + /** Set the position of the security warning. */ void setSecurityWarningPosition(Window w, Point2D point, --- old/src/solaris/classes/sun/awt/X11/XWarningWindow.java 2009-03-19 18:31:29.000000000 +0300 +++ new/src/solaris/classes/sun/awt/X11/XWarningWindow.java 2009-03-19 18:31:29.000000000 +0300 @@ -169,6 +169,8 @@ XToolkit.awtUnlock(); } sizeUpdated = false; + AWTAccessor.getWindowAccessor().setSecurityWarningSize( + ownerWindow, ico.getWidth(), ico.getHeight()); } } peer.repositionSecurityWarning(); --- /dev/null 2009-02-04 17:52:20.769947431 +0300 +++ new/test/com/sun/awt/SecurityWarning/GetSizeShouldNotReturnZero.java 2009-03-19 18:31:29.000000000 +0300 @@ -0,0 +1,369 @@ +/* + @test %W% %E% + @bug 6818312 + @summary The size returned by SecurityWarning.getSize() should not be zero + @author ###@###.###: area=awt.toplevel + @library ../../../../java/awt/regtesthelpers + @build Util + @run main GetSizeShouldNotReturnZero +*/ + +/** + * GetSizeShouldNotReturnZero.java + * + * summary: The size returned by SecurityWarning.getSize() should not be zero + */ + +import java.awt.*; +import java.awt.event.*; +import java.security.Permission; +import test.java.awt.regtesthelpers.Util; +import com.sun.awt.SecurityWarning; + +public class GetSizeShouldNotReturnZero +{ + private static void init() + { + String[] instructions = + { + "This is an AUTOMATIC test, simply wait until it is done.", + "The result (passed or failed) will be shown in the", + "message window below." + }; + Sysout.createDialog( ); + Sysout.printInstructions( instructions ); + + + // Install the security manager so that all subsequently created + // windows display the security warning. + System.setSecurityManager(new SecurityManager() { + + @Override + public void checkPermission(Permission perm) { + } + + @Override + public boolean checkTopLevelWindow(Object window) { + return false; + } + }); + + Frame f = new Frame(); + f.setSize(100, 100); + f.setVisible(true); + + Robot robot = Util.createRobot(); + Util.waitForIdle(robot); + + Dimension size = SecurityWarning.getSize(f); + if (size.width == 0 || size.height == 0) { + fail("Reported security warning size: " + size); + return; + } + pass(); + }//End init() + + + + /***************************************************** + * Standard Test Machinery Section + * DO NOT modify anything in this section -- it's a + * standard chunk of code which has all of the + * synchronisation necessary for the test harness. + * By keeping it the same in all tests, it is easier + * to read and understand someone else's test, as + * well as insuring that all tests behave correctly + * with the test harness. + * There is a section following this for test- + * classes + ******************************************************/ + private static boolean theTestPassed = false; + private static boolean testGeneratedInterrupt = false; + private static String failureMessage = ""; + + private static Thread mainThread = null; + + private static int sleepTime = 300000; + + // Not sure about what happens if multiple of this test are + // instantiated in the same VM. Being static (and using + // static vars), it aint gonna work. Not worrying about + // it for now. + public static void main( String args[] ) throws InterruptedException + { + mainThread = Thread.currentThread(); + try + { + init(); + } + catch( TestPassedException e ) + { + //The test passed, so just return from main and harness will + // interepret this return as a pass + return; + } + //At this point, neither test pass nor test fail has been + // called -- either would have thrown an exception and ended the + // test, so we know we have multiple threads. + + //Test involves other threads, so sleep and wait for them to + // called pass() or fail() + try + { + Thread.sleep( sleepTime ); + //Timed out, so fail the test + throw new RuntimeException( "Timed out after " + sleepTime/1000 + " seconds" ); + } + catch (InterruptedException e) + { + //The test harness may have interrupted the test. If so, rethrow the exception + // so that the harness gets it and deals with it. + if( ! testGeneratedInterrupt ) throw e; + + //reset flag in case hit this code more than once for some reason (just safety) + testGeneratedInterrupt = false; + + if ( theTestPassed == false ) + { + throw new RuntimeException( failureMessage ); + } + } + + }//main + + public static synchronized void setTimeoutTo( int seconds ) + { + sleepTime = seconds * 1000; + } + + public static synchronized void pass() + { + Sysout.println( "The test passed." ); + Sysout.println( "The test is over, hit Ctl-C to stop Java VM" ); + //first check if this is executing in main thread + if ( mainThread == Thread.currentThread() ) + { + //Still in the main thread, so set the flag just for kicks, + // and throw a test passed exception which will be caught + // and end the test. + theTestPassed = true; + throw new TestPassedException(); + } + theTestPassed = true; + testGeneratedInterrupt = true; + mainThread.interrupt(); + }//pass() + + public static synchronized void fail() + { + //test writer didn't specify why test failed, so give generic + fail( "it just plain failed! :-)" ); + } + + public static synchronized void fail( String whyFailed ) + { + Sysout.println( "The test failed: " + whyFailed ); + Sysout.println( "The test is over, hit Ctl-C to stop Java VM" ); + //check if this called from main thread + if ( mainThread == Thread.currentThread() ) + { + //If main thread, fail now 'cause not sleeping + throw new RuntimeException( whyFailed ); + } + theTestPassed = false; + testGeneratedInterrupt = true; + failureMessage = whyFailed; + mainThread.interrupt(); + }//fail() + +}// class GetSizeShouldNotReturnZero + +//This exception is used to exit from any level of call nesting +// when it's determined that the test has passed, and immediately +// end the test. +class TestPassedException extends RuntimeException +{ +} + +//*********** End Standard Test Machinery Section ********** + + +//************ Begin classes defined for the test **************** + +// if want to make listeners, here is the recommended place for them, then instantiate +// them in init() + +/* Example of a class which may be written as part of a test +class NewClass implements anInterface + { + static int newVar = 0; + + public void eventDispatched(AWTEvent e) + { + //Counting events to see if we get enough + eventCount++; + + if( eventCount == 20 ) + { + //got enough events, so pass + + GetSizeShouldNotReturnZero.pass(); + } + else if( tries == 20 ) + { + //tried too many times without getting enough events so fail + + GetSizeShouldNotReturnZero.fail(); + } + + }// eventDispatched() + + }// NewClass class + +*/ + + +//************** End classes defined for the test ******************* + + + + +/**************************************************** + Standard Test Machinery + DO NOT modify anything below -- it's a standard + chunk of code whose purpose is to make user + interaction uniform, and thereby make it simpler + to read and understand someone else's test. + ****************************************************/ + +/** + This is part of the standard test machinery. + It creates a dialog (with the instructions), and is the interface + for sending text messages to the user. + To print the instructions, send an array of strings to Sysout.createDialog + WithInstructions method. Put one line of instructions per array entry. + To display a message for the tester to see, simply call Sysout.println + with the string to be displayed. + This mimics System.out.println but works within the test harness as well + as standalone. + */ + +class Sysout +{ + private static TestDialog dialog; + + public static void createDialogWithInstructions( String[] instructions ) + { + dialog = new TestDialog( new Frame(), "Instructions" ); + dialog.printInstructions( instructions ); + dialog.setVisible(true); + println( "Any messages for the tester will display here." ); + } + + public static void createDialog( ) + { + dialog = new TestDialog( new Frame(), "Instructions" ); + String[] defInstr = { "Instructions will appear here. ", "" } ; + dialog.printInstructions( defInstr ); + dialog.setVisible(true); + println( "Any messages for the tester will display here." ); + } + + + public static void printInstructions( String[] instructions ) + { + dialog.printInstructions( instructions ); + } + + + public static void println( String messageIn ) + { + dialog.displayMessage( messageIn ); + System.out.println(messageIn); + } + +}// Sysout class + +/** + This is part of the standard test machinery. It provides a place for the + test instructions to be displayed, and a place for interactive messages + to the user to be displayed. + To have the test instructions displayed, see Sysout. + To have a message to the user be displayed, see Sysout. + Do not call anything in this dialog directly. + */ +class TestDialog extends Dialog +{ + + TextArea instructionsText; + TextArea messageText; + int maxStringLength = 80; + + //DO NOT call this directly, go through Sysout + public TestDialog( Frame frame, String name ) + { + super( frame, name ); + int scrollBoth = TextArea.SCROLLBARS_BOTH; + instructionsText = new TextArea( "", 15, maxStringLength, scrollBoth ); + add( "North", instructionsText ); + + messageText = new TextArea( "", 5, maxStringLength, scrollBoth ); + add("Center", messageText); + + pack(); + + setVisible(true); + }// TestDialog() + + //DO NOT call this directly, go through Sysout + public void printInstructions( String[] instructions ) + { + //Clear out any current instructions + instructionsText.setText( "" ); + + //Go down array of instruction strings + + String printStr, remainingStr; + for( int i=0; i < instructions.length; i++ ) + { + //chop up each into pieces maxSringLength long + remainingStr = instructions[ i ]; + while( remainingStr.length() > 0 ) + { + //if longer than max then chop off first max chars to print + if( remainingStr.length() >= maxStringLength ) + { + //Try to chop on a word boundary + int posOfSpace = remainingStr. + lastIndexOf( ' ', maxStringLength - 1 ); + + if( posOfSpace <= 0 ) posOfSpace = maxStringLength - 1; + + printStr = remainingStr.substring( 0, posOfSpace + 1 ); + remainingStr = remainingStr.substring( posOfSpace + 1 ); + } + //else just print + else + { + printStr = remainingStr; + remainingStr = ""; + } + + instructionsText.append( printStr + "\n" ); + + }// while + + }// for + + }//printInstructions() + + //DO NOT call this directly, go through Sysout + public void displayMessage( String messageIn ) + { + messageText.append( messageIn + "\n" ); + System.out.println(messageIn); + } + +}// TestDialog class + +

19-03-2009

EVALUATION Need to update the internal variables whenever the size of the warning changes.

17-03-2009