Skip navigation links

Oracle Fusion Middleware Java API Reference for Oracle WebCenter Portal
11g Release 1 (11.1.1.9.0)
E15995-08


oracle.wcps.conductor.services
Interface IProviderService


public interface IProviderService

Service for retrieving metadata about registered providers.


Method Summary
 IProviderConnection getConnection(ClientContext clientContext, java.lang.String providerName, java.lang.String connectionName)
          Retrieves a named connection for the specified provider.
 java.util.Map<java.lang.String,IConnectionMetadata> getConnectionMetadata(ClientContext clientContext, java.lang.String providerName, java.lang.String connectionName)
          Returns metadata about the data provider's connection.
 java.util.List<IProviderConnection> getConnections(ClientContext clientContext, java.lang.String providerName)
          Retrieves the collection of configured connections for the specified provider.
 IDataProviderMetadata getDataProvider(ClientContext clientContext, java.lang.String providerName)
          Retrieves the details of the specified provider.
 java.util.List<IDataProviderMetadata> getDataProviders(ClientContext clientContext)
          Retrieves the collection of data providers currently available on the server.
 IFunctionProviderMetadata getFunctionProvider(ClientContext clientContext, java.lang.String category, java.lang.String name)
          Retrieve a function provider's metadata by name
 java.util.List<IFunctionProviderMetadata> getFunctionProviders(ClientContext clientContext)
          Retrieves the collection of function providers currently available on the server.
 IMethodMetadata getMethod(ClientContext clientContext, java.lang.String providerName, java.lang.String connectionName, java.lang.String resourceName, java.lang.String methodName)
          Retrieves method detail by unique method name.
 java.util.List<IMethodMetadata> getMethods(ClientContext clientContext, java.lang.String providerName, java.lang.String connectionName, java.lang.String resourceName)
          Retrieves methods for the specified provider, connection and resource names.
 IResourceMetadata getResource(ClientContext clientContext, java.lang.String providerName, java.lang.String connectionName, java.lang.String resourceName)
          Retrieves a collection of executable resources for a provider and named connection.
 java.util.List<IResourceMetadata> getResources(ClientContext clientContext, java.lang.String providerName, java.lang.String connectionName)
          Retrieves a collection of executable resources for a provider and named connection.

 

Method Detail

getDataProviders

java.util.List<IDataProviderMetadata> getDataProviders(ClientContext clientContext)
                                                       throws ConductorException
Retrieves the collection of data providers currently available on the server.
Parameters:
clientContext - The client context to use for namespace, localization, etc.
Returns:
A collection of data provider metadata.
Throws:
ConductorException

getDataProvider

IDataProviderMetadata getDataProvider(ClientContext clientContext,
                                      java.lang.String providerName)
                                      throws ConductorException
Retrieves the details of the specified provider.
Parameters:
clientContext - The client context to use for namespace, localization, etc.
Returns:
A collection of provider metadata.
Throws:
ConductorException

getFunctionProviders

java.util.List<IFunctionProviderMetadata> getFunctionProviders(ClientContext clientContext)
                                                               throws ConductorException
Retrieves the collection of function providers currently available on the server.
Parameters:
clientContext - The client context to use for namespace, localization, etc.
Returns:
A collection of function provider metadata.
Throws:
ConductorException

getFunctionProvider

IFunctionProviderMetadata getFunctionProvider(ClientContext clientContext,
                                              java.lang.String category,
                                              java.lang.String name)
                                              throws ConductorException
Retrieve a function provider's metadata by name
Parameters:
clientContext - The client context to use for namespace, localization, etc.
category - The category or namespace of the function provider.
name - The function name.
Returns:
IFunctionProviderMetadata describing the function provider.
Throws:
ConductorException

getConnections

java.util.List<IProviderConnection> getConnections(ClientContext clientContext,
                                                   java.lang.String providerName)
                                                   throws ConductorException
Retrieves the collection of configured connections for the specified provider.
Parameters:
clientContext - The client context to use for namespace, localization, etc.
providerName - The data provider name.
Returns:
The collection of connection metadata for the provider.
Throws:
ConductorException

getConnection

IProviderConnection getConnection(ClientContext clientContext,
                                  java.lang.String providerName,
                                  java.lang.String connectionName)
                                  throws ConductorException
Retrieves a named connection for the specified provider.
Parameters:
clientContext - The client context to use for namespace, localization, etc.
providerName - The data provider name.
connectionName - The connection name to retrieve.
Returns:
The named connection
Throws:
ConductorException

getConnectionMetadata

java.util.Map<java.lang.String,IConnectionMetadata> getConnectionMetadata(ClientContext clientContext,
                                                                          java.lang.String providerName,
                                                                          java.lang.String connectionName)
                                                                          throws ConductorException
Returns metadata about the data provider's connection.
Parameters:
clientContext - The client context to use for namespace, localization, etc.
providerName - The data provider name.
connectionName - The connection name to retrieve.
Returns:
A map of metadata about the provider's connection.
Throws:
ConductorException

getResources

java.util.List<IResourceMetadata> getResources(ClientContext clientContext,
                                               java.lang.String providerName,
                                               java.lang.String connectionName)
                                               throws ConductorException
Retrieves a collection of executable resources for a provider and named connection.
Parameters:
clientContext - The client context to use for namespace, localization, etc.
providerName - The data provider name.
connectionName - The connection name to retrieve.
Returns:
The a collection of executable resource metadata.
Throws:
ConductorException

getResource

IResourceMetadata getResource(ClientContext clientContext,
                              java.lang.String providerName,
                              java.lang.String connectionName,
                              java.lang.String resourceName)
                              throws ConductorException
Retrieves a collection of executable resources for a provider and named connection.
Parameters:
clientContext - The client context to use for namespace, localization, etc.
providerName - The data provider name.
connectionName - The connection name to retrieve.
resourceName - The named executable resource.
Returns:
The metadata of the specified named resource, or null if the resource does not exist.
Throws:
ConductorException

getMethods

java.util.List<IMethodMetadata> getMethods(ClientContext clientContext,
                                           java.lang.String providerName,
                                           java.lang.String connectionName,
                                           java.lang.String resourceName)
                                           throws ConductorException
Retrieves methods for the specified provider, connection and resource names.
Parameters:
clientContext - The client context to use for namespace, localization, etc.
providerName - The data provider name.
connectionName - The connection name to retrieve.
resourceName - The named executable resource.
Returns:
Method metadata related to the specified executable resource.
Throws:
ConductorException

getMethod

IMethodMetadata getMethod(ClientContext clientContext,
                          java.lang.String providerName,
                          java.lang.String connectionName,
                          java.lang.String resourceName,
                          java.lang.String methodName)
                          throws ConductorException
Retrieves method detail by unique method name.
Parameters:
clientContext - The client context to use for namespace, localization, etc.
providerName - The data provider name.
connectionName - The connection name to retrieve.
resourceName - The named executable resource.
methodName - The unique method name (See IMethodMetadata.getUniqueMethodName())
Returns:
IMethodMetadata associated with the method.
Throws:
ConductorException

Skip navigation links

Oracle Fusion Middleware Java API Reference for Oracle WebCenter Portal
11g Release 1 (11.1.1.9.0)
E15995-08


Copyright © 2009, 2014, Oracle and/or its affiliates. All rights reserved.