OFBiz is made aware of a Service by the presence of a Service definition within a Service definition file. Each OFBiz Service has a Service definition that configures the Service with a name, location information, Service implementation engine type, and other optional parameters.
To create a new Service definition, follow these steps:
- Find an existing Service definition file or create a new one.
- Add one or more
serviceelement XML declarations. For example:<service name="someName" engine="one_of_the_available_engines" location="component_or_CLASSPATH_location" <!-- Add any INPUT/OUTPUT attribute elements here --> <!-- Add a PERMISSION-SERVICE element --> <!-- For Simple Services, add any AUTO-ATTRIBUTE elements --> </service>
- Make sure the new Service definition element has a closing
</services>tag. - Save and close the file.
- Restart OFBiz.
Using Service definitions, OFBiz removes Service location and implementation details from the Service and "injects" these values at runtime. This enables the Service developer to concentrate on implementing business logic and the Service consumer to call the Service without regard for location or implementation details.
When a Service is called, OFBiz automatically locates the Service on the CLASSPATH by consulting the Service's Service definition, manages all defined context parameters and passes control to the appropriate Service implementation engine.