FirewallZone.Name (AOServ Client 1.85.0 API)

java.lang.Object
- com.aoindustries.aoserv.client.net.FirewallZone.Name

All Implemented Interfaces:

DtoFactory<FirewallZoneName>, Internable<FirewallZone.Name>, Serializable, Comparable<FirewallZone.Name>

Enclosing class:

FirewallZone
```
public static final class FirewallZone.Name
extends Object
implements Comparable<FirewallZone.Name>, Serializable, DtoFactory<FirewallZoneName>, Internable<FirewallZone.Name>
```
Represents a name that may be used for a FirewallZone. Zones names must:
- Be non-null
- Be non-empty
- Be between 1 and 17 characters
- Contain the characters [a-z], [A-Z], [0-9], underscore (_), hyphen (-), and slash (/)
- Not begin with a slash (/)
- Not end with a slash (/)
- Not contain more than one slash (/)
We're unable to find well-defined rules for valid zone names. The rules above are based on the source code for firewalld included with CentOS 7.
1. See /usr/lib/python2.7/site-packages/firewall/core/io/zone.py, check_name.
2. See /usr/lib/python2.7/site-packages/firewall/core/io/io_object.py, check_name.
3. See /usr/lib/python2.7/site-packages/firewall/functions.py, max_zone_name_len.
Additionally, we tried creating a new zone with some UTF-8 characters, specifically Japanese, and firewalld-cmd just stalled, not even responding to Ctrl-C. We are implementing with a strict ASCII-compatible definition of "alphanumeric".
Author:

AO Industries, Inc.

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type Field Description

static int MAX_LENGTH
The longest name allowed for a FirewallZone.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`int`	`compareTo(FirewallZone.Name other)`
`boolean`	`equals(Object O)`
`FirewallZoneName`	`getDto()`
`int`	`hashCode()`
`FirewallZone.Name`	`intern()`	Interns this name much in the same fashion as `String.intern()`.
`String`	`toString()`
`static ValidationResult`	`validate(String name)`	Validates a `FirewallZone` name.
`static FirewallZone.Name`	`valueOf(String name)`

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Field Detail
  - MAX_LENGTH
```
public static final int MAX_LENGTH
```
    The longest name allowed for a FirewallZone.
    
    See Also:
    
    Constant Field Values
- Method Detail
  - validate
```
public static ValidationResult validate(String name)
```
    Validates a FirewallZone name.
  - valueOf
```
public static FirewallZone.Name valueOf(String name)
                                 throws ValidationException
```
    Parameters:
    
    name - when null, returns null
    
    Throws:
    
    ValidationException
  - equals
```
public boolean equals(Object O)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - compareTo
```
public int compareTo(FirewallZone.Name other)
```
    Specified by:
    
    compareTo in interface Comparable<FirewallZone.Name>
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - intern
```
public FirewallZone.Name intern()
```
    Interns this name much in the same fashion as String.intern().
    
    Specified by:
    
    intern in interface Internable<FirewallZone.Name>
    
    See Also:
    
    String.intern()
  - getDto
```
public FirewallZoneName getDto()
```
    Specified by:
    
    getDto in interface DtoFactory<FirewallZoneName>