| /* |
| * 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.openjpa.slice; |
| |
| import java.util.List; |
| |
| import org.apache.openjpa.conf.OpenJPAConfiguration; |
| |
| /** |
| * A configuration for multiple data stores, each referred as <em>slice</em>. |
| * This configuration allows each underlying slice be configured with its |
| * own specific configuration properties such as JDBC Driver or connection |
| * user/password etc. <br> |
| * This configuration also extends by adding a {@link DistributionPolicy |
| * DistributionPolicy} that governs how new instances be distributed |
| * among the slices. |
| * |
| * @author Pinaki Poddar |
| * |
| */ |
| public interface DistributedConfiguration extends OpenJPAConfiguration { |
| /** |
| * Gets the active slice identifiers. This list is determined by the |
| * configuration properties either by explicit listing in |
| * <code>openjpa.slice.Names</code> property or by scanning |
| * <code>openjpa.slice.*.*</code> properties. |
| * <br> |
| * The ordering of the slice identifiers is determined when they are |
| * specified explicitly in <code>openjpa.slice.Names</code> property or |
| * ordered alphabetically when found by scanning the properties. |
| * <br> |
| * This list always returns the identifiers that are <em>active</em>, slices |
| * that can not be connected to are not included in this list. |
| */ |
| List<String> getActiveSliceNames(); |
| |
| /** |
| * Gets the available slice identifiers irrespective of their status. |
| * @return |
| */ |
| List<String> getAvailableSliceNames(); |
| |
| |
| /** |
| * Gets the slices of given status. |
| * @param statuses list of status flags. If null, returns all slices |
| * irrespective of status. |
| */ |
| List<Slice> getSlices(Slice.Status...statuses); |
| |
| /** |
| * Gets the Slice for a given name. |
| * Exception is raised if the given slice is not configured. |
| */ |
| Slice getSlice(String sliceName); |
| |
| /** |
| * Gets the policy that governs how new instances will be distributed across |
| * the available slices. |
| */ |
| DistributionPolicy getDistributionPolicyInstance(); |
| } |