com.xmlmind.netutil

Class PasswordUtil

java.lang.Object

com.xmlmind.netutil.PasswordUtil

public final class PasswordUtil
extends Object

A collection of utilities (static methods) related to passwords.

This class is thread-safe.

Method Summary

Modifier and Type	Method and Description
static String	escapePassword(String unescaped) Invokes escapePassword(String, StringBuilder).
static void	escapePassword(String unescaped, StringBuilder escaped) Converts a password to UTF-8 and then encodes each byte in hexadecimal.
static String	getAnonymousFTPPassword() Convenience function which returns the customary password used for anonymous FTP connections.
static String	getLocalHostName() Convenience function which returns the name of local host if known; null otherwise.
static String	getUserIdentifier() Convenience function which returns user_name@host_name.
static String	getUserName() Convenience function which returns the value of system property user.name.
static String	unescapePassword(String escaped) Converts specified hexadecimal string to UTF-8 bytes, then returns the string built using these UTF-8 bytes.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

getAnonymousFTPPassword

public static String getAnonymousFTPPassword()

Convenience function which returns the customary password used for anonymous FTP connections. Example: john@rapid.acme.com.

Unlike for getUserIdentifier(), the returned password is guaranteed to contain character '@'.

Note that the returned password is unescaped.

getUserIdentifier

public static String getUserIdentifier()

Convenience function which returns user_name@host_name. Example: john@rapid.acme.com.

Note that the returned identifier is unescaped.

See Also:

getAnonymousFTPPassword()

getUserName

public static String getUserName()

Convenience function which returns the value of system property user.name.

getLocalHostName

public static String getLocalHostName()

Convenience function which returns the name of local host if known; null otherwise.

escapePassword

public static String escapePassword(String unescaped)

Invokes escapePassword(String, StringBuilder).

escapePassword

public static void escapePassword(String unescaped,
                                  StringBuilder escaped)

Converts a password to UTF-8 and then encodes each byte in hexadecimal.

Parameters:

unescaped - password to be ``escaped''

escaped - escaped password is appended to this buffer.

unescapePassword

public static String unescapePassword(String escaped)

Converts specified hexadecimal string to UTF-8 bytes, then returns the string built using these UTF-8 bytes. Inverse method of escapePassword(String).

Parameters:

escaped - a password in ``escaped'' form

Returns:

``unescaped'' password or null if specified string cannot be decoded.