|
Oracle® Fusion Middleware Content Integration Suite (CIS) Java API Reference 11g Release 1 (11.1) E17350-01 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface ICISAdministrativeAdapterAPI
The command API implementation of the administrative.adapter commands. This implementation can be accessed directly via the ICommandFacade
class, using the API name administrative.adapter, with the following syntax:
ICISAdministrativeAdapterAPI commandAPI = (ICISAdministrativeAdapterAPI)m_commandFacade.getCommandAPI ("administrative.adapter", m_commandFacade.getCommandTypeForName ("common"));
Field Summary | |
---|---|
static java.lang.String |
API_CATEGORY Category for this Command API |
Method Summary | |
---|---|
ICISAdapterConfig |
createAdapter(java.lang.String type) Create a new empty adapter of the given type. |
void |
deleteAdapter(java.lang.String name, java.lang.String type) Delete an adapter from the adapter configuration. |
void |
deleteAdapter(java.lang.String name, java.lang.String type, boolean persist) Delete an adapter from the adapter configuration. |
ICISAdapterConfig |
getAdapter(java.lang.String name) Retrieve an adapter by name. |
ICISAdapterConfig |
getAdapter(java.lang.String name, java.lang.String type) Retrieve an adapter by name. |
ICISAdapterConfig |
getDefaultAdapter(java.lang.String type) Get the default adapter configuration for the given type. |
java.util.Properties |
getGlobalProperties() Retrieve the list of global properties defined in the adapter configuration. |
java.util.Properties |
getServerJndiProperties() Retrieve the list of global properties defined in the adapter configuration. |
java.util.Collection |
listAdapters() |
java.util.Collection |
listAdapters(java.lang.String type) List the configured adapters in the system. |
java.util.List |
listResourceNames() List the available resource names for a given adapter type. |
void |
setDefaultAdapter(java.lang.String adapterName, java.lang.String adapterType, boolean shouldSave) Set an adapter to be the default for a given adapter type. |
void |
updateAdapter(ICISAdapterConfig adapterConfig) Updates the adapter configuration in the system. |
void |
updateAdapter(ICISAdapterConfig adapterConfig, boolean shouldPersist) Updates the adapter configuration in the system. |
void |
updateAdapter(ICISAdapterConfig adapterConfig, java.lang.String oldName) Updates the adapter configuration in the system. |
void |
updateAdapter(ICISAdapterConfig adapterConfig, java.lang.String oldName, boolean shouldPersist) Updates the adapter configuration in the system. |
void |
updateAdapterFactory(java.util.Properties factoryProperties, java.util.Properties jndiProperties, boolean reload, boolean persist) Make changes to the adapter factory. |
Field Detail |
---|
static final java.lang.String API_CATEGORY
Method Detail |
---|
ICISAdapterConfig createAdapter(java.lang.String type) throws CommandException
type
- the type of adapterCommandException
void deleteAdapter(java.lang.String name, java.lang.String type) throws CommandException
name
- the adapter nametype
- the adapter typeCommandException
void deleteAdapter(java.lang.String name, java.lang.String type, boolean persist) throws CommandException
name
- the adapter nametype
- the adapter typepersist
- persist the changes to the configuration file; defaults to trueCommandException
ICISAdapterConfig getAdapter(java.lang.String name) throws CommandException
name
- the name of the adapterCommandException
ICISAdapterConfig getAdapter(java.lang.String name, java.lang.String type) throws CommandException
name
- the name of the adaptertype
- the type of the adapterCommandException
ICISAdapterConfig getDefaultAdapter(java.lang.String type) throws CommandException
type
- the type of adapterCommandException
java.util.Properties getGlobalProperties() throws CommandException
CommandException
java.util.Properties getServerJndiProperties() throws CommandException
CommandException
java.util.Collection listAdapters() throws CommandException
CommandException
java.util.Collection listAdapters(java.lang.String type) throws CommandException
type
- the type of adapterCommandException
java.util.List listResourceNames() throws CommandException
CommandException
void setDefaultAdapter(java.lang.String adapterName, java.lang.String adapterType, boolean shouldSave) throws CommandException
adapterName
- the adapter nameadapterType
- the adapter typeshouldSave
- true to save after making changes; default to falseCommandException
void updateAdapter(ICISAdapterConfig adapterConfig) throws CommandException
adapterConfig
- the adapter config object with the updated configurationCommandException
void updateAdapter(ICISAdapterConfig adapterConfig, boolean shouldPersist) throws CommandException
adapterConfig
- the adapter config object with the updated configurationshouldPersist
- true to persist the configurationCommandException
void updateAdapter(ICISAdapterConfig adapterConfig, java.lang.String oldName) throws CommandException
adapterConfig
- the adapter config object with the updated configurationoldName
- the original name if the adapter name is being updatedCommandException
void updateAdapter(ICISAdapterConfig adapterConfig, java.lang.String oldName, boolean shouldPersist) throws CommandException
adapterConfig
- the adapter config object with the updated configurationoldName
- the original name if the adapter name is being updatedshouldPersist
- true to persist the configurationCommandException
void updateAdapterFactory(java.util.Properties factoryProperties, java.util.Properties jndiProperties, boolean reload, boolean persist) throws CommandException
factoryProperties
- the factory properties to setjndiProperties
- the JNDI properties to setreload
- true to reload the configuration after setting it; defaults to truepersist
- true to persist the configuration after setting it; defaults to falseCommandException
|
Oracle® Fusion Middleware Content Integration Suite (CIS) Java API Reference 11g Release 1 (11.1) E17350-01 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |