|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface ICISAdministrativeAPI
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 |
---|
static final java.lang.String API_CATEGORY
static final int CONFIG_TYPE_ADAPTER
static final int CONFIG_TYPE_CLIENT
static final int CONFIG_TYPE_SERVER
Method Detail |
---|
ICISTransferStream getConfigurationFile(int configType) throws CommandException
configType
- the configuration type to retrieve
CommandException
ICISCommonMetadataMap loadMetadataMap(java.net.URL url) throws CommandException
ICISCommonMetadataMap
object from a given URL to an XML file.
url
- the url to the metadata xml file
CommandException
ICISCommonMetadataMap loadMetadataMap(java.lang.String xml) throws CommandException
ICISCommonMetadataMap
object from a given URL to an XML file.
xml
- the xml of the metadata map
CommandException
java.lang.String persistMetadataMap(ICISCommonMetadataMap metadataMap) throws CommandException
metadataMap
- the metadata map object
CommandException
ICISCommonMetadataMap _createMetadataMap()
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |