/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (the
* "License"); you may not use this file except in compliance
* with the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
package org.apache.brooklyn.api.mgmt.rebind.mementos;
import java.io.Serializable;
import java.util.Collection;
import java.util.Map;
/**
* Represents an entire persisted Brooklyn management context, with all its entities and locations.
*
* The referential integrity of this memento is not guaranteed. For example, an entity memento might
* reference a child entity that does not exist. This is an inevitable consequence of not using a
* stop-the-world persistence strategy, and is essential for a distributed brooklyn to be performant.
*
* Code using this memento should be tolerant of such inconsistencies (e.g. log a warning about the
* missing entity, and then ignore dangling references when constructing the entities/locations, so
* that code will not subsequently get NPEs when iterating over children for example).
*
* @author aled
*/
public interface BrooklynMemento extends Serializable {
public EntityMemento getEntityMemento(String id);
public LocationMemento getLocationMemento(String id);
public PolicyMemento getPolicyMemento(String id);
public EnricherMemento getEnricherMemento(String id);
public FeedMemento getFeedMemento(String id);
public CatalogItemMemento getCatalogItemMemento(String id);
public Collection<String> getApplicationIds();
public Collection<String> getTopLevelLocationIds();
public Collection<String> getEntityIds();
public Collection<String> getLocationIds();
public Collection<String> getPolicyIds();
public Collection<String> getEnricherIds();
public Collection<String> getFeedIds();
public Collection<String> getCatalogItemIds();
public Map<String, EntityMemento> getEntityMementos();
public Map<String, LocationMemento> getLocationMementos();
public Map<String, PolicyMemento> getPolicyMementos();
public Map<String, EnricherMemento> getEnricherMementos();
public Map<String, FeedMemento> getFeedMementos();
public Map<String, CatalogItemMemento> getCatalogItemMementos();
}