Author: shawkins Date: 2010-03-04 13:28:17 -0500 (Thu, 04 Mar 2010) New Revision: 1905 Added: trunk/client/src/test/java/org/ trunk/client/src/test/java/org/teiid/ trunk/client/src/test/java/org/teiid/adminapi/ trunk/client/src/test/java/org/teiid/netty/ trunk/client/src/test/java/org/teiid/netty/handler/ trunk/client/src/test/java/org/teiid/netty/handler/codec/ Removed: trunk/client/src/main/java/org/teiid/adminapi/AdminOptions.java trunk/client/src/main/java/org/teiid/adminapi/Cache.java trunk/client/src/main/java/org/teiid/adminapi/ConfigurationAdmin.java trunk/client/src/main/java/org/teiid/adminapi/ConnectionPool.java trunk/client/src/main/java/org/teiid/adminapi/ConnectorType.java trunk/client/src/main/java/org/teiid/adminapi/EmbeddedLogger.java trunk/client/src/main/java/org/teiid/adminapi/ExtensionModule.java trunk/client/src/main/java/org/teiid/adminapi/Group.java trunk/client/src/main/java/org/teiid/adminapi/MonitoringAdmin.java trunk/client/src/main/java/org/teiid/adminapi/QueueWorkerPool.java trunk/client/src/main/java/org/teiid/adminapi/Role.java trunk/client/src/main/java/org/teiid/adminapi/RuntimeStateAdmin.java trunk/client/src/main/java/org/teiid/adminapi/SecurityAdmin.java Log: TEIID-833 committing JCA merge Deleted: trunk/client/src/main/java/org/teiid/adminapi/AdminOptions.java =================================================================== --- trunk/client/src/main/java/org/teiid/adminapi/AdminOptions.java 2010-03-04 18:25:21 UTC (rev 1904) +++ trunk/client/src/main/java/org/teiid/adminapi/AdminOptions.java 2010-03-04 18:28:17 UTC (rev 1905) @@ -1,195 +0,0 @@ -/* - * JBoss, Home of Professional Open Source. - * See the COPYRIGHT.txt file distributed with this work for information - * regarding copyright ownership. Some portions may be licensed - * to Red Hat, Inc. under one or more contributor license agreements. - * - * This library is free software; you can redistribute it and/or - * modify it under the terms of the GNU Lesser General Public - * License as published by the Free Software Foundation; either - * version 2.1 of the License, or (at your option) any later version. - * - * This library is distributed in the hope that it will be useful, - * but WITHOUT ANY WARRANTY; without even the implied warranty of - * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU - * Lesser General Public License for more details. - * - * You should have received a copy of the GNU Lesser General Public - * License along with this library; if not, write to the Free Software - * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA - * 02110-1301 USA. - */ - -package org.teiid.adminapi; - -import java.io.Serializable; - -import com.metamatrix.admin.AdminPlugin; - - -/** - * Creates, collects and stores option values for evaluation when - * executing methods where decisions should be made based on user preferences. - * <p> - * Method of use is to create with an option and use the method {@link #addOption(int)} - * when more than one option is wished or required.</p> - * <p> - * <b>Example:</b> - * <pre> - * AdminOptions options = new AdminOptions(AdminOptions.OnConflict.OVERWRITE); - * options.addOption(BINDINGS_IGNORE_DECRYPT_ERROR); - * </pre></p> - * @since 4.3 - */ -public class AdminOptions implements Serializable { - - // ************************************************************************* - // When adding an option to this interface, don't forget to - // add the corresponding string to the toString() method - // and to the ALLOWABLE_OPTIONS bitmask below. - // ************************************************************************* - private static final long serialVersionUID = 2809137776857876224L; - - /** - * In the case when adding resource to the system, if the resource already - * exists in the system, these modes define how to handle the situation. - */ - public interface OnConflict { - - /** - * Add all bindings in this file and overwrite any - * bindings that already exist in the system. - * <p><b>NOTE</b>: This will result in a {@link VDB} with - * a status of {@link VDB#INACTIVE} or - * {@link VDB#ACTIVE}.</p> - */ - public static final int OVERWRITE= 1; - - /** - * Don't add any existing bindings contained in this file - * (don't update/replace ones that already exist). This - * will <i>not</i> keep any new bindings specified from being - * added. - * <p><b>NOTE</b>: This will result in a {@link VDB} with - * a status of {@link VDB#INACTIVE} or - * {@link VDB#ACTIVE}.</p> - */ - public static final int IGNORE = 2; - - /** - * If there is conflict in the bindings then return with - * an exception - * <p><b>NOTE</b>: This will result in a {@link VDB} with - * a status of {@link VDB#INCOMPLETE} if all models in - * the VDB are not bound.</p> - */ - public static final int EXCEPTION = 4; - } - - /** - * Connector bindings have encrypted passwords as connection - * properties. If the password property cannot be decrypted, - * the connector binding will not start until the connector - * binding password property is changed. - * <p>Adding a VDB with this option allows the VDB and its - * connector bindings to be added and persisted to the system - * configuration, even if the connector binding properties - * cannot be decrypted. Users should set the password property - * on all connectors added after using this option.</p> - * <p><b>NOTE</b>: This will result in a {@link VDB} with - * a status of {@link VDB#INACTIVE}.</p> - */ - public static final int BINDINGS_IGNORE_DECRYPT_ERROR = 8; - -// ======================================================================================= -// End Options Interface -// ======================================================================================= - - private static final int ALLOWABLEOPTIONS = OnConflict.OVERWRITE | - OnConflict.IGNORE | - OnConflict.EXCEPTION | - BINDINGS_IGNORE_DECRYPT_ERROR; - - // A bitmask for multiple options - private int optionsMask; - - /** - * Construct with an option. For available options, see - * {@link AdminOptions}. - * <p> - * <b>Note</b>: A RutimeException is thrown for any option given - * that is not found in the interface.</p> - * - * @param option One of the available options in {@link AdminOptions}. - * @throws RuntimeException for any option given that is not - * found in the interface. - * @since 4.3 - */ - public AdminOptions(int option) throws RuntimeException { - super(); - - addOption(option); - } - - /** - * Add an option to this object if multiple options are required. - * <p> - * <b>Note</b>: A RutimeException is thrown for any option given - * that is not found in the interface.</p> - * - * @param anOption the option to add. - * @throws RuntimeException for any option given that is not - * found in the interface. - * @since 4.3 - */ - public void addOption(int anOption) { - if (anOption != 0 && (ALLOWABLEOPTIONS & anOption) == anOption) { - this.optionsMask |= anOption; - } else { - throw new RuntimeException(AdminPlugin.Util.getString("AdminOptions.Unknown_option", new Object[] {"" + anOption})); //$NON-NLS-1$ //$NON-NLS-2$ - } - } - - /** - * Check if the given option was specified. - * - * @param anOption the option to check. - * @return <code>true</true> iff this opject contains the - * geven option. - * @since 4.3 - */ - public boolean containsOption(int anOption) { - return (this.optionsMask & anOption) == anOption; - } - - /** - * @see java.lang.Object#toString() - * @since 4.3 - */ - public String toString() { - StringBuffer optionString = new StringBuffer("["); //$NON-NLS-1$ - - if ( (optionsMask & OnConflict.OVERWRITE) == OnConflict.OVERWRITE ) { - optionString.append("OnConflict_OVERWRITE, "); //$NON-NLS-1$ - } - if ( (optionsMask & OnConflict.IGNORE) == OnConflict.IGNORE ) { - optionString.append("OnConflict_IGNORE, "); //$NON-NLS-1$ - } - if ( (optionsMask & OnConflict.EXCEPTION) == OnConflict.EXCEPTION ) { - optionString.append("OnConflict_EXCEPTION, "); //$NON-NLS-1$ - } - if ( (optionsMask & BINDINGS_IGNORE_DECRYPT_ERROR) == BINDINGS_IGNORE_DECRYPT_ERROR ) { - optionString.append("BINDINGS_IGNORE_DECRYPT_ERROR, "); //$NON-NLS-1$ - } - - if ( optionString.length() == 1 ) { - optionString.append("UNKNOWN"); //$NON-NLS-1$ - } else if (optionString.length() > 2 && optionString.charAt(optionString.length() - 2) == ',' ) { - optionString.setLength(optionString.length() - 2); - } - - optionString.append(']'); - return optionString.toString(); - } - -} Deleted: trunk/client/src/main/java/org/teiid/adminapi/Cache.java =================================================================== --- trunk/client/src/main/java/org/teiid/adminapi/Cache.java 2010-03-04 18:25:21 UTC (rev 1904) +++ trunk/client/src/main/java/org/teiid/adminapi/Cache.java 2010-03-04 18:28:17 UTC (rev 1905) @@ -1,54 +0,0 @@ -/* - * JBoss, Home of Professional Open Source. - * See the COPYRIGHT.txt file distributed with this work for information - * regarding copyright ownership. Some portions may be licensed - * to Red Hat, Inc. under one or more contributor license agreements. - * - * This library is free software; you can redistribute it and/or - * modify it under the terms of the GNU Lesser General Public - * License as published by the Free Software Foundation; either - * version 2.1 of the License, or (at your option) any later version. - * - * This library is distributed in the hope that it will be useful, - * but WITHOUT ANY WARRANTY; without even the implied warranty of - * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU - * Lesser General Public License for more details. - * - * You should have received a copy of the GNU Lesser General Public - * License along with this library; if not, write to the Free Software - * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA - * 02110-1301 USA. - */ - -package org.teiid.adminapi; - - -/** - * Represents a cache in the MetaMatrix system. - * - * <p>An idetiifer for cache is specifically represented by a name. All the - * different kinds of available cache are listed as enumerations on this interface. - * </p> - * @since 4.3 - */ -public interface Cache extends - AdminObject { - - /** - * - */ - public static final String CODE_TABLE_CACHE = "CodeTableCache"; //$NON-NLS-1$ - /** - * - */ - public static final String PREPARED_PLAN_CACHE = "PreparedPlanCache"; //$NON-NLS-1$ - /** - * - */ - public static final String QUERY_SERVICE_RESULT_SET_CACHE = "QueryServiceResultSetCache"; //$NON-NLS-1$ - /** - * - */ - public static final String CONNECTOR_RESULT_SET_CACHE = "ConnectorResultSetCache"; //$NON-NLS-1$ - -} Deleted: trunk/client/src/main/java/org/teiid/adminapi/ConfigurationAdmin.java =================================================================== --- trunk/client/src/main/java/org/teiid/adminapi/ConfigurationAdmin.java 2010-03-04 18:25:21 UTC (rev 1904) +++ trunk/client/src/main/java/org/teiid/adminapi/ConfigurationAdmin.java 2010-03-04 18:28:17 UTC (rev 1905) @@ -1,360 +0,0 @@ -/* - * JBoss, Home of Professional Open Source. - * See the COPYRIGHT.txt file distributed with this work for information - * regarding copyright ownership. Some portions may be licensed - * to Red Hat, Inc. under one or more contributor license agreements. - * - * This library is free software; you can redistribute it and/or - * modify it under the terms of the GNU Lesser General Public - * License as published by the Free Software Foundation; either - * version 2.1 of the License, or (at your option) any later version. - * - * This library is distributed in the hope that it will be useful, - * but WITHOUT ANY WARRANTY; without even the implied warranty of - * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU - * Lesser General Public License for more details. - * - * You should have received a copy of the GNU Lesser General Public - * License along with this library; if not, write to the Free Software - * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA - * 02110-1301 USA. - */ - -package org.teiid.adminapi; - -import java.util.Properties; - -import com.metamatrix.admin.RolesAllowed; - - -/** - * This interface describes the methods to configure Teiid. - * - * @since 4.3 - */ -(a)RolesAllowed(value=AdminRoles.RoleName.ADMIN_SYSTEM) -public interface ConfigurationAdmin { - - /** - * Assign a {@link ConnectorBinding} to a {@link VDB}'s Model - * - * @param connectorBindingName - * Name of the ConnectorBinding - * @param vdbName - * Name of the VDB - * @param vdbVersion - * Version of the VDB - * @param modelName - * Name of the Model to map Connector Binding - * @throws AdminException - * if there's a system error or if there's a user input error. - * @since 4.3 - */ - void assignBindingToModel(String connectorBindingName, - String vdbName, - String vdbVersion, - String modelName) throws AdminException; - - void assignBindingsToModel(String[] connectorBindingName, - String vdbName, - String vdbVersion, - String modelName) throws AdminException; - - /** - * Set/update the property for the Connector Binding identified by the given deployed name. - * @param deployedName - * @param propertyName - * @param propertyValue - * @throws AdminException - */ - void setConnectorBindingProperty(String deployedName, String propertyName, String propertyValue) throws AdminException; - - /** - * Add Connector Type, will import Connector Type from a file - * - * @param name - * of the Connector Type to add - * @param cdkFile - * contents of File from Client - * @throws AdminException - * if there's a system error. - * @since 4.3 - */ - void addConnectorType(String name, char[] cdkFile) throws AdminException; - - /** - * Add Connector Type and all the required extension modules required by the - * this connector type into the system from the given file byte stream which is - * encoded inthe Connector Archive format. - * - * @param archiveContents contents of File - * @param options resolution option in case of conflict in the connector type - * @throws AdminException if there's a system error. - * @since 4.3.2 - */ - void addConnectorArchive(byte[] archiveContents, AdminOptions options ) throws AdminException; - - /** - * Delete Connector Type from Next Configuration - * - * @param name String name of the Connector Type to delete - * @throws AdminException - * if there's a system error. - * @since 4.3 - */ - void deleteConnectorType(String name) throws AdminException; - - /** - * Deploy a {@link ConnectorBinding} to Configuration - * - * @param name - * is the Connector Binding name that will be added to Configuration - * @param connectorTypeIdentifier - * Name of the Connector Type - * @param properties - * Name & Value pair need to deploy the Connector Binding - * @param options The perferred options when executing this method. There are choices about - * what to do when a connector binding with the given identifier already exists in the system. - * See the interface {@link AdminOptions.OnConflict} for details. - * <p> - * Another option is to ignore a binding connection password decrypt error, when adding a connector - * binding whose password was encrypted with a different keystore, so that the new password property - * can be set after the connector binding has been added.</p> - * @throws AdminException - * if there's a system error. - * @return the {@link ConnectorBinding} representing the current property values and runtime state. - * Note that if this is a system with multiple Processes, this method may actually create multiple deployed - * Connector Bindings (one for each process). This method will return one of them, arbitrarily. - * @since 4.3 - */ - ConnectorBinding addConnectorBinding(String name, - String connectorTypeIdentifier, - Properties properties, AdminOptions options) throws AdminException; - - /** - * Import a {@link ConnectorBinding} into the Configuration. - * - * @param name - * is the Connector Binding name that will be added to Configuration - * @param xmlFile - * contents of XML file that will be sent to the server. - * @param options The perferred options when executing this method. There are choices about - * what to do when a connector binding with the given identifier already exists in the system. - * See the interface {@link AdminOptions.OnConflict} for details. - * <p> - * Another option is to ignore a binding connection password decrypt error, when adding a connector - * binding whose password was encrypted with a different keystore, so that the new password property - * can be set after the connector binding has been added.</p> - * @throws AdminException - * if there's a system error. - * @return the {@link ConnectorBinding} representing the current property values and runtime state. - * Note that if this is a system with multiple Processes, this method may actually create multiple deployed - * Connector Bindings (one for each process). This method will return one of them, arbitrarily. - * @since 4.3 - */ - ConnectorBinding addConnectorBinding(String name, - char[] xmlFile, AdminOptions options) throws AdminException; - - /** - * Delete the {@link ConnectorBinding} from the Configuration - * - * @param connectorBindingIdentifier - * @throws AdminException - * if there's a system error. - * @since 4.3 - */ - void deleteConnectorBinding(String connectorBindingIdentifier) throws AdminException; - - /** - * Import a {@link VDB} file. - * <br>A VDB file with internal definitions. Thise is the default VDB export configuration - * begining with MetaMatrix version 4.3.</br> - * - * @param name - * VDB Name - * @param vdbFile - * byte array of the VDB Archive - * @param options The perferred options when executing this method. There are choices about - * what to do when a connector binding with the given identifier already exists in the system. - * @throws AdminException - * if there's a system error. - * @return the {@link VDB} representing the current property values and runtime state. - * @since 4.3 - */ - VDB addVDB(String name, - byte[] vdbFile, AdminOptions options) throws AdminException; - - - /** - * Delete the VDB with the given name and version - * @param vdbName - * @param version - * @throws AdminException - */ - void deleteVDB(String vdbName, String version) throws AdminException; - - /** - * Get the {@link LogConfiguration} - * - * @return LogConfiguration object - * @throws AdminException - * if there's a system error. - * @since 4.3 - */ - @RolesAllowed(value=AdminRoles.RoleName.ADMIN_READONLY) - LogConfiguration getLogConfiguration() throws AdminException; - - /** - * Set the {@link LogConfiguration} in the MetaMatrix Server - * - * @param config - * @throws AdminException - * if there's a system error. - * @since 4.3 - */ - void setLogConfiguration(LogConfiguration config) throws AdminException; - - - /** - * Set the log listener to install into MM Query. This log listener will receive all log messages - * written by the MM Query at it's current log level and log contexts. - * - * Note: Logging changes are not persistent. This will be fixed in future versions. - * - * @param listener The listener component - * @throws AdminException if there's a system error. - * @since 4.3 - */ - void setLogListener(EmbeddedLogger listener) throws AdminException; - - /** - * Adds an {@link ExtensionModule} to the end of the list of modules. - * <br><i>All caches (of Class objects) are cleared.</i></br> - * - * @param type - * one of the known types of extension file - * @param sourceName - * name (e.g. filename) of extension module - * @param source - * actual contents of module - * @param description - * (optional) description of the extension module - may be null - * @throws AdminException - * if there's a system error. - * @since 4.3 - */ - void addExtensionModule(String type, - String sourceName, - byte[] source, - String description) throws AdminException; - - /** - * Deletes an {@link ExtensionModule} from the list of modules. - * <br><i>All caches (of Class objects) are cleared.</i></br> - * - * @param sourceName - * name (e.g. filename) of extension module - * @throws AdminException - * if there's a system error. - */ - void deleteExtensionModule(String sourceName) throws AdminException; - - /** - * Export an {@link ExtensionModule} to byte array - * - * @param sourceName unique identifier for the {@link ExtensionModule}. - * @return byte array of the extension module - * @throws AdminException - * @since 4.3 - */ - byte[] exportExtensionModule(String sourceName) throws AdminException; - - /** - * Export Configuration to character Array in XML format - * - * @return character array of Configuration - * @throws AdminException - * if there's a system error. - * @since 4.3 - */ - char[] exportConfiguration() throws AdminException; - - /** - * Export a {@link ConnectorBinding} to character Array in XML format - * - * @param connectorBindingIdentifier the unique identifier for a {@link ConnectorBinding}. - * @return character Array in XML format - * @throws AdminException - * if there's a system error. - * @since 4.3 - */ - char[] exportConnectorBinding(String connectorBindingIdentifier) throws AdminException; - - /** - * Export Connector Type to character array - * - * @param connectorTypeIdentifier the unique identifier for for a {@link ConnectorType} - * @return character Array in XML format - * @throws AdminException - * if there's a system error. - * @since 4.3 - */ - char[] exportConnectorType(String connectorTypeIdentifier) throws AdminException; - - /** - * Export Connector Archive, which is bundled connector type with its xml - * properties file and all the extension modules required by the this connector type - * - * @param connectorTypeIdentifier the unique identifier for for a {@link ConnectorType} - * @return byte array of the connector archive. - * @throws AdminException if there's a system error. - * @since 4.3.2 - */ - byte[] exportConnectorArchive(String connectorTypeIdentifier) throws AdminException; - - /** - * Export VDB to byte array - * - * @param name identifier of the {@link VDB} - * @param version {@link VDB} version - * @return byte array of the MetaMatrix VDB Archive - * @throws AdminException - * if there's a system error. - * @since 4.3 - */ - byte[] exportVDB(String name, String version) throws AdminException; - - - /** - * Add User Defined Function model to the system. If one is already deployed before this - * will replace the previous, otherwise add this as the new UDF model. Once the UDF is added - * the new UDF model is loaded. - * @param modelFileContents - UDF contents - * @param classpath - classpath for the UDF - * @throws AdminException - */ - void addUDF(byte[] modelFileContents, String classpath) throws AdminException; - - /** - * Delete the User Defined Function model. Note that this will not delete any supporting - * extension jar files added, those need to be deleted separately. - * @throws AdminException - */ - void deleteUDF() throws AdminException; - - /** - * Indicates that an extension module has changed - * @throws AdminException - * @since 6.1.0 - */ - void extensionModuleModified(String name) throws AdminException; - - - /** - * Set a process level property. - * @param processIdentifier - identifier for the process where the property needs to be set - * @param propertyName - name of the property - * @param propertyValue - value of the property - */ - void setProcessProperty(String processIdentifier, String propertyName, String propertyValue) throws AdminException; -} Deleted: trunk/client/src/main/java/org/teiid/adminapi/ConnectionPool.java =================================================================== --- trunk/client/src/main/java/org/teiid/adminapi/ConnectionPool.java 2010-03-04 18:25:21 UTC (rev 1904) +++ trunk/client/src/main/java/org/teiid/adminapi/ConnectionPool.java 2010-03-04 18:28:17 UTC (rev 1905) @@ -1,73 +0,0 @@ -/* - * JBoss, Home of Professional Open Source. - * See the COPYRIGHT.txt file distributed with this work for information - * regarding copyright ownership. Some portions may be licensed - * to Red Hat, Inc. under one or more contributor license agreements. - * - * This library is free software; you can redistribute it and/or - * modify it under the terms of the GNU Lesser General Public - * License as published by the Free Software Foundation; either - * version 2.1 of the License, or (at your option) any later version. - * - * This library is distributed in the hope that it will be useful, - * but WITHOUT ANY WARRANTY; without even the implied warranty of - * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU - * Lesser General Public License for more details. - * - * You should have received a copy of the GNU Lesser General Public - * License along with this library; if not, write to the Free Software - * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA - * 02110-1301 USA. - */ - -package org.teiid.adminapi; - -import java.io.Serializable; - - -/** - * This object holds the statistics for a ConnectionPool that is being utilized by a Connector. - * As per how many available connections - * processed etc. - * <p>An identifier for ConnectionPool, is nothing but the modules it self, like "DQP", - * "QueryService" or Connector Binding names etc.</p> - * - * @since 4.3 - */ -public interface ConnectionPool extends Serializable { - /** - * @return Returns total number of current connections in the Connection Pool - */ - int getTotalConnections(); - - /** - * @return Returns the number of connections waiting for use in the connection pool. - */ - int getConnectionsWaiting(); - - /** - * @return Returns the number of Connections currently in use by clients. - */ - int getConnectionsInuse(); - - /** - * @return Returns the number of Connections created since the Connection Pool was created. - */ - long getConnectionsCreated(); - - /** - * @return The number of Connections destroyed since the Connection Pool was created. - */ - long getConnectionsDestroyed(); - - /** - * @return true if this represents an XA connection pool - */ - boolean isXAPoolType(); - - /** - * @return the identifier of the connector binding this pool is used with - */ - String getConnectorBindingIdentifier(); - -} Deleted: trunk/client/src/main/java/org/teiid/adminapi/ConnectorType.java =================================================================== --- trunk/client/src/main/java/org/teiid/adminapi/ConnectorType.java 2010-03-04 18:25:21 UTC (rev 1904) +++ trunk/client/src/main/java/org/teiid/adminapi/ConnectorType.java 2010-03-04 18:28:17 UTC (rev 1905) @@ -1,40 +0,0 @@ -/* - * JBoss, Home of Professional Open Source. - * See the COPYRIGHT.txt file distributed with this work for information - * regarding copyright ownership. Some portions may be licensed - * to Red Hat, Inc. under one or more contributor license agreements. - * - * This library is free software; you can redistribute it and/or - * modify it under the terms of the GNU Lesser General Public - * License as published by the Free Software Foundation; either - * version 2.1 of the License, or (at your option) any later version. - * - * This library is distributed in the hope that it will be useful, - * but WITHOUT ANY WARRANTY; without even the implied warranty of - * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU - * Lesser General Public License for more details. - * - * You should have received a copy of the GNU Lesser General Public - * License along with this library; if not, write to the Free Software - * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA - * 02110-1301 USA. - */ - -package org.teiid.adminapi; - - -/** - * Represents a connector type in the MetaMatrix system. - * - * <p>{@link ConnectorBinding}s are instances of a connector type.</p> - * - * <p>The identifier pattern for a connector type is simply the name - * of the connector type. Usally name consistes of multiple words with spaces in between - * for example: "Loopback Connector" - * </p> - * - * @since 4.3 - */ -public interface ConnectorType extends AdminObject { - -} Deleted: trunk/client/src/main/java/org/teiid/adminapi/EmbeddedLogger.java =================================================================== --- trunk/client/src/main/java/org/teiid/adminapi/EmbeddedLogger.java 2010-03-04 18:25:21 UTC (rev 1904) +++ trunk/client/src/main/java/org/teiid/adminapi/EmbeddedLogger.java 2010-03-04 18:28:17 UTC (rev 1905) @@ -1,44 +0,0 @@ -/* - * JBoss, Home of Professional Open Source. - * See the COPYRIGHT.txt file distributed with this work for information - * regarding copyright ownership. Some portions may be licensed - * to Red Hat, Inc. under one or more contributor license agreements. - * - * This library is free software; you can redistribute it and/or - * modify it under the terms of the GNU Lesser General Public - * License as published by the Free Software Foundation; either - * version 2.1 of the License, or (at your option) any later version. - * - * This library is distributed in the hope that it will be useful, - * but WITHOUT ANY WARRANTY; without even the implied warranty of - * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU - * Lesser General Public License for more details. - * - * You should have received a copy of the GNU Lesser General Public - * License along with this library; if not, write to the Free Software - * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA - * 02110-1301 USA. - */ - -package org.teiid.adminapi; - - -/** - * Custom logging interface that provides a hook for custom implementations to log messages - * produced by MM Query. - * @since 4.3 - */ -public interface EmbeddedLogger { - - /** - * Logs the given message if the current logging level is &gt;= the logLevel parameter. - * @param logLevel logging level for this message - * @param timestamp timestamp at which this log message was generated - * @param componentName name of the component that generated this message - * @param threadName name of the thread that generated this message - * @param message message body. May be null. - * @param throwable exception thrown. May be null. - * @since 4.3 - */ - void log(int logLevel, long timestamp, String componentName, String threadName, String message, Throwable throwable); -} Deleted: trunk/client/src/main/java/org/teiid/adminapi/ExtensionModule.java =================================================================== --- trunk/client/src/main/java/org/teiid/adminapi/ExtensionModule.java 2010-03-04 18:25:21 UTC (rev 1904) +++ trunk/client/src/main/java/org/teiid/adminapi/ExtensionModule.java 2010-03-04 18:28:17 UTC (rev 1905) @@ -1,103 +0,0 @@ -/* - * JBoss, Home of Professional Open Source. - * See the COPYRIGHT.txt file distributed with this work for information - * regarding copyright ownership. Some portions may be licensed - * to Red Hat, Inc. under one or more contributor license agreements. - * - * This library is free software; you can redistribute it and/or - * modify it under the terms of the GNU Lesser General Public - * License as published by the Free Software Foundation; either - * version 2.1 of the License, or (at your option) any later version. - * - * This library is distributed in the hope that it will be useful, - * but WITHOUT ANY WARRANTY; without even the implied warranty of - * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU - * Lesser General Public License for more details. - * - * You should have received a copy of the GNU Lesser General Public - * License along with this library; if not, write to the Free Software - * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA - * 02110-1301 USA. - */ - -package org.teiid.adminapi; - - -/** - * An extension module is a library (usually in jar format) that extends - * the MetaMatrix system in some way. Classes of a custom connector can - * be added as an extension module. - * - * <p> The unique identifier pattern for the extension module is generally - * the name of the jar file since it applies system wide. Example: <code>MJjdbc.jar</code> - * @since 4.3 - */ -public interface ExtensionModule extends AdminObject { - - /** - * The name of the JAR file type of extension - * module - this is the only type of - * extension module that can be searched - * for Class objects - */ - public static final String JAR_FILE_TYPE = "JAR File"; //$NON-NLS-1$ - - /** - * The name of the Metadata Keyword type of - * extension module. - */ - public static final String METADATA_KEYWORD_TYPE = "Metadata Keyword"; //$NON-NLS-1$ - - /** - * The name of the Metamodel Extension type of - * extension module. - */ - public static final String METAMODEL_EXTENSION_TYPE = "Metamodel Extension"; //$NON-NLS-1$ - - /** - * The name of the Function Definition type of - * extension module. - */ - public static final String FUNCTION_DEFINITION_TYPE = "Function Definition"; //$NON-NLS-1$ - - /** - * The name of the Configuration Model type of - * extension module. - */ - public static final String CONFIGURATION_MODEL_TYPE = "Configuration Model"; //$NON-NLS-1$ - - /** - * The name of the VDB File type of extension module. - */ - public static final String VDB_FILE_TYPE = "VDB File"; //$NON-NLS-1$ - - /** - * The name of the Keystore File of extension module. - */ - public static final String KEYSTORE_FILE_TYPE = "Keystore File"; //$NON-NLS-1$ - - /** - * The name of the Miscellaneous File type of extension module. - */ - public static final String MISC_FILE_TYPE = "Miscellaneous Type"; //$NON-NLS-1$ - - - /** - * @return description - */ - public String getDescription(); - - /** - * @return byte array of file contents - */ - public byte[] getFileContents(); - - /** - * @return String of the Module Type for this Extension Module - */ - public String getModuleType(); - - - - -} Deleted: trunk/client/src/main/java/org/teiid/adminapi/Group.java =================================================================== --- trunk/client/src/main/java/org/teiid/adminapi/Group.java 2010-03-04 18:25:21 UTC (rev 1904) +++ trunk/client/src/main/java/org/teiid/adminapi/Group.java 2010-03-04 18:28:17 UTC (rev 1905) @@ -1,35 +0,0 @@ -/* - * JBoss, Home of Professional Open Source. - * See the COPYRIGHT.txt file distributed with this work for information - * regarding copyright ownership. Some portions may be licensed - * to Red Hat, Inc. under one or more contributor license agreements. - * - * This library is free software; you can redistribute it and/or - * modify it under the terms of the GNU Lesser General Public - * License as published by the Free Software Foundation; either - * version 2.1 of the License, or (at your option) any later version. - * - * This library is distributed in the hope that it will be useful, - * but WITHOUT ANY WARRANTY; without even the implied warranty of - * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU - * Lesser General Public License for more details. - * - * You should have received a copy of the GNU Lesser General Public - * License along with this library; if not, write to the Free Software - * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA - * 02110-1301 USA. - */ - -package org.teiid.adminapi; - - -/** - * This interface is used to represent a group of principals. - */ -public interface Group extends AdminObject { - - /** - * Optional property for a group; group description - */ - static final String DESCRIPTION = "description"; //$NON-NLS-1$ -} Deleted: trunk/client/src/main/java/org/teiid/adminapi/MonitoringAdmin.java =================================================================== --- trunk/client/src/main/java/org/teiid/adminapi/MonitoringAdmin.java 2010-03-04 18:25:21 UTC (rev 1904) +++ trunk/client/src/main/java/org/teiid/adminapi/MonitoringAdmin.java 2010-03-04 18:28:17 UTC (rev 1905) @@ -1,238 +0,0 @@ -/* - * JBoss, Home of Professional Open Source. - * See the COPYRIGHT.txt file distributed with this work for information - * regarding copyright ownership. Some portions may be licensed - * to Red Hat, Inc. under one or more contributor license agreements. - * - * This library is free software; you can redistribute it and/or - * modify it under the terms of the GNU Lesser General Public - * License as published by the Free Software Foundation; either - * version 2.1 of the License, or (at your option) any later version. - * - * This library is distributed in the hope that it will be useful, - * but WITHOUT ANY WARRANTY; without even the implied warranty of - * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU - * Lesser General Public License for more details. - * - * You should have received a copy of the GNU Lesser General Public - * License along with this library; if not, write to the Free Software - * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA - * 02110-1301 USA. - */ - -package org.teiid.adminapi; - -import java.util.Collection; - -import com.metamatrix.admin.RolesAllowed; - - -/** - * Used to access the monitorable components of the Teiid system. - * - * <p>See the particular admin object in question for an example of - * allowed identifier patterns.</p> - * - * @since 4.3 - */ -(a)RolesAllowed(value=AdminRoles.RoleName.ADMIN_READONLY) -public interface MonitoringAdmin { - - /** - * Get the Connector Types that correspond to the specified identifier pattern. - * - * @param connectorTypeIdentifier the unique identifier for for a {@link ConnectorType} - * <ul> - * <li> <code>"*"</code> - for all connector types in the system - * <li> <code>"name*"</code> - for all the connector types that begin with given name - * <li> <code>"name"</code> - for the single connector type identified by name - * </ul> - * @return Collection of {@link ConnectorType} - * @throws AdminException if there's a system error. - * @since 4.3 - */ - Collection<ConnectorType> getConnectorTypes(String connectorTypeIdentifier) throws AdminException; - - /** - * Get the VDBs that correspond to the specified identifier pattern. - * - * @param vdbIdentifier the unique identifier for for a {@link VDB} in the system - * <ul> - * <li> <code>"*"</code> - for all VDBs in the system - * <li> <code>"name"</code> or <code>"name*"</code> - for all the VDBs that begin with given name - * <li><code>"name<{@link AdminObject#DELIMITER_CHAR}>version"</code> - for single VDB - * </ul> - * @return Collection of {@link VDB}s. There could be multiple VDBs with the - * same name in the Collection but they will differ by VDB version. - * @throws AdminException if there's a system error. - * @since 4.3 - */ - @RolesAllowed(value=AdminRoles.RoleName.ANONYMOUS) - Collection<VDB> getVDBs(String vdbIdentifier) throws AdminException; - - /** - * Get the Connector Bindings that correspond to the specified identifier pattern. - * - * @param connectorBindingIdentifier the unique identifier pattern of {@link ConnectorBinding} - * <ul> - * <li> <code>"*"</code> - for all connector bindings in the system - * <li> <code>"name*"</code> - for all connector bindings that begin with given name - * <li><code>"name"</code> - for single connector binding by the given name - * </ul> - * @return Collection of {@link ConnectorBinding} - * @throws AdminException if there's a system error. - * @since 4.3 - */ - Collection<ConnectorBinding> getConnectorBindings(String connectorBindingIdentifier) throws AdminException; - - /** - * Get all the Connector Bindings for the given VDB identifier pattern - * @param vdbName - Name of the VDB - * @param vdbVersion - version of the VDB - * @return Collection of {@link ConnectorBinding} - * @throws AdminException if there's a system error. - * @since 4.3 - */ - Collection<ConnectorBinding> getConnectorBindingsInVDB(String vdbName, String vdbVersion) throws AdminException; - - /** - * Get the Extension Modules that correspond to the specified identifier pattern - * @param extensionModuleIdentifier - the unique identifier for {@link ExtensionModule} - * <ul> - * <li> <code>"*"</code> - for all extension modules in the system - * <li> <code>"name*"</code> - for all the extension modules in that begin with given name - * <li><code>"name"</code> - for a single extension module identified by given name - * </ul> - * @return Collection of {@link ExtensionModule} - * @throws AdminException if there's a system error. - * @since 4.3 - */ - Collection<ExtensionModule> getExtensionModules(String extensionModuleIdentifier) throws AdminException; - - /** - * Get the Queue Worker Pools that correspond to the specified identifier pattern. - * - * @param identifier - an identfier for the queues {@link QueueWorkerPool} - * <ul> - * <li> <code>"*"</code> - for all Queue workers in the system - * <li> <code>"name*"</code> - for all the Queue workers in that begin with given name - * <li><code>"name"</code> - for a single queue in the system - * </ul> - * for example, In MM Query - "dqp" will return the Stats for MM Query Worker Pool. Also any Connector Binding - * name will return the stats for that connector binding. - * @return Collection of {@link QueueWorkerPool} - * @throws AdminException if there's a system error. - * @since 4.3 - */ - Collection<QueueWorkerPool> getQueueWorkerPools(String identifier) throws AdminException; - - - /** - * Get the Connection Pool Stats that correspond to the specified identifier pattern. - * If the {@link ConnectionPool ConnectionPool} represents an XA connection, there - * will be 2 {@link ConnectionPool ConnectionPool}s. - * - * @param identifier - an identfier that corresponds to the ConnectorBinding that is - * running in a process {@link ConnectionPool} - * <ul> - * <li> <code>"*"</code> - for all Connection Pools in the system - * <li> <code>"name*"</code> - for all the Connection Pools that begin with given name - * <li><code>"name"</code> - for a single Connection Pool in the system - * </ul> - * @return Collection of {@link ConnectionPool} - * @throws AdminException if there's a system error. - * @since 6.1 - */ - Collection<? extends ConnectionPool> getConnectionPoolStats(String identifier) throws AdminException; - - - /** - * Get the Caches that correspond to the specified identifier pattern - * @param identifier - an identifier for the cache in {@link Cache} - * <ul> - * <li> <code>"*"</code> - for all different caches in the system - * <li> <code>"name*"</code> - for all the caches that begin with given name - * <li><code>"name"</code> - for a single cache in the system - * </ul> - * @return Collection of {@link Cache} - * @throws AdminException if there's a system error. - * @since 4.3 - */ - Collection<Cache> getCaches(String identifier) throws AdminException; - - /** - * Get the Sessions that correspond to the specified identifier pattern - * @param identifier - an unique identifier for {@link Session} - * <ul> - * <li> <code>"*"</code> - for all current sessions of the system - * <li> <code>"number*"</code> - for all the sessions that begin with given number - * <li><code>"number"</code> - for a single current session in the system - * </ul> - * @return Collection of {@link Session} - * @throws AdminException if there's a system error. - * @since 4.3 - */ - Collection<Session> getSessions(String identifier) throws AdminException; - - /** - * Get the Requests that correspond to the specified identifier pattern - * @param identifier - An Identifier for {@link Request} - * <ul> - * <li> <code>"*"</code> - for all current in process requests of the system - * <li> <code>"number* or number<{@link AdminObject#DELIMITER_CHAR}>*"</code> - for all the sessions - * that begin with given number, or all the requests for particular session etc. - * <li><code>"number<{@link AdminObject#DELIMITER_CHAR}>number"</code> - for a single request in the system - * </ul> - * @return Collection of {@link Request} - * @throws AdminException if there's a system error. - * @since 4.3 - */ - - Collection<Request> getRequests(String identifier) throws AdminException; - - /** - * Get the Source Request that correspond to the specified identifier pattern - * @param identifier An Identifier for {@link Request} - * <ul> - * <li> <code>"*"</code> - for all current in process requests of the system - * <li> <code>"number* or number<{@link AdminObject#DELIMITER_CHAR}>* or number.number.*"</code> - for all the sessions - * that begin with given number, or all the requests for particular session etc. - * <li><code>"number<{@link AdminObject#DELIMITER_CHAR}>number<{@link AdminObject#DELIMITER_CHAR}>number"</code> - for a single source request in the system - * </ul> - * @return Collection of {@link Request} - * @throws AdminException if there's a system error. - * @since 4.3 - */ - Collection<Request> getSourceRequests(String identifier) throws AdminException; - - - /** - * Get all of the available Configuration Properties for the specified AdminObject, and details about them. - * @param connectorTypeIdentifier - * @return - * @throws AdminException - */ - Collection<PropertyDefinition> getConnectorTypePropertyDefinitions(String connectorTypeIdentifier) throws AdminException; - - - /** - * Get all transaction matching the identifier. - * @return - * @throws AdminException - */ - Collection<Transaction> getTransactions() throws AdminException; - - /** - * Get the processes that correspond to the specified identifier pattern. - * - * @param processIdentifier the unique identifier for for a {@link org.teiid.adminapi.ProcessObject ProcessObject} - * in the system or "{@link org.teiid.adminapi.AdminObject#WILDCARD WILDCARD}" - * if all Processes are desired. - * @return Collection of {@link org.teiid.adminapi.ProcessObject ProcessObject} - * @throws AdminException if there's a system error. - * @since 4.3 - */ - @RolesAllowed(value=AdminRoles.RoleName.ANONYMOUS) - Collection<ProcessObject> getProcesses(String processIdentifier) throws AdminException; - -} Deleted: trunk/client/src/main/java/org/teiid/adminapi/QueueWorkerPool.java =================================================================== --- trunk/client/src/main/java/org/teiid/adminapi/QueueWorkerPool.java 2010-03-04 18:25:21 UTC (rev 1904) +++ trunk/client/src/main/java/org/teiid/adminapi/QueueWorkerPool.java 2010-03-04 18:28:17 UTC (rev 1905) @@ -1,88 +0,0 @@ -/* - * JBoss, Home of Professional Open Source. - * See the COPYRIGHT.txt file distributed with this work for information - * regarding copyright ownership. Some portions may be licensed - * to Red Hat, Inc. under one or more contributor license agreements. - * - * This library is free software; you can redistribute it and/or - * modify it under the terms of the GNU Lesser General Public - * License as published by the Free Software Foundation; either - * version 2.1 of the License, or (at your option) any later version. - * - * This library is distributed in the hope that it will be useful, - * but WITHOUT ANY WARRANTY; without even the implied warranty of - * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU - * Lesser General Public License for more details. - * - * You should have received a copy of the GNU Lesser General Public - * License along with this library; if not, write to the Free Software - * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA - * 02110-1301 USA. - */ - -package org.teiid.adminapi; - - -/** - * All server modules use queue based processing inside them. This - * object holds the statistics of those queues, as per how many of them queued, dequeued, - * processed etc. - * <p>An identifier for QueueWorkerPool, is nothing but the modules it self, like "DQP", - * "QueryService" or Connector Binding names etc.</p> - * - * @since 4.3 - */ -public interface QueueWorkerPool extends AdminObject { - /** - * @return Returns the number of requests queued. - * @since 4.3 - */ - public int getQueued(); - - /** - * @return Returns the number of threads. - * @since 4.3 - */ - public int getThreads(); - - /** - * @return Returns the highest number of active threads - */ - public int getHighestThreads(); - - /** - * @return Returns the number of totalDequeues. - * @since 4.3 - * @deprecated see {@link #getTotalCompleted()} - */ - public long getTotalDequeues(); - - /** - * @return The number of completed tasks - */ - long getTotalCompleted(); - - /** - * @return Returns the number of totalEnqueues. - * @since 4.3 - * @deprecated see {@link #getTotalSubmitted()} - */ - public long getTotalEnqueues(); - - /** - * @return The number of submitted tasks - */ - long getTotalSubmitted(); - - /** - * @return Returns the totalHighwaterMark. - * @since 4.3 - * @deprecated see {@link #getHighestQueued()} - */ - public int getTotalHighwaterMark(); - - /** - * @return Returns the highest queue size - */ - public int getHighestQueued(); -} Deleted: trunk/client/src/main/java/org/teiid/adminapi/Role.java =================================================================== --- trunk/client/src/main/java/org/teiid/adminapi/Role.java 2010-03-04 18:25:21 UTC (rev 1904) +++ trunk/client/src/main/java/org/teiid/adminapi/Role.java 2010-03-04 18:28:17 UTC (rev 1905) @@ -1,39 +0,0 @@ -/* - * JBoss, Home of Professional Open Source. - * See the COPYRIGHT.txt file distributed with this work for information - * regarding copyright ownership. Some portions may be licensed - * to Red Hat, Inc. under one or more contributor license agreements. - * - * This library is free software; you can redistribute it and/or - * modify it under the terms of the GNU Lesser General Public - * License as published by the Free Software Foundation; either - * version 2.1 of the License, or (at your option) any later version. - * - * This library is distributed in the hope that it will be useful, - * but WITHOUT ANY WARRANTY; without even the implied warranty of - * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU - * Lesser General Public License for more details. - * - * You should have received a copy of the GNU Lesser General Public - * License along with this library; if not, write to the Free Software - * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA - * 02110-1301 USA. - */ - -package org.teiid.adminapi; - - - -/** - * @since 4.3 - */ -public interface Role extends AdminObject { - - /** System admin role name */ - public static final String ADMIN_SYSTEM = AdminRoles.RoleName.ADMIN_SYSTEM; - /** Product admin role name */ - public static final String ADMIN_PRODUCT = AdminRoles.RoleName.ADMIN_PRODUCT; - /** Read-only admin role name */ - public static final String ADMIN_READONLY = AdminRoles.RoleName.ADMIN_READONLY; - -} Deleted: trunk/client/src/main/java/org/teiid/adminapi/RuntimeStateAdmin.java =================================================================== --- trunk/client/src/main/java/org/teiid/adminapi/RuntimeStateAdmin.java 2010-03-04 18:25:21 UTC (rev 1904) +++ trunk/client/src/main/java/org/teiid/adminapi/RuntimeStateAdmin.java 2010-03-04 18:28:17 UTC (rev 1905) @@ -1,153 +0,0 @@ -/* - * JBoss, Home of Professional Open Source. - * See the COPYRIGHT.txt file distributed with this work for information - * regarding copyright ownership. Some portions may be licensed - * to Red Hat, Inc. under one or more contributor license agreements. - * - * This library is free software; you can redistribute it and/or - * modify it under the terms of the GNU Lesser General Public - * License as published by the Free Software Foundation; either - * version 2.1 of the License, or (at your option) any later version. - * - * This library is distributed in the hope that it will be useful, - * but WITHOUT ANY WARRANTY; without even the implied warranty of - * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU - * Lesser General Public License for more details. - * - * You should have received a copy of the GNU Lesser General Public - * License along with this library; if not, write to the Free Software - * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA - * 02110-1301 USA. - */ - -package org.teiid.adminapi; - -import javax.transaction.xa.Xid; - -import com.metamatrix.admin.RolesAllowed; - - -/** - * This interface defines the methods to interact with the Teiid system - * during runtime. - * - * @since 4.3 - */ -(a)RolesAllowed(value=AdminRoles.RoleName.ADMIN_PRODUCT) -public interface RuntimeStateAdmin { - - /** - * Start Connector Binding - * - * @param connectorBindingIdentifier identifier for {@link org.teiid.adminapi.ConnectorBinding} - * <ul> - * <li> <code>"*"</code> - for all connector bindings in the system - * <li> <code>"name*"</code> - for all connector bindings that begin with given name - * <li><code>"name"</code> - for single connector binding by the given name - * </ul> - * @throws AdminException if there's a system error. - * @since 4.3 - */ - void startConnectorBinding(String connectorBindingIdentifier) throws AdminException; - - /** - * Stop Connector Binding - * - * @param connectorBindingIdentifier identifier for {@link org.teiid.adminapi.ConnectorBinding} - * <ul> - * <li> <code>"*"</code> - for all connector bindings in the system - * <li> <code>"name*"</code> - for all connector bindings that begin with given name - * <li><code>"name"</code> - for single connector binding by the given name - * </ul> - * @param stopNow If true, stop the process forcefully. If false, wait until any pending work is done. - * @throws AdminException - if there's a system error. - * @since 4.3 - */ - void stopConnectorBinding(String connectorBindingIdentifier, - boolean stopNow) throws AdminException; - - /** - * Clear the cache or caches specified by the cacheIdentifier. - * @param cacheIdentifier Cache name identifier {@link org.teiid.adminapi.Cache}. - * No wild cards currently supported, must be explicit - * @throws AdminException if there's a system error. - * @since 4.3 - */ - @RolesAllowed(value=AdminRoles.RoleName.ADMIN_SYSTEM) - void clearCache(String cacheIdentifier) throws AdminException; - - /** - * Terminate the Session - * - * @param identifier Session Identifier {@link org.teiid.adminapi.Session}. - * No wild cards currently supported, must be explicit - * @throws AdminException if there's a system error. - * @since 4.3 - */ - void terminateSession(String identifier) throws AdminException; - - /** - * Cancel Request - * - * @param identifier The request identifier defined by {@link org.teiid.adminapi.Request} - * No wild cards currently supported, must be explicit - * @throws AdminException if there's a system error. - * @since 4.3 - */ - void cancelRequest(String identifier) throws AdminException; - - /** - * Cancel Source Request - * - * @param identifier The request identifier defined by {@link org.teiid.adminapi.Request} - * No wild cards currently supported, must be explicit - * @throws AdminException if there's a system error. - * @since 4.3 - */ - void cancelSourceRequest(String identifier) throws AdminException; - - /** - * Change the status of a Deployed VDB - * - * @param name Name of the Virtual Database - * @param version Version of the Virtual Database - * @param status Active, InActive, Delete - * @throws AdminException if there's a system error. - * @since 4.3 - */ - public void changeVDBStatus(String name, String version, int status) - throws AdminException; - - /** - * Mark the given global transaction as rollback only. - * @param transactionId - * @throws AdminException - */ - void terminateTransaction(Xid transactionId) throws AdminException; - - /** - * Mark the given transaction as rollback only. - * @param identifier - * The exact identifier of the transaction. Wild card is not supported. - * @param the session the transaction is associated with. - * @throws AdminException - */ - void terminateTransaction(String transactionId, String sessionId) throws AdminException; - - - /** - * Stop the MM Query. If millisToWait is >0, then close to incoming queries, wait the time period - * for work to stop, then stop the MM Query. Otherwise, stop immediately, aborting all running queries. - * @param millisToWait Milliseconds to wait (if >0) or <=0 for no wait before stopping - * @throws AdminException - * @since 4.3 - */ - void shutdown(int millisToWait) throws AdminException; - - /** - * Restart System - * @throws AdminException if there's a system error. - * @since 4.3 - */ - void restart() throws AdminException; -} Deleted: trunk/client/src/main/java/org/teiid/adminapi/SecurityAdmin.java =================================================================== --- trunk/client/src/main/java/org/teiid/adminapi/SecurityAdmin.java 2010-03-04 18:25:21 UTC (rev 1904) +++ trunk/client/src/main/java/org/teiid/adminapi/SecurityAdmin.java 2010-03-04 18:28:17 UTC (rev 1905) @@ -1,159 +0,0 @@ -/* - * JBoss, Home of Professional Open Source. - * See the COPYRIGHT.txt file distributed with this work for information - * regarding copyright ownership. Some portions may be licensed - * to Red Hat, Inc. under one or more contributor license agreements. - * - * This library is free software; you can redistribute it and/or - * modify it under the terms of the GNU Lesser General Public - * License as published by the Free Software Foundation; either - * version 2.1 of the License, or (at your option) any later version. - * - * This library is distributed in the hope that it will be useful, - * but WITHOUT ANY WARRANTY; without even the implied warranty of - * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU - * Lesser General Public License for more details. - * - * You should have received a copy of the GNU Lesser General Public - * License along with this library; if not, write to the Free Software - * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA - * 02110-1301 USA. - */ - -package org.teiid.adminapi; - -import java.io.Serializable; -import java.util.Collection; -import java.util.List; - -import com.metamatrix.admin.RolesAllowed; - - -/** - * This interface defines the methods available for security administration - * in the Teiid system. - * - * @since 4.3 - */ -(a)RolesAllowed(value=AdminRoles.RoleName.ADMIN_SYSTEM) -public interface SecurityAdmin { - /** - * Get the Collection of administrative role names possessed by the given group, if any. - * - * @param groupIdentifier The unique identifier for the {@link Group}. This is group name. - * The {@link AdminObject#WILDCARD WILDCARD} cannot be used here. - * @return The Collection of {@link Role}s. - * @throws AdminException - * if there's a system error. - * @since 4.3 - */ - Collection<Role> getRolesForGroup(String groupIdentifier) throws AdminException; - - /** - * Get the group memberships for the given user. - * - * @param userIdentifier - * The unique identifier for the user. This is generally a user name. - * The {@link AdminObject#WILDCARD WILDCARD} cannot be used here. - * @return The collection of groups in which the given user has membership. - * @throws AdminException - * if there's a system error. - * @since 4.3 - */ - Collection<Group> getGroupsForUser(String userIdentifier) throws AdminException; - - - /** - * Get the group denoted by the given <code>groupIdentifier</code>. - * - * @param groupIdentifier - * The unique identifier for the {@link Group}. This is generally a group name. - * Note that by supplying the {@link AdminObject#WILDCARD WILDCARD} identifier, all all groups in the system will - * retrieved.</br> - * @return The Collection of groups. - * @throws AdminException - * if there's a system error. - * @since 4.3 - */ - Collection<Group> getGroups(String groupIdentifier) throws AdminException; - - /** - * Assign to the given {@link Group} the given Administrative Role. - * - * @param roleIdentifier - * one of {@link AdminRoles}. - * @param groupIdentifier - * the unique identifier for the Group. The {@link AdminObject#WILDCARD WILDCARD} cannot be used here. - * @throws AdminException - * if there's a system error. - * @since 4.3 - */ - void assignRoleToGroup(String roleIdentifier, - String groupIdentifier) throws AdminException; - - /** - * Remove an administrative role from the given {@link Group}. - * - * @param roleIdentifier - * one of {@link AdminRoles} - * @param groupIdentifier - * the unique identifier for the group. The {@link AdminObject#WILDCARD WILDCARD} cannot be used here. - * @throws AdminException - * if there's a system error. - * @since 4.3 - */ - void removeRoleFromGroup(String roleIdentifier, - String groupIdentifier) throws AdminException; - - /** - * Import the data Roles for given vdb and version into the connected server - * @param vdbName - target name of the VDB, the roles to be imported under - * @param vdbVersion - target version of the vdb, the roles to be imported under - * @param data - character data array containing the XML file which defines the roles - * @param options - options to overwrite in case the matching roles already exist. - * @return a report of the import - * @throws AdminException - */ - String importDataRoles(String vdbName, String vdbVersion, char[] data, AdminOptions options) - throws AdminException; - - /** - * Export the data roles defined for the given vdb from the current system - * @param vdbName - Name of the vdb - * @param vdbVersion - version of the vdb - * @return - char[] stream containing the XML contents of the roles. - * @throws AdminException - */ - char[] exportDataRoles(String vdbName, String vdbVersion) throws AdminException; - - /** - * Authenticate a user with the specified user name and credentials - * for use with the specified application. The application name may also - * be used by the Membership Service to determine the appropriate authentication - * mechanism. - * @param username the user name that is to be authenticated - * @param credential - * @param trustePayload - * @param applicationName the name of the application for which the user - * is authenticating - * @return true if the authentication is successful - * @throws AdminException - */ - boolean authenticateUser(String username, char[] credentials, Serializable trustePayload, String applicationName) throws AdminException; - - /** - * Returns the active authorization provider domain names, in authentication order. - * @return List<String> - * @throws AdminException - */ - List<String> getDomainNames( ) throws AdminException; - - /** - * Return the {@link Group}s for a given domain. The domain name must be an specified - * exactly. See {@link #getActiveDomainNames()} for possible domain names. - * @param domainName - * @return - * @throws AdminException - */ - Collection<Group> getGroupsForDomain(String domainName) throws AdminException; -}