Module com.aoindustries.aoserv.client

Package com.aoindustries.aoserv.client.linux

Class User.Name

java.lang.Object

com.aoindustries.aoserv.client.account.User.Name

com.aoindustries.aoserv.client.linux.User.Name

All Implemented Interfaces:

DtoFactory<UserName>, FastExternalizable, Internable<User.Name>, Externalizable, Serializable, Comparable<User.Name>

Direct Known Subclasses:

User.Name, User.Name

Enclosing class:

User

public static class User.Name
extends User.Name
implements FastExternalizable

Represents a Linux username. User names must:

• Be non-null
• Be non-empty
• Be between 1 and 32 characters
• Must start with [a-z]
• Uses only ASCII 0x21 through 0x7f, excluding space , : ( ) [ ] ' " | & ; A-Z \ /
• If contains any @ symbol, must also be a valid email address. Please note that the reverse is not implied - email addresses may exist that are not valid user names.
• May not start with cyrus@
• TODO: May only end on "$"?
• TODO: "+" is allowed, "lost+found" should be specifically disallowed due to /home/lost+found on mount points.
• Must be a valid User.Name - this is implied by the above rules

Author:

AO Industries, Inc.

See Also:

• Email.validate(java.lang.String)
• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static final int	LINUX_NAME_MAX_LENGTH	The maximum length of a Linux username.

Fields inherited from class com.aoindustries.aoserv.client.account.User.Name

MAX_LENGTH, name

Constructor Summary

Constructors

Modifier	Constructor	Description
	Name()	Deprecated. Only required for implementation, do not use directly.
protected	Name(String name)
protected	Name(String name, boolean validate)

Method Summary

Modifier and Type	Method	Description
LinuxUserName	getDto()
long	getSerialVersionUID()
User.Name	intern()	Interns this name much in the same fashion as String.intern().
protected void	validate()
static ValidationResult	validate(String name)	Validates a User name.
static User.Name	valueOf(String name)

Methods inherited from class com.aoindustries.aoserv.client.account.User.Name

compareTo, equals, hashCode, readExternal, toString, writeExternal

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.io.Externalizable

readExternal, writeExternal

Field Details

LINUX_NAME_MAX_LENGTH

public static final int LINUX_NAME_MAX_LENGTH

The maximum length of a Linux username.

Implementation Note:
32 characters

See Also:

• Constant Field Values

Constructor Details

Name

protected Name(String name,
 boolean validate)
        throws ValidationException

Throws:

ValidationException

Name

protected Name(String name)

Parameters:

name - Does not validate, should only be used with a known valid value.

Name

@Deprecated(forRemoval=false)
public Name()

Deprecated.

Only required for implementation, do not use directly.

See Also:

• FastExternalizable

Method Details

validate

public static ValidationResult validate(String name)

Validates a User name.

valueOf

public static User.Name valueOf(String name)
                         throws ValidationException

Parameters:

name - when null, returns null

Throws:

ValidationException

validate

protected void validate()
                 throws ValidationException

Overrides:

validate in class User.Name

Throws:

ValidationException

intern

public User.Name intern()

Description copied from class: User.Name

Interns this name much in the same fashion as String.intern().

Because this has subtypes, two User.Name that are User.Name.equals(java.lang.Object) may not necessarily return the same instance object after interning. Thus, unless you know objects are of the same class, User.Name.equals(java.lang.Object) should still be used for equality check instead of the obj1 == obj2 shortcut.

To more efficiently check post-interned equivalence, one could also do obj1 == obj2 || (obj1.getClass() != obj2.getClass() && obj1.equals(obj2)), but is it worth it?

And then if we abuse the fact that interned user ids have an interned name, one could check equivalence of post-interned user ids as obj1.getId() == obj2.getId(), but once again, is it worth it? Just call User.Name.equals(java.lang.Object).

Specified by:

intern in interface Internable<User.Name>

Overrides:

intern in class User.Name

See Also:

• String.intern()

getDto

public LinuxUserName getDto()

Specified by:

getDto in interface DtoFactory<UserName>

Overrides:

getDto in class User.Name

getSerialVersionUID

public long getSerialVersionUID()

Specified by:

getSerialVersionUID in interface FastExternalizable

Overrides:

getSerialVersionUID in class User.Name