public class AdminShell extends Object
Admin| Constructor and Description |
|---|
AdminShell() |
| Modifier and Type | Method and Description |
|---|---|
static void |
addDataRoleMapping(String vdbName,
Object vdbVersion,
String policyName,
String role) |
static void |
addSource(String vdbName,
Object vdbVersion,
String modelName,
String sourceName,
String translatorName,
String jndiName) |
static void |
adminHelp() |
static void |
adminHelp(String method) |
static void |
cancelRequest(String sessionId,
long executionId) |
static void |
changeVDBConnectionType(String vdbName,
Object vdbVersion,
String type) |
static void |
clearCache(String cacheType) |
static void |
clearCache(String cacheType,
String vdbName,
Object vdbVersion) |
static void |
connectAsAdmin() |
static void |
connectAsAdmin(String host,
int port,
String username,
String password,
String connectionName) |
static void |
createDataSource(String deploymentName,
String templateName,
Properties properties) |
static void |
deleteDataSource(String deployedName) |
static void |
deploy(String vdbFile) |
static void |
disconnect() |
static void |
disconnectAll() |
static org.teiid.adminapi.Admin |
getAdmin() |
static Collection<String> |
getAllConnections() |
static Collection<? extends org.teiid.adminapi.CacheStatistics> |
getCacheStats(String identifier) |
static Collection<String> |
getCacheTypes() |
static String |
getConnectionName() |
static Properties |
getDataSource(String deployedName) |
static Collection<String> |
getDataSourceNames() |
static Set<String> |
getDataSourceTemplateNames() |
static Collection<? extends org.teiid.adminapi.EngineStatistics> |
getEngineStats() |
static String |
getQueryPlan(String sessionId,
int executionId) |
static Collection<? extends org.teiid.adminapi.Request> |
getRequests() |
static Collection<? extends org.teiid.adminapi.Request> |
getRequestsForSession(String sessionId) |
static String |
getSchema(String vdbName,
Object vdbVersion,
String modelName) |
static Collection<? extends org.teiid.adminapi.Session> |
getSessions() |
static Collection<? extends org.teiid.adminapi.PropertyDefinition> |
getTemplatePropertyDefinitions(String templateName) |
static Collection<? extends org.teiid.adminapi.Transaction> |
getTransactions() |
static org.teiid.adminapi.Translator |
getTranslator(String deployedName) |
static Collection<? extends org.teiid.adminapi.PropertyDefinition> |
getTranslatorPropertyDefinitions(String translatorName) |
static Collection<? extends org.teiid.adminapi.PropertyDefinition> |
getTranslatorPropertyDefinitions(String translatorName,
String type) |
static Collection<? extends org.teiid.adminapi.Translator> |
getTranslators() |
static org.teiid.adminapi.VDB |
getVDB(String vdbName,
Object vdbVersion) |
static Collection<? extends org.teiid.adminapi.VDB> |
getVDBs() |
static Collection<? extends org.teiid.adminapi.WorkerPoolStatistics> |
getWorkerPoolStats() |
static boolean |
hasTranslator(String factoryName) |
static boolean |
hasVDB(String vdbName) |
static boolean |
hasVDB(String vdbName,
Object vdbVersion) |
static void |
removeDataRoleMapping(String vdbName,
Object vdbVersion,
String policyName,
String role) |
static void |
removeSource(String vdbName,
Object vdbVersion,
String modelName,
String sourceName) |
static void |
restart() |
static void |
restartVDB(String vdbName,
Object vdbVersion,
String... models) |
static void |
setAnyAuthenticatedForDataRole(String vdbName,
Object vdbVersion,
String dataRole,
boolean anyAuthenticated) |
static void |
setProfileName(String profileName) |
static void |
terminateSession(String sessionId) |
static void |
terminateTransaction(String transactionId) |
static void |
undeploy(String deployedName) |
static void |
updateSource(String vdbName,
Object vdbVersion,
String sourceName,
String translatorName,
String jndiName) |
static void |
useConnection(String name) |
protected static Logger log
@Help.Doc(text="Get a named Admin connection to the specified server") public static void connectAsAdmin(@Help.Doc(text="host - hostname") String host, @Help.Doc(text="port - port") int port, @Help.Doc(text="username") String username, @Help.Doc(text="password") String password, @Help.Doc(text="connection name") String connectionName) throws org.teiid.adminapi.AdminException
org.teiid.adminapi.AdminException@Help.Doc(text="Connect as Admin using the defaults from connection.properties") public static void connectAsAdmin() throws org.teiid.adminapi.AdminException
org.teiid.adminapi.AdminException@Help.Doc(text="Adds a mapped role to the specified data role") public static void addDataRoleMapping(@Help.Doc(text="vdb name") String vdbName, @Help.Doc(text="vdb version") Object vdbVersion, @Help.Doc(text="dataRole name") String policyName, @Help.Doc(text="mapped role name") String role) throws org.teiid.adminapi.AdminException
org.teiid.adminapi.AdminException@Help.Doc(text="Update a translator and data source for a given source") public static void updateSource(@Help.Doc(text="vdb name") String vdbName, @Help.Doc(text="vdb version") Object vdbVersion, @Help.Doc(text="source name") String sourceName, @Help.Doc(text="translator name") String translatorName, @Help.Doc(text="jndi name") String jndiName) throws org.teiid.adminapi.AdminException
org.teiid.adminapi.AdminException@Help.Doc(text="Add a source to a model") public static void addSource(@Help.Doc(text="vdb name") String vdbName, @Help.Doc(text="vdb version") Object vdbVersion, @Help.Doc(text="model name") String modelName, @Help.Doc(text="source name") String sourceName, @Help.Doc(text="translator name") String translatorName, @Help.Doc(text="jndi name") String jndiName) throws org.teiid.adminapi.AdminException
org.teiid.adminapi.AdminException@Help.Doc(text="Remove a source from a model") public static void removeSource(@Help.Doc(text="vdb name") String vdbName, @Help.Doc(text="vdb version") Object vdbVersion, @Help.Doc(text="model name") String modelName, @Help.Doc(text="source name") String sourceName) throws org.teiid.adminapi.AdminException
org.teiid.adminapi.AdminException@Help.Doc(text="Cancel a request") public static void cancelRequest(@Help.Doc(text="session id") String sessionId, @Help.Doc(text="execution id") long executionId) throws org.teiid.adminapi.AdminException
org.teiid.adminapi.AdminException@Help.Doc(text="Clear the given cache") public static void clearCache(@Help.Doc(text="cache type") String cacheType) throws org.teiid.adminapi.AdminException
org.teiid.adminapi.AdminException@Help.Doc(text="Clear the given cache for a VDB") public static void clearCache(@Help.Doc(text="cache type") String cacheType, @Help.Doc(text="vdb name") String vdbName, @Help.Doc(text="vdb version") Object vdbVersion) throws org.teiid.adminapi.AdminException
org.teiid.adminapi.AdminException@Help.Doc(text="Undeploy a artifact (JAR, RAR, VDB)") public static void undeploy(@Help.Doc(text="deployed name") String deployedName) throws org.teiid.adminapi.AdminException
org.teiid.adminapi.AdminException@Help.Doc(text="Get all cache type Strings") public static Collection<String> getCacheTypes() throws org.teiid.adminapi.AdminException
org.teiid.adminapi.AdminException@Help.Doc(text="Change a VDB Connection Type") public static void changeVDBConnectionType(@Help.Doc(text="vdb name") String vdbName, @Help.Doc(text="vdb version") Object vdbVersion, @Help.Doc(text="Connection Type (NONE, BY_VERSION, or ANY") String type) throws org.teiid.adminapi.AdminException
org.teiid.adminapi.AdminException@Help.Doc(text="Get all translator instances") public static Collection<? extends org.teiid.adminapi.Translator> getTranslators() throws org.teiid.adminapi.AdminException
org.teiid.adminapi.AdminException@Help.Doc(text="Get the specified ConnectionFactory") public static org.teiid.adminapi.Translator getTranslator(@Help.Doc(text="deployed name") String deployedName) throws org.teiid.adminapi.AdminException
org.teiid.adminapi.AdminException@Help.Doc(text="Get all PropertyDefinitions for the given template") public static Collection<? extends org.teiid.adminapi.PropertyDefinition> getTemplatePropertyDefinitions(@Help.Doc(text="template name") String templateName) throws org.teiid.adminapi.AdminException
org.teiid.adminapi.AdminException@Help.Doc(text="Get all PropertyDefinitions for the given translator") public static Collection<? extends org.teiid.adminapi.PropertyDefinition> getTranslatorPropertyDefinitions(@Help.Doc(text="translator name") String translatorName) throws org.teiid.adminapi.AdminException
org.teiid.adminapi.AdminException@Help.Doc(text="Get all PropertyDefinitions for the given translator") public static Collection<? extends org.teiid.adminapi.PropertyDefinition> getTranslatorPropertyDefinitions(@Help.Doc(text="translator name") String translatorName, @Help.Doc(text="type of property IMPPORT, OVERRIDE, EXTENSION_METADATA") String type) throws org.teiid.adminapi.AdminException
org.teiid.adminapi.AdminException@Help.Doc(text="Get all Request instances") public static Collection<? extends org.teiid.adminapi.Request> getRequests() throws org.teiid.adminapi.AdminException
org.teiid.adminapi.AdminException@Help.Doc(text="Get all Request instances for the given session") public static Collection<? extends org.teiid.adminapi.Request> getRequestsForSession(@Help.Doc(text="session id") String sessionId) throws org.teiid.adminapi.AdminException
org.teiid.adminapi.AdminException@Help.Doc(text="Get all Session instances") public static Collection<? extends org.teiid.adminapi.Session> getSessions() throws org.teiid.adminapi.AdminException
org.teiid.adminapi.AdminException@Help.Doc(text="Get all Transaction instances") public static Collection<? extends org.teiid.adminapi.Transaction> getTransactions() throws org.teiid.adminapi.AdminException
org.teiid.adminapi.AdminException@Help.Doc(text="Get a specific VDB") public static org.teiid.adminapi.VDB getVDB(@Help.Doc(text="vdb name") String vdbName, @Help.Doc(text="vdb version") Object vdbVersion) throws org.teiid.adminapi.AdminException
org.teiid.adminapi.AdminException@Help.Doc(text="Get all VDB instances") public static Collection<? extends org.teiid.adminapi.VDB> getVDBs() throws org.teiid.adminapi.AdminException
org.teiid.adminapi.AdminException@Help.Doc(text="Get thread pool statistics for Teiid") public static Collection<? extends org.teiid.adminapi.WorkerPoolStatistics> getWorkerPoolStats() throws org.teiid.adminapi.AdminException
org.teiid.adminapi.AdminException@Help.Doc(text="Get cache statistics for given cache type") public static Collection<? extends org.teiid.adminapi.CacheStatistics> getCacheStats(@Help.Doc(text="cacheType") String identifier) throws org.teiid.adminapi.AdminException
org.teiid.adminapi.AdminException@Help.Doc(text="Get engine statistics for Teiid") public static Collection<? extends org.teiid.adminapi.EngineStatistics> getEngineStats() throws org.teiid.adminapi.AdminException
org.teiid.adminapi.AdminException@Help.Doc(text="Remove a mapped role for the data role") public static void removeDataRoleMapping(@Help.Doc(text="vdb name") String vdbName, @Help.Doc(text="vdb version") Object vdbVersion, @Help.Doc(text="dataRole name") String policyName, @Help.Doc(text="mapped role name") String role) throws org.teiid.adminapi.AdminException
org.teiid.adminapi.AdminException@Help.Doc(text="Set the any authenticated flag for the data role") public static void setAnyAuthenticatedForDataRole(@Help.Doc(text="vdb name") String vdbName, @Help.Doc(text="vdb version") Object vdbVersion, @Help.Doc(text="dataRole name") String dataRole, @Help.Doc(text="any authenticated") boolean anyAuthenticated) throws org.teiid.adminapi.AdminException
org.teiid.adminapi.AdminException@Help.Doc(text="Terminate a session and associated requests") public static void terminateSession(@Help.Doc(text="session id") String sessionId) throws org.teiid.adminapi.AdminException
org.teiid.adminapi.AdminException@Help.Doc(text="Terminate a transaction") public static void terminateTransaction(@Help.Doc(text="transaction id") String transactionId) throws org.teiid.adminapi.AdminException
org.teiid.adminapi.AdminException@Help.Doc(text="Checks if a translator exists") public static boolean hasTranslator(@Help.Doc(text="deployed name") String factoryName) throws org.teiid.adminapi.AdminException
org.teiid.adminapi.AdminException@Help.Doc(text="Checks if a VDB exists") public static boolean hasVDB(@Help.Doc(text="vdb name") String vdbName) throws org.teiid.adminapi.AdminException
org.teiid.adminapi.AdminException@Help.Doc(text="Checks if a specific VDB version exists") public static boolean hasVDB(@Help.Doc(text="vdb name") String vdbName, @Help.Doc(text="vdb version") Object vdbVersion) throws org.teiid.adminapi.AdminException
org.teiid.adminapi.AdminException@Help.Doc(text="Deploy a Artifact (JAR, RAR, VDB) from file") public static void deploy(@Help.Doc(text="file name") String vdbFile) throws org.teiid.adminapi.AdminException, FileNotFoundException
org.teiid.adminapi.AdminExceptionFileNotFoundException@Help.Doc(text="Create a data source from supplied properties") public static void createDataSource(@Help.Doc(text="deployed name") String deploymentName, @Help.Doc(text="template name") String templateName, @Help.Doc(text="properties") Properties properties) throws org.teiid.adminapi.AdminException
org.teiid.adminapi.AdminException@Help.Doc(text="Delete data source") public static void deleteDataSource(@Help.Doc(text="deployed name") String deployedName) throws org.teiid.adminapi.AdminException
org.teiid.adminapi.AdminException@Help.Doc(text="Available data sources") public static Collection<String> getDataSourceNames() throws org.teiid.adminapi.AdminException
org.teiid.adminapi.AdminExceptionpublic static Properties getDataSource(@Help.Doc(text="Data Source Name") String deployedName) throws org.teiid.adminapi.AdminException
org.teiid.adminapi.AdminException@Help.Doc(text="Available data source template names") public static Set<String> getDataSourceTemplateNames() throws org.teiid.adminapi.AdminException
org.teiid.adminapi.AdminException@Help.Doc(text="Restart the VDB") public static void restartVDB(@Help.Doc(text="vdb name") String vdbName, @Help.Doc(text="vdb version") Object vdbVersion, @Help.Doc(text="models") String... models) throws org.teiid.adminapi.AdminException
org.teiid.adminapi.AdminException@Help.Doc(text="Get query execution plan for the given execution id") public static String getQueryPlan(@Help.Doc(text="Session Id") String sessionId, @Help.Doc(text="Execution Id") int executionId) throws org.teiid.adminapi.AdminException
org.teiid.adminapi.AdminException@Help.Doc(text="Get schema for the model") public static String getSchema(@Help.Doc(text="vdb name") String vdbName, @Help.Doc(text="vdb version") Object vdbVersion, @Help.Doc(text="models") String modelName) throws org.teiid.adminapi.AdminException
org.teiid.adminapi.AdminException@Help.Doc(text="Get the current org.teiid.adminapi.Admin instance for direct use. Note: Used for advanced usecases to bypass AdminShell methods") public static org.teiid.adminapi.Admin getAdmin()
@Help.Doc(text="Disconnect the current connection for the server") public static void disconnect()
@Help.Doc(text="Disconnect all connections from the server") public static void disconnectAll()
@Help.Doc(text="Use another connection") public static void useConnection(@Help.Doc(text="connection name") String name)
@Help.Doc(text="Returns the current connection name") public static String getConnectionName()
@Help.Doc(text="Return all connection names") public static Collection<String> getAllConnections()
@Help.Doc(text="Show help for the given admin method") public static void adminHelp(@Help.Doc(text="method name") String method)
Copyright © 2018 JBoss by Red Hat. All rights reserved.