javax.security: update classes in javax.security.auth.callback
Cosmetic changes
Change-Id: I4e99be5fa6cb3ab86232641609eb61768a019e5c
Test: make droid docs and check-ojluni-files
Bug: 29631070
diff --git a/ojluni/src/main/java/javax/security/auth/callback/Callback.java b/ojluni/src/main/java/javax/security/auth/callback/Callback.java
index 43f884f..83855ca 100755
--- a/ojluni/src/main/java/javax/security/auth/callback/Callback.java
+++ b/ojluni/src/main/java/javax/security/auth/callback/Callback.java
@@ -1,5 +1,5 @@
/*
- * Copyright (c) 1999, Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 1999, 2013, Oracle and/or its affiliates. All rights reserved.
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* This code is free software; you can redistribute it and/or modify it
@@ -28,14 +28,14 @@
/**
* <p> Implementations of this interface are passed to a
- * <code>CallbackHandler</code>, allowing underlying security services
+ * {@code CallbackHandler}, allowing underlying security services
* the ability to interact with a calling application to retrieve specific
* authentication data such as usernames and passwords, or to display
* certain information, such as error and warning messages.
*
- * <p> <code>Callback</code> implementations do not retrieve or
+ * <p> {@code Callback} implementations do not retrieve or
* display the information requested by underlying security services.
- * <code>Callback</code> implementations simply provide the means
+ * {@code Callback} implementations simply provide the means
* to pass such requests to applications, and for applications,
* if appropriate, to return requested information back to the
* underlying security services.
diff --git a/ojluni/src/main/java/javax/security/auth/callback/CallbackHandler.java b/ojluni/src/main/java/javax/security/auth/callback/CallbackHandler.java
index f49b1c4..af02496 100755
--- a/ojluni/src/main/java/javax/security/auth/callback/CallbackHandler.java
+++ b/ojluni/src/main/java/javax/security/auth/callback/CallbackHandler.java
@@ -1,5 +1,5 @@
/*
- * Copyright (c) 1999, 2005, Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 1999, 2013, Oracle and/or its affiliates. All rights reserved.
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* This code is free software; you can redistribute it and/or modify it
@@ -26,7 +26,7 @@
package javax.security.auth.callback;
/**
- * <p> An application implements a <code>CallbackHandler</code> and passes
+ * <p> An application implements a {@code CallbackHandler} and passes
* it to underlying security services so that they may interact with
* the application to retrieve specific authentication data,
* such as usernames and passwords, or to display certain information,
@@ -40,33 +40,30 @@
*
* <p> Underlying security services make requests for different types
* of information by passing individual Callbacks to the
- * <code>CallbackHandler</code>. The <code>CallbackHandler</code>
+ * {@code CallbackHandler}. The {@code CallbackHandler}
* implementation decides how to retrieve and display information
* depending on the Callbacks passed to it. For example,
* if the underlying service needs a username and password to
- * authenticate a user, it uses a <code>NameCallback</code> and
- * <code>PasswordCallback</code>. The <code>CallbackHandler</code>
+ * authenticate a user, it uses a {@code NameCallback} and
+ * {@code PasswordCallback}. The {@code CallbackHandler}
* can then choose to prompt for a username and password serially,
* or to prompt for both in a single window.
*
- * <p> A default <code>CallbackHandler</code> class implementation
- * may be specified in the <i>auth.login.defaultCallbackHandler</i>
- * security property. The security property can be set
- * in the Java security properties file located in the file named
- * <JAVA_HOME>/lib/security/java.security.
- * <JAVA_HOME> refers to the value of the java.home system property,
- * and specifies the directory where the JRE is installed.
+ * <p> A default {@code CallbackHandler} class implementation
+ * may be specified by setting the value of the
+ * {@code auth.login.defaultCallbackHandler} security property.
*
* <p> If the security property is set to the fully qualified name of a
- * <code>CallbackHandler</code> implementation class,
- * then a <code>LoginContext</code> will load the specified
- * <code>CallbackHandler</code> and pass it to the underlying LoginModules.
- * The <code>LoginContext</code> only loads the default handler
+ * {@code CallbackHandler} implementation class,
+ * then a {@code LoginContext} will load the specified
+ * {@code CallbackHandler} and pass it to the underlying LoginModules.
+ * The {@code LoginContext} only loads the default handler
* if it was not provided one.
*
* <p> All default handler implementations must provide a public
* zero-argument constructor.
*
+ * @see java.security.Security security properties
*/
public interface CallbackHandler {
@@ -74,15 +71,15 @@
* <p> Retrieve or display the information requested in the
* provided Callbacks.
*
- * <p> The <code>handle</code> method implementation checks the
- * instance(s) of the <code>Callback</code> object(s) passed in
+ * <p> The {@code handle} method implementation checks the
+ * instance(s) of the {@code Callback} object(s) passed in
* to retrieve or display the requested information.
* The following example is provided to help demonstrate what an
- * <code>handle</code> method implementation might look like.
+ * {@code handle} method implementation might look like.
* This example code is for guidance only. Many details,
* including proper error handling, are left out for simplicity.
*
- * <pre>
+ * <pre>{@code
* public void handle(Callback[] callbacks)
* throws IOException, UnsupportedCallbackException {
*
@@ -136,9 +133,9 @@
* private char[] readPassword(InputStream in) throws IOException {
* // insert code to read a user password from the input stream
* }
- * </pre>
+ * }</pre>
*
- * @param callbacks an array of <code>Callback</code> objects provided
+ * @param callbacks an array of {@code Callback} objects provided
* by an underlying security service which contains
* the information requested to be retrieved or displayed.
*
@@ -146,7 +143,7 @@
*
* @exception UnsupportedCallbackException if the implementation of this
* method does not support one or more of the Callbacks
- * specified in the <code>callbacks</code> parameter.
+ * specified in the {@code callbacks} parameter.
*/
void handle(Callback[] callbacks)
throws java.io.IOException, UnsupportedCallbackException;
diff --git a/ojluni/src/main/java/javax/security/auth/callback/PasswordCallback.java b/ojluni/src/main/java/javax/security/auth/callback/PasswordCallback.java
index d040740..0e8fb7b 100755
--- a/ojluni/src/main/java/javax/security/auth/callback/PasswordCallback.java
+++ b/ojluni/src/main/java/javax/security/auth/callback/PasswordCallback.java
@@ -1,5 +1,5 @@
/*
- * Copyright (c) 1999, 2003, Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 1999, 2013, Oracle and/or its affiliates. All rights reserved.
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* This code is free software; you can redistribute it and/or modify it
@@ -27,8 +27,8 @@
/**
* <p> Underlying security services instantiate and pass a
- * <code>PasswordCallback</code> to the <code>handle</code>
- * method of a <code>CallbackHandler</code> to retrieve password information.
+ * {@code PasswordCallback} to the {@code handle}
+ * method of a {@code CallbackHandler} to retrieve password information.
*
* @see javax.security.auth.callback.CallbackHandler
*/
@@ -53,7 +53,7 @@
private char[] inputPassword;
/**
- * Construct a <code>PasswordCallback</code> with a prompt
+ * Construct a {@code PasswordCallback} with a prompt
* and a boolean specifying whether the password should be displayed
* as it is being typed.
*
@@ -64,8 +64,8 @@
* @param echoOn true if the password should be displayed
* as it is being typed.
*
- * @exception IllegalArgumentException if <code>prompt</code> is null or
- * if <code>prompt</code> has a length of 0.
+ * @exception IllegalArgumentException if {@code prompt} is null or
+ * if {@code prompt} has a length of 0.
*/
public PasswordCallback(String prompt, boolean echoOn) {
if (prompt == null || prompt.length() == 0)
diff --git a/ojluni/src/main/java/javax/security/auth/callback/UnsupportedCallbackException.java b/ojluni/src/main/java/javax/security/auth/callback/UnsupportedCallbackException.java
index cb9b66b..0a9fa51 100755
--- a/ojluni/src/main/java/javax/security/auth/callback/UnsupportedCallbackException.java
+++ b/ojluni/src/main/java/javax/security/auth/callback/UnsupportedCallbackException.java
@@ -1,5 +1,5 @@
/*
- * Copyright (c) 1999, 2003, Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 1999, 2013, Oracle and/or its affiliates. All rights reserved.
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* This code is free software; you can redistribute it and/or modify it
@@ -26,8 +26,8 @@
package javax.security.auth.callback;
/**
- * Signals that a <code>CallbackHandler</code> does not
- * recognize a particular <code>Callback</code>.
+ * Signals that a {@code CallbackHandler} does not
+ * recognize a particular {@code Callback}.
*
*/
public class UnsupportedCallbackException extends Exception {
@@ -40,12 +40,12 @@
private Callback callback;
/**
- * Constructs a <code>UnsupportedCallbackException</code>
+ * Constructs a {@code UnsupportedCallbackException}
* with no detail message.
*
* <p>
*
- * @param callback the unrecognized <code>Callback</code>.
+ * @param callback the unrecognized {@code Callback}.
*/
public UnsupportedCallbackException(Callback callback) {
super();
@@ -59,7 +59,7 @@
*
* <p>
*
- * @param callback the unrecognized <code>Callback</code>. <p>
+ * @param callback the unrecognized {@code Callback}. <p>
*
* @param msg the detail message.
*/
@@ -69,11 +69,11 @@
}
/**
- * Get the unrecognized <code>Callback</code>.
+ * Get the unrecognized {@code Callback}.
*
* <p>
*
- * @return the unrecognized <code>Callback</code>.
+ * @return the unrecognized {@code Callback}.
*/
public Callback getCallback() {
return callback;
diff --git a/ojluni/src/main/java/javax/security/auth/callback/package-info.java b/ojluni/src/main/java/javax/security/auth/callback/package-info.java
new file mode 100644
index 0000000..4cd5daf
--- /dev/null
+++ b/ojluni/src/main/java/javax/security/auth/callback/package-info.java
@@ -0,0 +1,35 @@
+/*
+ * Copyright (c) 2000, 2013, Oracle and/or its affiliates. All rights reserved.
+ * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
+ *
+ * This code is free software; you can redistribute it and/or modify it
+ * under the terms of the GNU General Public License version 2 only, as
+ * published by the Free Software Foundation. Oracle designates this
+ * particular file as subject to the "Classpath" exception as provided
+ * by Oracle in the LICENSE file that accompanied this code.
+ *
+ * This code is distributed in the hope that it will be useful, but WITHOUT
+ * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
+ * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
+ * version 2 for more details (a copy is included in the LICENSE file that
+ * accompanied this code).
+ *
+ * You should have received a copy of the GNU General Public License version
+ * 2 along with this work; if not, write to the Free Software Foundation,
+ * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
+ *
+ * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
+ * or visit www.oracle.com if you need additional information or have any
+ * questions.
+ */
+
+/**
+ * This package provides the classes necessary for services
+ * to interact with applications in order to retrieve
+ * information (authentication data including usernames
+ * or passwords, for example) or to display information
+ * (error and warning messages, for example).
+ *
+ * @since JDK1.4
+ */
+package javax.security.auth.callback;
diff --git a/ojluni/src/main/java/javax/security/auth/callback/package.html b/ojluni/src/main/java/javax/security/auth/callback/package.html
deleted file mode 100755
index 66d58e4..0000000
--- a/ojluni/src/main/java/javax/security/auth/callback/package.html
+++ /dev/null
@@ -1,57 +0,0 @@
-<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2 Final//EN">
-<html>
-<head>
-<!--
-Copyright (c) 2000, Oracle and/or its affiliates. All rights reserved.
-DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
-
-This code is free software; you can redistribute it and/or modify it
-under the terms of the GNU General Public License version 2 only, as
-published by the Free Software Foundation. Oracle designates this
-particular file as subject to the "Classpath" exception as provided
-by Oracle in the LICENSE file that accompanied this code.
-
-This code is distributed in the hope that it will be useful, but WITHOUT
-ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
-FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
-version 2 for more details (a copy is included in the LICENSE file that
-accompanied this code).
-
-You should have received a copy of the GNU General Public License version
-2 along with this work; if not, write to the Free Software Foundation,
-Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
-
-Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
-or visit www.oracle.com if you need additional information or have any
-questions.
--->
-
-</head>
-<body bgcolor="white">
-
- This package provides the classes necessary for services
- to interact with applications in order to retrieve
- information (authentication data including usernames
- or passwords, for example) or to display information
- (error and warning messages, for example).
-
-<!--
-<h2>Package Specification</h2>
-
-##### FILL IN ANY SPECS NEEDED BY JAVA COMPATIBILITY KIT #####
-<ul>
- <li><a href="">##### REFER TO ANY FRAMEMAKER SPECIFICATION HERE #####</a>
-</ul>
-
-<h2>Related Documentation</h2>
-
-For overviews, tutorials, examples, guides, and tool documentation, please see:
-<ul>
- <li><a href="">##### REFER TO NON-SPEC DOCUMENTATION HERE #####</a>
-</ul>
-
--->
-
-@since JDK1.4
-</body>
-</html>
diff --git a/openjdk_java_files.mk b/openjdk_java_files.mk
index 118e687..be25f2c 100644
--- a/openjdk_java_files.mk
+++ b/openjdk_java_files.mk
@@ -1104,6 +1104,7 @@
ojluni/src/main/java/javax/security/auth/callback/Callback.java \
ojluni/src/main/java/javax/security/auth/callback/PasswordCallback.java \
ojluni/src/main/java/javax/security/auth/callback/UnsupportedCallbackException.java \
+ ojluni/src/main/java/javax/security/auth/callback/package-info.java \
ojluni/src/main/java/javax/security/auth/Destroyable.java \
ojluni/src/main/java/javax/security/auth/DestroyFailedException.java \
ojluni/src/main/java/javax/security/auth/login/LoginException.java \