org.jumpmind.symmetric.route.IDataRouter Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of symmetric-ds Show documentation

SymmetricDS is an open source database synchronization solution. It is platform-independent, web-enabled, and database-agnostic. SymmetricDS was first built to replicate changes between 'retail store' databases and ad centralized 'corporate' database.

The newest version!

/*
 * Licensed to JumpMind Inc under one or more contributor 
 * license agreements.  See the NOTICE file distributed
 * with this work for additional information regarding 
 * copyright ownership.  JumpMind Inc licenses this file
 * to you under the GNU Lesser General Public License (the
 * "License"); you may not use this file except in compliance
 * with the License. 
 * 
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, see           
 * .
 * 
 * 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.jumpmind.symmetric.route;

import java.util.Collection;
import java.util.Set;

import org.jumpmind.symmetric.ext.IExtensionPoint;
import org.jumpmind.symmetric.model.DataMetaData;
import org.jumpmind.symmetric.model.Node;
import org.jumpmind.symmetric.model.OutgoingBatch;

/**
 * The data router is an extension point that allows the end user to target 
 * certain nodes with data changes.  SymmetricDS comes with a build-in data routers like
 * {@link SubSelectDataRouter} and {@link ColumnMatchDataRouter}.
 * 
 * In order to configure a data router you use the router_type and router_expression column on
 * the trigger table. The given Spring bean name of the {@link IDataRouter} is the router_type and 
 * each data router is configured using the routing_expression according to its implementation. 
 * 
 * @since 2.0
 * @see SubSelectDataRouter
 * @see ColumnMatchDataRouter
 *
 * 
 */
public interface IDataRouter extends IExtensionPoint {

    public Collection routeToNodes(IRouterContext context, DataMetaData dataMetaData, Set nodes, boolean initialLoad);
    
    public void completeBatch(IRouterContext context, OutgoingBatch batch);

}