Java Doc for ToolAgentFactory.java in » Workflow-Engines » obe-1.0 » org » obe » spi » service » Java Source Code / Java DocumentationJava Source Code and Java Documentation

Java Source Code / Java Documentation

1.	6.0 JDK Core
2.	6.0 JDK Modules
3.	6.0 JDK Modules com.sun
4.	6.0 JDK Modules com.sun.java
5.	6.0 JDK Modules sun
6.	6.0 JDK Platform
7.	Ajax
8.	Apache Harmony Java SE
9.	Aspect oriented
10.	Authentication Authorization
11.	Blogger System
12.	Build
13.	Byte Code
14.	Cache
15.	Chart
16.	Chat
17.	Code Analyzer
18.	Collaboration
19.	Content Management System
20.	Database Client
21.	Database DBMS
22.	Database JDBC Connection Pool
23.	Database ORM
24.	Development
25.	EJB Server geronimo
26.	EJB Server GlassFish
27.	EJB Server JBoss 4.2.1
28.	EJB Server resin 3.1.5
29.	ERP CRM Financial
30.	ESB
31.	Forum
32.	GIS
33.	Graphic Library
34.	Groupware
35.	HTML Parser
36.	IDE
37.	IDE Eclipse
38.	IDE Netbeans
39.	Installer
40.	Internationalization Localization
41.	Inversion of Control
42.	Issue Tracking
43.	J2EE
44.	JBoss
45.	JMS
46.	JMX
47.	Library
48.	Mail Clients
49.	Net
50.	Parser
51.	PDF
52.	Portal
53.	Profiler
54.	Project Management
55.	Report
56.	RSS RDF
57.	Rule Engine
58.	Science
59.	Scripting
60.	Search Engine
61.	Security
62.	Sevlet Container
63.	Source Control
64.	Swing Library
65.	Template Engine
66.	Test Coverage
67.	Testing
68.	UML
69.	Web Crawler
70.	Web Framework
71.	Web Mail
72.	Web Server
73.	Web Services
74.	Web Services apache cxf 2.0.1
75.	Web Services AXIS2
76.	Wiki Engine
77.	Workflow Engines
78.	XML
79.	XML UI

Java

Java Tutorial

Illustrator Tutorials

GIMP Tutorials

C# / C Sharp

C# / CSharp Tutorial

C# / CSharp Open Source

SQL Server / T-SQL Tutorial

Oracle PL / SQL

Oracle PL/SQL Tutorial

Flash / Flex / ActionScript

VBA / Excel / Access / Word

XML

XML Tutorial

Microsoft Office PowerPoint 2007 Tutorial

Microsoft Office Excel 2007 Tutorial

Microsoft Office Word 2007 Tutorial

Java Source Code / Java Documentation » Workflow Engines » obe 1.0 » org.obe.spi.service

Source Cross Reference

Class Diagram

Java Document (Java Doc)

org.obe.spi.service .ToolAgentFactory

All known Subclasses:   org.obe.runtime.tool .BasicToolAgentFactory,
ToolAgentFactory
public interface ToolAgentFactory extends WorkflowService(Code)
Standard interface for a tool agent factory. The tool agent factory is used to retrieve tool agents at run-time. Workflow tool IDs are mapped to a specific agent at run-time.
author:
   Adrian Price

Field Summary
String SERVICE_NAME


Method Summary
void createTool(ToolAgentMetaData tool)
     Registers a tool.
void deleteTool(String id)
     Unregisters a tool.
ToolAgent findToolAgent(Application toolDef, Parameter[] parameters)
     Finds a tool agent.
ToolAgentMetaData[] findToolMetaData()
     Finds meta-data for all tools.
ToolAgentMetaData findToolMetaData(Application toolDef)
     Finds meta-data for a tool.
ToolAgentMetaData findToolType(String className, String locale)
     Returns information about the specified too type.
ToolAgentMetaData[] findToolTypes(String locale)
     Finds all tool types known to the repository.
void updateTool(ToolAgentMetaData tool)
     Updates a tool.

Field Detail
SERVICE_NAME
String SERVICE_NAME(Code)

Method Detail
createTool
void createTool(ToolAgentMetaData tool) throws RepositoryException(Code)
Registers a tool.
Parameters:
  tool - The tool definition.
throws:
  ObjectAlreadyExistsException - if the tool ID is alreadyregistered.
throws:
  RepositoryException - if the tool could not be registered someother reason.

deleteTool
void deleteTool(String id) throws RepositoryException(Code)
Unregisters a tool.
Parameters:
  id - The tool ID.
throws:
  ObjectNotFoundException - if the tool ID is not registered.
throws:
  RepositoryException - if the tool could not be unregistered forsome other reason.

findToolAgent
ToolAgent findToolAgent(Application toolDef, Parameter[] parameters) throws RepositoryException(Code)
Finds a tool agent. This method is called by the engine at run-time when it needs to execute the tool invocation.
Parameters:
  toolDef - The XPDL tool definition.
Parameters:
  parameters - The parameters to pass to a stateful (non-threadsafe)tool agent's constructor. N.B. Stateless tool agents ignore thisparameter but it must always be passed because the caller does not knowwhether the tool itself is threadsafe. A tool agent to invoke the specified tool.
throws:
  ObjectNotFoundException - if no suitable tool agent is registered.
throws:
  RepositoryException - if some other error occurred.

findToolMetaData
ToolAgentMetaData[] findToolMetaData() throws RepositoryException(Code)
Finds meta-data for all tools. This method is intended to support design-time clients and management applications. The list of all tools.
throws:
  RepositoryException - if an error occurred.

findToolMetaData
ToolAgentMetaData findToolMetaData(Application toolDef) throws RepositoryException(Code)
Finds meta-data for a tool. This method is intended to support design-time clients and management applications.
Parameters:
  toolDef - The XPDL tool definition. Meta-data about the requested tool.
throws:
  ObjectNotFoundException - if the tool is not registered.
throws:
  RepositoryException - if some other error occurred.

findToolType
ToolAgentMetaData findToolType(String className, String locale) throws RepositoryException(Code)
Returns information about the specified too type. This method is intended to support design-time clients and management applications.
Parameters:
  className - The tool type (i.e., the fully qualified name of theimplementation class).
Parameters:
  locale - The locale in which the results should be formatted. Information about the specified tool type.
throws:
  ObjectNotFoundException - if the tool type is unknown.
throws:
  RepositoryException - if some other error occurred.

findToolTypes
ToolAgentMetaData[] findToolTypes(String locale) throws RepositoryException(Code)
Finds all tool types known to the repository. This method is intended to support design-time clients and management applications.
Parameters:
  locale - The locale in which the results should be formatted. All tool types.
throws:
  RepositoryException - if an error occurred.

updateTool
void updateTool(ToolAgentMetaData tool) throws RepositoryException(Code)
Updates a tool.
Parameters:
  tool - The tool definition.
throws:
  ObjectNotFoundException - if the tool ID is not registered.
throws:
  RepositoryException - if the tool could not be updated for someother reason.

www.java2java.com | Contact Us

All other trademarks are property of their respective owners.