Interface Summary Interface Description AddressableAny addressable object has a URL and title. ApiRestEntityFactoryFactory for producing REST entities for serialization to Json, and entity property enrichment. AttachmentResourceRepresents a resource that exposes the required state to create a Confluence attachment. BatchOperation<I,O>An operation that consists of a sequence of independent units of work that need to be run as a batch job. BatchOperationManagerPerform batch operations without any explicit dependency on a particular version of Hibernate or Spring. Beanable Deprecated.since 5.2. BodyTypeFactoryDescribes a factory responsible for providing a consistent and fixed set of BodyType instances to other components. ConfluencePropertySetManagerConvenient way to break out creation of property sets for testing ConfluenceSidManagerAn SID is a unique ID for a particular Confluence instance. ContentEntityManager ContentPermissionManager ContentPropertyManagerThis interface should be considered almost-deprecated - unless you're retrieving or modifying existing content properties that were added using a ContentPropertyManager, you should use the entity's
ContentTypeAwareUsed to mark classes that expose a content type ContextPathHolderHolds and serves the servlet context path. CustomPageSettingsManagerThe CustomPageSettingsManager is used to retrieve and store custom page settings. DataSourceFactoryConstructs DataSources for use in mail notifications. DeleteContextContext for managers to call upon when making decisions about how to delete an object. FileExportableClasses that implement this interface are exported as files, rather than the native format (XML, HTML, etc) FormatSettingsManagerPersistent storage and retrieval of format settings. FormAwareThis interface has to be implemented if the new AUI form styles are being used. HasLinkWikiMarkupContent classes implementing this interface can be linked to by wiki markup. HeartbeatManager Hierarchical<T>Please do not use this interface. InheritedContentPermissionManager ListBuilder<T>A lazy builder that allows clients to retrieve individual pages of potentially long (and performance-degrading) lists of entities. ListBuilderCallback<T> MimetypesExtensionTranslationMapFactory MimetypesFileTypeMapFactory Modification<T extends ContentEntityObject>Clients should implement this interface and modify the passed in reference to
ContentEntityObjectas they see fit.
NotExportableClasses which implement this are not exported as part of exports. OperationContext<TRIGGER extends OperationTrigger>Context for managers to call upon when making decisions on how to handle a given object operation (create,delete,save) OperationTriggerUsed to specify how an operation was triggered. PluginDataSourceFactoryProduces
DataSourcesfor plugin module
PluginDataSourceFactory.ResourceViewA view on the
SaveContextContext for managers to call upon when making decisions about how to save an object. SynchronizationManagerManages transaction synchronizations: a list of actions to be done when the transaction completes on the current thread. VersionedA Confluence object that can exist in multiple versions.
Class Summary Class Description AbstractLabelableEntityObject AbstractOperationContext<TRIGGER extends OperationTrigger> AbstractOperationContext.BaseBuilder<T extends AbstractOperationContext.BaseBuilder,TRIGGER extends OperationTrigger> AbstractVersionedEntityObject ActivityAjaxResponse BodyContent BodyTypeBodyType is not an enum because ultimately there may not be a fixed set of BodyType. BodyTypeUserTypeA UserType implementation for the BodyType enum. CancellingInterceptorAn interceptor that looks for a request parameter named 'cancel' in the request. ConfluenceActionSupportBase class for all Confluence Struts actions. ConfluenceAutowireInterceptorIntercepts an action created by xwork and autowires dependencies before xwork can execute the action. ConfluenceEntityObjectThe superclass of all entity objects within Confluence. ConfluenceLicenseInterceptorValidates whether the license is not expired and the user count does not exceed the license setting. ConfluenceSynchronizationManagerConfluence transaction sycnhronization manager. ConfluenceSystemPropertiesQuery the status of various Confluence system properties ConfluenceWorkflowInterceptor ContentEntityObject ContentPermissionSummaryContainer for all information which are needed for Content permission check ContentPermissionUtils ContributionStatusA record of a recent contribution made by a user to a specific piece of content. CustomPageSettings DatabaseSidManagerManages a SID backed by Bandana. DateFormatterFormats dates and times into a given timezone in a variety of formats. DefaultContentPermissionManager DefaultContextPathHolderServes the context path stored/managed by the
BootstrapManager(this value is kept up to date with every request that comes into the server).
DefaultCustomPageSettingsManager DefaultDataSourceFactory DefaultDataSourceFactory.NamedDataSource DefaultDeleteContext DefaultDeleteContext.Builder DefaultFormatSettingsManagerImplementation of
FormatSettingsManagerwhich persists the date format settings in Bandana.
DefaultHeartbeatManager Deprecated.since 8.0 Use
DefaultInheritedContentPermissionManager DefaultListBuilder<T>Skeleton implementation of a list builder that takes care of maintaining the class invariants but delegates the final building of the list to a callback function. DefaultMimetypesExtensionTranslationMapFactoryAs MimeTypesFileTypeMap only allows one way conversion (from file to mime type) this class manually parses the file and can be used for reverse mapping. DefaultMimetypesFileTypeMapFactory DefaultPluginDataSourceFactory DefaultPropertySetManager DefaultSaveContext DefaultSaveContext.Builder InputStreamAttachmentResourceRepresents an attachment resource that is supported by an input stream. InputStreamDataSourceA datasource that provides access to an input stream of data. InputStreamExceptionDecoratorDecorator for potential
IOExceptionsthrown by an
MaybeNot<T> Deprecated.since 7.0.1. None<T>Helps constructing the left, erroneous case of a
PartialList<T>CAVEAT: This class is a temporary copy of the PartialList in confluence-api, for use with managers that are planned for migration to the API (at which point this class can be removed). PersistentDecorator PointcutClassLoaderProcessorBeanPostProcessor that swaps out Spring's default AspectJExpressionPointcut and substitutes it for an implementation that is customised to use the Confluence application classloader. ResultLoggingInterceptorSubclass of default XWork logging interceptor which adds logging of the action result. SingleListBuilderCallback<T>A very simple implementation which can be used in the case where you don't actually require paging and you actually have the entire list already. SpaceContentEntityObjectA ContentEntityObject that is a first-class member of a Space (i.e. TimeZoneRepresents an instance of an valid time zone, wrapping a
UploadedResourceResource wrapper for uploaded files. VersionHistoryA record of an upgrade performed on Confluence. VersionHistorySummaryThat bit of a ContentEntityObject relevant to a version history VersionHistorySummary.Builder VersionHistorySummaryCollaboratorRepresents a collaborator and the version history of a piece of content they have worked on.
Enum Summary Enum Description ApiRestEntityFactory.SchemaType PluginDataSourceFactory.FilterByType VersionChildOwnerPolicyThis enum dictates the policies used when saving children for CEOs and CCEOs in regard to the version of the parent they belong to
Exception Summary Exception Description ConfluenceExceptionFor when we want a generic checked exception InsufficientPrivilegeExceptionRuntime exception that is thrown when a user tries to perform an operation without the required privileges.