Package org.nuxeo.runtime.model

Interface Component

All Superinterfaces:
Extensible, TimestampedService
All Known Implementing Classes:
AbstractLayoutManager, ActionService, AnnotationServiceImpl, AutomationComponent, AutomationScriptingComponent, AutomationServerComponent, AvroComponent, AWSConfigurationServiceImpl, BatchManagerComponent, BinaryMetadataComponent, BlobHolderAdapterComponent, BlobManagerComponent, BulkComponent, CacheServiceImpl, CapabilitiesServiceImpl, CertServiceImpl, CharacterFilteringServiceImpl, ClusterActionServiceImpl, ClusterServiceImpl, CodecServiceImpl, CollectionManagerImpl, CommandLineExecutorComponent, CommentService, ComputedGroupsServiceImpl, ConfigurationServiceImpl, ConnectClientComponent, ContentTemplateServiceImpl, ContributionPersistenceComponent, ConversionServiceImpl, CoreDirectoryFactory, CoreManagementComponent, CoreService, CoreSessionServiceImpl, CounterManagerImpl, CUserServiceImpl, DataSourceComponent, DBSRepositoryService, DefaultComponent, DefaultDirectoryFactory, DefaultImporterComponent, DefaultMonitorComponent, DeputyManagementService, DirectoryServiceImpl, DmkComponent, DocumentAdapterService, DocumentBlobManagerComponent, DocumentRoutingEngineServiceImpl, DocumentRoutingServiceImpl, DocumentValidationServiceImpl, DocumentViewCodecService, DownloadServiceImpl, DublinCoreStorageServiceImpl, ElasticSearchComponent, ELServiceComponent, EventService, EventServiceComponent, ExceptionHandlingComponent, FavoritesManagerImpl, FileEventTracker, FileManagerService, FileSystemItemAdapterServiceImpl, FreemarkerComponent, FSExporter, GenericDirectoryComponent, HtmlSanitizerServiceImpl, ImagingComponent, IOComponent, IOManagerComponent, JtaActivator, JWTServiceImpl, KafkaConfigServiceImpl, KeyManagerImpl, KeyValueServiceImpl, LayoutStoreImpl, LDAPDirectoryFactory, LibrarySelectorService, LifeCycleServiceImpl, LocalConfigurationServiceImpl, LocaleComponent, LocationManagerService, LockManagerService, LoginAsComponent, LoginComponent, MailServiceImpl, MailServiceImpl, ManagedComponent, MarshallerRegistryImpl, MemRepositoryService, MetricComponent, MetricsServiceImpl, MigrationServiceImpl, MimetypeRegistryService, MongoDBComponent, MongoDBDirectoryFactory, MongoDBRepositoryService, MultiDirectoryFactory, MultiTenantServiceImpl, NotificationService, NuxeoAdobeConnectorServiceImpl, NuxeoCmisServiceFactoryManager, NuxeoDriveManagerImpl, NuxeoRepositories, NXAuditEventsService, OAuth2ClientServiceImpl, OAuth2ServiceProviderRegistryImpl, OAuth2TokenServiceImpl, OAuthConsumerRegistryImpl, OAuthServerKeyManagerImpl, OAuthServiceProviderRegistryImpl, OAuthTokenStoreImpl, ObjectResolverServiceImpl, OpenIDConnectProviderRegistryImpl, PackageUpdateComponent, PageProviderServiceImpl, PathSegmentComponent, PDFTransformationServiceImpl, PersistenceComponent, PlatformManagementComponent, PluggableAuthenticationService, PreviewAdapterManagerComponent, PropertiesMappingComponent, PublisherServiceImpl, PubSubServiceImpl, QueryMakerServiceImpl, QuotaSizeServiceImpl, QuotaStatsServiceImpl, RelationService, ReloadComponent, RenderingServiceImpl, RenditionServiceImpl, RepositoryManagerImpl, RepositoryService, RequestControllerService, RequestFilterService, ResourcePublisherService, ResourceService, RestAPIServiceImpl, RootServiceImpl, RuntimeComponent, ScannedFileMapperComponent, SchedulerServiceImpl, ScimV2MappingServiceImpl, ScrollComponent, SecurityService, ServerComponent, ServerLocatorService, ServletRegistryComponent, ShibbolethAuthenticationServiceImpl, SignatureServiceImpl, SQLDirectoryFactory, SQLRepositoryCompatService, SQLRepositoryService, StandbyComponent, StreamServiceImpl, StreamWorkManager, SuggestionServiceImpl, TagServiceImpl, TargetPlatformServiceImpl, TaskServiceImpl, TemplateProcessorComponent, TemplateSerializerServiceImpl, ThemeStylingServiceImpl, ThreeDServiceImpl, ThumbnailServiceImpl, TransientStorageComponent, TrashServiceImpl, TypeService, TypeService, UIDGeneratorComponent, UserInvitationComponent, UserMapperComponent, UserPreferencesServiceImpl, UserProfileServiceImpl, UserService, UserWorkspaceServiceImplComponent, VersioningComponent, VersioningManagerImpl, VideoServiceImpl, VideoToolsServiceImpl, WebDavService, WebEngineComponent, WebResourceManagerImpl, WOPIServiceImpl, WorkManagerImpl, XMLImporterComponent
public interface Component extends Extensible, TimestampedService
A Nuxeo Runtime component.

Components are extensible and adaptable objects and they provide methods to respond to component life cycle events.

Author:
Bogdan Stefanescu

  • Method Details

    • setName

      void setName(String name)
      Sets the name for this component, as it was defined in its XML.

      This is called once after construction by the runtime framework.

      Parameters:
      name - the name
      Since:
      10.3

    • activate

      void activate(ComponentContext context)
      Activates the component.

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

      Parameters:
      context - the runtime context

    • deactivate

      void deactivate(ComponentContext context)
      Deactivates the component.

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

      Parameters:
      context - the runtime context

    • getApplicationStartedOrder

      default int getApplicationStartedOrder()
      The component notification order for start(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.

      Returns:
      the order, 1000 by default
      Since:
      5.6

    • start

      void start(ComponentContext context)
      Start the component. This method is called after all the components were resolved and activated
      Since:
      9.2

    • stop

      void stop(ComponentContext context) throws InterruptedException
      Stop the component.
      Throws:
      InterruptedException
      Since:
      9.2