Package net.sourceforge.sconman

SCONMAN Usage Guide (TODO)

See:
          Description

Interface Summary
IAgent An agent is an active entity associated to a Project that does periodic maintenance tasks.
IContentTypeHandler This class filters an input stream so its ouput is an indexable text stream
IExternalProjectSynchronizer IExternalProjectSynchronizer implementations are responsible for: receiving external changes notifications (usually from other nodes in a distributed environment) and notifying them to the IProjectSynchronizer receiving internal changes notifications from the project and sending them to other nodes Implementor classes will be instantiated by name.
IProgressObserver Implementors of this interface will listen to progress events thrown by lengthy operations
IProjectSynchronizer IProjectSynchronizer manages bidirectional external repository synchonization.
IRepository File repository interface
IRepository.IVisitor Visitor for repository entries
IRepositoryChangeListener Listener to external changes of the contents repository.
ISCMEventListener Implementors of this interfaces can be subscribed (see Project.addSCMEventListener(ISCMEventListener)) to project events, as ISCMEventListener.afterAddContent(Content)or ISCMEventListener.onCategoryModified(Category).
ISearchResults A ISearchResults provides access to search results over a content repository (see Category#safeSearch(User, Query, boolean, boolean)).
ISubscriptionHandler Implementations of this class will handle subscription sending
IXMLSerializable Implementations of this interface knows how to serialize/deserialize to and from XML
 

Class Summary
AgentManager This class handles agent scheduling.
Category A Categoryrepresents a logical group for s within Projectcontext.
Cont2DocTranslator Translator that knows how to map SCM contents to Lucene documents and viceversa.
Content A content is a typed, categorized, and described document.
ContentLockManager  
ContentType A content type represents a kind of Content.
DateFormatHelper This class is a helper to work with DateFormat classes
Descriptor This class handles I18N object description
Descriptor.Entry Localized data entry
Field Fields represent specific content attributes, and are defined within content types (ContentType).
IndexManager Lucene's index manager
IndexManager.SearchResults Default ISearchResultsimplementation
Item This class represents an item of the list of a field of type "List"
Language Language defines a new language for I18N issues
Multiproject A multiproject is an agregator instance that handles several Project, and the main entry point to the system.
Permission  
PermissionAggregator  
Project The Projectis the main point for content management, as it's the root of the Categorytree of contents, and the place where ContentTypes are defined, and IAgents work on.
ProjectSynchronizer  
Query Queryrepresents queries over the content store.
Relationships Relationships content wrapper
Role Roles group users according to the way they must use and access to the Category and ContentType defined in the Project, defining the set of permissions that User with that role will have.
SafeSearchResults This class is a wrapper that ensures that the wrapped SearchResults is closed
SCMEventListenerAdapter Convenience class for writting ISCMEventListener implementations
SCMEventMulticaster SCM events multicaster, used by the Project to multicast events
SecurityContext This class handles security elements, as users, roles, permissions, and does security checks
Subscription Instances of this class represent user's subscriptions to some content category.
Subscriptions Subscriptions helper
SubscriptionsListener This is an ISCMEventListenerthat will listen to content additions in order to send this event to subscribed users.
User User class represent actors that access a Projectand performs operations on it.
 

Exception Summary
SCMException This class represents exceptions that can appear performing SCM tasks.
SCMLoginException Exception for login errors
SCMSecurityException This class represents a security violation
SCMStorageException This class represents a storage error
 

Package net.sourceforge.sconman Description

SCONMAN Usage Guide (TODO)



Copyright null null. All Rights Reserved.