Package com.atlassian.confluence.core
-
Interface Summary Interface Description Addressable Any addressable object has a URL and title.ApiRestEntityFactory Factory for producing REST entities for serialization to Json, and entity property enrichment.AttachmentResource Represents 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.BatchOperationManager Perform batch operations without any explicit dependency on a particular version of Hibernate or Spring.Beanable Deprecated. since 5.2.BodyTypeFactory Deprecated, for removal: This API element is subject to removal in a future version. since 8.8ConfluencePropertySetManager Deprecated, for removal: This API element is subject to removal in a future version. since 8.9 UseContentEntityObject.getProperties()
ConfluenceSidManager An SID is a unique ID for a particular Confluence instance.ContentEntityManager ContentPermissionManager ContentPropertyManager This 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'sContentProperties
instead.ContentTypeAware Used to mark classes that expose a content typeContextPathHolder Holds and serves the servlet context path.CustomPageSettingsManager The CustomPageSettingsManager is used to retrieve and store custom page settings.DataSourceFactory Constructs DataSources for use in mail notifications.DeleteContext Context for managers to call upon when making decisions about how to delete an object.FileExportable Classes that implement this interface are exported as files, rather than the native format (XML, HTML, etc)FormatSettingsManager Persistent storage and retrieval of format settings.FormAware This interface has to be implemented if the new AUI form styles are being used.HasLinkWikiMarkup Content 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 toContentEntityObject
as they see fit.NotExportable Classes 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)OperationTrigger Used to specify how an operation was triggered.PluginDataSourceFactory ProducesDataSources
for plugin moduleresources
.PluginDataSourceFactory.ResourceView A view on theResourceDescriptor
.SaveContext Context for managers to call upon when making decisions about how to save an object.SynchronizationManager Manages transaction synchronizations: a list of actions to be done when the transaction completes on the current thread.Versioned A Confluence object that can exist in multiple versions. -
Class Summary Class Description AbstractI18nActionSupport AbstractLabelableEntityObject AbstractOperationContext<TRIGGER extends OperationTrigger> AbstractOperationContext.BaseBuilder<T extends AbstractOperationContext.BaseBuilder,TRIGGER extends OperationTrigger> AbstractVersionedEntityObject ActivityAjaxResponse BodyContent BodyType BodyType is not an enum because ultimately there may not be a fixed set of BodyType.BodyTypeUserType A UserType implementation for the BodyType enum.CancellingInterceptor An interceptor that looks for a request parameter named 'cancel' in the request.ConfluenceActionSupport Base class for all Confluence Struts actions.ConfluenceAutowireInterceptor Intercepts an action created by xwork and autowires dependencies before xwork can execute the action.ConfluenceEntityObject The superclass of all entity objects within Confluence.ConfluenceLicenseInterceptor Validates whether the license is not expired and the user count does not exceed the license setting.ConfluenceSynchronizationManager Confluence transaction sycnhronization manager.ConfluenceSystemProperties Query the status of various Confluence system propertiesConfluenceWorkflowInterceptor ContentEntityObject ContentPermissionSummary Container for all information which are needed for Content permission checkContentPermissionUtils ContributionStatus A record of a recent contribution made by a user to a specific piece of content.CustomPageSettings DatabaseSidManager Manages a SID backed by Bandana.DateFormatter Formats dates and times into a given timezone in a variety of formats.DefaultContentPermissionManager DefaultContextPathHolder Serves the context path stored/managed by theBootstrapManager
(this value is kept up to date with every request that comes into the server).DefaultCustomPageSettingsManager DefaultDataSourceFactory DefaultDataSourceFactory.NamedDataSource DefaultDeleteContext DefaultDeleteContext.Builder DefaultFormatSettingsManager Implementation ofFormatSettingsManager
which persists the date format settings in Bandana.DefaultHeartbeatManager Deprecated. since 8.0 UseDefaultHeartbeatManager
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.DefaultMimetypesExtensionTranslationMapFactory As 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 Deprecated, for removal: This API element is subject to removal in a future version. since 8.9DefaultSaveContext DefaultSaveContext.Builder InputStreamAttachmentResource Represents an attachment resource that is supported by an input stream.InputStreamDataSource A datasource that provides access to an input stream of data.InputStreamExceptionDecorator Decorator for potentialIOExceptions
thrown by anInputStream
.InputStreamSerializer ComposesInputStreams
.MaybeNot<T> Deprecated. since 7.0.1.None<T> Helps constructing the left, erroneous case of a
.Maybe
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 PointcutClassLoaderProcessor BeanPostProcessor that swaps out Spring's default AspectJExpressionPointcut and substitutes it for an implementation that is customised to use the Confluence application classloader.ResultLoggingInterceptor Subclass 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.SpaceContentEntityObject A ContentEntityObject that is a first-class member of a Space (i.e.TimeZone Represents an instance of an valid time zone, wrapping aTimeZone
.UploadedResource Resource wrapper for uploaded files.VersionHistory A record of an upgrade performed on Confluence.VersionHistorySummary That bit of a ContentEntityObject relevant to a version historyVersionHistorySummary.Builder VersionHistorySummaryCollaborator Represents a collaborator and the version history of a piece of content they have worked on. -
Enum Summary Enum Description ApiRestEntityFactory.SchemaType PluginDataSourceFactory.FilterByType VersionChildOwnerPolicy This 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 ConfluenceException For when we want a generic checked exceptionInsufficientPrivilegeException Runtime exception that is thrown when a user tries to perform an operation without the required privileges.