com.stellent.cis.client.api.common.administrative.adapter
Interface ICISAdministrativeAdapterAPI

All Superinterfaces:

ICommandAPI

public interface ICISAdministrativeAdapterAPI
extends ICommandAPI

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

API_CATEGORY

static final java.lang.String API_CATEGORY

Category for this Command API

See Also:

Constant Field Values

Method Detail

createAdapter

ICISAdapterConfig createAdapter(java.lang.String type)
                                throws CommandException

Create a new empty adapter of the given type.

Parameters:

type - the type of adapter

Throws:

CommandException

deleteAdapter

void deleteAdapter(java.lang.String name,
                   java.lang.String type)
                   throws CommandException

Delete an adapter from the adapter configuration.

Parameters:

name - the adapter name

type - the adapter type

Throws:

CommandException

deleteAdapter

void deleteAdapter(java.lang.String name,
                   java.lang.String type,
                   boolean persist)
                   throws CommandException

Delete an adapter from the adapter configuration.

Parameters:

name - the adapter name

type - the adapter type

persist - persist the changes to the configuration file; defaults to true

Throws:

CommandException

getAdapter

ICISAdapterConfig getAdapter(java.lang.String name)
                             throws CommandException

Retrieve an adapter by name.

Parameters:

name - the name of the adapter

Throws:

CommandException

getAdapter

ICISAdapterConfig getAdapter(java.lang.String name,
                             java.lang.String type)
                             throws CommandException

Retrieve an adapter by name.

Parameters:

name - the name of the adapter

type - the type of the adapter

Throws:

CommandException

getDefaultAdapter

ICISAdapterConfig getDefaultAdapter(java.lang.String type)
                                    throws CommandException

Get the default adapter configuration for the given type.

Parameters:

type - the type of adapter

Throws:

CommandException

getGlobalProperties

java.util.Properties getGlobalProperties()
                                         throws CommandException

Retrieve the list of global properties defined in the adapter configuration.

Throws:

CommandException

getServerJndiProperties

java.util.Properties getServerJndiProperties()
                                             throws CommandException

Retrieve the list of global properties defined in the adapter configuration.

Throws:

CommandException

listAdapters

java.util.Collection listAdapters()
                                  throws CommandException

Throws:

CommandException

listAdapters

java.util.Collection listAdapters(java.lang.String type)
                                  throws CommandException

List the configured adapters in the system. If the type is specified, return only those adapters matching that type.

Parameters:

type - the type of adapter

Throws:

CommandException

listResourceNames

java.util.List listResourceNames()
                                 throws CommandException

List the available resource names for a given adapter type. Returns a list of strings naming each resource in the system.

Throws:

CommandException

setDefaultAdapter

void setDefaultAdapter(java.lang.String adapterName,
                       java.lang.String adapterType,
                       boolean shouldSave)
                       throws CommandException

Set an adapter to be the default for a given adapter type. Optionally persist the configuration after changes are made.

Parameters:

adapterName - the adapter name

adapterType - the adapter type

shouldSave - true to save after making changes; default to false

Throws:

CommandException

updateAdapter

void updateAdapter(ICISAdapterConfig adapterConfig)
                   throws CommandException

Updates the adapter configuration in the system.

Parameters:

adapterConfig - the adapter config object with the updated configuration

Throws:

CommandException

updateAdapter

void updateAdapter(ICISAdapterConfig adapterConfig,
                   boolean shouldPersist)
                   throws CommandException

Updates the adapter configuration in the system.

Parameters:

adapterConfig - the adapter config object with the updated configuration

shouldPersist - true to persist the configuration

Throws:

CommandException

updateAdapter

void updateAdapter(ICISAdapterConfig adapterConfig,
                   java.lang.String oldName)
                   throws CommandException

Updates the adapter configuration in the system.

Parameters:

adapterConfig - the adapter config object with the updated configuration

oldName - the original name if the adapter name is being updated

Throws:

CommandException

updateAdapter

void updateAdapter(ICISAdapterConfig adapterConfig,
                   java.lang.String oldName,
                   boolean shouldPersist)
                   throws CommandException

Updates the adapter configuration in the system.

Parameters:

adapterConfig - the adapter config object with the updated configuration

oldName - the original name if the adapter name is being updated

shouldPersist - true to persist the configuration

Throws:

CommandException

updateAdapterFactory

void updateAdapterFactory(java.util.Properties factoryProperties,
                          java.util.Properties jndiProperties,
                          boolean reload,
                          boolean persist)
                          throws CommandException

Make changes to the adapter factory.

Parameters:

factoryProperties - the factory properties to set

jndiProperties - the JNDI properties to set

reload - true to reload the configuration after setting it; defaults to true

persist - true to persist the configuration after setting it; defaults to false

Throws:

CommandException