org.glassfish.hk2.configuration.hub.api.Hub Maven / Gradle / Ivy
/*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
*
* Copyright (c) 2014 Oracle and/or its affiliates. All rights reserved.
*
* The contents of this file are subject to the terms of either the GNU
* General Public License Version 2 only ("GPL") or the Common Development
* and Distribution License("CDDL") (collectively, the "License"). You
* may not use this file except in compliance with the License. You can
* obtain a copy of the License at
* https://glassfish.dev.java.net/public/CDDL+GPL_1_1.html
* or packager/legal/LICENSE.txt. See the License for the specific
* language governing permissions and limitations under the License.
*
* When distributing the software, include this License Header Notice in each
* file and include the License file at packager/legal/LICENSE.txt.
*
* GPL Classpath Exception:
* Oracle designates this particular file as subject to the "Classpath"
* exception as provided by Oracle in the GPL Version 2 section of the License
* file that accompanied this code.
*
* Modifications:
* If applicable, add the following below the License Header, with the fields
* enclosed by brackets [] replaced by your own identifying information:
* "Portions Copyright [year] [name of copyright owner]"
*
* Contributor(s):
* If you wish your version of this file to be governed by only the CDDL or
* only the GPL Version 2, indicate your decision by adding "[Contributor]
* elects to include this software in this distribution under the [CDDL or GPL
* Version 2] license." If you don't indicate a single choice of license, a
* recipient has the option to distribute your version of this file under
* either the CDDL, the GPL Version 2 or to extend the choice of license to
* its licensees as provided above. However, if you add GPL Version 2 code
* and therefore, elected the GPL Version 2 license, then the option applies
* only if the new code is made subject to such option by the copyright
* holder.
*/
package org.glassfish.hk2.configuration.hub.api;
import org.jvnet.hk2.annotations.Contract;
/**
* The central repository of configuration objects in the system.
* Configuration objects are organized by type, and within
* that type keyed instances of the configuration object.
*
* A configuration object can be a java bean following
* the java bean standard. A configuration object
* can also be a bean-like Map, which is a Map<String,Object>
* that has as keys the names of the properties and as
* values value that property should take
*
* @author jwells
*
*/
@Contract
public interface Hub {
/**
* Gets the current database running in the system
*
* @return The current database known to the Hub
*/
public BeanDatabase getCurrentDatabase();
/**
* Creates a writeable copy of the currently running
* database. If the {@link WriteableBeanDatabase#commit()}
* method is called (and no other {@link WriteableBeanDatabase#commit()}
* method has been called) then a read-only copye of the
* {@link WriteableBeanDatabase} will become the current database.
* There is no requirement to eventually call the
* {@link WriteableBeanDatabase#commit()} method
*
* @return A writeable copy of the current database
*/
public WriteableBeanDatabase getWriteableDatabaseCopy();
}