|
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 ISCSAdministrativeAPI
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 |
---|
static final java.lang.String API_CATEGORY
Method Detail |
---|
ICISAPIObjectFactory getObjectFactory()
ISCSServerComponentsResponse getServerComponents(ISCSContext SCSContext) throws CommandException
SCSContext
- the context object representing the current userCommandException
ISCSServerComponentsResponse getServerComponents(ISCSRequestModifier requestModifier, ISCSContext SCSContext) throws CommandException
requestModifier
- modify the requestSCSContext
- the context object representing the current userCommandException
ISCSDocTypesResponse getDocumentTypes(ISCSContext SCSContext) throws CommandException
SCSContext
- the context object representing the current userCommandException
ISCSDocTypesResponse getDocumentTypes(ISCSRequestModifier requestModifier, ISCSContext SCSContext) throws CommandException
requestModifier
- modify the requestSCSContext
- the context object representing the current userCommandException
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
SCSContext
- the context object representing the current userserviceName
- name of the IDC Service that will be executedarguments
- a map of argument name to argument valueCommandException
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
requestModifier
- modify the requestSCSContext
- the context object representing the current userserviceName
- name of the IDC Service that will be executedarguments
- a map of argument name to argument valueCommandException
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
SCSContext
- the context object representing the current userserverBinder
- the populated serverbinder to executeCommandException
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
requestModifier
- modify the requestSCSContext
- the context object representing the current userserverBinder
- the populated serverbinder to executeCommandException
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
SCSContext
- the context object representing the current userserviceName
- name of the IDC Service that will be executedarguments
- a map of argument name to argument valueCommandException
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
requestModifier
- modify the requestSCSContext
- the context object representing the current userserviceName
- name of the IDC Service that will be executedarguments
- a map of argument name to argument valueCommandException
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
SCSContext
- the context object representing the current userserverBinder
- the populated serverbinder to executeCommandException
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
requestModifier
- modify the requestSCSContext
- the context object representing the current userserverBinder
- the populated serverbinder to executeCommandException
ISCSPingResponse pingServer(ISCSContext SCSContext) throws CommandException
SCSContext
- the context object representing the current userCommandException
ISCSPingResponse pingServer(ISCSRequestModifier requestModifier, ISCSContext SCSContext) throws CommandException
requestModifier
- modify the requestSCSContext
- the context object representing the current userCommandException
ISCSPingResponse pingServer(ISCSContext SCSContext, java.lang.String monitoredSubjects, java.lang.String monitoredTopics) throws CommandException
SCSContext
- the context object representing the current usermonitoredSubjects
- subjects to monitor during the server pingmonitoredTopics
- topics to monitor during the server pingCommandException
ISCSPingResponse pingServer(ISCSRequestModifier requestModifier, ISCSContext SCSContext, java.lang.String monitoredSubjects, java.lang.String monitoredTopics) throws CommandException
requestModifier
- modify the requestSCSContext
- the context object representing the current usermonitoredSubjects
- subjects to monitor during the server pingmonitoredTopics
- topics to monitor during the server pingCommandException
void validateServerCommunication(ISCSContext SCSContext) throws CommandException
SCSContext
- the context object representing the current userCommandException
void validateServerCommunication(ISCSRequestModifier requestModifier, ISCSContext SCSContext) throws CommandException
requestModifier
- modify the requestSCSContext
- the context object representing the current userCommandException
|
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 |