Tool Organization

Status

Tools are structurally organized slightly different for Sakai 2.2. For a tool called "tool-name":

tool-name
	toolname-api
		api
			src/java/org/sakaiproject/toolname/api
			src/java/org/sakaiproject/toolname/cover
	toolname-impl
		impl
			src/bundle
			src/java/org/sakaiproject/toolname/impl
			src/sql
				hsqldb
				mysql
				oracle
			
		pack
			/src/webapp/WEB-INF/components.xml
	toolname-tool
		tool
			src/bundle
			src/java/org/sakaiproject/toolname/tool
			src/webapp

An extra level of directory structure has been added before the src directory. Also notice the consistency of identify apis, impls, covers, and tool code. Impl is now preferred to component, which avoids confusion with the component manager, among other things.

Also note that this structure only applies to tools with application logic broken out into an application service defined by an API. Simpler tools without an application service would not require "toolname-api" or "toolname-impl" directories.