All Downloads are FREE. Search and download functionalities are using the official Maven repository.

a.bonita-server.5.0.M4.source-code.wire.xsd Maven / Gradle / Ivy




        
  
    XML schema to express how java objects can be 
    created and wired together.  aka IoC.
    
  

  

  
    A BusinessCalendar that knows about working hours
    
      
        
        
        
        
        
        
        
        
          
            
              Two dates in date-format, separated by 
              a dash that specify a holiday period.  If it's just one day, a single day 
              is also valid.
            
          
        
      
      
        Optional specification of the timezone as specified by 
        java.util.TimeZone.getTimeZone(String)
      
      
        Indicates how to interpret the hour specifications 
        in this business calendar in java.text.SimpleDateFormat(String)
      
      
        Indicates how to interpret the date specifications 
        in this business calendar in java.text.SimpleDateFormat(String)
      
    
  

  
    A java.lang.Byte
	  
	    
	      The name of the object.  It's optional and serves 
	      as an id to refer to this object from other object declarations.  This name can 
	      also be used lookup the object programmatically.
	    
	    
	  
  

  
    A java.lang.Character
	  
	    
	      The name of the object.  It's optional and serves 
	      as an id to refer to this object from other object declarations.  This name can 
	      also be used lookup the object programmatically.
	    
	    
	      
	        
	          
	        
	      
	    
	  
  
  
  
    A java.lang.Class
		
	    
	      The name of the object.  It's optional and serves 
	      as an id to refer to this object from other object declarations.  This name can 
	      also be used lookup the object programmatically.
	    
		  
		    Specifies when and how this object should be 
		    created and initialized. Default is lazy.
		  
		  
		    A fully qualified name of a
		      class that can be found on the wire context classpath or 
		      (if that is not specified) on the current thread's context 
		      classpath.  
		    
		  
		
  
  
  
    The context.  This refers to
    the environment, environment-factory or the wire context.
    
    
      
        The name of the context in the current 
        environment.  If this attribute is omitted, the enclosing 
        context will be given. 
        
      
    
  

  
    Defines an environment factory and 
    an environment.
    
    
      
        
        
      
    
  

  
    Defines the environment factory 
    context.  (Aka application context)
    
  

  
    Defines the environment 
    context.  This context exists stretches for the duration of 
    an Environment try-finally block.
    
  

  
    Has a list of deployers (org.ow2.bonita.deploy.Deployer) 
    for each process language for handling deployments.  
    
	  
	    
	    	
		      A process language that contains 
		      a list of deployers
	    	  
	    	    
	    	      
	    	    
	          
	          
	    	  
	    	
	    
	    
	      The name of the object.  It's optional and serves 
	      as an id to refer to this object from other object declarations.  This name can 
	      also be used lookup the object programmatically.
	    
	    
	      Specifies when and how this object should be 
	      created and initialized. Default is lazy.
	    
	    
	      Imports contents of the document element 
	      of all resource files (using deep scan ClassLoader.getResources(String)) 
	      as content into this element.
	      
	    
	  
  

  
    A java.lang.Double
	  
	    
	      The name of the object.  It's optional and serves 
	      as an id to refer to this object from other object declarations.  This name can 
	      also be used lookup the object programmatically.
	    
	    
	  
  

  
    Obtains the current environment.  The environment 
    is only available in objects declared inside the environment context.  So it 
    can't be used inside the session-factory context. 
    
  

  
    Obtains the current environment.  The environment 
    is only available in objects declared inside the environment context.  So it 
    can't be used inside the session-factory context. 
    
  

  
    java.lang.Boolean.FALSE 
    
    
	    
	      The name of the object.  It's optional and serves 
	      as an id to refer to this object from other object declarations.  This name can 
	      also be used lookup the object programmatically.
	    
    
  

  
    A java.lang.Float
    
	  
	    
	      The name of the object.  It's optional and serves 
	      as an id to refer to this object from other object declarations.  This name can 
	      also be used lookup the object programmatically.
	    
	    
	  
  
  
  
    A hibernate Configuration to be used in the 
    environment-factory context
  
  
  
    A hibernate Session to be used in the 
    environment context
	  
	    
	      Optional name of this hibernate session.
	      Typically a session is looked up by type.  Only if multiple sessions 
	      are declared, a name can be used to distinct them. 
	      
	    
	    
	      Specifies when and how this object should be 
	      initialized. Default is lazy.
	    
	    
	      Optional name referring to the session-factory.
	      If no factory name is provided, the SessionFactory is looked up by type.
	      
	    
	    
	      Indicates if a hibernate transaction should 
	      be started and ended in this environment.  Default is true.
	      
	    
	    
	      Indicates if the SessionFactory.getCurrentSession()
	      should be used instead of opening and closing a new session.  Default is false.
	      If 'current' is set to true, then the default of 'close' will be set to false. 
	      
	    
	    
	      Indicates if the session should be closed when the
	      environment closes.  The default is true (unless 'current' is set to true) 
	      
	    
	    
	      Optional name of the standard transaction.
	      If 'tx' is set to true, a StandardTransaction needs to be found to enlist 
	      this hibernate session.  By default, the lookup of the StandardTransaction 
	      is done by type.  But this attribute allows to refer to the standard 
	      transaction by name.   
	      
	    
	    
	      Optional name of the JDBC connection to use 
	      when creating this hibernate session.  If no connection name is specified,
	      the creation of the connection is left to the hibernate session.
	      
	    
	  
  
  
  
    A hibernate SessionFactory to be used in the 
    environment-factory context.  The hibernate Configuration can be inlined in this 
    'session-factory', it can be refered by type or referred by name.
    
	  
	    
	      
	        
			      The name of the configuration to use to build 
			      this hibernate SessionFactory.  This is optional as the alternative methods 
			      to specify a configuration are just inlining it here in this hibernate 
			      session-factory element or looking up the hibernate Configuration by type.
			      
			    
	      
	    
	  
  
  
  
    A java.lang.Integer
    
	  
	    
	      The name of the object.  It's optional and serves 
	      as an id to refer to this object from other object declarations.  This name can 
	      also be used lookup the object programmatically.
	    
	    
	  
  
  
  
    A lookup from JNDI through the InitialContext
    
	  
	    
	      The name of the object.  It's optional and serves 
	      as an id to refer to this object from other object declarations.  This name can 
	      also be used lookup the object programmatically.
	    
	    
	  
  
  
  
    A hibernate based JobDbSession
	  
	    
	      The name of the object.  It's optional and serves 
	      as an id to refer to this object from other object declarations.  This name can 
	      also be used lookup the object programmatically.
	    
	    
	      Specifies when and how this object should be 
	      initialized. Default is lazy.
	    
	    
	  
  
  
  
    The default component for executing timers and messages.
    A job-executor requires a CommandService.  
    
		
		  
		    Optional name of this object used to look up 
		    this object from the environment.  This name (along with ip-address) is 
        used as the basis for the names of the threads in the job executor's thread 
		    pool.  So when you're running more then one job-executor on the same 
		    machine, you should be specifying custom job executor names.
		  
		  
		    Specifies when and how this object should be 
		    initialized. Default is lazy.
		  
		  
		    Optional name of the command service to use.  If 
		    this attribute is not present, the command service will be looked up 
		    by type.
		  
		  
		    Number of worker threads.  One extra thread will 
		    be created for scanning and acquisition of jobs (DispatcherThread).
		  
		  
		    Number of milliseconds the dispatcher thread  
		    will normally wait inbetween checks for new jobs.  Each time an exception
		    occurs, the idle period will be doubled until the 'idle-max' is reached.
		    This is a back-off mechanism in case the job executor can't access the 
		    database. 
		    
		  
		  
		    Maxumum number of milliseconds the dispatcher thread  
		    will wait inbetween checks for new jobs.  
		    
		  
		  
		    Number of history records of job executions that will be 
		    kept in memory.
		  
		  
		    Number of milliseconds that a job will be locked at 
		    acquisition time.  When a job is acquired, the job executor will write it's name 
		    in the lock owner field of the job and the lockExpirationTime
		    will be set to the current time plus 'lock' milliseconds.  The lock by that thread should 
		    be considered as released if the lockExpirationTime has passed.  This prevents starvation 
		    in case one of more JobExecutors in a cluster would die.
		  
		  
		    Indicates if the job-executor should be started when it 
		    is created.  Default is true.  If the job-executor is not auto-started, it can be 
		    started programmatically with the start method on the JobExecutor.
		  
		
  

  
    A test helper for controlling job executions
  

  
    A java.util.List
	  
	    
	      
	    
	    
	      The name of the object.  It's optional and serves 
	      as an id to refer to this object from other object declarations.  This name can 
	      also be used lookup the object programmatically.
	    
	    
	      Specifies when and how this object should be 
	      created and initialized. Default is lazy.
	    
	    
	      Implementation class for this list.
	      
	    
	    
	      Indicates if this collection should be synchronized
	      with Collections.synchronizedList(List)
	    
	  
  
  
  
    A java.lang.Long
	  
	    
	      The name of the object.  It's optional and serves 
	      as an id to refer to this object from other object declarations.  This name can 
	      also be used lookup the object programmatically.
	    
	    
	  
  
  
  
    A java.util.Map
	  
	    
	      
	        
	          
	            
	              
	                
	              
	            
	            
	              
	                
	              
	            
	          
	        
	      
	    
	    
	      The name of the object.  It's optional and serves 
	      as an id to refer to this object from other object declarations.  This name can 
	      also be used lookup the object programmatically.
	    
	    
	      Specifies when and how this object should be 
	      created and initialized. Default is lazy.
	    
	    
	      Implementation class for this map.
	      
	    
	    
	      Indicates if this collection should be synchronized
	      with Collections.synchronizedMap(Map)
	    
	  
  
  
  
    Specifies an implementation of the MessageSession 
    interface that sends messages to the JobExecutor.  The main usage of MessageSession 
    is by the PVM implementation for asynchronous continuations.  The PVM will look 
    up the message session by type.  All message-session implementations depend on a 
    DbSession like e.g. the 'pvm-db-session'.  A DbSession will be looked up by type.
    
	  
	    
	      The name of the object.  It's optional and serves 
	      as an id to refer to this object from other object declarations.  This name can 
	      also be used lookup the object programmatically.
	    
	    
	      
	      

Specifies the implementation of the message session.

job-executor: Is the default and sends to messages to the job-executor. In this case the message session has a dependency on a DbSession (like the PvmDbSession) and a Transaction to which the message session will register a listener to notify the job executor upon successfull completion.

jms: Sends the messages over JMS and a JMS listener is assumed (like the command executor MDB) that executes the message. If 'jms' is specified, attributes 'session-jndi' and 'destination-jndi' become required.

The JNDI name of the JMS Session. Only used in case of target jms. The JNDI name of the Queue destination to use. Only used in case of target jms.
the null value Any java object that will be created by reflection. .

There are three main ways to create an object: by constructor or by a factory object or a static factory method.

Using the constructor: Then the class attribute must provide the fully qualified class name. In case another constructor then the default is targetted, a constructor child element can be provided. The factory attribute should not be provided for using a constructor.

Using a factory: Then the factory attribute or one factory element must be provided along with the attribute method.

Using a static factory method: Then the class and method attributes should be specified. There should be no reference to a factory attribute of element.

Construction and initialization: all objects (constructor and factory) are build in two phases: construction and initialisation phase. During construction all is done until a pointer is obtained to the object. In initialisation, operations are applied to the object until it is ready to be used. The separation between construction and initialisation is made to allow for bidirectional references. In that case, at least one of both ends can not be fully initialised before it is injected into the other end.

Operations: after construction, various operations can be applied to objects like e.g. direct field injection, injection through setters, method invocation, enlist with the standard transaction, subscribe the object as a listener to an observable

Arguments: There are two different places for arguments. The arg elements for the factory method invocation should be placed as child elements under the object element. The arg elements for the constructor should be placed as child elements under the constructor element.

Contains one element that describes the factory object. Specifies the arguments to use for a non-default constructor. The factory method arguments. The name of the object. It's optional and serves as an id to refer to this object from other object declarations. This name can also be used lookup the object programmatically. Specifies when and how this object should be initialized. Default is lazy. The fully qualified class name The name of the factory object The factory method name Indicates if the member fields and setter properties should be automatically wired based on matching the property names and types with the object names and types
The default process service implementation that delegates method implementations to a CommandService. process-service depends on a command service. A java.util.Properties The name of the object. It's optional and serves as an id to refer to this object from other object declarations. This name can also be used lookup the object programmatically. A file on the file system A file as a resource in the classpath the contents is fetched by loading a url optionally indicates if the content of referenced file in attributes 'file', 'resource' or 'url' is XML. The default is the plain properties format with a space or the equals character (=) separating key and value on each line. A hibernate based PvmDbSession The name of the object. It's optional and serves as an id to refer to this object from other object declarations. This name can also be used lookup the object programmatically. Specifies when and how this object should be initialized. Default is lazy. A reference to another object by name The name of the object. It's optional and serves as an id to refer to this object from other object declarations. This name can also be used lookup the object programmatically. The name of the referred object A java.util.Set The name of the object. It's optional and serves as an id to refer to this object from other object declarations. This name can also be used lookup the object programmatically. Specifies when and how this object should be initialized. Default is lazy. Implementation class for this set. Indicates if this collection should be synchronized with Collections.synchronizedSet(Set) a java.lang.Short The name of the object. It's optional and serves as an id to refer to this object from other object declarations. This name can also be used lookup the object programmatically. The command service for usage in standard Java environments. The name of the object. It's optional and serves as an id to refer to this object from other object declarations. This name can also be used lookup the object programmatically. Specifies when and how this object should be initialized. Default is lazy. a java.lang.String The name of the object. It's optional and serves as an id to refer to this object from other object declarations. This name can also be used lookup the object programmatically. A timer session is used during process execution to create timers. Different implementations of the timer service make the process portable over different environments. The name of the object. It's optional and serves as an id to refer to this object from other object declarations. This name can also be used lookup the object programmatically. Specifies when and how this object should be initialized. Default is lazy. Specifies the target implementation. Use job-executor when the job executor is responsible for executing the timers (default). Use ejb in case the EJB Timer Service should be used. If the target is job-executor, there is a dependency on the transaction, the job-executor and a job-db-session. The transaction binding. Specifies how the transaction in the pvm environment gets bound to the actual transaction in the real environment. The name of the object. It's optional and serves as an id to refer to this object from other object declarations. This name can also be used lookup the object programmatically. The real transaction to be wrapped. Use standard in standard environments and enterprise in enterprise environments. In case of the enterprise target, the jndi name of the user transaction and the manage attribute can optionally be specified. The jndi name of the user transaction Indicates if the user transaction be controlled (=managed) by the environment. Reference to the org.ow2.bonita.pvm.api.env.Transaction in the current environment. java.lang.Boolean.TRUE The name of the object. It's optional and serves as an id to refer to this object from other object declarations. This name can also be used lookup the object programmatically. Specifies automatic variable type resolution, transforming variable values of any java class into their persistable format. When the type of a variable needs to be automatically detected. Each of the type elements will be scanned in order. When the type matches, it is used to store the value. Alternative to the class attribute to specify the matcher for this type. The name of the type is optional. It's used when users declare variables in the process. Specifies a matcher based on the class of the object. The java class name of the values that will be stored in this type. Apart from Java class names following literals can be used as well:

persistable: Matches when the class of the object is known by the hibernate-session-factory so that a generic reference (any-mapping) can be created to the persistable object. If class="persistable" the attribute id-type becomes required.

serializable: Matches if the object implements the java.io.Serializable interface.

If no class is provided, a matcher can also be specified as a separate child element.

The name of the hibernate-session-factory. Only required if class="persistable" is used and if there is more then one hibernate session factory specified in the environment. The type of the id property in the persistable object. The class name of the converter. The converter must implement the Converter interface and have a default constructor The class name of the variable class. The variable class must be a sub class of Variable and must have a default constructor.
The name of the object. It's optional and serves as an id to refer to this object from other object declarations. This name can also be used lookup the object programmatically. Specifies when and how this object should be initialized. Default is lazy. Imports variable types from a file. All the top level elements of the root document element are imported. Imports variable types from a URL. All the top level elements of the root document element are imported. Imports variable types from a resource. All the top level elements of the root document element are imported.
The method arguments. Each 'arg' element should have exactly one child element that represents the value of the argument. The java class name representing the type of the method. This is optional and can be used to indicate the appropriate method in case of method overloading. A context is a set of object descriptions. Imports mapping file references from the referenced resource files Import mapping references from a resource file. The full classpath is scanned for all the resource files of the given name. All mapping elements that are found as the content in the top level document element will be imported for all of the resource files found on the classpath with that name. Imports a hibernate mapping file Adds the referenced resource file as a mapping file to the hibernate configuration Adds the referenced file as a mapping file to the hibernate configuration Adds the resource file that matches the given class name as a mapping file to the hibernate configuration. Matching means .hbm.xml instead of .java Adds file supplied by the URL as a mapping file to the hibernate configuration Persistent class for which hibernate should activate its second level cache Fully qualified classname Persistent collection for which hibernate should activate its second level cache Fully qualified classname, a dot (.) and then the property name of the collection The caching strategy. see hibernate docs for more info. Import source for class-cache elements Import source for class-cache elements Import source for class-cache elements Optional name of this hibernate session factory. Typically a session factory is looked up by type. Only if multiple sessions are declared, a name can be used to distinct them. Specifies when and how this object should be initialized. Default is lazy. Optional class of the hibernate configuration. By default org.hibernate.cfg.Configuration will be used. This can be used to specify e.g. an AnnotationConfiguration. Optional schema operation to be applied when this configuration has been created. By default, no schema operation will be applied. The working hours of this day. Day parts are separated with 'and'. Begin and end hours are separated by '-'. E.g: 9:00-12:00 and 12:30-17:00 Specifies when and how this object should be initialized. Default is lazy.

lazy: The object is only created when it is asked for. In case of transitive dependencies, the object might not yet be initialized.

eager: The object is created when the context is created. In case of transitive dependencies, the object might not yet be initialized.

eager: The object is created when the context is created. In case of transitive dependencies, the initialization is also mandatory.

eager: The object is only created when it is asked for. In case of transitive dependencies, initialization is mandatory.

Interceptor that can be used as part of declaring a command service. Interceptor that retries the method invocation in case of exceptions. Max number of attempts before giving up Delay in milliseconds after the first exception Factor with which the delay is multiplied after subsequent failed attempts. This enables back-off to reduce load in case of repetitive failures. Interceptor that will make sure the transaction is initialized before each invocation and it will issue a setRollbackOnly on the transaction in case an exception occors. Deployer that can instantiate the process definition of a given type. Deployer checks if the version of the deployed process is exactly 1 more then the last version of the same process. If a version already exists, it is left untouched. If no version exists, by default, this deployer will assign a version to the process definition that is 1 higher then the highest deployed version in the DB for that process name. This default can be overridden by the 'assign' attribute. In case there the process definition has not be given a version explicitely, this attribute specifies if this deployer should assign a version. The assigned version will be 1 higher then the highest version in the db for processes with the same name. Starting with 1 if no similarly named procses definitions are found. Deployer verifies if the version of the deployed process is exactly 1 more then the last version of the same process. Deployer that saves the process with the PvmDbSession. Enlists this object (assumes a org.ow2.bonita.tx.Resource) with the current org.ow2.bonita.tx.StandardTransaction Optional reference to the name of the standard transaction. If no transaction name is specified, the transaction is looked up by type in the environment. Injects a value into a member field of this object. Exactly one child element must specify the value. The member field name Invokes a method the method name Subscribes this object to an observable The context in which to find the observable. If not specified, the context of this object will be taken. If no observable object names are specified, the context object itself will be used as the observable. Indicates if this object is interested in the events fired by the object itself (object-events) or in the wire events fired by the wire context (wire-events). A single event. See 'events' for more information. Comma separated list of events to listen to, filtering out all other events. If no events are specified or if the '*' wildcard is specified, the object will be notified of all events. A single object name. See 'objects' for more information. Comma separated list of object names to listen to. If no objects are specified the specified context will be used as the observable. Name of the method to invoke. If no method is specified, it is assumed that the object implements the Listener interface. Nested 'arg' elements can be used to provide arguments in the method invocation.




© 2015 - 2025 Weber Informatics LLC | Privacy Policy