+ * This is the interface for the replication master controller + * service. The master controller service is booted when this instance + * of Derby will have the replication master role for this database. + *
+ *+ * The replication master service is responsible for managing all + * replication related functionality on the master side of replication. + * This includes connecting to the slave, setting up a log buffer to + * temporarily store log records from the LogFactory, and to ship + * these log records to the slave. + *
+ *
+ * The master controller currently only supports asynchronous
+ * replication. This means that there are no guarantees that
+ * transactions that have committed here (the master side) are also
+ * reflected on the slave side. However, the slave version of the
+ * database IS guaranteed to be transaction consistent. This implies
+ * that:
+ *
+ *
Please see Derby on line documentation on backup and restore. Modified: db/derby/code/trunk/java/engine/org/apache/derby/iapi/store/raw/RawStoreFactory.java URL: http://svn.apache.org/viewvc/db/derby/code/trunk/java/engine/org/apache/derby/iapi/store/raw/RawStoreFactory.java?rev=572951&r1=572950&r2=572951&view=diff ============================================================================== --- db/derby/code/trunk/java/engine/org/apache/derby/iapi/store/raw/RawStoreFactory.java (original) +++ db/derby/code/trunk/java/engine/org/apache/derby/iapi/store/raw/RawStoreFactory.java Wed Sep 5 06:38:05 2007 @@ -681,6 +681,20 @@ */ public TransactionInfo[] getTransactionInfo(); + /** + * Start the replication master role for this database + * @param host The hostname for the slave + * @param port The port the slave is listening on + * @param replicationMode The type of replication contract. + * Currently only asynchronous replication is supported, but + * 1-safe/2-safe/very-safe modes may be added later. + * @exception StandardException Standard Derby exception policy, + * thrown on error. + */ + public void startReplicationMaster(String host, int port, + String replicationMode) + throws StandardException; + /** * Freeze the database temporarily so a backup can be taken. *
Please see Derby on line documentation on backup and restore. Modified: db/derby/code/trunk/java/engine/org/apache/derby/impl/db/BasicDatabase.java URL: http://svn.apache.org/viewvc/db/derby/code/trunk/java/engine/org/apache/derby/impl/db/BasicDatabase.java?rev=572951&r1=572950&r2=572951&view=diff ============================================================================== --- db/derby/code/trunk/java/engine/org/apache/derby/impl/db/BasicDatabase.java (original) +++ db/derby/code/trunk/java/engine/org/apache/derby/impl/db/BasicDatabase.java Wed Sep 5 06:38:05 2007 @@ -349,6 +349,25 @@ return this.authenticationService; } + /** + * Start the replication master role for this database + * @param host The hostname for the slave + * @param port The port the slave is listening on + * @param replicationMode The type of replication contract. + * Currently only asynchronous replication is supported, but + * 1-safe/2-safe/very-safe modes may be added later. + * @exception SQLException Thrown on error + */ + public void startReplicationMaster(String host, int port, + String replicationMode) + throws SQLException { + try { + af.startReplicationMaster(host, port, replicationMode); + } catch (StandardException se) { + throw PublicAPI.wrapStandardException(se); + } + } + public void freeze() throws SQLException { try { Added: db/derby/code/trunk/java/engine/org/apache/derby/impl/services/replication/master/MasterController.java URL: http://svn.apache.org/viewvc/db/derby/code/trunk/java/engine/org/apache/derby/impl/services/replication/master/MasterController.java?rev=572951&view=auto ============================================================================== --- db/derby/code/trunk/java/engine/org/apache/derby/impl/services/replication/master/MasterController.java (added) +++ db/derby/code/trunk/java/engine/org/apache/derby/impl/services/replication/master/MasterController.java Wed Sep 5 06:38:05 2007 @@ -0,0 +1,270 @@ +/* + + Derby - Class + org.apache.derby.impl.services.replication.master.MasterController + + 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.derby.impl.services.replication.master; + +import org.apache.derby.iapi.error.StandardException; +import org.apache.derby.iapi.reference.SQLState; +import org.apache.derby.iapi.services.monitor.ModuleControl; +import org.apache.derby.iapi.services.monitor.ModuleSupportable; + +import org.apache.derby.iapi.store.raw.RawStoreFactory; +import org.apache.derby.iapi.store.raw.log.LogFactory; +import org.apache.derby.iapi.store.raw.data.DataFactory; + +import org.apache.derby.iapi.services.replication.master.MasterFactory; +import org.apache.derby.impl.services.replication.buffer.ReplicationLogBuffer; +import org.apache.derby.impl.services.replication.buffer.LogBufferFullException; + +import java.util.Properties; + +/** + *
+ * This is an implementation of the replication master controller + * service. The service is booted when this instance of Derby will + * have the replication master role for this database. + *
+ *+ * Note: The current version of the class is far from complete. Code + * to control the replication master behavior will be added as more + * parts of the replication functionality is added to Derby. + *
+ * + * @see MasterFactory + */ +public class MasterController implements MasterFactory, ModuleControl, + ModuleSupportable { + + private static final int DEFAULT_LOG_BUFFER_SIZE = 32768; //32K + + private RawStoreFactory rawStoreFactory; + private DataFactory dataFactory; + private LogFactory logFactory; + private ReplicationLogBuffer logBuffer; + // waiting for code to go into trunk: + // private LogShipper logShipper; + // private NetworkTransmit connection; + + private String replicationMode; + private String slavehost; + private int slaveport; + + + + /** + * Empty constructor required by Monitor.bootServiceModule + */ + public MasterController() { } + + //////////////////////////////////////////////////////////// + // Implementation of methods from interface ModuleControl // + //////////////////////////////////////////////////////////// + + /** + * Used by Monitor.bootServiceModule to start the service. Will: + * + * Set up basic variables + * Connect to the slave using the network service (DERBY-2921) + * + * Not implemented yet + * + * @param create Currently ignored + * @param properties Properties used to start the service in the + * correct mode + * @exception StandardException Standard Derby exception policy, + * thrown on error. + */ + public void boot(boolean create, Properties properties) + throws StandardException { + + replicationMode = + properties.getProperty(MasterFactory.REPLICATION_MODE); + + slavehost = properties.getProperty(MasterFactory.SLAVE_HOST); + + String port = properties.getProperty(MasterFactory.SLAVE_PORT); + if (port != null) { + slaveport = new Integer(port).intValue(); + } + + // Added when Network Service has been committed to trunk + // connection = new NetworkTransmit(); + + System.out.println("MasterController booted"); + } + + /** + * Will stop the replication master service + * + * Not implemented yet + */ + public void stop() { } + + //////////////////////////////////////////////////////////////// + // Implementation of methods from interface ModuleSupportable // + //////////////////////////////////////////////////////////////// + + /** + * Used by Monitor.bootServiceModule to check if this class is + * usable for replication. To be usable, we require that + * asynchronous replication is specified in startParams by + * checking that a property with key + * MasterFactory.REPLICATION_MODE has the value + * MasterFactory.ASYNCHRONOUS_MODE. + * @param startParams The properties used to boot replication + * @return true if asynchronous replication is requested, meaning + * that this MasterController is a suitable implementation for the + * MasterFactory service. False otherwise + * @see ModuleSupportable#canSupport + */ + public boolean canSupport(Properties startParams) { + String modeParam = + startParams.getProperty(MasterFactory.REPLICATION_MODE); + + // currently only one attribute: asynchronous replication mode + if (modeParam != null && + modeParam.equals(MasterFactory.ASYNCHRONOUS_MODE)) { + return true; + } else { + return false; + } + } + + //////////////////////////////////////////////////////////// + // Implementation of methods from interface MasterFactory // + //////////////////////////////////////////////////////////// + + /** + * Will perform all the work that is needed to set up replication + * + * Not implemented yet + * + * @param rawStore The RawStoreFactory for the database + * @param dataFac The DataFactory for this database + * @param logFac The LogFactory ensuring recoverability for this database + */ + public void startMaster(RawStoreFactory rawStore, + DataFactory dataFac, LogFactory logFac) { + // Added when Network Service has been committed to trunk: + // connection.connect(); // sets up a network connection to the slave + + rawStoreFactory = rawStore; + dataFactory = dataFac; + logFactory = logFac; + logBuffer = new ReplicationLogBuffer(DEFAULT_LOG_BUFFER_SIZE); + // logFactory.setReplicationMaster(this); //added later + + if (replicationMode.equals(MasterFactory.ASYNCHRONOUS_MODE)) { + System.out.println("MasterController would now " + + "start asynchronous log shipping"); + // Added when Master Log Shipping code has been committed to trunk: + // logShipper = new AsynchronousLogShipper(connection); + } + + // Add code that initializes replication by sending the + // database to the slave, making logFactory add logrecords to + // the buffer etc. Repliation should be up and running when + // this method returns. + + System.out.println("MasterController started"); + } + + /** + * Will perform all work that is needed to shut down replication + * + * Not implemented yet + */ + public void stopMaster() { + // logFactory.stopReplicationLogging(); // added later + + // Added when Network Service has been committed to trunk: + // if (connection.isUp()) { + // logShipper.flushAllLog(); + // } + + // logBuffer.stop(); + System.out.println("MasterController stopped"); + } + + /** + * Append a single log record to the replication log buffer. + * + * @param instant the log address of this log record. + * @param dataLength number of bytes in data[] + * @param dataOffset offset in data[] to start copying from. + * @param optionalDataLength number of bytes in optionalData[] + * @param optionalDataOffset offset in optionalData[] to start copy from + * @param data "from" array to copy "data" portion of rec + * @param optionalData "from" array to copy "optional data" from + * + **/ + public void appendLogRecord(long instant, + int dataLength, + int dataOffset, + int optionalDataLength, + int optionalDataOffset, + byte[] data, + byte[] optionalData) { + try { + logBuffer.appendLogRecord(instant, dataLength, dataOffset, + optionalDataLength, optionalDataOffset, + data, optionalData); + } catch (LogBufferFullException lbfe) { + // Waiting for log shipper to implement this + // We have multiple alternatives: + // 1) Try to force-send some log to the slave: + // logShipper.forceFlush() + // 2) Increase the size of the buffer + // Stop replication if both these are unsuccessful or not + // an alternative. + } + } + + /** + * Used by the LogFactory to notify the replication master + * controller that the log records up to this instant have been + * flushed to disk. The master controller takes action according + * to the current replication strategy when this method is called. + * + * When the asynchronous replication strategy is used, the method + * does not force log shipping to the slave; the log records may + * be shipped now or later at the MasterController's discretion. + * + * However, if another strategy like 2-safe replication is + * implemented in the future, a call to this method may force log + * shipment before returning control to the caller. + * + * Currently, only asynchronous replication is supported. + * + * Not implemented yet + * + * @param instant The highest log instant that has been flushed to + * disk + * + * @see MasterFactory#flushedTo + * @see LogFactory#flush + */ + public void flushedTo(long instant) { + // logShipper.flushedTo(instant); + } + +} Propchange: db/derby/code/trunk/java/engine/org/apache/derby/impl/services/replication/master/MasterController.java ------------------------------------------------------------------------------ svn:eol-style = native Modified: db/derby/code/trunk/java/engine/org/apache/derby/impl/store/access/RAMAccessManager.java URL: http://svn.apache.org/viewvc/db/derby/code/trunk/java/engine/org/apache/derby/impl/store/access/RAMAccessManager.java?rev=572951&r1=572950&r2=572951&view=diff ============================================================================== --- db/derby/code/trunk/java/engine/org/apache/derby/impl/store/access/RAMAccessManager.java (original) +++ db/derby/code/trunk/java/engine/org/apache/derby/impl/store/access/RAMAccessManager.java Wed Sep 5 06:38:05 2007 @@ -912,6 +912,22 @@ return rawstore.getTransactionInfo(); } + /** + * Start the replication master role for this database. + * @param host The hostname for the slave + * @param port The port the slave is listening on + * @param replicationMode The type of replication contract. + * Currently only asynchronous replication is supported, but + * 1-safe/2-safe/very-safe modes may be added later. + * @exception StandardException Standard Derby exception policy, + * thrown on error. + */ + public void startReplicationMaster(String host, int port, + String replicationMode) + throws StandardException { + rawstore.startReplicationMaster(host, port, replicationMode); + } + public void freeze() throws StandardException { rawstore.freeze(); Modified: db/derby/code/trunk/java/engine/org/apache/derby/impl/store/raw/RawStore.java URL: http://svn.apache.org/viewvc/db/derby/code/trunk/java/engine/org/apache/derby/impl/store/raw/RawStore.java?rev=572951&r1=572950&r2=572951&view=diff ============================================================================== --- db/derby/code/trunk/java/engine/org/apache/derby/impl/store/raw/RawStore.java (original) +++ db/derby/code/trunk/java/engine/org/apache/derby/impl/store/raw/RawStore.java Wed Sep 5 06:38:05 2007 @@ -88,6 +88,7 @@ import java.security.PrivilegedExceptionAction; import java.lang.SecurityException; +import org.apache.derby.iapi.services.replication.master.MasterFactory; /** A Raw store that implements the RawStoreFactory module by delegating all the @@ -440,6 +441,40 @@ logFactory.checkpoint(this, dataFactory, xactFactory, false); } + /** + * Start the replication master role for this database + * @param host The hostname for the slave + * @param port The port the slave is listening on + * @param replicationMode The type of replication contract. + * Currently only asynchronous replication is supported, but + * 1-safe/2-safe/very-safe modes may be added later. + * @exception StandardException Standard Derby exception policy, + * thrown on error. + */ + public void startReplicationMaster(String host, int port, + String replicationMode) + throws StandardException { + + if (isReadOnly()) { + throw StandardException.newException( + SQLState.CANNOT_REPLICATE_READONLY_DATABASE); + } + + Properties replicationProps = new Properties(); + replicationProps.setProperty(MasterFactory.SLAVE_HOST, host); + replicationProps.setProperty(MasterFactory.SLAVE_PORT, + new Integer(port).toString()); + + replicationProps.setProperty(MasterFactory.REPLICATION_MODE, + replicationMode); + + MasterFactory masterFactory = (MasterFactory) + Monitor.bootServiceModule(true, this, getMasterFactoryModule(), + replicationProps); + masterFactory.startMaster(this, dataFactory, logFactory); + + } + public void freeze() throws StandardException { logFactory.checkpoint(this, dataFactory, xactFactory, true); @@ -1988,6 +2023,11 @@ { return TransactionFactory.MODULE; } + + public String getMasterFactoryModule() + { + return MasterFactory.MODULE; + } public String getDataFactoryModule() { Modified: db/derby/code/trunk/java/engine/org/apache/derby/loc/messages.xml URL: http://svn.apache.org/viewvc/db/derby/code/trunk/java/engine/org/apache/derby/loc/messages.xml?rev=572951&r1=572950&r2=572951&view=diff ============================================================================== --- db/derby/code/trunk/java/engine/org/apache/derby/loc/messages.xml (original) +++ db/derby/code/trunk/java/engine/org/apache/derby/loc/messages.xml Wed Sep 5 06:38:05 2007 @@ -4670,6 +4670,10 @@