org.nuxeo.runtime.model

Class DefaultComponent

java.lang.Object

org.nuxeo.runtime.model.DefaultComponent

All Implemented Interfaces:

Adaptable, Component, Extensible, TimestampedService

Direct Known Subclasses:

AbstractLayoutManager, ActionService, ActivityServiceImpl, ActivityStreamServiceImpl, AgendaComponent, AjaxProxyComponent, AnnotationsComponent, AnnotationsRepositoryComponent, AppDataServiceImpl, ApplicationRedirectServiceImpl, AutomationComponent, AutomationServerComponent, BatchManagerComponent, BinaryManagerService, BlobHolderAdapterComponent, BookTitleServiceImpl, BulkEditServiceImpl, BusinessDaysServiceImpl, CacheServiceImpl, CertServiceImpl, ClientRegistryImpl, CollectionManagerImpl, CommandLineExecutorComponent, CommentService, ComputedGroupsServiceImpl, ConnectClientComponent, ContentDiffAdapterManagerComponent, ContentEnricherServiceImpl, ContentTemplateServiceImpl, ContentViewServiceImpl, ContributionPersistenceComponent, ConversionServiceImpl, CoreManagementComponent, CoreService, CounterManagerImpl, CSVHolidaysChecker, CUserServiceImpl, DamServiceImpl, DataSourceComponent, DefaultImporterComponent, DefaultMonitorComponent, DeploymentService, DeputyManagementService, DiffDisplayServiceImpl, DirectoryServiceImpl, DirectoryTreeService, DirectoryUIManagerImpl, DmkComponent, DocumentAdapterService, DocumentationComponent, DocumentCategorizationServiceImpl, DocumentRoutingEngineServiceImpl, DocumentRoutingServiceImpl, DocumentsListsService, DocumentViewCodecService, DublinCoreStorageService, ElasticSearchComponent, ESSequenceGeneratorComponent, EventService, EventServiceComponent, ExcelExportServiceImpl, ExceptionHandlingComponent, FacetedSearchServiceImpl, FavoritesManagerImpl, FileEventTracker, FileManagerService, FileSystemItemAdapterServiceImpl, FreemarkerComponent, GadgetServiceImpl, HtmlEditorPluginServiceImpl, HtmlSanitizerServiceImpl, ImagingComponent, IndexingAdapterService, IOComponent, IOManagerComponent, JettyComponent, JtaActivator, KeyManagerImpl, LayoutDemoService, LayoutStoreImpl, LDAPDirectoryFactory, LibrarySelectorService, LifeCycleServiceImpl, LikeServiceImpl, LocalConfigurationServiceImpl, LocaleComponent, LocationManagerService, LockManagerService, LoginComponent, LoginPluginRegistry, MailServiceImpl, ManagedComponent, MetricComponent, MetricsServiceImpl, MimetypeRegistryService, MongoDBRepositoryService, MultiDirectoryFactory, MultiTenantServiceImpl, NavTreeService, NotificationService, NuxeoCmisServiceFactoryManager, NuxeoDriveManagerImpl, NuxeoDriveThemeActivationComponent, NuxeoRepositories, NXAuditEventsService, OAuth2ServiceProviderRegistryImpl, OAuthConsumerRegistryImpl, OAuthServerKeyManagerImpl, OAuthServiceProviderRegistryImpl, OAuthTokenStoreImpl, OOoManagerComponent, OpenIDConnectProviderRegistryImpl, OpenSocialServiceImpl, PackageUpdateComponent, PageProviderServiceImpl, PathSegmentComponent, PersistenceComponent, PersonServiceImpl, PictureTilingComponent, PlacefulServiceImpl, PlatformManagementComponent, PluggableAuthenticationService, PluggableRestletService, PreviewAdapterManagerComponent, PropertiesMappingComponent, PublisherServiceImpl, QueryMakerServiceImpl, QuotaSizeServiceImpl, QuotaStatsServiceImpl, RatingServiceImpl, RedisComponent, RelationService, RelationshipServiceImpl, ReloadableComponent, ReloadComponent, RenderingServiceImpl, RenditionServiceImpl, ReportComponent, RepositoryManagerImpl, RepositoryService, RequestControllerService, ResourcePublisherService, RootServiceImpl, RoutingTaskServiceImpl, ScannedFileMapperComponent, SchedulerServiceImpl, ScriptingComponent, SeamRemotingJSBuilderComponent, SecurityService, ServerLocatorService, ServletRegistryComponent, ShibbolethAuthenticationServiceImpl, ShibbolethGroupsServiceImpl, SignatureServiceImpl, SnapshotManagerComponent, SocialWorkspaceServiceImpl, SpaceManagerImpl, SpacesAdapterComponent, SQLDirectoryFactory, SQLRepositoryCompatService, SQLRepositoryService, StyleGuideServiceImpl, SuggestionServiceImpl, TagServiceImpl, TaskServiceImpl, TemplateProcessorComponent, ThemeService, ThemeStylingServiceImpl, ThumbnailServiceImpl, TrashManagementService, TrashServiceImpl, TreeManagerImpl, TypeService, TypeService, UIDGeneratorService, UIPermissionService, URLServiceComponent, UserInvitationComponent, UserPreferencesServiceImpl, UserProfileServiceImpl, UserService, UserWorkspaceServiceImplComponent, VersioningComponent, VersioningManagerImpl, VideoServiceImpl, WebAnnotationConfigurationServiceImpl, WebContentSaverServiceImpl, WebDavService, WebEngineComponent, WorkManagerImpl, WSEndpointManagerImpl, WSRemotingSessionManagerImpl, XMLImporterComponent

public class DefaultComponent
extends Object
implements Component, Adaptable

Empty implementation for a component.

Author:

Bogdan Stefanescu

Constructor Summary

Constructors

Constructor and Description
DefaultComponent()

Method Summary

Methods

Modifier and Type	Method and Description
void	activate(ComponentContext context) Activates the component.
void	applicationStarted(ComponentContext context) Notify the component that Nuxeo Framework finished starting all Nuxeo bundles.
void	deactivate(ComponentContext context) Deactivates the component.
<T> T	getAdapter(Class<T> adapter) Returns an object which is an instance of the given class associated with this object.
int	getApplicationStartedOrder() The component notification order for Component.applicationStarted(org.nuxeo.runtime.model.ComponentContext).
Long	getLastModified() Returns the last modification timestamp or null if unknown.
void	registerContribution(Object contribution, String extensionPoint, ComponentInstance contributor)
void	registerExtension(Extension extension) Registers the given extension.
void	setLastModified(Long lastModified) Sets the last modified date.
void	unregisterContribution(Object contribution, String extensionPoint, ComponentInstance contributor)
void	unregisterExtension(Extension extension) Unregisters the given extension.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DefaultComponent

public DefaultComponent()

Method Detail

activate

public void activate(ComponentContext context)
              throws Exception

Description copied from interface: Component

Activates the component.

This method is called by the runtime when a component is activated.

Specified by:

activate in interface Component

Parameters:

context - the runtime context

Throws:

Exception - if an error occurs during activation

deactivate

public void deactivate(ComponentContext context)
                throws Exception

Description copied from interface: Component

Deactivates the component.

This method is called by the runtime when a component is deactivated.

Specified by:

deactivate in interface Component

Parameters:

context - the runtime context

Throws:

Exception - if an error occurs during activation

registerExtension

public void registerExtension(Extension extension)
                       throws Exception

Description copied from interface: Extensible

Registers the given extension.

Specified by:

registerExtension in interface Extensible

Parameters:

extension - the extension to register

Throws:

Exception - if any error occurs

unregisterExtension

public void unregisterExtension(Extension extension)
                         throws Exception

Description copied from interface: Extensible

Unregisters the given extension.

Specified by:

unregisterExtension in interface Extensible

Parameters:

extension - the extension to unregister

Throws:

Exception - if any error occurs

registerContribution

public void registerContribution(Object contribution,
                        String extensionPoint,
                        ComponentInstance contributor)
                          throws Exception

Throws:

Exception

unregisterContribution

public void unregisterContribution(Object contribution,
                          String extensionPoint,
                          ComponentInstance contributor)
                            throws Exception

Throws:

Exception

getAdapter

public <T> T getAdapter(Class<T> adapter)

Description copied from interface: Adaptable

Returns an object which is an instance of the given class associated with this object. Returns null if no such object can be found.

Specified by:

getAdapter in interface Adaptable

Parameters:

adapter - the adapter class to look up

Returns:

a object castable to the given class, or null if this object does not have an adapter for the given class

getApplicationStartedOrder

public int getApplicationStartedOrder()

Description copied from interface: Component

The component notification order for Component.applicationStarted(org.nuxeo.runtime.model.ComponentContext).

Components are notified in increasing order. Order 1000 is the default order for components that don't care. Order 100 is the repository initialization.

Specified by:

getApplicationStartedOrder in interface Component

Returns:

the order, 1000 by default

applicationStarted

public void applicationStarted(ComponentContext context)
                        throws Exception

Description copied from interface: Component

Notify the component that Nuxeo Framework finished starting all Nuxeo bundles.

Specified by:

applicationStarted in interface Component

Throws:

Exception

getLastModified

public Long getLastModified()

Description copied from interface: TimestampedService

Returns the last modification timestamp or null if unknown.

This method is useful for third-party code implementing caching on resources held by the component/service.

Specified by:

getLastModified in interface TimestampedService

See Also:

TimestampedService.setLastModified(Long)

setLastModified

public void setLastModified(Long lastModified)

Description copied from interface: TimestampedService

Sets the last modified date.

This method is supposed to be called whenever the component/service resources or state changes.

Specified by:

setLastModified in interface TimestampedService

See Also:

TimestampedService.getLastModified()