AbstractCloudMachineNamer (Apache Brooklyn)

java.lang.Object
- brooklyn.location.cloud.names.AbstractCloudMachineNamer

All Implemented Interfaces:

CloudMachineNamer

Direct Known Subclasses:

BasicCloudMachineNamer
```
public abstract class AbstractCloudMachineNamer
extends java.lang.Object
implements CloudMachineNamer
```
Implements most of CloudMachineNamer, leaving just one method -- #generateNewIdOfLength(int) -- for subclasses to provide.
CloudLocationConfig.VM_NAME_MAX_LENGTH is used to find the VM length, unless getCustomMaxNameLength(ConfigBag) is overridden or setDefaultMachineNameMaxLength(int) invoked on the instance supplied.

Constructor Summary

Constructors
Constructor and Description

AbstractCloudMachineNamer()

Constructors
Constructor and Description
`AbstractCloudMachineNamer()`

Method Summary

Methods
Modifier and Type	Method and Description
`java.lang.String`	`generateNewGroupId(ConfigBag setup)` Generate a name stem for a group of machines, based on context.
`java.lang.String`	`generateNewMachineUniqueName(ConfigBag setup)` Generate a name for a new machine, based on context.
`java.lang.String`	`generateNewMachineUniqueNameFromGroupId(ConfigBag setup, java.lang.String groupId)` Generate a unique name from the given name stem.
`java.lang.Integer`	`getCustomMaxNameLength(ConfigBag setup)` Method for overriding to provide custom logic when an explicit config key is not set for the machine length.
`int`	`getLengthForMachineUniqueNameSalt(ConfigBag setup, boolean includeSeparator)`
`int`	`getMaxNameLength(ConfigBag setup)` Returns the max length of a VM name for the cloud specified in setup; this value is typically decremented by 9 to make room for jclouds labels; delegates to `#getCustomMaxNameLength()` when `CloudLocationConfig.VM_NAME_MAX_LENGTH` is not set
`static java.lang.String`	`sanitize(java.lang.String s)`
`AbstractCloudMachineNamer`	`setDefaultMachineNameMaxLength(int defaultMaxLength)`
`AbstractCloudMachineNamer`	`setDefaultMachineNameSeparatorAndSaltLength(java.lang.String separator, int defaultMachineUniqueNameSaltLength)` Number of chars to use or reserve for the machine identifier when constructing a group identifier; jclouds for instance uses "-" plus 8

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - AbstractCloudMachineNamer
```
public AbstractCloudMachineNamer()
```
- Method Detail
  - generateNewMachineUniqueName
```
public java.lang.String generateNewMachineUniqueName(ConfigBag setup)
```
    Description copied from interface: CloudMachineNamer
    
    Generate a name for a new machine, based on context.
    The name should normally be unique, as a context might produce multiple machines, for example basing it partially on information from the context but also including some random salt.
    
    Specified by:
    
    generateNewMachineUniqueName in interface CloudMachineNamer
  - generateNewMachineUniqueNameFromGroupId
```
public java.lang.String generateNewMachineUniqueNameFromGroupId(ConfigBag setup,
                                                       java.lang.String groupId)
```
    Description copied from interface: CloudMachineNamer
    
    Generate a unique name from the given name stem.
    The name stem is normally based on context information so the usual function of this method is to apply a suffix which helps to uniquely distinguish between machines in cases where the same name stem (#generateNewGroupId()) is used for multiple machines.
    
    Specified by:
    
    generateNewMachineUniqueNameFromGroupId in interface CloudMachineNamer
  - generateNewGroupId
```
public java.lang.String generateNewGroupId(ConfigBag setup)
```
    Description copied from interface: CloudMachineNamer
    
    Generate a name stem for a group of machines, based on context.
    The name does not need to be unique, as uniqueness will be applied by #generateNewMachineUniqueNameFromGroupId(String).
    
    Specified by:
    
    generateNewGroupId in interface CloudMachineNamer
  - getMaxNameLength
```
public int getMaxNameLength(ConfigBag setup)
```
    Returns the max length of a VM name for the cloud specified in setup; this value is typically decremented by 9 to make room for jclouds labels; delegates to #getCustomMaxNameLength() when CloudLocationConfig.VM_NAME_MAX_LENGTH is not set
  - getLengthForMachineUniqueNameSalt
```
public int getLengthForMachineUniqueNameSalt(ConfigBag setup,
                                    boolean includeSeparator)
```
  - setDefaultMachineNameMaxLength
```
public AbstractCloudMachineNamer setDefaultMachineNameMaxLength(int defaultMaxLength)
```
  - setDefaultMachineNameSeparatorAndSaltLength
```
public AbstractCloudMachineNamer setDefaultMachineNameSeparatorAndSaltLength(java.lang.String separator,
                                                                    int defaultMachineUniqueNameSaltLength)
```
    Number of chars to use or reserve for the machine identifier when constructing a group identifier; jclouds for instance uses "-" plus 8
  - getCustomMaxNameLength
```
public java.lang.Integer getCustomMaxNameLength(ConfigBag setup)
```
    Method for overriding to provide custom logic when an explicit config key is not set for the machine length.
  - sanitize
```
@Beta
public static java.lang.String sanitize(java.lang.String s)
```

Class AbstractCloudMachineNamer

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

AbstractCloudMachineNamer

Method Detail

generateNewMachineUniqueName

generateNewMachineUniqueNameFromGroupId

generateNewGroupId

getMaxNameLength

getLengthForMachineUniqueNameSalt

setDefaultMachineNameMaxLength

setDefaultMachineNameSeparatorAndSaltLength

getCustomMaxNameLength

sanitize