LocalLocationManager (Apache Brooklyn)

java.lang.Object
- brooklyn.management.internal.LocalLocationManager

All Implemented Interfaces:: LocationManagerInternal, LocationManager

public class LocalLocationManager
extends java.lang.Object
implements LocationManagerInternal

Field Summary

Fields
Modifier and Type Field and Description

static ConfigKey<java.lang.Boolean> CREATE_UNMANAGED

Fields
Modifier and Type	Field and Description
`static ConfigKey<java.lang.Boolean>`	`CREATE_UNMANAGED`

Constructor Summary

Constructors
Constructor and Description

LocalLocationManager(LocalManagementContext managementContext)

Constructors
Constructor and Description
`LocalLocationManager(LocalManagementContext managementContext)`

Method Summary

Methods
Modifier and Type	Method and Description
`<T extends Location> T`	`createLocation(LocationSpec<T> spec)` Creates a new location, which is tracked by the management context.
`<T extends Location> T`	`createLocation(java.util.Map<?,?> config, java.lang.Class<T> type)` Convenience (particularly for groovy code) to create a location.
`ManagementTransitionInfo.ManagementTransitionMode`	`getLastManagementTransitionMode(java.lang.String itemId)`
`Location`	`getLocation(java.lang.String id)` Returns the location under management (e.g.
`Location`	`getLocationEvenIfPreManaged(java.lang.String id)`
`InternalLocationFactory`	`getLocationFactory()`
`java.util.Collection<java.lang.String>`	`getLocationIds()`
`java.util.Collection<Location>`	`getLocations()` All locations under control of this management plane.
`boolean`	`isKnownLocationId(java.lang.String id)`
`boolean`	`isManaged(Location loc)` whether the location is under management by this management context
`Location`	`manage(Location loc)` management on creation
`void`	`manageRebindedRoot(Location item)` Begins management for the given rebinded root, recursively; if rebinding as a read-only copy, `#setReadOnly(Location, boolean)` should be called prior to this.
`void`	`setManagementTransitionMode(Location item, ManagementTransitionInfo.ManagementTransitionMode mode)`
`void`	`unmanage(Location loc)` Causes the given location and its children, recursively, to be removed from the management plane (for instance because the location is no longer relevant).
`void`	`unmanage(Location loc, ManagementTransitionInfo.ManagementTransitionMode mode)`

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

- Field Detail
  - CREATE_UNMANAGED
```
@Beta
public static final ConfigKey<java.lang.Boolean> CREATE_UNMANAGED
```
- Constructor Detail
  - LocalLocationManager
```
public LocalLocationManager(LocalManagementContext managementContext)
```
- Method Detail
  - getLocationFactory
```
public InternalLocationFactory getLocationFactory()
```
  - createLocation
```
public <T extends Location> T createLocation(LocationSpec<T> spec)
```
    Description copied from interface: LocationManager
    
    Creates a new location, which is tracked by the management context.
    
    Specified by:
    
    createLocation in interface LocationManager
  - createLocation
```
public <T extends Location> T createLocation(java.util.Map<?,?> config,
                                    java.lang.Class<T> type)
```
    Description copied from interface: LocationManager
    
    Convenience (particularly for groovy code) to create a location. Equivalent to createLocation(LocationSpec.create(type).configure(config))
    
    Specified by:
    
    createLocation in interface LocationManager
    
    See Also:
    LocationManager.createLocation(LocationSpec)
  - getLocations
```
public java.util.Collection<Location> getLocations()
```
    Description copied from interface: LocationManager
    
    All locations under control of this management plane. This returns a snapshot of the current locations; it will not reflect future changes in the locations. If no locations are found, the collection will be empty (i.e. null is never returned).
    
    Specified by:
    
    getLocations in interface LocationManager
  - getLocationIds
```
public java.util.Collection<java.lang.String> getLocationIds()
```
    Specified by:
    
    getLocationIds in interface LocationManagerInternal
  - getLocation
```
public Location getLocation(java.lang.String id)
```
    Description copied from interface: LocationManager
    
    Returns the location under management (e.g. in use) with the given identifier (e.g. random string; and different to the LocationDefinition id). May return a full instance, or a proxy to one which is remote. If no location found with that id, returns null.
    
    Specified by:
    
    getLocation in interface LocationManager
  - getLocationEvenIfPreManaged
```
public Location getLocationEvenIfPreManaged(java.lang.String id)
```
  - isManaged
```
public boolean isManaged(Location loc)
```
    Description copied from interface: LocationManager
    
    whether the location is under management by this management context
    
    Specified by:
    
    isManaged in interface LocationManager
  - isKnownLocationId
```
public boolean isKnownLocationId(java.lang.String id)
```
  - getLastManagementTransitionMode
```
public ManagementTransitionInfo.ManagementTransitionMode getLastManagementTransitionMode(java.lang.String itemId)
```
    Specified by:
    
    getLastManagementTransitionMode in interface LocationManagerInternal
  - setManagementTransitionMode
```
public void setManagementTransitionMode(Location item,
                               ManagementTransitionInfo.ManagementTransitionMode mode)
```
    Specified by:
    
    setManagementTransitionMode in interface LocationManagerInternal
  - manage
```
public Location manage(Location loc)
```
    management on creation
    
    Specified by:
    
    manage in interface LocationManager
  - manageRebindedRoot
```
public void manageRebindedRoot(Location item)
```
    Description copied from interface: LocationManagerInternal
    
    Begins management for the given rebinded root, recursively; if rebinding as a read-only copy, #setReadOnly(Location, boolean) should be called prior to this.
    
    Specified by:
    
    manageRebindedRoot in interface LocationManagerInternal
  - unmanage
```
public void unmanage(Location loc)
```
    Description copied from interface: LocationManager
    
    Causes the given location and its children, recursively, to be removed from the management plane (for instance because the location is no longer relevant). If the given location is not managed (e.g. it has already been unmanaged) then this is a no-op (though it may be logged so duplicate calls are best avoided).
    
    Specified by:
    
    unmanage in interface LocationManager
  - unmanage
```
public void unmanage(Location loc,
            ManagementTransitionInfo.ManagementTransitionMode mode)
```
    Specified by:
    
    unmanage in interface LocationManagerInternal

Class LocalLocationManager

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

CREATE_UNMANAGED

Constructor Detail

LocalLocationManager

Method Detail

getLocationFactory

createLocation

createLocation

getLocations

getLocationIds

getLocation

getLocationEvenIfPreManaged

isManaged

isKnownLocationId

getLastManagementTransitionMode

setManagementTransitionMode

manage

manageRebindedRoot

unmanage

unmanage