001: /*
002: * JBoss, Home of Professional Open Source.
003: * Copyright 2006, Red Hat Middleware LLC, and individual contributors
004: * as indicated by the @author tags. See the copyright.txt file in the
005: * distribution for a full listing of individual contributors.
006: *
007: * This is free software; you can redistribute it and/or modify it
008: * under the terms of the GNU Lesser General Public License as
009: * published by the Free Software Foundation; either version 2.1 of
010: * the License, or (at your option) any later version.
011: *
012: * This software is distributed in the hope that it will be useful,
013: * but WITHOUT ANY WARRANTY; without even the implied warranty of
014: * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
015: * Lesser General Public License for more details.
016: *
017: * You should have received a copy of the GNU Lesser General Public
018: * License along with this software; if not, write to the Free
019: * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
020: * 02110-1301 USA, or see the FSF site: http://www.fsf.org.
021: */
022: package org.jboss.jdbc;
023:
024: import javax.management.ObjectName;
025:
026: import org.jboss.mx.util.ObjectNameFactory;
027: import org.jboss.system.ServiceMBean;
028:
029: /**
030: * MBean interface.
031: *
032: * In all cases we run Hypersonic in the same VM with JBoss.
033: * A few notes on Hypersonic running modes:
034: *
035: * remote (server) mode
036: * hsqldb will listen for connections from local/remote clients
037: *
038: * in-process (standalone) mode
039: * hsqldb can only be contacted from in-vm clients
040: *
041: * memory-only mode
042: * hsqldb will only keep tables in memory, no persistence of data
043: *
044: * @version $Revision: 57210 $
045: */
046: public interface HypersonicDatabaseMBean extends ServiceMBean {
047: /** The default ObjectName */
048: ObjectName OBJECT_NAME = ObjectNameFactory
049: .create("jboss:service=Hypersonic");
050:
051: // Attributes ----------------------------------------------------
052:
053: /** The silent flag, default is 'true' */
054: boolean getSilent();
055:
056: void setSilent(boolean silent);
057:
058: /** The trace flag, default is 'false' */
059: boolean getTrace();
060:
061: void setTrace(boolean trace);
062:
063: /** The database name, default is 'default' */
064: String getDatabase();
065:
066: void setDatabase(String name);
067:
068: /** The listening port when in remove server mode, default is '1701' */
069: int getPort();
070:
071: void setPort(int port);
072:
073: /** The binding address, default is '0.0.0.0' */
074: String getBindAddress();
075:
076: void setBindAddress(String address);
077:
078: /** Whether remote server mode hypersonic should avoid calling System.exit() on shutdown, default is 'true'
079: By far, the worse mbean attribute name */
080: boolean getNo_system_exit();
081:
082: void setNo_system_exit(boolean no_system_exit);
083:
084: /** Whether DB is persisted, default is 'true'. A false value will activate memory only mode. */
085: boolean getPersist();
086:
087: void setPersist(boolean persist);
088:
089: /** Whether DB is in in-process mode or remote server mode, default is 'false' */
090: boolean isInProcessMode();
091:
092: void setInProcessMode(boolean b);
093:
094: /** The default user to use when connecting to the DB, default is "sa" */
095: String getUser();
096:
097: void setUser(String user);
098:
099: /** The default password to use when connecting to the DB, default is "" */
100: String getPassword();
101:
102: void setPassword(String password);
103:
104: /** The shutdown command to use when stopping the DB */
105: String getShutdownCommand();
106:
107: void setShutdownCommand(String string);
108:
109: /** The database manager (UI) class, default is 'org.hsqldb.util.DatabaseManagerSwing' */
110: String getDatabaseManagerClass();
111:
112: void setDatabaseManagerClass(String databaseManagerClass);
113:
114: /** The full database path */
115: String getDatabasePath();
116:
117: // Operations ----------------------------------------------------
118:
119: /**
120: * Start DatabaseManager accessible from the management console.
121: */
122: void startDatabaseManager();
123:
124: }
|