diff options
Diffstat (limited to 'libjava/java/net/Authenticator.java')
| -rw-r--r-- | libjava/java/net/Authenticator.java | 92 |
1 files changed, 48 insertions, 44 deletions
diff --git a/libjava/java/net/Authenticator.java b/libjava/java/net/Authenticator.java index 7592b525a50..8a951cb2dfd 100644 --- a/libjava/java/net/Authenticator.java +++ b/libjava/java/net/Authenticator.java @@ -7,7 +7,7 @@ GNU Classpath is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2, or (at your option) any later version. - + GNU Classpath 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 @@ -37,18 +37,19 @@ exception statement from your version. */ package java.net; + /** * This abstract class provides a model for obtaining authentication * information (in the form of a username and password) required by * some network operations (such as hitting a password protected * web site). * <p> - * To make use of this feature, a programmer must create a subclass + * To make use of this feature, a programmer must create a subclass * that knows how to obtain the necessary info. An example - * would be a class that popped up a dialog box to prompt the user. - * After creating an instance of that subclass, the static - * <code>setDefault</code> method of this class is called to set up - * that instance as the object to use on subsequent calls to obtain + * would be a class that popped up a dialog box to prompt the user. + * After creating an instance of that subclass, the static + * <code>setDefault</code> method of this class is called to set up + * that instance as the object to use on subsequent calls to obtain * authorization. * * @since 1.2 @@ -106,8 +107,8 @@ public abstract class Authenticator */ /** - * This method sets the default <code>Authenticator</code> object (an - * instance of a subclass of <code>Authenticator</code>) to use when + * This method sets the default <code>Authenticator</code> object (an + * instance of a subclass of <code>Authenticator</code>) to use when * prompting the user for * information. Note that this method checks to see if the caller is * allowed to set this value (the "setDefaultAuthenticator" permission) @@ -115,9 +116,9 @@ public abstract class Authenticator * * @param defAuth The new default <code>Authenticator</code> object to use * - * @exception SecurityException If the caller does not have permission + * @exception SecurityException If the caller does not have permission * to perform this operation - */ + */ public static void setDefault(Authenticator defAuth) { SecurityManager sm = System.getSecurityManager(); @@ -125,38 +126,40 @@ public abstract class Authenticator sm.checkPermission(new NetPermission("setDefaultAuthenticator")); defaultAuthenticator = defAuth; - } + } /** * This method is called whenever a username and password for a given * network operation is required. First, a security check is made to see * if the caller has the "requestPasswordAuthentication" * permission. If not, the method thows an exception. If there is no - * default <code>Authenticator</code> object, the method then returns - * <code>null</code>. Otherwise, the default authenticators's instance + * default <code>Authenticator</code> object, the method then returns + * <code>null</code>. Otherwise, the default authenticators's instance * variables are initialized and it's <code>getPasswordAuthentication</code> * method is called to get the actual authentication information to return. * * @param addr The address requesting authentication * @param port The port requesting authentication * @param protocol The protocol requesting authentication - * @param prompt The prompt to display to the user when requesting + * @param prompt The prompt to display to the user when requesting * authentication info * @param scheme The authentication scheme in use - * - * @return A <code>PasswordAuthentication</code> object with the user's + * + * @return A <code>PasswordAuthentication</code> object with the user's * authentication info. * - * @exception SecurityException If the caller does not have permission to + * @exception SecurityException If the caller does not have permission to * perform this operation - */ - public static PasswordAuthentication - requestPasswordAuthentication(InetAddress addr, int port, String protocol, - String prompt, String scheme) + */ + public static PasswordAuthentication requestPasswordAuthentication(InetAddress addr, + int port, + String protocol, + String prompt, + String scheme) throws SecurityException { - return(requestPasswordAuthentication (null, addr, port, protocol, - prompt, scheme)); + return requestPasswordAuthentication(null, addr, port, protocol, prompt, + scheme); } /** @@ -175,21 +178,24 @@ public abstract class Authenticator * @param addr The address requesting authentication * @param port The port requesting authentication * @param protocol The protocol requesting authentication - * @param prompt The prompt to display to the user when requesting + * @param prompt The prompt to display to the user when requesting * authentication info * @param scheme The authentication scheme in use * - * @return A <code>PasswordAuthentication</code> object with the user's + * @return A <code>PasswordAuthentication</code> object with the user's * authentication info. * - * @exception SecurityException If the caller does not have permission to + * @exception SecurityException If the caller does not have permission to * perform this operation * * @since 1.4 */ - public static PasswordAuthentication - requestPasswordAuthentication(String host, InetAddress addr, int port, - String protocol, String prompt, String scheme) + public static PasswordAuthentication requestPasswordAuthentication(String host, + InetAddress addr, + int port, + String protocol, + String prompt, + String scheme) throws SecurityException { SecurityManager sm = System.getSecurityManager(); @@ -197,7 +203,7 @@ public abstract class Authenticator sm.checkPermission(new NetPermission("requestPasswordAuthentication")); if (defaultAuthenticator == null) - return(null); + return null; defaultAuthenticator.host = host; defaultAuthenticator.addr = addr; @@ -206,7 +212,7 @@ public abstract class Authenticator defaultAuthenticator.prompt = prompt; defaultAuthenticator.scheme = scheme; - return(defaultAuthenticator.getPasswordAuthentication()); + return defaultAuthenticator.getPasswordAuthentication(); } /* @@ -232,7 +238,7 @@ public abstract class Authenticator */ protected final InetAddress getRequestingSite() { - return(addr); + return addr; } /** @@ -240,24 +246,24 @@ public abstract class Authenticator * or <code>null</code> if not available. * * @return The name of the host requesting authentication, or - * </code>null</code> if it is not available. + * <code>null</code> if it is not available. * * @since 1.4 */ protected final String getRequestingHost() { - return(host); + return host; } /** - * This method returns the port of the site that is requesting + * This method returns the port of the site that is requesting * authentication. * * @return The requesting port */ protected final int getRequestingPort() { - return(port); + return port; } /** @@ -268,18 +274,18 @@ public abstract class Authenticator */ protected final String getRequestingProtocol() { - return(protocol); + return protocol; } /** - * Returns the prompt that should be used when requesting authentication + * Returns the prompt that should be used when requesting authentication * information from the user - * + * * @return The user prompt */ protected final String getRequestingPrompt() { - return(prompt); + return prompt; } /** @@ -289,7 +295,7 @@ public abstract class Authenticator */ protected final String getRequestingScheme() { - return(scheme); + return scheme; } /** @@ -302,8 +308,6 @@ public abstract class Authenticator */ protected PasswordAuthentication getPasswordAuthentication() { - return(null); + return null; } - } // class Authenticator - |
