org.red5.server.api.persistence.IPersistenceStore Maven / Gradle / Ivy
/*
* RED5 Open Source Media Server - https://github.com/Red5/
*
* Copyright 2006-2016 by respective authors (see below). All rights reserved.
*
* Licensed 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.red5.server.api.persistence;
import java.util.Collection;
import java.util.Set;
/**
* Storage for persistent objects.
*
* @author The Red5 Project
* @author Luke Hubbard ([email protected])
* @author Joachim Bauch ([email protected])
*/
public interface IPersistenceStore {
/**
* Persist given object.
*
* @param obj
* Object to store
* @return
* true
*
*
* on success,
*
*
* false
*
*
* otherwise
*/
public boolean save(IPersistable obj);
/**
* Load a persistent object with the given name. The object must provide either a constructor that takes an input stream as only parameter or an empty constructor so it can be loaded from the persistence store.
*
* @param name
* the name of the object to load
* @return The loaded object or
*
*
* null
*
*
* if no such object was found
*/
public IPersistable load(String name);
/**
* Load state of an already instantiated persistent object.
*
* @param obj
* the object to initializ
* @return true if the object was initialized, false otherwise
*/
public boolean load(IPersistable obj);
/**
* Delete the passed persistent object.
*
* @param obj
* the object to delete
* @return
* true
*
*
* if object was persisted and thus can be removed,
*
*
* false
*
*
* otherwise
*/
public boolean remove(IPersistable obj);
/**
* Delete the persistent object with the given name.
*
* @param name
* the name of the object to delete
* @return
* true
*
*
* if object was persisted and thus can be removed,
*
*
* false
*
*
* otherwise
*/
public boolean remove(String name);
/**
* Return iterator over the names of all already loaded objects in the storage.
*
* @return Set of all object names
*/
public Set getObjectNames();
/**
* Return iterator over the already loaded objects in the storage.
*
* @return Set of all objects
*/
public Collection getObjects();
/**
* Notify store that it's being closed. This allows the store to write any pending objects to disk.
*/
public void notifyClose();
}