Skip navigation links

Oracle® Fusion Middleware Content Integration Suite (CIS) Java API Reference
11g Release 1 (11.1)

E17350-01


com.stellent.cis.client.api.scs.administrative
Interface ISCSAdministrativeAPI

All Superinterfaces:
ICommandAPI

public interface ISCSAdministrativeAPI
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:

 ISCSAdministrativeAPI commandAPI =
       (ISCSAdministrativeAPI)m_commandFacade.getCommandAPI ("administrative", m_commandFacade.getCommandTypeForName ("active"));
 

Field Summary
static java.lang.String API_CATEGORY
          Category for this Command API

 

Method Summary
 ISCSServerResponse executeIDCService(ISCSContext SCSContext, ISCSServerBinder serverBinder)
          Executes any IDC service command.
 ISCSServerResponse executeIDCService(ISCSContext SCSContext, java.lang.String serviceName, java.util.Map arguments)
          Executes any IDC service command.
 ISCSServerResponse executeIDCService(ISCSRequestModifier requestModifier, ISCSContext SCSContext, ISCSServerBinder serverBinder)
          Executes any IDC service command.
 ISCSServerResponse executeIDCService(ISCSRequestModifier requestModifier, ISCSContext SCSContext, java.lang.String serviceName, java.util.Map arguments)
          Executes any IDC service command.
 ICISTransferStream executeIDCServiceStream(ISCSContext SCSContext, ISCSServerBinder serverBinder)
          Executes any IDC service command.
 ICISTransferStream executeIDCServiceStream(ISCSContext SCSContext, java.lang.String serviceName, java.util.Map arguments)
          Executes any IDC service command.
 ICISTransferStream executeIDCServiceStream(ISCSRequestModifier requestModifier, ISCSContext SCSContext, ISCSServerBinder serverBinder)
          Executes any IDC service command.
 ICISTransferStream executeIDCServiceStream(ISCSRequestModifier requestModifier, ISCSContext SCSContext, java.lang.String serviceName, java.util.Map arguments)
          Executes any IDC service command.
 ISCSDocTypesResponse getDocumentTypes(ISCSContext SCSContext)
          Retrieve a list of all content item types, their descriptions, and their associated GIF images.
 ISCSDocTypesResponse getDocumentTypes(ISCSRequestModifier requestModifier, ISCSContext SCSContext)
          Retrieve a list of all content item types, their descriptions, and their associated GIF images.
 ICISAPIObjectFactory getObjectFactory()
          Retrieve the object factory associated with this API
 ISCSServerComponentsResponse getServerComponents(ISCSContext SCSContext)
          Query the server configuration and retrieve a list of installed components.
 ISCSServerComponentsResponse getServerComponents(ISCSRequestModifier requestModifier, ISCSContext SCSContext)
          Query the server configuration and retrieve a list of installed components.
 ISCSPingResponse pingServer(ISCSContext SCSContext)
          Ping the content server, evaluates whether a connection to the content server exists and returns status information.
 ISCSPingResponse pingServer(ISCSContext SCSContext, java.lang.String monitoredSubjects, java.lang.String monitoredTopics)
          Ping the content server, evaluates whether a connection to the content server exists and returns status information.
 ISCSPingResponse pingServer(ISCSRequestModifier requestModifier, ISCSContext SCSContext)
          Ping the content server, evaluates whether a connection to the content server exists and returns status information.
 ISCSPingResponse pingServer(ISCSRequestModifier requestModifier, ISCSContext SCSContext, java.lang.String monitoredSubjects, java.lang.String monitoredTopics)
          Ping the content server, evaluates whether a connection to the content server exists and returns status information.
 void validateServerCommunication(ISCSContext SCSContext)
          Validates the connection to the content server, evaluates whether a connection to the content server exists and returns status information.
 void validateServerCommunication(ISCSRequestModifier requestModifier, ISCSContext SCSContext)
          Validates the connection to the content server, evaluates whether a connection to the content server exists and returns status information.

 

Field Detail

API_CATEGORY

static final java.lang.String API_CATEGORY
Category for this Command API
See Also:
Constant Field Values

Method Detail

getObjectFactory

ICISAPIObjectFactory getObjectFactory()
Retrieve the object factory associated with this API

getServerComponents

ISCSServerComponentsResponse getServerComponents(ISCSContext SCSContext)
                                                 throws CommandException
Query the server configuration and retrieve a list of installed components.
Parameters:
SCSContext - the context object representing the current user
Throws:
CommandException
See Also:
"Content Server Documentation for: CONFIG_INFO"

getServerComponents

ISCSServerComponentsResponse getServerComponents(ISCSRequestModifier requestModifier,
                                                 ISCSContext SCSContext)
                                                 throws CommandException
Query the server configuration and retrieve a list of installed components.
Parameters:
requestModifier - modify the request
SCSContext - the context object representing the current user
Throws:
CommandException
See Also:
"Content Server Documentation for: CONFIG_INFO"

getDocumentTypes

ISCSDocTypesResponse getDocumentTypes(ISCSContext SCSContext)
                                      throws CommandException
Retrieve a list of all content item types, their descriptions, and their associated GIF images.
Parameters:
SCSContext - the context object representing the current user
Throws:
CommandException
See Also:
"Content Server Documentation for: GET_DOCTYPES"

getDocumentTypes

ISCSDocTypesResponse getDocumentTypes(ISCSRequestModifier requestModifier,
                                      ISCSContext SCSContext)
                                      throws CommandException
Retrieve a list of all content item types, their descriptions, and their associated GIF images.
Parameters:
requestModifier - modify the request
SCSContext - the context object representing the current user
Throws:
CommandException
See Also:
"Content Server Documentation for: GET_DOCTYPES"

executeIDCService

ISCSServerResponse executeIDCService(ISCSContext SCSContext,
                                     java.lang.String serviceName,
                                     java.util.Map arguments)
                                     throws CommandException

Executes any IDC service command. This is the integration point for all services that need to be executed but do have a corresponding command entry. A services can be executed by specifying the IDC service name and a mapping of service arguments.

For example, to execute a search query (but not use the com.stellent.cis.server.api.scs.commands.search.SearchCommand command, perform the following

 command.setService ("GET_SEARCH_RESULTS"); command.setUser ("sysadmin"); Map arguments = new HashMap (); arguments.put ("QueryText", "test query"); executeCommand.setArguments (arguments); ((ICommandExecutor)BeanFactory.getInstance()).getCommandExecutor (command).executeCommand (command); 

If passing a file stream to the server in the argument map, your stream must of type ICISTransferStream

Parameters:
SCSContext - the context object representing the current user
serviceName - name of the IDC Service that will be executed
arguments - a map of argument name to argument value
Throws:
CommandException

executeIDCService

ISCSServerResponse executeIDCService(ISCSRequestModifier requestModifier,
                                     ISCSContext SCSContext,
                                     java.lang.String serviceName,
                                     java.util.Map arguments)
                                     throws CommandException

Executes any IDC service command. This is the integration point for all services that need to be executed but do have a corresponding command entry. A services can be executed by specifying the IDC service name and a mapping of service arguments.

For example, to execute a search query (but not use the com.stellent.cis.server.api.scs.commands.search.SearchCommand command, perform the following

 command.setService ("GET_SEARCH_RESULTS"); command.setUser ("sysadmin"); Map arguments = new HashMap (); arguments.put ("QueryText", "test query"); executeCommand.setArguments (arguments); ((ICommandExecutor)BeanFactory.getInstance()).getCommandExecutor (command).executeCommand (command); 

If passing a file stream to the server in the argument map, your stream must of type ICISTransferStream

Parameters:
requestModifier - modify the request
SCSContext - the context object representing the current user
serviceName - name of the IDC Service that will be executed
arguments - a map of argument name to argument value
Throws:
CommandException

executeIDCService

ISCSServerResponse executeIDCService(ISCSContext SCSContext,
                                     ISCSServerBinder serverBinder)
                                     throws CommandException

Executes any IDC service command. This is the integration point for all services that need to be executed but do have a corresponding command entry. A services can be executed by specifying the IDC service name and a mapping of service arguments.

For example, to execute a search query (but not use the com.stellent.cis.server.api.scs.commands.search.SearchCommand command, perform the following

 command.setService ("GET_SEARCH_RESULTS"); command.setUser ("sysadmin"); Map arguments = new HashMap (); arguments.put ("QueryText", "test query"); executeCommand.setArguments (arguments); ((ICommandExecutor)BeanFactory.getInstance()).getCommandExecutor (command).executeCommand (command); 

If passing a file stream to the server in the argument map, your stream must of type ICISTransferStream

Parameters:
SCSContext - the context object representing the current user
serverBinder - the populated serverbinder to execute
Throws:
CommandException

executeIDCService

ISCSServerResponse executeIDCService(ISCSRequestModifier requestModifier,
                                     ISCSContext SCSContext,
                                     ISCSServerBinder serverBinder)
                                     throws CommandException

Executes any IDC service command. This is the integration point for all services that need to be executed but do have a corresponding command entry. A services can be executed by specifying the IDC service name and a mapping of service arguments.

For example, to execute a search query (but not use the com.stellent.cis.server.api.scs.commands.search.SearchCommand command, perform the following

 command.setService ("GET_SEARCH_RESULTS"); command.setUser ("sysadmin"); Map arguments = new HashMap (); arguments.put ("QueryText", "test query"); executeCommand.setArguments (arguments); ((ICommandExecutor)BeanFactory.getInstance()).getCommandExecutor (command).executeCommand (command); 

If passing a file stream to the server in the argument map, your stream must of type ICISTransferStream

Parameters:
requestModifier - modify the request
SCSContext - the context object representing the current user
serverBinder - the populated serverbinder to execute
Throws:
CommandException

executeIDCServiceStream

ICISTransferStream executeIDCServiceStream(ISCSContext SCSContext,
                                           java.lang.String serviceName,
                                           java.util.Map arguments)
                                           throws CommandException

Executes any IDC service command. This is the integration point for all services that need to be executed but do have a corresponding command entry. A services can be executed by specifying the IDC service name and a mapping of service arguments.

For example, to execute a search query (but not use the com.stellent.cis.server.api.scs.commands.search.SearchCommand command, perform the following

 command.setService ("GET_SEARCH_RESULTS"); command.setUser ("sysadmin"); Map arguments = new HashMap (); arguments.put ("QueryText", "test query"); executeCommand.setArguments (arguments); ((ICommandExecutor)BeanFactory.getInstance()).getCommandExecutor (command).executeCommand (command); 

If passing a file stream to the server in the argument map, your stream must of type ICISTransferStream

Parameters:
SCSContext - the context object representing the current user
serviceName - name of the IDC Service that will be executed
arguments - a map of argument name to argument value
Throws:
CommandException

executeIDCServiceStream

ICISTransferStream executeIDCServiceStream(ISCSRequestModifier requestModifier,
                                           ISCSContext SCSContext,
                                           java.lang.String serviceName,
                                           java.util.Map arguments)
                                           throws CommandException

Executes any IDC service command. This is the integration point for all services that need to be executed but do have a corresponding command entry. A services can be executed by specifying the IDC service name and a mapping of service arguments.

For example, to execute a search query (but not use the com.stellent.cis.server.api.scs.commands.search.SearchCommand command, perform the following

 command.setService ("GET_SEARCH_RESULTS"); command.setUser ("sysadmin"); Map arguments = new HashMap (); arguments.put ("QueryText", "test query"); executeCommand.setArguments (arguments); ((ICommandExecutor)BeanFactory.getInstance()).getCommandExecutor (command).executeCommand (command); 

If passing a file stream to the server in the argument map, your stream must of type ICISTransferStream

Parameters:
requestModifier - modify the request
SCSContext - the context object representing the current user
serviceName - name of the IDC Service that will be executed
arguments - a map of argument name to argument value
Throws:
CommandException

executeIDCServiceStream

ICISTransferStream executeIDCServiceStream(ISCSContext SCSContext,
                                           ISCSServerBinder serverBinder)
                                           throws CommandException

Executes any IDC service command. This is the integration point for all services that need to be executed but do have a corresponding command entry. A services can be executed by specifying the IDC service name and a mapping of service arguments.

For example, to execute a search query (but not use the com.stellent.cis.server.api.scs.commands.search.SearchCommand command, perform the following

 command.setService ("GET_SEARCH_RESULTS"); command.setUser ("sysadmin"); Map arguments = new HashMap (); arguments.put ("QueryText", "test query"); executeCommand.setArguments (arguments); ((ICommandExecutor)BeanFactory.getInstance()).getCommandExecutor (command).executeCommand (command); 

If passing a file stream to the server in the argument map, your stream must of type ICISTransferStream

Parameters:
SCSContext - the context object representing the current user
serverBinder - the populated serverbinder to execute
Throws:
CommandException

executeIDCServiceStream

ICISTransferStream executeIDCServiceStream(ISCSRequestModifier requestModifier,
                                           ISCSContext SCSContext,
                                           ISCSServerBinder serverBinder)
                                           throws CommandException

Executes any IDC service command. This is the integration point for all services that need to be executed but do have a corresponding command entry. A services can be executed by specifying the IDC service name and a mapping of service arguments.

For example, to execute a search query (but not use the com.stellent.cis.server.api.scs.commands.search.SearchCommand command, perform the following

 command.setService ("GET_SEARCH_RESULTS"); command.setUser ("sysadmin"); Map arguments = new HashMap (); arguments.put ("QueryText", "test query"); executeCommand.setArguments (arguments); ((ICommandExecutor)BeanFactory.getInstance()).getCommandExecutor (command).executeCommand (command); 

If passing a file stream to the server in the argument map, your stream must of type ICISTransferStream

Parameters:
requestModifier - modify the request
SCSContext - the context object representing the current user
serverBinder - the populated serverbinder to execute
Throws:
CommandException

pingServer

ISCSPingResponse pingServer(ISCSContext SCSContext)
                            throws CommandException
Ping the content server, evaluates whether a connection to the content server exists and returns status information.
Parameters:
SCSContext - the context object representing the current user
Throws:
CommandException
See Also:
"Content Server Documentation for: PING_SERVER"

pingServer

ISCSPingResponse pingServer(ISCSRequestModifier requestModifier,
                            ISCSContext SCSContext)
                            throws CommandException
Ping the content server, evaluates whether a connection to the content server exists and returns status information.
Parameters:
requestModifier - modify the request
SCSContext - the context object representing the current user
Throws:
CommandException
See Also:
"Content Server Documentation for: PING_SERVER"

pingServer

ISCSPingResponse pingServer(ISCSContext SCSContext,
                            java.lang.String monitoredSubjects,
                            java.lang.String monitoredTopics)
                            throws CommandException
Ping the content server, evaluates whether a connection to the content server exists and returns status information.
Parameters:
SCSContext - the context object representing the current user
monitoredSubjects - subjects to monitor during the server ping
monitoredTopics - topics to monitor during the server ping
Throws:
CommandException
See Also:
"Content Server Documentation for: PING_SERVER"

pingServer

ISCSPingResponse pingServer(ISCSRequestModifier requestModifier,
                            ISCSContext SCSContext,
                            java.lang.String monitoredSubjects,
                            java.lang.String monitoredTopics)
                            throws CommandException
Ping the content server, evaluates whether a connection to the content server exists and returns status information.
Parameters:
requestModifier - modify the request
SCSContext - the context object representing the current user
monitoredSubjects - subjects to monitor during the server ping
monitoredTopics - topics to monitor during the server ping
Throws:
CommandException
See Also:
"Content Server Documentation for: PING_SERVER"

validateServerCommunication

void validateServerCommunication(ISCSContext SCSContext)
                                 throws CommandException
Validates the connection to the content server, evaluates whether a connection to the content server exists and returns status information.
Parameters:
SCSContext - the context object representing the current user
Throws:
CommandException

validateServerCommunication

void validateServerCommunication(ISCSRequestModifier requestModifier,
                                 ISCSContext SCSContext)
                                 throws CommandException
Validates the connection to the content server, evaluates whether a connection to the content server exists and returns status information.
Parameters:
requestModifier - modify the request
SCSContext - the context object representing the current user
Throws:
CommandException

Skip navigation links

Oracle® Fusion Middleware Content Integration Suite (CIS) Java API Reference
11g Release 1 (11.1)

E17350-01


Copyright © 1996, 2010, Oracle and/or its affiliates. All rights reserved.