brooklyn.location.basic.LocationInternal Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of brooklyn-core Show documentation

Entity implementation classes, events, and other core elements

There is a newer version: 0.7.0-M1

package brooklyn.location.basic;

import brooklyn.location.Location;
import java.util.Map;

/**
 * Information about locations private to Brooklyn.
 */
public interface LocationInternal extends Location {
    
    /**
     * Registers the given extension for the given type. If an extension already existed for
     * this type, then this will override it.
     * 
     * @throws NullPointerException if extensionType or extension are null
     * @throws IllegalArgumentException if extension does not implement extensionType
     */
     void addExtension(Class extensionType, T extension);

    /**
     * Get a record of the metadata of this location.
     * 
     * 
Metadata records are used to record an audit trail of events relating to location usage
     * (for billing purposes, for example). Implementations (and subclasses) should override this
     * method to return information useful for this purpose.
     *
     * @return
     */
    public Map toMetadataRecord();
}