Sakai Framework

According to The Organization of Sakai Enabling Technologies and Information Models by Glenn Golden (April 10, 2006), the Sakai Framework is now organized into two collections of enabling technologies:

Name

Location

Notes

Functional Technologies

 

 

  • Universal Components

https://source.sakaiproject.org/svn/component/trunk

component

    • ComponentManager

 

Register and find components.

    • ServerConfigurationService

 

System properties.

  • Collaborative Tools

https://source.sakaiproject.org/svn/tool/trunk

tool

    • ToolManager

 

Manage tools.

    • ActiveToolManager

 

Access the active tools.

    • SessionManager

 

Access the session.

    • Tool

 

A Sakai Tool object.

    • ActiveTool

 

An Active Tool object.

    • Session

 

A Sakai session.

    • ContextSession

 

 

    • ToolSession

 

A tool session.

    • SessionBindingEvent

 

 

    • SessionBindingListener

 

 

  • Database

https://source.sakaiproject.org/svn/db/trunk

db

    • SqlService

 

Database access

    • SqlReader

 

 

  • Server Push

https://source.sakaiproject.org/svn/courier/trunk

courier

    • CourierService

 

Heartbeat, content push, etc.

    • Delivery

 

 

    • ObservingCourier

 

 

  • Email Out

https://source.sakaiproject.org/svn/email/trunk

email

    • Digest

 

 

    • DigestMessage

 

 

    • DigestService

 

Manage digests.

    • EmailService

 

Send email messages.

  • Memory Cache

https://source.sakaiproject.org/svn/memory/trunk

memory

    • Cache

 

 

    • Cacher

 

 

    • MemoryService

 

Cache your objects here.

  • Presence

https://source.sakaiproject.org/svn/presence/trunk

presence

    • PresenceService

 

Manage who's on-line and visible.

  • JSF

https://source.sakaiproject.org/svn/jsf/trunk

jsf

    • JSF Components

 

JSF component implementations for Sun and myFaces.

  • Velocity

https://source.sakaiproject.org/svn/velocity/trunk

velocity

    • Velocity Components

 

The old Velocity components.

  • Util

https://source.sakaiproject.org/svn/util/trunk

util

    • Exceptions

 

Defintions of general Sakai exceptions.

    • IdManager

 

Generate UUIDs.

    • ThreadLocalManager

 

Manage local threads.

    • TimeService

 

Sakai time management.

    • Logger

 

Note that the log4j.properties file is in ..util-impl/log/src/conf

 

 

 

Informational Technologies

 

 

  • Entity Bus

https://source.sakaiproject.org/svn/entity/trunk

entity

    • Entity

 

Generic Sakai objects.

    • EntityProducer

 

Generic entity producer.

    • EntityManager

 

Manage Sakai objects.

  • User

https://source.sakaiproject.org/svn/user/trunk

user

    • UserDirectoryService

 

Create and manage users.

    • UserDirectoryProvider

 

External user service integration.

    • User

 

A Sakai user.

    • SakaiPerson

 

User metadata.

    • Authentication

 

User authentication.

    • Evidence

 

Passwords, etc.

    • PreferencesService

 

Manage user preferences.

    • Preferences

 

Preference properties.

  • Authorization

https://source.sakaiproject.org/svn/authz/trunk

authz

    • FunctionManager

 

Register and manage authz functions.

    • PermissionsHelper

 

 

    • SecurityAdvisor

 

Allows policy overrides.

    • SecurityService

 

Resolve permission questions.

    • AuthzGroupService

 

Permissions by groups.

    • AuthzGroup

 

The basic authorization group (realm).

    • GroupProvider

 

External group service integration.

    • Member

 

Group membership.

    • Role

 

Group roles.

  • Context

https://source.sakaiproject.org/svn/context/trunk

context

    • (no code)

 

Currently handled by sites. To be broken out later.

  • Usage Events

https://source.sakaiproject.org/svn/event/trunk

event

    • EventTrackingService

 

Track events using this service.

    • Event

 

A Sakai event.

    • UsageSessionService

 

Manage usage sessions.

    • UsageSession

 

 

    • NotificationService

 

Manage notification.

    • Notification

 

A notification.

    • NotificationAction

 

 

  • Course Management

https://source.sakaiproject.org/svn/course-management/trunk

course-management

    • AcademicSession

 

 

    • CanonicalCourse

 

 

    • CourseManagementAdministration

 

 

    • CourseManagementService

 

Course management.

    • CourseOffering

 

 

    • CourseSet

 

 

    • Enrollment

 

 

    • EnrollmentSet

 

 

    • Membership

 

 

    • Section

 

 

  • Alias

https://source.sakaiproject.org/svn/alias/trunk

alias

    • Alias

 

An alias

    • AliasService

 

Manage resource aliases.

  • Site

https://source.sakaiproject.org/svn/site/trunk

site

    • Site

 

A Sakai site.

    • SitePage

 

A site page.

    • ToolConfiguration

 

A tool configuration including skin, etc.

    • SiteService

 

Manage sites.

    • Group

 

A site group.

These groupings reflect the actual organization of the code. In some cases, top level modules will also include tools that maniuplate the data for administrative purposes.