com.stellent.cis.client.api.common.administrative
Interface ICISAdministrativeAPI

All Superinterfaces:

ICommandAPI

public interface ICISAdministrativeAPI
extends ICommandAPI

The command API implementation of the administrative commands. This implementation can be accessed directly via the ICommandFacade class, using the API name administrative, with the following syntax:

 ICISAdministrativeAPI commandAPI =
       (ICISAdministrativeAPI)m_commandFacade.getCommandAPI ("administrative", m_commandFacade.getCommandTypeForName ("common"));
 

Field Summary

static java.lang.String	API_CATEGORY Category for this Command API
static int	CONFIG_TYPE_ADAPTER
static int	CONFIG_TYPE_CLIENT
static int	CONFIG_TYPE_SERVER

Method Summary

ICISCommonMetadataMap	_createMetadataMap() Create an empty metadata map object
ICISTransferStream	getConfigurationFile(int configType) Retrieve the stream to the given configuration file type from the server.
ICISCommonMetadataMap	loadMetadataMap(java.lang.String xml) Load a ICISCommonMetadataMap object from a given URL to an XML file.
ICISCommonMetadataMap	loadMetadataMap(java.net.URL url) Load a ICISCommonMetadataMap object from a given URL to an XML file.
java.lang.String	persistMetadataMap(ICISCommonMetadataMap metadataMap) Convert the metadata map object to a string.

Field Detail

API_CATEGORY

static final java.lang.String API_CATEGORY

Category for this Command API

See Also:

Constant Field Values

CONFIG_TYPE_ADAPTER

static final int CONFIG_TYPE_ADAPTER

See Also:

Constant Field Values

CONFIG_TYPE_CLIENT

static final int CONFIG_TYPE_CLIENT

See Also:

Constant Field Values

CONFIG_TYPE_SERVER

static final int CONFIG_TYPE_SERVER

See Also:

Constant Field Values

Method Detail

getConfigurationFile

ICISTransferStream getConfigurationFile(int configType)
                                        throws CommandException

Retrieve the stream to the given configuration file type from the server.

Parameters:

configType - the configuration type to retrieve

Throws:

CommandException

loadMetadataMap

ICISCommonMetadataMap loadMetadataMap(java.net.URL url)
                                      throws CommandException

Load a ICISCommonMetadataMap object from a given URL to an XML file.

Parameters:

url - the url to the metadata xml file

Throws:

CommandException

loadMetadataMap

ICISCommonMetadataMap loadMetadataMap(java.lang.String xml)
                                      throws CommandException

Load a ICISCommonMetadataMap object from a given URL to an XML file.

Parameters:

xml - the xml of the metadata map

Throws:

CommandException

persistMetadataMap

java.lang.String persistMetadataMap(ICISCommonMetadataMap metadataMap)
                                    throws CommandException

Convert the metadata map object to a string.

Parameters:

metadataMap - the metadata map object

Throws:

CommandException

_createMetadataMap

ICISCommonMetadataMap _createMetadataMap()

Create an empty metadata map object

Returns:

a newly created metadata map object