|
|
The file CiscoTaskServiceModel.idl contains the following interfaces:
CiscoTaskServiceModel::TaskMgr CiscoTaskServiceModel::TaskServer
The CiscoTaskServiceModel module defines a set of CORBA interface with which to manage specific tasks. The TaskServer interface is the entry point for the Task Server. The TaskMgr interface represents a manager object for a particular client. It is the primary interface to top-level task objects, such as persistent tasks, scheduled tasks and runtime tasks. The TaskMgr object also tracks task-object creation and deletes the TaskMgr object when the client connection is closed.
Before sending task requests, you must program your clients to bind to a TaskServer object and get a TaskMgr object. Through these interfaces, you can program your client software to:
The Cisco VPN Solutions Center software also has an embedded database, the Task Repository. The Task Repository maps the task objects to the database schema. All objects are stored in the Task Repository tables.
See Also
CiscoTaskManagedObjects, CiscoTaskExceptions
Since
Cisco VPN Solutions Center, Release 1.1
An instance of the TaskMgr manages the creation of top level Task objects, through which a client can query, create and delete other task objects.
Since
Cisco VPN Solutions Center, Release 1.1
Gets all active runtime tasks from the Task Repository
Usage
CiscoTaskManagedObjects::TaskRuntimeTaskSeq getAllActiveRuntimeTasks(); raises(RepException);
Parameters
None
Returns
TaskRuntimeTaskSeq—List of runtime tasks(TaskRuntimeTask which is active
Raises
CiscoTaskExceptions::RepException if a Task Repositoryerror occurs.
See Also
CiscoTaskManagedObjects::TaskRuntimeTask
Since
Cisco VPN Solutions Center, Release 1.1
Gets all TaskPersistentTask objects in the Task Repository
Usage
CiscoTaskManagedObjects::TaskPersistentTaskSeq getAllPersistentTasks(); raises(RepException);
Returns
TaskPersistentTaskSeq—List of persistent tasks (CiscoTaskManagedObjects::TaskPersistentTask) which is stored in the Task Repository.
Raises
CiscoTaskExceptions::RepException if a Task Repositoryerror occurs.
See Also
CiscoTaskManagedObjects::TaskPersistentTask
Since
Cisco VPN Solutions Center, Release 1.1
Get all TaskRuntimeTask objects from the Task Repository.
Usage
CiscoTaskManagedObjects::TaskRuntimeTaskSeq getAllRuntimeTasks(); raises(RepException);
Parameters
None
Returns
TaskRuntimeTaskSeq—List of runtime tasks(TaskRuntimeTask which are stored in the Task Repository.
Raises
CiscoTaskExceptions::RepException if a Task Repositoryerror occurs
See Also
CiscoTaskManagedObjects::TaskRuntimeTask
Since
Cisco VPN Solutions Center, Release 1.1
Gets all TaskScheduledTask objects in the Task Repository
Usage
CiscoTaskManagedObjects::TaskScheduledTaskSeq getAllScheduledTasks(); raises(RepException);
Returns
TaskScheduledTaskSeq—List of TaskScheduledTask objects that are stored in the Task Repository.
Raises
CiscoTaskExceptions::RepException if a Task Repositoryerror occurs.
See Also
CiscoTaskManagedObjects::TaskScheduledTask
Since
Cisco VPN Solutions Center, Release 1.1
Gets all targets from directory the Task Repository.
Usage
CiscoTaskManagedObjects::DevTargetSeq getAllTargets(); raises(RepException);
Parameters
None
Returns
DevTargetSeq—a sequence of DevTarget objects.
Raises
CiscoTaskExceptions::RepException if a Task Repositoryerror occurs.
See Also
CiscoTaskManagedObjects::DevTarget
Since
Cisco VPN Solutions Center, Release 1.1
Gets a TaskPersistentTask object by its task Name.
Usage
CiscoTaskManagedObjects::TaskPersistentTask getPersistentTaskByName(in string taskName)
raises(RepException);
Parameters
taskName—in string that represents the name of the TaskPersistentTask object to get.
Returns
TaskPersistentTask—The TaskPersistentTask object that has that the name supplied through the taskName input parameter.
Raises
CiscoTaskExceptions::RepException if a Task Repositoryerror occurs.
See Also
CiscoTaskManagedObjects::TaskPersistentTask
Since
Cisco VPN Solutions Center, Release 1.1
Gets the time of the last updated time of the Task Repository
Usage
CiscoTaskManagedObjects::TaskTime getRepLastUpdateTime(); raises(RepException);
Returns
CiscoTime::Time object which represents the time of the Task Repository was last updated.
Raises
CiscoTaskExceptions::RepException if a Task Repositoryerror occurs.
See Also
CiscoTime::Time
Since
Cisco VPN Solutions Center, Release 1.1
Gets a TaskRuntimeTask object by its ID
Usage
CiscoTaskManagedObjects::TaskRuntimeTask getRuntimeTaskByID(in string runtimeID)
raises(RepException);
Parameters
runtimeID—a string that represents the runtime task ID
Returns
TaskRuntimeTask—object which has that ID
Raises
CiscoTaskExceptions::RepException if a Task Repositoryerror occurs
See Also
CiscoTaskManagedObjects::TaskRuntimeTask
Since
Cisco VPN Solutions Center, Release 1.1
Get all TaskRuntimeTask objects contained in a scheduled task.
Usage
CiscoTaskManagedObjects::TaskRuntimeTaskSeq getRuntimeTasksForAScheduledTask(in CiscoTaskManagedObjects::TaskScheduledTask scheduledTask)
raises(RepException);
Parameters
scheduledTask—a TaskScheduledTask object which contain runtime tasks.
Returns
TaskRuntimeTaskSeq—List of runtime tasks(TaskRuntimeTask which contained in a scheduled task.
Raises
CiscoTaskExceptions::RepException if a Task Repositoryerror occurs
See Also
CiscoTaskManagedObjects::TaskRuntimeTask, CiscoTaskManagedObjects::TaskScheduledTask
Since
Cisco VPN Solutions Center, Release 1.1
Gets a TaskScheduledTask object by its schedule task name
Usage
CiscoTaskManagedObjects::TaskScheduledTask getScheduledTaskByName(in string scheduleName)
raises(RepException);
Parameters
scheduleName—a string represents the Name of the scheduled task.
Returns
TaskScheduledTask object with the specified task name
Raises
CiscoTaskExceptions::RepException if a Task Repositoryerror occurs.
See Also
CiscoTaskManagedObjects::TaskScheduledTask
Since
Cisco VPN Solutions Center, Release 1.1
Gets all TaskScheduledTask objects that belong to a specified TaskPersistentTask object.
Usage
CiscoTaskManagedObjects::TaskScheduledTaskSeq getScheduledTasksForAPersistentTask(in CiscoTaskManagedObjects::TaskPersistentTask persistentTask)
raises(RepException);
Parameters
persistentTask—a TaskPersistentTask that we want to get its scheduled tasks.
Returns
TaskScheduledTaskSeq—List of TaskScheduledTask objects that belong to a specific TaskPersistentTask object.
Raises
CiscoTaskExceptions::RepException if a Task Repositoryerror occurs.
See Also
CiscoTaskManagedObjects::TaskScheduledTask
Since
Cisco VPN Solutions Center, Release 1.1
Gets a CiscoTaskFactory::TaskFactory object. User can use this object to create all the standard tasks supported by Cisco VPN Solutions Center.
Usage
CiscoTaskFactory::TaskFactory getTaskFactory();
Returns
TaskFactory—a TaskFactory object.
See Also
CiscoTaskFactory::TaskFactory
Since
Cisco VPN Solutions Center, Release 1.1
Creates an emtpy instance of the CiscoTaskManagedObjects::TaskAction interface.
Usage
CiscoTaskManagedObjects::TaskAction newAction(in short index)
raises(RepException);
Parameters
index—in short that uniquely identifies the TaskAction object within the CiscoTaskManagedObjects::TaskPersistentTask object to which it belongs.
Returns
CiscoTaskManagedObjects::TaskAction—An empty instance of the CiscoTaskManagedObjects::TaskAction interface.
Raises
CiscoTaskExceptions::RepException if a Task Repositoryerror occurs.
Description
Program your client-application code to set attributes for the new CiscoTaskManagedObjects::TaskAction object before storing it in the Task Repository.
See Also
CiscoTaskManagedObjects::TaskAction, CiscoTaskManagedObjects::TaskPersistentTask
Since
Cisco VPN Solutions Center, Release 1.1
Creates an empty instance of the CiscoTaskManagedObjects::TaskPersistentTask interface.
Usage
CiscoTaskManagedObjects::TaskPersistentTask newPersistentTask(in string taskName);
Parameters
taskName—in string that represents the name of the new CiscoTaskManagedObjects::TaskPersistentTask object to be created.
Returns
CiscoTaskManagedObjects::TaskPersistentTask—An empty instance of the CiscoTaskManagedObjects::TaskPersistentTask interface.
Description
Program your client-application code to set attributes for the new CiscoTaskManagedObjects::TaskPersistentTask object before storing it in the Task Repository.
See Also
releasePersistentTask
Since
Cisco VPN Solutions Center, Release 1.1
Creates an emtpy instance of the CiscoTaskManagedObjects::TaskScheduledTask interface.
Usage
CiscoTaskManagedObjects::TaskScheduledTask newScheduledTask(in string taskName)
raises(RepException);
Parameters
taskName—in string that represents the name of the new CiscoTaskManagedObjects::TaskPersistentTask object to be created.
Returns
CiscoTaskManagedObjects::TaskScheduledTask—An empty instance of the CiscoTaskManagedObjects::TaskScheduledTask interface.
Raises
CiscoTaskExceptions::RepException if a Task Repositoryerror occurs.
Description
Program your client-application code to set attributes for the new CiscoTaskManagedObjects::TaskScheduledTask object before storing it in the Task Repository.
See Also
CiscoTaskManagedObjects::TaskScheduledTask
Since
Cisco VPN Solutions Center, Release 1.1
Releases the TaskAction object from the Task Server
Usage
void releaseAction(in CiscoTaskManagedObjects::TaskAction action);
Parameters
action represents the TaskAction object to be released.
See Also
newAction
Since
Cisco VPN Solutions Center, Release 1.1
Releases the CiscoFileInputStream object from the Task Server
Usage
void releaseFileInputStream(in CiscoStream::CiscoFileInputStream streamReference);
Parameters
streamReference—CiscoStream::CiscoFileInputStream that represents the CiscoFileInputStream object to be released.
See Also
newFileInputStream
Since
Cisco VPN Solutions Center, Release 1.1
Releases the TaskPersistentTask object from the Task Server
Usage
void releasePersistentTask(in CiscoTaskManagedObjects::TaskPersistentTask persistentTask);
Parameters
persistentTask represents a TaskPersistentTask object to be released.
See Also
newPersistentTask
Since
Cisco VPN Solutions Center, Release 1.1
Releases the TaskRuntimeAction object from the Task Server
Usage
void releaseRuntimeAction(in CiscoTaskManagedObjects::TaskRuntimeAction runtimeAction);
Parameters
runtimeAction represents the TaskRuntimeAction object to be released.
Since
Cisco VPN Solutions Center, Release 1.1
Releases the TaskRuntimeActionGlobalState object from the Task Server
Usage
void releaseRuntimeGlobalState(in CiscoTaskManagedObjects::TaskRuntimeActionGlobalState runtimeState);
Parameters
runtimeState represents the TaskRuntimeActionGlobalState object to be released.
Since
Cisco VPN Solutions Center, Release 1.1
Releases the TaskRuntimeTask object from the Task Server
Usage
void releaseRuntimeTask(in CiscoTaskManagedObjects::TaskRuntimeTask runtimeTask);
Parameters
runtimeTask represents the TaskRuntimeTask object to be released.
Since
Cisco VPN Solutions Center, Release 1.1
Releases the TaskScheduledTask object from the Task Server
Usage
void releaseScheduledTask(in CiscoTaskManagedObjects::TaskScheduledTask scheduledTask);
Parameters
scheduledTask represents the TaskScheduledTask object to be released.
Raises
None
See Also
newScheduledTask
Since
Cisco VPN Solutions Center, Release 1.1
An instance of the TaskServer interface is the global singleton object through which a client application can connect to the Task Server and obtain its corresponding TaskClientMgr object. In a thread per client model, each different client will have its own TaskMgr object.
See Also
TaskMgr
Since
Cisco VPN Solutions Center, Release 1.1
gets corresponding TaskMgr object. if a new client connects the first time, it will get a new instance of TaskMgr.
Usage
TaskMgr getTaskMgr();
Returns
TaskMgr—Object that represents the VPN Inventory Manager for the client application.
See Also
TaskMgr
Since
Cisco VPN Solutions Center, Release 1.1
Verifies the TaskServer object is executing properly. If not, the client will get an exception.
Usage
void ping();
Since
Cisco VPN Solutions Center, Release 1.1
Posted: Tue Sep 26 16:50:45 PDT 2000
Copyright 1989-2000©Cisco Systems Inc.