| Home >> All >> org >> jbpm |
| • | org.jbpm.examples.* (8) | • | org.jbpm.test.* (5) | • | org.jbpm.util.* (58) | • | org.jbpm.web.* (57) |
| • | org.jbpm.workflow.* (193) |
Package Samples:
• org.jbpm.workflow.organisation.impl: is the read-only interface to organisation information : org.jbpm.workflow.organisation.User s, org.jbpm.workflow.organisation.Group s and org.jbpm.workflow.organisation.Membership s.
• org.jbpm.workflow.delegation.impl: is the package that contains all delegation interfaces and the DelegateContext's as described in "The delegation principle" on the jBpm website.
• org.jbpm.workflow.log.impl: contains is the interface for retrieving audit logger information about process executions.
• org.jbpm.util.experimental.container.lifecycle: This container specification is a runtime environment for loosely coupled components.
• org.jbpm.workflow.scheduler.ejb: contains the interface for scheduling time-based process events.
• org.jbpm.workflow.execution.impl: contains the interface for execution of processes .
• org.jbpm.workflow.execution.ejb.impl
• org.jbpm.workflow.execution.ejb
• org.jbpm.workflow.execution
• org.jbpm.workflow.definition.impl
• org.jbpm.workflow.definition.attribute
• org.jbpm.workflow.definition.ejb.impl
• org.jbpm.workflow.definition.ejb
• org.jbpm.workflow.definition
• org.jbpm.workflow.delegation.impl.serializer
• org.jbpm.workflow.delegation.impl.htmlformatter
• org.jbpm.workflow.delegation.impl.assignment
• org.jbpm.workflow.delegation.impl.action
• org.jbpm.workflow.delegation.impl.decision
• org.jbpm.workflow.delegation.impl.join
Classes:
• AssignmentHandler: is the delegation interface for selecting the org.jbpm.workflow.organisation.User or org.jbpm.workflow.organisation.Group that will be assigned as actor for an acitivity. For more information on activity assignment see also the concepts page on the jBpm website After the assignment of an actor to an activity, the actor is the only user that is able to act upon the activity. An actor of an activity can do one of the following actions : perform the activity delegate the activity to another user cancel the flow cancel the process instance If an activity is assigned to a org.jbpm.workflow.organisation.Group ...
• ExecutionComponent: is the session facade that exposes the interface for the execution of processes. WfMC In WfMC-terminology this is interface 2 : Workflow Client API. Authentication Authentication is letting the ExecutionSession-bean know which user is calling a method. There are 2 ways of authenticating the User that executes a method upon an ExecutionSession-bean. using J2EE-security and the stateless session bean. See ExecutionSecuredSessionLocalHome using the statefull non-secure session bean. See ExecutionSessionLocalHome . In this case, the client can freely specify the user-name. Component interface The two ...
• AttributeInstance: is a process-variable associated with one process instance. The value can be changed during the execution of the flow in following ways : field input : In the org.jbpm.workflow.definition.ProcessDefinition , a org.jbpm.workflow.definition.Field associates an attribute with an Activity . When an actor performs that Activity , it has to provide input for the attribute. The value that is provided by the actor is stored in the AttributeInstance. interaction : In every org.jbpm.workflow.delegation.Interaction -implementation the implementor has read & write access to all AttributeInstances through the ...
• Flow: represents one 'thread-of-execution' for a sequence of Activity s. Flows hierarchically ordered. When starting a process instance, a root-flow will be created. At a fork, the parent-flow will spawn a set of child-flows and then wait until they join again. The 3 methods getActivity(), getFork() and getJoin() combined represent the state of a flow. A flow is always in one of 4 states : activity : the flow is waiting until an actor performs the activity. All state-getters will return null except getActivity() fork : a flow is assigned to a fork when it is waiting on its subflows to join again. All ...
• ActionHandler: is the delegation-interface for the execution of process-initiated actions. Interactions are used to communicate with the existing infrastructure in an organisation. The InteractionContext allows the Interaction-developer to access all information about the process instance. The Interaction is executed within a J2EE-container so by instantiating an javax.naming.InitialContext without constructor-parameters, the Interaction-developer can use all J2EE technologies to communicate with the existing infrastructure in the organisation. jBpm provides a lot of ready-to-use, configurable interactions such ...
• OrganisationComponent: is this component's interface that is used by the process execution component for obtaining organisational information such as Users, Groups and Memberships. The implementation of this component can be customized so that organisational data is fetched from whatever IT-system. Therefor the organisation-component is only accessed by the other components through this local interface, never directly to the database. This design makes it easier to change the implementation of this component so that it is coupled to e.g. an LDAP server instead of the default jBpm-database-tables. This interface is kept ...
• Relations: specifies which related objects should be resolved for data-transfer-objects, returned from a session-facade. A session facade is supposed to collect data from the persistency-layer and return data-transfer-objects to the client. If the datamodel has a lot of relations, a problem arises : Which related objects should be resolved in the object that is returned to the client. A Relations-object is a convenient way of specifying which related objects you want to be resolve on the objects returned by the session facade. You can specify these Relations with dot-separated property-names. E.g. if the ...
• ActorExpressionResolver: resolves an expression to a user or a group using the following syntax : The general syntax is firstArgument->nextArgument->nextArgument->...->nextArgument For the firstArgument, following constructions are valid : previousActor : processInitiator : actor( <actorName> ) : role( <attributeName> ) : user( <userName> ) : group( <groupName> ) : For the nextArgument's, following constructions are valid : [User]->group( <membership-type> ) results in a Group [Group]->role( <role> ) results in a User [Group]->parentGroup results in a Group
• AssignmentExpressionResolver: allows to specify the next-actor in a process definition as an expression using the following syntax. The general syntax is firstArgument->nextArgument->nextArgument->...->nextArgument For the firstArgument, following constructions are valid : previousActor : actor( <actorName> ) : user( <userName> ) : group( <groupName> ) : For the nextArgument's, following constructions are valid : [User]->group( <membership-type> ) results in a Group [Group]->role( <role> ) results in a User [Group]->parentGroup results in a Group
• HtmlFormatter: is an interface used for the automatic generation of activity-forms in the web-interface. IMPORTANT NOTE : In the web-interface, the class-name is used as a key for finding the internationalized name of this HtmlFormatter. It is used when a ParseException is thrown in parseHttpParameter(java.lang.String, javax.servlet.http.HttpServletRequest) 55 to inform the user what kind of data whas excpected. The error-msg is constructed like this : "Wrong input for field [field-name]. [received-value] could not be parsed as [translated text for html-formatter]"
• Group: is any type of collection of users. Organisational entities such as a business unit, a department, a team, ... or a goup could be created for e.g. : all the people with red hair. Groups can be ordered hierarchically. This is mostly the case in groups that represent the organisational hierarchy. Since it's not possible to capture all group-information that is used in all organisations in this interface, a basic default set of properties is provided and it is made easy to extend them by customizing this organisation component.
• DefinitionComponent: is the session facade that exposes the interface for loading process definitions into the process engine. For an introduction on how to build process definitions please refer to 'The jBpm Process definition language' (jPdl) on the jBpm website. Also the DTD and XSD of the processdefinition.xml file can be found there. For more information on how jBpm copes with multiple versions of the same process definition, see section 'Versioning' on the jBpm website .
• Configuration: contains the configurations as specified within a configuration-element inside the configuration.xml. The 'path' parameter is a dot-separated hierarchical name. The hierarchy corresponds with the xml-nesting. E.g. path one.two.three could correspond with <one> <two> <three> --this is the value-- </three> </two> </one> Alternatively, XPath could be used for this, I think.
• DecisionHandler: if more then one org.jbpm.workflow.definition.Transition leaves an org.jbpm.workflow.definition.Activity , a Decision chooses the org.jbpm.workflow.definition.Transition that has to be activated when the org.jbpm.workflow.definition.Activity is performed. See also The delegation principle .
• JpdlException: is the checked exception that is thrown when a process archive is not compliant as specified in the jBpm Process Defintition Language (jPdl). A JpdlException tries to collect as many error messages in one parsing or validation, analogue to a compiler. This allows a process developer to correct more then one problem before redeploying the process archive. Each message is optionally composed of a list of sub-messages separated by colons ':'. The sub-messages are ordered from general to specific.
• User: represents a human user or an IT-system. In most methods of the ExecutionSession-bean, that bean needs to to know which User is performing that operation. The userName is used in the ExecutionSession-bean to identify the User-object. Since it's not possible to capture all user-information that is used in all organisations in this interface, a basic default set of properties is provided and it is made easy to extend them by customizing this organisation component.
• HttpInputException: is thrown when the http-parameters are not as expected due to a bug in the application-software or if somebody is hacking with the url's. This exception should result in the displaying of an error-page that says that shows the message of this exception. NOTE: This exception should not be thrown when the user- input is not as expected. In such cases Msg's should be put in the ActionContext so they are displayed to the user in the appropriate screen.
• Evaluation: is a frequently used Attribute-type, it is used for representing the result of an approval decision. The org.jbpm.workflow.delegation.Serializer for Evaluation-objects is org.jbpm.workflow.delegation.impl.serializer.EvaluationSerializer. To convert Evaluation-objects in jBpm's web-interface to and from html, use org.jbpm.workflow.delegation.impl.htmlformatter.EvaluationHtmlFormatter as org.jbpm.workflow.delegation.HtmlFormatter
• Serializer: performs (de)serialisation of org.jbpm.workflow.execution.AttributeInstance -values (which are ordinary java-objects), for storage in the database. It is even possible to use a process specific java-type as org.jbpm.workflow.execution.AttributeInstance -value.
• Aspect: is a decorator for services, also known as interceptor (jboss) or filter (servlets). An Aspect-implementation must have the following constructor : Constructor( Container, Configuration ) throws DependancyException, ConfigurationException; Aspects can be chained. Note that in a chain the postInvocations are called in the opposite order then the preInvocations.
• DbSession: This class wraps the Hibernate Session. It adds the guarantee that if a method throws an exception, the session will already be closed. Furthermore, this wrapper adds 2 convenience-methods findOne(...) and iterateOne(...) that checks if exactly one object is returned and extracts that single object from the collection.
• AuthorizationHandler: verifies if an authenticated user has enough privileges. An AuthorizationHandler can be specified on the level of a process definition. All method-calls to the admin and execution component that are related to that process definition will call the AuthorizationHandler to validate authorization.
• TcpProxy: This is a modified version of the TcpTunnelGui utility borrowed from the xml.apache.org project. A TcpTunnelGui object listens on the given port, and once Start is pressed, will forward all bytes to the given host and port. All traffic is displayed in a UI.
• Actor: is a User or a Group to which a flow can be assigned.
• Membership: represents the n-m relation between User s and Group s.
| Home | Contact Us | Privacy Policy | Terms of Service |