All Classes and Interfaces
Class
Description
Marks a test class which is capturing a11y regression screenshots
using
com.atlassian.confluence.webdriver.rules.A11yRegressionRule
in order to filter out a11y regression tests via a test runner configurationProduces absolute URL's / HREF's for the specified object.
This method implements some of the methods from the AttachmentDao.AttachmentCopier interface.
Class represents a link to an attachment.
Abstract superclass for all audit listeners that provides some useful common functionality like i18n string handling
Abstract class for any site or space backup operations.
AbstractBootstrapApplicationListener<E extends org.springframework.context.ApplicationEvent>
Abstact filter class which will delegate to a particular filter once the container manager is setup.
Contains common functionality for clustered and standalone safety managers
CommandAction-implementing class that delegates to a CommandActionHelper.
Abstract class for long running tasks which change Collaborative Editing configuration
Usually, this is a change to the collaborative editing mode (on, limited, off) as well as restart.
An abstract
Aspect for wrapping Cache objects returned by the CacheManager
Spring bean.This class is used for handling confluence license.
Deprecated.
since 5.7.
An abstract upgrade task for when you just want to run a bunch of constraint creation statements from a properties
file.
Deprecated.
since 7.6.0, use confluence-notifications-api instead
TODO: Document this class / interface here
Functions shared between creating pages and blog posts.
Convenient superclass for Database Collation Health Check Rules.
Convenient superclass for Database Setup Health Check Rules.
An
AttachmentDaoInternal implementation that just delegates to another AttachmentDaoInternal.An abstract Collector that exposes a Consumer which in turn accepts an object of a generic type
Contains all the common functionality of the global and space edit permissions administrators
AbstractEntityPaginationAction<T extends com.atlassian.user.Entity>
A partial implementation of
ExceptionTolerantMigrator which provides a default implementation of the
deprecated AbstractExceptionTolerantMigrator.migrate(String, com.atlassian.renderer.RenderContext, java.util.List) method, which delegates
to the ExceptionTolerantMigrator.migrate(String, com.atlassian.confluence.content.render.xhtml.ConversionContext) method.Abstract exporter that only deals with simple general export utility methods
like where the files go.
This class provides a skeletal implementation of the
FieldMapping interface.Module descriptor base class to use when the module defines fields that should be created in and index.
Performs the file IO side of the export/backup
Base class for actions that flush index queues
Convenient superclass for health checks.
Superclass for Health Check Rules.
Abstract class that defines the basic methods necessary for saving Attachments
to a database.
Deprecated.
since 9.3 Only to be used as a compatibility superclass for migration away from
AbstractHttpFilterResponsible for keeping id mappings between the xml ids and the database ids during restore.
A JUnit 4 friendly version of what the old AbstractConfluenceSingleContextSpringPersistenceTest does
Abstract base class for
IndexTaskQueue implementations that are backed by the journal.A nice abstract class for actions which display label/s on a global AND per space basis.
Provides basic label methods that should be common to all label commands
This is a base class for string builders that limit their length.
Behaviour of the string builder when the limit is reached.
An abstract link defines a source page (the source of the link) and is the superclass for all Link objects.
From 8.8, calling
AbstractLuceneMapperModuleDescriptor.getModule() with OpenSearch config will return null
as we don't support this module descriptor for OpenSearchDeprecated, for removal: This API element is subject to removal in a future version.
since 9.4
Implements common properties for various implementations of ManagedScheduledJob.
Abstract class for monitoring audit events emitted for change of state in toggles from
ConfigureMonitoringActionA stateless base class for the nav builders that is safe for the delegating nav builder
to extend directly.
Base class for any
Conditions that work with a NotificationContext.Deprecated.
sinace 7.6.0, use confluence-notifications-api instead
Deprecated.
since 7.17.0
AbstractOperationContext.BaseBuilder<T extends AbstractOperationContext.BaseBuilder,TRIGGER extends OperationTrigger>
Parent of the concrete Page and BlogPost classes
Parent class for actions which operate on AbstractPages (pages or blog posts).
Dao for Abstract Page.
TODO: Document this class / interface here
Base class for upgrade tasks that want to migrate page templates from one format to another.
Abstract superclass for queries holding a list of parameters of a single type.
Base class for incremental sync recorder classes
Relation descriptor, which should be used as a base class for all custom relation descriptors.
ChildContentService implementation that communicates with Confluence remotely.ContentLabelService implementation that communicates with Confluence remotely.ContentService implementation that communicates with Confluence remotely.Common parent class of all Confluence API Remote Service implementations, handling authentication and REST
infrastructure.
WebView implementation that communicates with Confluence remotely.WebViewService implementation that communicates with Confluence remotely.An event that is sent when the state of site restore process changes.
An abstract representation of a search to be performed.
Searches for users using the
CrowdService and
QueryCommon fields for a
SearchRequestAbstract base implementation of SearchResult taken from LuceneSearchResult after removing dependency from Lucene classes
Deprecated.
since 7.2.0, use
AbstractInjectableStateTestBase implementation of
ServiceCommand that takes care of the internal logic related to the order in which
the various operations must be performed.This action communicates with BootstrapManager.
Base class for SingleEntityLocator that enforces the contract between
getEntity and
getEntitiesAbstract service for interacting with VersionsRemovalStatus object
Abstract superclass for simple sort types that just sort in a particular direction on some field.
Common class for all Breadcrumbs with an Action and a Space.
CONFSERVER-58180
due the following change in DefaultServlet http://svn.apache.org/viewvc?view=revision&revision=1845799 our
static resources are no longer served with the correct Content-Type header.
Shared tab logic.
An abstract action for actions that use page templates.
Abstract test harness with all the default includes and excludes.
Deprecated.
since 5.10.
Base class for all the trusted application actions.
Perform the update of a Confluence license.
A useful base class for UpgradeTasks.
Responsible for finding users by user keys - if not found try second stage finder.
Upgrade task to ensure that for all the user names in Confluence a ConfluenceUser object
exist.
A clone of
AbstractUserProfileAction from confluence-core,
with the core-only FollowManagerInternal field removed.Query parameter that describes the user to be matched with
Base class for actions that view index queues
abstract class that deals strictly with the conversion of a objects to an xml stream
Wraps a delegate Filter and ensures that only live (non-deleted) docs are accepted through this filter.
Access Check wrapper for
DelegatingPluginFilterA simple return type representing the state where a user (logged in our anonymous) does not have access to Confluence
or a given permission type is invalid for a user (depending on their
AccessStatus), so they cannot be granted
the permission.Base class for access enforcers.
Logs the username and request URL via log4j.
This enum defines different mode that Confluence is running on
This interface should be used internally in core only
Backdoor REST resource for toggling read-only mode
Resource for plugins to check the access mode set on Confluence.
Represents the type of access to Confluence a user has.
Deprecated, for removal: This API element is subject to removal in a future version.
since 9.0.
Deprecated, for removal: This API element is subject to removal in a future version.
since 9.3, use
ActionContext instead.Wrapper for
ActionContext which ensures compatibility with Struts 6.7, specifically
the usage of JavaX APIs rather than Jakarta APIs.TODO come up with decent name for this
Additional imports for Actions.
This class is for limiting the request and can be used in action classes.
Annotation to mark a method whose return value should be passed to the view.
Deprecated.
since 9.3, use
ActionViewData instead.Annotation to mark a method that returns a map of view data.
Deprecated.
since 9.3, use
ActionViewDataMappings instead.Backup and restore provider, implementing confluences backup and restore
module component and bridging to active objects backup component.
An implementation of the ActiveObjects that obtains its JDBC connections
from Hibernate
Thrown when ActiveObjectsBackupRestoreProvider fails to complete active objects hot restart.
The Confluence implementation of the AO
TransactionSynchronisationManager SPI.Active theme condition.
Query which filters out documents representing users that are no longer active.
Query which filters out documents representing users that are no longer active.
Represents an activity that is being monitored.
Represents the ability to record current activity in the system.
Represents a snapshot of an activity currently being performed.
Deprecated.
since 7.5.0.
Allows to read and write records to a storage (for example, database)
Any implementation must guarantee that data is available after a restart
Adaptive most used label cache.
An implementation of AdaptiveMostUsedLabelsCache which stores data in a separate DB table
Deprecated.
since 5.3 Use
MemoryAwareImageRenderPredicate.Responsible for removing and adding a change document for versioned content to the change index.
Adds a searchable to the content index.
Makes a page or blogpost the favourite of the specified user.
A command for creating a named foreign key constraint between two columns
ComponentImports required by components created indirectly, e.g.
Adds a label to a page or blog post
Used for JSON requests, a list of the labels added are available under the 'labels' key
of the bean.
Takes a string of comma separated labels and adds them to a
Page or Blog Post for the specified user.
labels are added to the Space's SpaceDescription object
Simple POJO class to store the add-on's information
Adding change document based on prefetch data
This class simply write document into Lucene/OS without needed to extract it
Any addressable object has a URL and title.
Extractor for CHANGE index, responsible for indexing the title and url path of
Addressable content.Makes a page or blogpost the favourite of the specified user.
A command for creating a string virtual column with default placeholder based on a nullable column of a table
Represents a unique constraint on a set of columns.
Action for adding a user macro
Represents the link needed to add a watch for a given piece of content
Represents "Administration" in "Dashboard > Administration > Do some admin action"
Check that all calls through this interceptor are performed by a user with administration permissions.
Encapsulates select configuration parameters or values
for Confluence and determines whether those parameters or values meet
a specified programmatic acceptance criteria.
REST API for
Group management actions that require elevated privileges.Section provider for quick nav that includes admin items in the results.
Allows members of the 'confluence-administrators' group to be exempt from permission checks, or if a temporary
request-level exemption has been applied.
A Soap service holding functionality for Confluence Administrators.
REST API for
Space management actions that require elevated privileges.A discrete, actionable task that an administrator should be aware of.
An AdminTask aims to encapsulate goals around (correctly) affecting high-value changes to Confluence that could or should be made in order to get the best out of Confluence.
An AdminTask aims to encapsulate goals around (correctly) affecting high-value changes to Confluence that could or should be made in order to get the best out of Confluence.
Encapsulates the non-serializable system components of an
AdminTask.A serializable object which maintains the state of completion and other metadata
relating to a particular
AdminTask.A Spring
Configuration which defines the AdminTasklistManager bean.Handles storage and retrieval of
AdminTasks.REST API for
User management actions that require elevated privileges.REST API for users management actions that require elevated privileges.
Advanced bulk permission service provides low-level access to fast permissions service.
Simple AOP advice for adding advice to the returned value of advised methods
Deprecated.
since 7.5.0.
Deprecated.
since 7.5.0.
Will aggregate name from other PageNameConflictResolvers.
Simple action for redirecting to after logging in via the ajax authentication handler.
Hibernate data transfer object for cryptographic keys
Implements the "All Updates" tab
Get all latest attachment of a container
This will load attachment in a batch (default is 100)
Caches a map of macro metadata by macro names loaded using the given a macro module descriptor class and a macro
module descriptor predicate.
AllMacroMetadataLoader<T extends com.atlassian.plugin.ModuleDescriptor<Macro> & MacroMetadataSource>
Loads a map of macro metadata by macro names when given a macro module
descriptor class and a macro module descriptor predicate.
AllMacroMetadataProvider<T extends com.atlassian.plugin.ModuleDescriptor<Macro> & MacroMetadataSource>
Provider that returns a map of macro metadata by macro names when given a
macro module descriptor class and a macro module descriptor predicate.
Adds `allowedOperations` collection to entities which has a set `allowedOperations` in hibernate mapping.
Provides urls which could be excluded from some security checks (for e.g.
Represent an entire set of documents.
Deprecated, for removal: This API element is subject to removal in a future version.
since 9.4
This class provides support for grouping a collection of data alphabetically.
Exception thrown when a user tries to create an object that already exists
Marks a column as not null or nullable.
Supports the
AlternativeDirectoryResourceLoader for StaticPlugins.Finds possible content matches for a supplied title and space.
Interface for all alter table commands.
Executes all the various database-specific table altering commands.
Merge policy that takes neither entry, emptying out the keys in the merging map
Condition that specifies that the macro body should always be transformed.
Listener of eviction process which pushes events to analytics
Provides a
MappingAnalyzerDescriptor that should be used to analyze text for a given LanguageDescriptor if
it is defined.Thrown when there is a problem rebuilding the page ancestor tree.
Persists page ancestors (see CONFANCESTORS table).
JDBC methods for operations with CONFANCESTORS table.
Custom entity info for CONFANCESTORS table.
We do not have a dedicated class for ancestors, so we use this fake class basically for logging or methods like equals etc
Deletes ancestors records from CONFANCESTORS table.
This ancestors repairer checks page trees and finds pages with broken ancestors
Then it sends this information to PageRepairWorker, which fixes pages in small separated transactions
AncestorsRepairJob fixes ancestors in CONFANCESTORS table
AncestorsUpdateEvent is fired when ancestors are changed.
This will check annotations from com.atlassian.annotations.security for all Struts actions
Class that overrides properties from
EntityObject
which need to be mapped to the columns in classes that inherit from it.Template for writing rules which read configuration from a method annotation.
Deprecated.
since 7.20 no replacement
Helper class which helps to check if checked class contains required annotation or not
Allows macro body transformation based on the
RequiresFormat annotation on the
Macro class.Deprecated.
since 7.0.1 , use
AnonymousLoads a web resource based when anonymous access is enabled.
A service for managing permissions for the anonymous Confluence user.
Deprecated.
since 7.17.0.
An internal interface for
AnyTypeDaoUtilities for aspect oriented programming
Helps
ConfluenceActionSupport instances deal with the API.Provides metadata about of type com.atlassian.confluence.api.model.content.Container that might be useful in the web tier: the location of icons, relevant
CSS classes, links and so on.
Flags API Model classes that represent enums, but are not Java enums.
Factory for producing REST entities for serialization to Json, and entity property enrichment.
Create a serializer module factory to allow api model objects to be serialized.
Allows api support to be accessed for a given content type.
A super-skinny SpringBoot application for running a
EmbeddedApacheDS as a standalone process.Custom entity info for cwd_application_attribute table.
We do not have a dedicated class for cwd_application_attribute, so we use this fake class basically for logging or methods like equals etc
Caches Embedded Crowd Application objects by name to avoid frequent retrieval from the database.
Cannot use
Function here, since we need to propagate checked exceptions.Provides
FilesystemFileStore instances via ApplicationConfiguration.This is an aide for
ApplicationConfigurationLicenseStore, telling it when the
EventPublisher is available, or not.This class listeners for all events of type
ConfluenceEvent, and re-published them via the
Spring ApplicationEventPublisher.A message that represents an application configuration change.
Persists
ApplicationImpl.Event produced when the application has completed starting up, and all life-cycle event plug-ins have had
their start-up methods called successfully.
The current state of the server.
Monitors for the state of the server.
Servlet that provides application status information.
Basic event listener for notify ApplicationStatusService that lifecycle modules have run.
Event produced when the application has shut down, and all the life-cycle plug-ins have had their
shutdown methods called.
Event produced when the application is about to shut down, before any shutdown life-cycle
plug-ins are run.
Command to process ApplicationUpdatedEvent
An ApplyDecorator directive for Sitemesh.
Deprecated, for removal: This API element is subject to removal in a future version.
since 9.1 replaced by
ApplyDecoratorDirectiveEvent that is emitted for change of state in App monitoring toggle from
ConfigureMonitoringAction.Arabic language analyzer provider
Contains information about archived background jobs only.
Filters archived spaces (and their contents) out of search results.
Represents interface capable of archiving data from the input stream
Indicates that the entity is artificial and should not take part in statistics.
Folds a token into an ascii one.
Simple interface for generating public/private key pairs
Published at the beginning of an import.
An implementation of
Cache that is backed by a local cache, and which publishes cache
invalidation events when certain mutable operations are performed.Responsible for creating
AsyncInvalidationCache instances, as well as managing the scheduled publishing of
sequence snapshots and observability events from those caches.Asynchronous version of LikeCreatedEvent
Asynchronous version of LikeRemovedEvent
This class is an asynchronous and non-clustered version of
PluginDisableEvent.This class is an asynchronous and non-clustered version of
PluginEvent.This class is an asynchronous and non-clustered version of
PluginEvent.Published when the plugin framework has finished starting.
This class is an asynchronous and non-clustered version of
PluginInstallEvent.This class is an asynchronous and non-clustered version of
PluginModuleDisableEvent.This class is an asynchronous and non-clustered version of
PluginModuleEnableEvent.This class is an asynchronous and non-clustered version of
PluginUninstallEvent.Used to annotate a macro that is safe to be rendered asynchronously on a page without requiring a page refresh
An implementation of
Cache that is backed by a local cache, and which publishes changes
to the cache entries via invalidations and replications.A mechanism to allow Hibernate instrumentation data to be recorded using the host Atlassian products infrastructure.
Represents a timer split.
Represents a factory for creating
AtlassianInstrumentation.AtlasSplit.An implementation of the Confluence Monitoring interfaces that's based upon the Atlassian Instrumentation library.
Provides operations to allow Confluence's uses of the atlassian-instrumentation library to be manipulated from plugins.
Responsible for registering various strategies with Atlassian Profiling.
This class is responsible for building an AtlassianDocument using a selective set of fields.
This is temporary replacement of the AtomicReferenceConverter from XStream
library v1.4.20.
Marshal an
EmbeddedImage for an image attached to content, rather than referring to an external resource.This helper is used for rendering the attached images.
Simple Action to retrieve the details of a
ContentEntityObject's image attachments.Upload attachments via a multipart request.
Deprecated, for removal: This API element is subject to removal in a future version.
since 9.4, use
AttachmentUploadHelper instead.An enum of basic Attachment types with a text description of each type.
Provides metadata about of type com.atlassian.confluence.api.model.content.Content when it is attachment type: the location of icons, relevant
CSS classes, links and so on.
Handles attachment-related events for auditing
A
SearchableResolver implementation which concatenates a ContentEntityObject's attachments to
the existing list of Searchable.getSearchableDependants().An event indicating that o batch of one or more visible attachments have completed
uploading.
A marker interface for attachment container resource identifiers.
Deprecated.
since 6.10.0, use
ContentIdExports of upgraded attachments from Confluence 5.7 and lower may have a blank content status field for Attachment
objects.
Performs API operations for
Attachments.Provides the number of attachments on a given page.
An event indicating that one or more visible attachments have been added to a piece of content.
This interface defines the methods for classes acting as a DAO
at the level of meta-data storage for Attachments.
Deprecated, for removal: This API element is subject to removal in a future version.
since 8.8, no replacement
This interface defines a method by which an implementing class
can return a wired AttachmentDao instance, given a particular
data DAO.
Dao for Attachments.
This class encapsulates Attachment metadata and maintains an InputStream that represents
the data for the Attachment object.
This interface defines the methods for classes acting as a DAO at
the level of data storage for Attachments.
This exception should be used when attachment data was found, when it
should not have existed.
AttachmentDataFile<T extends com.atlassian.dc.filestore.api.FileStore.Path>
Represents a single attachment data file, plus its metadata.
Represents the filesystem used to store attachment data files.
Deprecated.
since 8.1 Use
AttachmentDataFileSystemThis exception can be used when no Attachment data was found, but was expected.
Resolves the location of the directory used to store attachment data.
Represents the different types of
AttachmentDataDao implementations.Whitelist for
AttachmentDataStorageTypes.Represents the data for an attachment.
Deprecated.
Deprecated.
Deprecated.
Thrown when the the size of the
InputStream received to create an attachment
is different to the declared size or length of the attachment.An enumeration of the known types of attachment data stream.
Represent an option to control bulk attachment delete.
Simple class to identify attachment
A List wrapper for
AttachmentEntity objectsParent class for all attachment related events.
Attempts to add an attachment extracted text into default searchable text if it is available, otherwise requests
a text extraction, wait for its completion and reattempt.
Deletes physical versions of attachments (used during space deletion).
Comparator for
Attachments based on file names in the given locale.Factory for creating
AttachmentDataFileSystem instances.Helper class providing access to an Attachment.
How we're dealing with attachment and attachment container
Creates JSON objects for attachments.
Attachment link takes in either a page or blog post object.
Represents a user viewing the attachment listview action.
Provides a handler for detecting if a page contains an atlassian page layout.
Responsible for listening to
AttachmentManagerEventListener.VisitorEvents and resolving them against the AttachmentManagerInternal.DMZ version of the
AttachmentManager interface; see the package-info.java for rationale.Extracts metadata for attachments.
Used when the
AttachmentMigratorToV4 runs a migration, requiring analytics.Adds a field for attachment mime type.
Translates mime types for attachments.
Extracts and indexes the classname of the content that owns an attachment.
Responsible for pre-fetching attachments and storing them in the conversion context for later retrieval by the
rendering pipeline.
An event indicating that attachment prefetch was attempted.
Represents a reference to an
Attachment, and containins enough information to unambiguously reference a single
version of an attachment.Represents a reference to an
Attachment container entity.Get Attachment using specific version.
Listens to AttachmentTrashedEvent and AttachmentRestoreEvent and
triggers editor content reconciliation for referring contents with Synchrony.
Event fired when an attachment (all of its versions) has been removed from DB
Event sent *before* the removal of a visible attachment.
Represents a resource that exposes the required state to create a Confluence attachment.
CRUD operations for Attachments on Content.
Resolves a uri for an attachment which only looks at the supplied resource identifier.
Finds all the attachments on the selected page that match the provided filetype(s).
Represents the different levels at which attachments can be viewed - always downloaded, always displayed inline, or a mix of the two.
Provides methods for creating, reading, updating and deleting Confluence Attachment
Content objects.Deprecated.
since 7.0.1 , use
ContentLabelServiceA finder for locating attachments.
Provides methods for validating the actions on the AttachmentService
Persists Attachment entities.
Implementation of remote methods for handling attachments.
Simple class to store statistics data fetched by
AttachmentDao.getAttachmentStatistics()Attachment status reflects the result of attachment content extraction operation, which is a part of content
indexing operation.
Attachment status manager.
Marshals the state of an attachment to a stax stream.
Holding information about the attachment storage.
An enumeration of the known types of attachment data storage.
An enumeration of the known versions of attachment data storage.
Deprecated, for removal: This API element is subject to removal in a future version.
since 9.4, use
AttachmentUploadHelper instead.A result of calling
AttachmentTextExtractionService.A function that enables transaction demarcation around attachment text extraction.
Extract text from an attachment.
Attachment text extractor module descriptors
Published when an attachment is moved to the trash.
Search for attachments of a particular type or types.
Deprecated.
Since 4.3.
A command to handle AttachmentUpdateEvent
An event indicating that a visible attachment has been updated
Represents a single attachment being uploaded.
Converts an attachment upload multipart request into a list of
AttachmentResource objects.Generates URIs to Confluence attachments
A URL parser for attachments (including thumbnails).
Event sent *before* the removal of a visible attachment version.
Event fired every time an attachment is viewed.
Generates
ImportedObjectV2 records for cwd_directory_attribute and cwd_application_attribute tables, so they could be saved to the DB.Adds `attributes` collection to entities which has a map `attributes` in hibernate mapping.
Whether entity was added or removed.
String constants for audit categories.
Confluence has two sets of APIs for audit logs:
- For legacy audit log functionality added in 5.10
- For new cross product auditing
Contains helper methods to build auditing entities.
Provides a context to omit auditing for certain actions
Deprecated.
since 7.5.0.
Deprecated.
since 7.5.0.
Deprecated.
since 7.5.0.
Deprecated.
since 7.5.0.
Deprecated.
since 7.5.0.
Deprecated.
since 7.5.0.
An interface for Scheduled Job Auditing.
This default color should be the colors that AUI has as defaults.
Listens to authentication events and saves them as audit records
Used to authenticate a web sudo session.
Impersonates an authenticated user during the execution of the given callback.
A
ValidatingRelationDescriptor which checks that the User for which the relation is being created is
also the currently authenticated user.A simple ThreadLocal to store the currently authenticated user.
Provides authenticated
WebTargets for Remote API clients.Indicates that the implementation represents an authentication event.
Exception thrown when a login attempt fails
AuthenticationHelper class with common method logout and getLoginURL
Deprecated, for removal: This API element is subject to removal in a future version.
since 7.0.1 will be removed in 9.0
Provides utilities for thread-local-based accumulation of elapsed time spent inside Seraph authentication code.
A servlet filter which interacts with
AuthenticatorMetrics to publish events containing timing metrics
regarding Seraph authenticationDisables Web Sudo and other password confirmation features when a custom authenticator is configured.
s
Represents an author parameter.
Represents a set of results from an autocomplete Search request.
Represents the internal and displayed state of a single autocomplete result in an
AutocompleteResult.This class will help to transform invalid input raw query to a valid one.
Deprecated.
since 7.0.1.
Deprecated.
since 7.0.1.
Deprecated.
since 8.4 No longer required
Scores of component functions are averaged according to
weights.Service for retrieving clustered database metadata from AWS Aurora
As AwsProperties enum from Hazelcast has package-level visibility, we can't access it directly.
Contains information about active background jobs.
Removes non-active background jobs older than 7 days.
DAO for background job records.
An interface for any background job.
Information returned by a background service.
The service that allows to add new background tasks.
Is thrown when the background job is not found.
A standard scheduled job that calls the background service periodically (to process active jobs).
Possible background job states.
Reader that allows to read files from the container.
Factory that creates instances of BackupContainerReader.
Default implementation for restore container reader factory.
Responsible for writing data (objects, properties, attachment's etc).
Allows to create backup container writer factory.
Default implementation for backup container writer factory.
Generates data for exportDescriptor.properties file.
Deprecated.
since 7.17.0.
Deprecated.
since 7.17.0.
Deprecated.
since 7.17.0.
Provides convenient operations for working with backup properties (exportDescriptor.properties)
Used when a backup or restore job is added to the queue.
Regular consumer but allows to throw BackupRestoreException exceptions.
General exception class for all exceptions related to backup/restore process.
Used when a backup or restore job finished running.
Util to remove lazy-loading and proxying from all objects in a hibernate configuration, as they
just get in the way of backups.
Contains information about the backup/restore job.
Every value represents one bit in the configuration.
A standard scheduled job that checks and removes old backup/restore job entries from the database
based on the job's createTime.
Provides methods to convert BackupRestoreJob into JobDetails and vice versa
Dao for backup/restore jobs.
Backup restore job result.
Converts BackupRestoreJobResult to JSON object
Runs a backup/restore jobs on a proper service.
A DB record with backup job settings
Backup restore filter for searching jobs.
A DB record with backup job statistics.
Responsible for accepting backup/restore operations, checking permissions, managing the queue and cluster-wide locks.
Job that checks if backups files exist and if not mark them as not existing.
Responsible for checking permissions required for space/site backup/restore/cancel/view operations.
A standard scheduled job that calls the background service periodically (to process active jobs).
Service responsible for accepting backup/restore operations.
Contains settings for the site/space backup/restore operation.
Used when a backup or restore job begins processing.
A standard scheduled job that checks and removes non-permanent backup zip files
based on a job's fileDeleteTime.
Check whether the scheduled automatic backups for Confluence have been disabled.
Interface implemented by
AbstractUpgradeTasks which provide information
to the backup manager to manage backward and forward compatibility.Thrown when the data in the incoming request is incomplete or otherwise invalid.
Migrates Confluence global and space configuration data from the file system into the database Specifically, the
confluence-global.bandana.xml file and space config data contained in directories underneath the 'config' folder
Deprecated, for removal: This API element is subject to removal in a future version.
since 9.3 for removal in 10.0
An implementation of
GlobalSettingsManager backed by Bandana.Stores journal queue state in bandana.
Cleans up the bandana table so that unique and not null constraints can be applied to the context and key columns.
Alter the Bandana table to make sure the Bandana context and keys have not null and unique constraints on them.
An implementation of
LegacyPluginSettingsManager backed by Bandana.Deprecated.
since 9.3, for removal in 11.0.
Deprecated.
since 9.4, for removal in 11.0.
Handles global messages using Bandana for message persistence.
Deprecated, for removal: This API element is subject to removal in a future version.
since 9.3 for removal in 10.0
Stores PluginManagerState using Bandana.
A Bandana-powered
ReIndexJobPersister.Modifies Bandana storage.
Interface providing object serialization and deserialization for Bandana records.
Factory to create BandanaSerializers.
An implementation of
SiteDarkFeaturesDao based upon Bandana.An implementation of
SpaceSettingsManager backed by Bandana.An implementation of
ThemeKeyDao backed by Bandana.This upgrade task clears all expired tokens stored in the bandana table
Stores
UserVerificationToken objects in Bandana.We may have backups older than 7.9 needing to be imported, so the xstream format needs to be updated
for these entries.
Deprecated.
since 8.3.0.
Migrates Bandana values stored with XStream 1.1.1 format to XStream 1.4.1 based format.
Base implementation of ApiEnum with default implementations of interface methods.
A base template for attachment content extractors to extend.
A Confluence L&F colour-scheme that is editable - colours are stored in a map in memory.
A subclass for extensible content type support in the api
A base class for Custom Content to extend.
Abstract class for H2 operations
This class is a wrapper on top of
ConfluenceLicense which implements BaseLicenseDetailsAbstract class for MySql operations
Base class for implementing
OperationChecks.Abstract class for Oracle operations
A base implementation of
Parameter, providing support
for multiple default parameter names, and a default value if
no parameter is specified.Base class for conditions which check a permission on an object.
Abstract class for Postgres operations
A simpler super interface of SearchResult.
Abstract class for MSSQL operations
Checks that the base URL for Confluence is unlikely to be pointed at
localhost or another address with limited visibility on a network.
A theme that is loaded from a Confluence plugin.
Source of migration work that can be broken up into batches.
A request to render one or more storage-fragment strings with a given ConversionContext.
Wraps a number of rendered strings and any exceptions thrown for individual renders.
A composite exception that wraps a list of exceptions, useful for propagating list of exceptions
that might have occurred during a batch task.
Provides an abstraction for implementation that indexes large amount of data.
Replacement for
BatchingMultiEventPublisher due to Hibernate 2 removal.An operation that consists of a sequence of independent units of work that need to be run as
a batch job.
Perform batch operations without any explicit dependency on a particular version of Hibernate or Spring.
A BatchTask implementation is supplied to a
WorkSourceBatchRunner to actually
perform the required work on individual items read from the BatchableWorkSource.A simple functional interface for the batch update action
Deprecated.
since 5.2.
Provides a map of Velocity context items that is initialised once alongside this bean construction.
Deprecated, for removal: This API element is subject to removal in a future version.
since 9.3
Deprecated.
since 8.8 no replacement
Field mapping for storing binary values.
Breadcrumb for each piece of the blog date and blog title
A Path converter that converts friendly blog path urls to a viewpage or viewblogposts action
if the dark feature confluence.readable.url is disabled.
Breadcrumb for a Blog post for the 5.0+ default theme (Space IA).
Fetcher for blog posts
since 9.2.5
Locates a single Blog Post
Deprecated.
since 7.6.0, use confluence-notifications-api instead
An interface implemented by a class that can provide the BlogPost to be created.
This class is used to represent blogpost reference in markup required for rendering.
Parse the part of a resource identifier in wiki markup which identifies a blog post.
Restrict BlogPostsForDateDto to a single BlogPost on a date.
Helper bean that turns a list of blog posts into a monthly calendar.
A service that provides methods to retrieve service commands to manipulate blog posts
Simple class to store statistics data fetched by
BlogPostDao.getBlogPostStatistics()Reindexer which uses blue/green approach in order to avoid downtime, i.e.
Extension of BM25 which shifts the term frequency normalization formula
to boost scores of very long documents.
Persists BodyContent entities.
BodyType is not an enum because ultimately there may not be a fixed set of BodyType.
Allows clients to produce a safe rendering of a
ContentEntityObject that respects
its BodyType.Deprecated, for removal: This API element is subject to removal in a future version.
since 8.8
A UserType implementation for the BodyType enum.
Parses Bill Of Materials files into information that can be used by plugins.
Field mapping for true and false values
Wraps a boolean supplier to prevent the returned value from changing once 'tripped'.
A boolean query that allows and/or and not combinations of sub queries.
Container class for the results of a
SearchQueryParser operation,
providing a mutable version of the BooleanQuery.Parameter that parses its values into
BooleanQueryFactory
instances.Maps a
BooleanQuery to its corresponding Lucene Query.Represents a boolean restriction entity.
Configures the beans of the bootstrap spring context.
This will be invoked AFTER all parameters have been supplied to the action and all dependencies have been injected.
This class defines beans that are common to the production bootstrap spring context and the integration test
bootstrap spring context.
Provides operations for (re-)configuring the Confluence bootstrap.
An event indicating that the bootstrap context has been initialised.
Defines beans related to the Hazelcast implementation of the
ClusterManager and ClusterLockService.A Spring
Configuration which defines the HealthCheckRegistrar and the various HealthCheckRules
which it registers with the HealthCheckRegistry.Controls the bootstrapping of Confluence - starting essential, core services.
Internal interface of Bootstrap Manager
Deprecated.
since 7.14 No longer used.
Returns information from the BootstrapManager.
Manages SID generation and persistence before the database is available.
BootstrapStatusProvider is responsible to expose only required methods of DefaultBootstrapManager.
This is the Spring
Configuration class for the Bootstrap Spring context used by integration tests.Initializes the test context to have a reference to a fully initialized bootstrap context.
Takes a serialized HTML document as input and injects CSS taken from the
<style> tags in to the appropriate elements as inline
style attributes.Brazilian language analyzer provider
Represents a single item in a breadcrumb chain, like the 'Dashboard' link at the start (however, the dashboard
breadcrumb is filtered out of the trail in
BreadcrumbGenerator as of 5.0).Returns the breadcrumb of a page via JSON.
Indicates that the action speciifies the breadcrumbs that should be displayed
REST resource for getting displayable breadcrumbs for confluence content
Deprecated, for removal: This API element is subject to removal in a future version.
since 8.6
Creates a Map containing a list of categories and a list of macros.
Helper methods for picking up request languages.
Represents the breadcrumb "Browse Space" in "Dashboard > Demo Space > Browse Space > Labels > labelOne"
Searches for people that are unsynced in Confluence using the
PersonService.A custom UserType that maps stings to clobs.
Callback for resource cleanup at the end of a transaction.
Responsible for exporting objects that should not be exported as a part of the space
unless other objects have references to them.
It's a build number which also provides the human-readable version.
A wrapper around ImmutableList builder that produces immutable lists if elements are added to the
builder or a collapsed list otherwise.
Singleton which provides build and version information for the Confluence application.
A utility class which compares the various build numbers associated with a Confluence instance, and checks them for
consistency.
Displays the web-item if the Confluence build number is between the
minBuildNumber and maxBuildNumber
parameter values.Represents a build number related constraint to be tested against an UpgradeTask which decides whether the task
should apply or not.
Displays the web-resource if the Confluence build number is between the
minBuildNumber and
maxBuildNumber parameter values.This will handle the logic of bulk action
Interface to receive report from BulkAction
Interface define bulk attachment delete action
Context to be passed around during bulk attachment delete
This context will be passed through every process
Provides operations that allow bulk extraction of multiple entities at once, as an alternative to the
Extractor2 interface.A module descriptor that allows plugin to add an
BulkExtractor into indexing pipeline.Provides a means to locate
BulkExtractors.Supports generation of ids in batches.
Collects OpenSearch operations in memory before being sent to OpenSearch bulk API.
Concrete context specific for copy pages
Bulk permission service allows to check permissions in batches quickly and efficiently.
Caches the underlying remote directory base by id.
An implementation of CaptchaStore that stores captchas in Confluence's cache.
Employs a cache to provide temporary caching of notifications.
Interface indicting a class can 'compact' caches.
A partial implementation of
CacheCompactor.Manages cache configuration changes (such as max cache size).
Caches the most frequently-used method on this interface:
CachedCrowdApplicationDao.findByName(java.lang.String).A composite key between an entity name and a directory Id.
A caching decorator for an InternalUserDao.
Immutable group for caching
Removes cached membership information as required by the bulk operations on the
InternalMembershipDao interface.Caches membership information.
Immutable Timestamped user for caching
A caching decorator for an InternalUserDao.
This class clears all cached introspection results after plugin framework
has been started.
Container for caching crowd entities with the option to cache the entity or a representation that entity
does not exist.
Deprecated, for removal: This API element is subject to removal in a future version.
since 9.3
Provides an implementation for storing data used by the ScheduledJobManager.
Provides operations for flushing (i.e.
Deprecated.
since 7.17.0.
Repreents operations for invalidating some or all entries in a cache.
Responsible for creating
CacheInvalidators for a given Cache, as well managing the sequence snapshot process.Controls how a session on the current thread interacts with the second-level cache and query cache.
Return noop splits if cache monitoring disabled.
A cache operation recorder.
Interacts with the CacheManager.
A manager for cache settings, provides operations for retrieving, runtime update and saving settings to persistent
storage.
A factory for
CacheSettingsManager objects.Deprecated.
since 7.5 Use
ManagedCache.getStatistics()Describes optional capabilities as exposed by the Cache Statistics service
Provides utility methods useful for classes that implement the
CacheStatistics interface.Provides information on how effective each managed cache is.
Declares JMX attributes for exposing application cache statistics.
Caches calculation of caches settings in order to avoid traversing long list of expensive regexps
A
ConfluenceAccessManager implementation with thread-local caching.This class is responsible for caching user keys by username.
Represents the different types of caching headers used by Confluence.
Caching for
IncrementalSyncSubscriptionManagerAn
InheritedContentPermissionManager implementation that delegates to another, and caches the lookups.Caching for NotificationDao.
An implementation of
PersistentDecoratorDao which combines a cache with Hibernate.Wrapper for
PluginPersistentStateStore that caches the PluginPersistentState.Utility class for loading properties from a specified resource that should be available on the classpath,
using the specified class to get the classloader.
An implmentation of
SiteDarkFeaturesDao which uses a CachedReference to reduce pressure
on a delegate SiteDarkFeaturesDao.Implementation of SpacePermissionManager that implements caching before a SpacePermission is requested,
saved or removed from the SpacePermissionDao.
Caching space retention policies by space keys.
An implementation of
ThemeKeyDao that caches the responses from a delegate.A cache decorator around
VersionHistoryDaoInternalDefault implementaion that reads mappings from calendar-language-util.properties file.
Determines if the "Add Users" panel on the Dashboard should be displayed
An interceptor that looks for a request parameter named 'cancel' in the request.
Checked exception thrown when there is an issue resolving a resource identifier for an attachment.
Checked exception thrown when there is an issue resolving a resource identifier.
An exception thrown when an embedded resource read from the Editor cannot be unmarshalled.
Thrown when an editor formatted link cannot be unmarshalled.
Returns true if the global "allow public signup" setting is enabled in General Configuration.
A filter which checks if the current user is permitted to use Confluence.
A filter which checks if the current user is permitted to use Confluence, including users with visitor (limited)
access.
Interface used to mark
Actions that require captcha validation.Thrown when a Captcha check fails
Gives the Captcha web panel access to Captcha-specific context
Interceptor that performs captcha validation on any actions that implement
CaptchaAware.A filter for requests that require a captcha to be supplied.
Represents a caret for in a placeholder.
A Lucene SortComparator that will convert field text to lower case effectively rendering all comparisons case
insensitive.
Deprecated.
since 7.0 user
LowercaseFieldSortMapper.Represents a category in which results coming back from a content name search can be put in.
Provides operations for Categories.
Provides methods for validating category operations.
A word generator that wraps around another word generator, and censors the words that
the wrapped generator produces.
This service is used to download application certificates and present them as a
AliasedKeyA simple colour scheme that looks through a list of colour schemes until it finds a matching colour (or null if none found).
Deprecated.
since 7.17.0.
Extends the default
VelocityContext to ensure that the ChainedVelocityContext.getKeys() method returns all keys from the
current context and the chained context.Providing batch processing for change index
Updates a schedule for a particular job.
This class is used to generate the ids used to identify change documents and
groups of change document in the Lucene index
Policy that defines what
Searchables should be indexed as change documents.Deprecated.
since 7.5.0.
Deprecated.
since 7.5.0.
Indexer for changes.
IndexRecoverer for the change index.
Journal index task queue for the change index
Event representing the act of a user successfully changing their password from within Confluence
Updates a schedule for a particular simple job.
Represents a search against change information.
A Character filter must be predefined in Confluence.
Makes Children and Descendants map and list instances, both expanded and collapsed.
Graph-ql query field provider for the
ChildContentService.REST wrapper for the
ChildContentService.Interacts with
Content children, providing methods to both get collections of children for various
ContentTypes at various depths.A finder interface to encapsulate finding content under a particular parent
Server implementation of the
ChildContentService.A comparator used to sort pages based on the Page Ordering sort rules.
Provides a list callback on a list of children for a page or comment.
Provides child
Content items.A analyzer for European languages which will tokenize, apply the standard filter and lower case.
Chinese language analyzer provider
atlassian-rest doesn't play nice with the Joda time DateTime class, since it doesn't have a constructor with a
single string parameter to deserialize it with.
CJK analyzer provider
The class verifies whether the imported object has to imported or not (based on its class).
The purpose of this class it to allow unit testing via mocking Class objects.
This filter removes the english possessive from the end of words, and it removes dots from acronym.
This tokenizer has heuristics for special treatment of acronyms, company names, email addresses, and internet host
names.
Classes on the classpath and the JARs that contain them.
I18NResource reading resource bundle from the classpath
Finds duplicate classes in JARs in the classpath of the thread context classloader.
Contains a set of JAR files for each class on the classpath: the set of JARs that contain the class.
Deprecated.
since 7.14 unused
Classpath discovery utilities
The class verifies whether the imported object has to imported or not (based on its class).
Clause type in boolean query.
Removes files from the Confluence temporary files directory.
Provides an alternative to AutoCloseable that removes the throws clause on the close() method.
Delete re-index job history from Bandana after import
A Journal State Store which will store the state from
MultiSubscriptionPerJournalIdentifierProvides cloud platform-specific information like type and metadata urls
Simple bean holding information about the cloud platform on which Confluence is running, if any
Service for retrieving metadata from supported cloud platforms for analytics
List of cloud platforms from which we support retrieving metadata for analytics
Event to fire when read-only mode is enabled or disabled by the administrator on 1 node.
This listener is used for synchronizing the site.wide.read.only.mode property stored in the local confluence.cfg.xml
among the cluster nodes
The result of a node trying to authenticate to join the cluster.
Authenticates a node attempting to join the cluster.
Responsible for selecting which of 2 beans should be used, depending on whether Confluence is clustered or not.
Marker interface for cluster-aware cache compactor
Signal that all managed caches have been flushed in this cluster
This class validates if the current node is compatible with the cluster.
Immutable value bean for Confluence cluster configuration
A facade for interacting with the clustering subsystem
Parts of
ClusterConfigurationHelper
that should not be visible for plugins.Helper class for retrieving cluster configuration information.
Provides the current cluster node's identifier to the velocity context.
Used to signal that all nodes should disable a (local) job.
Simple bean holding information about the clustered database platform on which Confluence is running, if any.
Service for retrieving metadata from supported clustered database platforms for analytics
List of clustered database platforms from which we support retrieving metadata for analytics
Used to signal that all nodes should enable a (local) job.
Marker interface for those events which should be broadcast to other nodes in a cluster.
Listens for events which are implementations of
ClusterEvent,
and wraps them in a ClusterEventWrapper and publishes them via the ClusterManager.Defines a service for publishing application events to every node in the Confluence cluster.
Wraps an event for transmission to other nodes in the cluster.
Service that wraps events in an appropriate Cluster event class depending on the underlying cluster fabric.
If clustering is enabled, adds a custom HTTP header (
ResponseHeaderNames.CLUSTER_NODE_IDENTIFIER})
to the response to indicate which node is handling the request.Event to fire to ask for a snapshot of a lucene index.
Event to fire to ask for a snapshot of a lucene index.
Event to fire to notify other nodes that a snapshot of a lucene index has been created successfully.
Event to fire to ask for a snapshot of a lucene index.
Event to fire to notify other nodes that this has received the request to take a snapshot of a lucene index.
This class contains all attributes of a cluster which must be identical between nodes on a stable cluster
Manages the initial establishment of connections between nodes in the cluster
Describes whether a node is
initiating the connection to another node or accepting
a connection from another node.A request for a cluster join check
A
MemberSocketInterceptor which delegates to ClusterJoinManager to verify if a member can join.A service to execute a runnable with a cluster lock.
Event to fire when the banner feature is enabled or disabled by the administrator on 1 node.
Represents the cluster execution in each node (e.g.
Used when the
ClusterSafetyManager detects a fatal error in the configuration of the cluster.Used when the
ClusterSafetyManager detects a fatal error in the configuration of the cluster.Event to fire when every other node in the cluster requires a reindex.
REST wrapper for the
ClusterService.Provides a partial implementation of
ScheduledJobDao, and is a stripped-down version of
CachedScheduledJobDao.Wrap cluster management as a service for relevant rest APIs
Provides validators for validating inputs to methods in
ClusterServiceSimple flyweight that validates the user-inputted parameters required to setup a cluster.
Even to fire when a node wants to ensure that shared home directory is
visible to other nodes.
Used to signal that all nodes should update the run interval of a cron job
Used to signal that all nodes should update the run interval of a simple job
Evaluates to true if Confluence is in a clustered configuration
Utilities for clustering
When a
ClusterReindexRequiredEvent is fired on another cluster node, this listener
will respond by doing a full reindex.Deprecated, for removal: This API element is subject to removal in a future version.
since 9.4.
Provides helper methods to check Collaborative Editing Mode and status.
Collaborative editing modes
Superclass for analytics events to record a Synchrony mode change
Provides information about the time since the last Collaborative Editing mode change, 'off,' 'on,' or
'limited.'
Published when collaborative editing is switched off.
Published when collaborative editing is switched on.
A GraphQLList builder for List or Iterable types that may be
Collapsed.A marker interface indicating an object is a placeholder for properties in our model
that have not been expanded.
Attempting to access a property of a collapsed object should throw an exception, indicating that it was not in the
original request.
Enriches collections with extra properties that participate in json or graph-ql serialization.
Deprecated.
since 7.17.0.
Deprecated.
since 7.17.0
A callable for collecting JMX profiling config on the current node
Collect ZDU-related information from the current node.
Converts the old style wiki color macro into an XHTML
<span> elements (as used by TinyMCE).Provides accessors for all the expected colours in a
ColourScheme.This is the model for color scheme api
This is the model for color scheme api for light/dark theme
Used for rendering Confluence's color stylesheet, using either the
global or space color scheme.
Utilities for supporting design token color
Poorly named.
Fired when the colour scheme is changed, either within a space, or globally.
TODO CONFSRVDEV-30457: Migrate com.atlassian.plugin.webresource.transformer to com.atlassian.spi.webresource.transformer
Color manipulation utilities
Check the type for a database column.
A factory class for creating
ResourceBundles by combining other ResourceBundles together.concrete Command class will be associated with an event.
Helper class for Struts actions that want to execute a command.
Will associate with single
Command.Allow plugin to contribute to Content Command Factory
Common interface for
Command creationFactory class responsible for creating and managing instances of event processing commands
Supporter class for Command to serialize and deserialize to Journal
An event indicating whether or not a created or added comment was safe to be rendered asynchronously.
Indicates an action may have a
Comment set on it by the CommentAwareInterceptor.A helper utility for taking request parameters, mapping them on to a
Comment, and injecting them into a
supplier CommentAware object.Grabs the 'commentId' or 'focusedCommentId' parameter from the request and sets the associated comment on the action.
ø
Performs API operations for
Comments.Dao for Comments.
Provides an expandable tree of comments
Expands a
CommentEntityTree.An internal SPI to allow core comments to be extended by Atlassian
Extracts the url, title and content type of the entity which contains a comment.
Retrieve comments based on the pagination restrictions specified in the request
LimitedRequest, utilizing a content finder AbstractContentFinderManager for page comments.
DMZ version of the
CommentManager interface; see the package-info.java for rationale.Deprecated.
since 7.6.0, use confluence-notifications-api instead
A comment plus the actions appropriate for that comment.
Service interface for manipulating Comments.
Status values enum
Date: Jan 24, 2007 - 4:46:17 PM
Generates URI to Confluence comments
Token filter that generates bigrams for frequently occurring terms.
Defines the Spring context used by all integration tests.
Writes attributes common to any
Link.
An interface used to determine which fragment transformers need to be loaded from plugins, so that they can be used to compare pages.
This resource manager will instantiate resource loaders which will correct legal Velocity 1.3 syntax
to legal Velocity 1.4 syntax for any resource loader defined with the velocity13.compatibility property
set to true
This class caters for encoding of url strings for the following protocols: - file - http (see RFC 2396 for
reference)
Convenience utility methods that make
CompletionStage a bit easier to deal with.This class is used to import the SAL user manager.
Deprecated.
since 7.17.0
Deprecated.
since 7.17.0.
Marker interface for a function that can be composed by e.g.
Maps v2
ComposableScoreFunction to OpenSearch FunctionScoreDeprecated, for removal: This API element is subject to removal in a future version.
since 9.1, use
CompositeContext instead.Simple immutable composite Velocity
Context implementation that delegates to a collection of other contexts.Combines several trackers into one
Deprecated.
since 7.17.0.
Deprecated.
since 7.17.0
Allows us to flush an arbitrary number of index queues while exposing only one IndexFlushRequester
Any method calls on instances of this class will invoke that same method on all flushRequesters
passed into the constructor
Allows us to use multiple
IndexManagers under the hood whilst maintaining backwards compatibilityDeprecated.
since 7.9 Use
IndexManager methods instead of calling corresponding methods on queue directly.Hibernate interceptor that allows the chaining of multiple sub-interceptors.
Ensures that the more specific
LicenseExceptionHandler gets asked before.Provides a union view of two maps.
Deprecated.
since 7.0.1.
This is a class which could compound the result of multiple
ExistingEntityFinder
which has same supported class and same job sourceA token filter that decomposes compound words found in many Germanic languages based on dictionary.
A multi-threaded batch indexing implementation.
@Conditional that only matches when the "search.platform" property in the application config is set to "opensearch".@Conditional that only matches when the "search.platform" property in the application config matches the specified search platform (e.g.Deprecated, for removal: This API element is subject to removal in a future version.
since 8.6, replaced by
HibernateMappingFactoryClass to manage the text resource for the Velocity Runtime.
Factory methods for Velocity resource objects
Deprecated.
since 7.3.0 will be removed in 8.0.
A
TestRule that configures the Johnson framework before the test and tears it down
afterwards.Configure mobile apps action
This action allows administrators to configure monitoring settings (App Monitoring and JMX) across
the cluster
Thrown when a request cannot be performed due to the state of the content,
as per the semantics of the HTTP 409 'Conflict' status code.
Base class for long running tasks in Confluence.
Confluence specific wrapper for
AbstractWebFragmentModuleDescriptor.Grants or denies the current user access to the action method currently being invoked, depending on which access
check annotations are present.
Determines the access status of a user, which grants them a level of access to Confluence.
Don't log (as in super) when we fall back to using the default action or namespace names.
Base class for all Confluence Struts actions.
Servlet Filter for recording the activity with the
ActivityMonitor.Condition that restricts access to Confluence administrators (and those with greater privileges such as system administrators)
Integrates Confluence-specific allowlisting criteria into the
PluginAwareSecureIntrospector.A
SingletonUberspector subclass which uses a ConfluenceAnnotationBoxingUberspect as the Uberspect
delegate and a ConfluenceAllowlistIntrospector as the coupled Introspector.Specialisation of the AnnotatioBoxingUberspect to be used in a Confluence velocity environment.
Represents a
ApplicationContext that still allows ServletContextAware and
ServletConfigAware processing, and unregistering bean definitions.Represents a
WebApplicationContext that supports spring annotation processing,
and allows for unregistering bean definitions.Configures the beans of the production spring application context.
Required by the plugin system.
Confluence wrapper for ApplicationConfiguration
which allows to mutate
SetupContext setupComplete state as false only during setup process.Confluence implementation of the SAL Application Properties.
Extracts metadata of attachments including the data of their owners.
This SPI defines how Node ID will be stored in audit events
Confluence version of
LegacyAuditEntityMigrator.Puts URI into resources and users so they will become clickable in the UI.
This SPI defines how IP address will be stored in audit events
This SPI defines how method will be stored in audit events
Backs User and Space dropdown menus in Audit UI.
Confluence version of
LegacyRetentionConfigProvider.This SPI defines how current user will be stored in audit events
Provides a factory for creating
ConfluenceOAuth2AuthenticationContext instances for use in mail authentication.Authenticator which uses Confluence's user management code to authenticate a user
against the directory which they come from (e.g.
This class contains utilities shared by different Confluence authenticators.
Intercepts an action created by xwork and autowires dependencies before xwork can execute the action.
Renders a web panel in the context of Confluence.
As hazelcast includes hazelcast-aws since version 5.0, we no longer include hazelcast-aws in our confluence.
Responsible for cancelling jobs (including cluster).
Responsible for accepting backup/restore operations, checking permissions, managing the queue and cluster-wide locks.
Deprecated, for removal: This API element is subject to removal in a future version.
since 8.6
A 'grouping' object to store a collection of BandanaConfig objects in a single XML file.
TODO: Move these to where they're used.
Deprecated.
since 7.12 No replacement.
Hibernate object used by
HibernateConfluenceBandanaRecordDao for storing and retrieving Bandana records.Interface for DAOs which handle persistence of ConfluenceBandanaRecord instances.
Defines what Base URL is saved in Audit events
Base cache interface for all caches in confluence.
Provides a list of caching strategies to use with Confluence.
Switch for CDN support.
Finds users by emails.
Deprecated, for removal: This API element is subject to removal in a future version.
since 9.4
Brings up the initial, minimal environment necessary to bootstrap Confluence.
Connection provider implementation for
SpringHostConnectionAccessor,
which is a generic spring implementation of SAL's HostConnectionAccessor.Note: this class does not parse complete wiki markup links, because pages and blogs can contain arbitrary characters (like colons and slashes) now.
Shared sandbox pool that was initially designed for so called short tasks (e.g.
Overrides removal and addition of directories to make sure they're added to the single internal application,
as well as making sure each operation os
Transactional.Use this authenticator instead of the default
ConfluenceAuthenticator to enable SSO.BandanaPersister that stores and retrieves Bandana via a
ConfluenceBandanaRecordDao.Encapsulates the database configuration at the database setup stage.
The builder for creating an instance of ConfluenceDatabaseDetails.
Confluence decorator selector.
Deprecated, for removal: This API element is subject to removal in a future version.
since 9.1 use
ConfluenceDecoratorSelectorFactory class to create the default OpenSearch normalizer on indices.
The bean to be returned in a JSON request.
Provides operations to obtain the location of various filesystem directory locations used by Confluence.
Propagates
DirectoryUpdatedEvent and DirectoryDeletedEvent to other nodes in a cluster
to trigger the relevant updates to caches and directory monitors on each node.Crowd's event classes are not Serializable, so we need to extract the event class and directory, then
reconstruct the event on the other nodes.
Temporary override to provide cross-compatibility with Servlet API 4.0 and 6.0.
Confluence specific implementation of the Seraph
ElevatedSecurityGuard.CONFSERVER-58180
Avoid setting the content type header on static resources, let the DefaultServlet do its magic
The superclass of all entity objects within Confluence.
Detached event about confluence entity updated.
Indicates that the implementation represents an update to a
ConfluenceEntityObject.Deprecated.
since 8.9 no replacement, events do not need to extend this any more, but they should still be Serializable
Confluence-specific event dispatcher which preserves thread local state across event dispatch threads, and maintains
the VCache request context for the dispatching thread.
A class of RuntimeException that will be propagated through the event system.
For when we want a generic checked exception
Deprecated.
since 5.10.
Holder for services needed during export.
Since the
ConfluenceAnalyzer does not handle filenames very well, we have a different Analyzer for that
field.Utilities that patch/extend Atlassian Core FileUtils.
Provides Confluence-specific types and behaviour for graphql.
Provides the REST API endpoint for GraphQL.
This class replaces com.atlassian.seraph.util.GroupCache, and works with atlassian-user.
This authenticator adds users to the default users group when they first log in.
Trivial extension of GzipFilter that creates an appropriate
GzipFilterIntegration
in the default constructor.Provides integration between
GzipFilter and Confluence.Deprecated, for removal: This API element is subject to removal in a future version.
since 8.4 Replaced by
HibernateManagedCacheAwareCacheManagerA subclass of
HazelcastCacheManager which overrides the creation of certain cache types.Factory for region caches.
Creates anchor values in a Confluence specific way.
Confluence implementation of HelpPathResolver.
Generates a length 32 string which is NOT compliant with the IETF RFC 4122 UUID standard.
A Micrometer
MeterBinder which binds several metrics exposed by Hibernate.A hibernate 5 (onwards) SchemaManagementTool implementation that:
- Suppresses unnecessary sql warning log messages
This class keeps track of transaction state and logs it in case of rollback.
Host container that uses Spring to instantiate objects.
Deprecated, for removal: This API element is subject to removal in a future version.
since 6.5, for removal in 10.0 alongside
HtmlSafe.This reference insertion policy implements the strategy used by Confluence to determine whether automatic HTML
entity encoding should be applied to any particular context or template used by the Velocity rendering system.
Takes a branch root and creates an HTML file for it.
A specialisation of the standard SAL
HttpClientRequestFactory which configures the
connection parameters using ConfluenceHttpParameters rather than using
SAL's own defaults.A trusted request factory that respects timeouts similarly to
ConfluenceHttpClientRequestFactoryPreviously customers were instructed to add HSTS headers by configuring the
HttpHeaderSecurityFilter filter at the global Tomcat conf/web.xml.This interface represent the data captured about a session with Confluence.
A Confluence IMAP server.
An index task that will perform writing to the index.
Bean for holding simple non-settings information about the Confluence instance.
Central InstrumentRegistry for Confluence.
Provides a bridge between Confluence and the External Application.
This subclass implements the following additional capabilities:
Maps max file size to Confluence global attachment size limit
Exempts certain URLs from the multipart request size limits
This class offers basic configuration for some of Confluence's JMX metrics
This service takes care of configuring and initializing the JMX configuration across the cluster.
This filter tries to conserve the resource location for the browser.
An event used to broadcast LDAP directory updates to all the nodes in confluence cluster.
Publisher responsible for publishing information about LDAP directory deletion/deactivation/updates to other nodes in cluster using event
ConfluenceLdapDirectoryClearingClusterEventThis authenticator adds users to default users group when they first log in, but only for users
which belong to an LDAP directory.
Validates whether the license is not expired and the user count does not exceed the license setting.
Deprecated.
Since 5.6.
Contains license utility methods.
Notifies all registered LifecycleAware objects of onStart and onStop events.
Renders Links titles using i18n for link tooltips
How Confluence converts text into links
Configures which kinds of listeners Confluence supports.
Locks the whole UI on site restore.
If the ConfluenceHomeLogAppender has been configured, then this listener is responsible for configuring it to
redirect logging to the confluence home directory once the bootstrap context is initialised.
The default implementation of
LuceneAnalyzerMapper.Deprecated.
since 7.6.0, this is used by mail-archiving only, we should consider moving it there
A Confluence/Atlassian-flavoured OAuth2 credentials that stores the token ID, status and username
Simplified class to replace the somewhat confusing MailNotificationQueueItem hierarchy.
Confluence's implementation to manage MailServers CRUD.
Confluence-specific wrapper around a standard atlassian-cache implementation.
Specifies whether to publish metrics via Micrometer.
This is a simple stub class to return the context path we have cached, used in Velocity templates when we don't _actually_ have a request.
A wrapper for monitoring the performance of Confluence caches.
An
Aspect which wraps all Cache objects returned by the 'getCache' methods of CacheFactory
in a ConfluenceMonitoringCache.A service provider interface to be implemented by
ConfluenceMonitoring
implementations.Deprecated, for removal: This API element is subject to removal in a future version.
since 8.3
A method interceptor that records the execution time of methods.
This class can ve used for creating monitoring names based on request urls.
No op servlet for CONF-7953
A Confluence/Atlassian-flavoured OAuth2 authentication context that uses XOAUTH2 for authentication.
Subclass of the standard ObjectFactory which specifies that no-arg constructors are not required
In a case of OOM error, default
OutOfMemoryHandler shuts down Hazelcast instance and uregisters all
hazelcast servers.A Velocity
ParserPool implementation that is backed by commons-pool.Subclass of the
DefaultAcceptedPatternsChecker that does not log warnings when overriding the accepted
patterns.Cluster safe extension of
DefaultPluginManager which listens for plugin events fired on other nodes
and guarantees that plugin state is consistent across nodes.Deprecated.
since 8.3 Replaced by
ThreadPoolEventExecutorFactoryA Confluence/Atlassian-flavoured POP server that stores the email address associated
with the POP account.
Confluence profiling strategy to be injected into
StrategiesRegistry.Progress monitor that logs progress.
The Confluence implementation of the project manager.
Deprecated, for removal: This API element is subject to removal in a future version.
since 8.9, for removal in 10.0.
Similar to com.atlassian.renderer.RenderContextOutputType
However these output types are specific to confluence rendering.
ConfluenceRendererComponentModuleDescriptor<T extends com.atlassian.renderer.v2.components.RendererComponent>
Module descriptor for wiki renderer components that uses Spring to
instantiate components.
This is a call through class provided for the renderer that will use confluence specific
setup information to relay the information to the renderer.
Utilities for rendering Confluence wiki content.
Confluence's configuration for the super batch.
Determine if a user has permission to view audit logs of a space
This Tuckey URL
RewriteRule will noramlise a URL and then make sure that it does
not attempt to use directory traversal to access the WEB-INF directory.Deprecated, for removal: This API element is subject to removal in a future version.
since 9.3
Factory for getting RuntimeInformation that has been filtered to be safe to send through Atlassian analytics
Confluence SAL implementation of the HttpContext, this implementation delegates to the
Confluence internal
HttpContext class.Compared to
CaesiumSchedulerService, this adds a few features:
(1) stops job after a number of repeats (intended for interval jobs),
(2) schedule jittering (intended cron jobs in OnDemand environment),
(3) job execution listener,
(4) ThreadLocalCache is initialized before a job is run and disposed after thatResponsible for creating (or recreating) the Confluence database schema on initial setup or backup restoration.
Replaces functionality in the ConfluenceHibernateSetup for running schema actions against a database.
Internal API to check the scope of the request
This class acts a wrapper to Lazily construct the SecretService when it is first used.
Confluence security controller to disable security if Confluence
is not setup.
Removes the Seraph ALREADY_FILTERED attribute from requests, so that requests from the error dispatcher get their
security context set up.
The purpose of this class it to define Confluence specific behaviour for Struts SecurityMemberAccess class.
Confluence specific
SeraphAuthenticationListener that converts
principals to ConfluenceUserPrincipal.Confluence specific
SeraphAuthenticationListener that converts
principals to ConfluenceUserPrincipal.A
ServletContainerInitializer which bootstraps Confluence.A simplified variant of
SpringSessionContext which re-resolves the supplied
SessionFactory against the SessionFactoryRegistry to work around the programmatic wrapping of the
SessionFactory that would otherwise break TransactionSynchronizationManager.An SID is a unique ID for a particular Confluence instance.
Renders Velocity decorators with a context map of objects provided by Confluence.
Deprecated, for removal: This API element is subject to removal in a future version.
since 9.1 use
ConfluenceSitemeshDecoratorJust like ConfluenceSitemeshDecorator, but specifically for rendering the decorator for errors.
Deprecated, for removal: This API element is subject to removal in a future version.
since 9.1 use
ConfluenceSitemeshErrorDecoratorThis class will use Confluence default charset for PrintWriter.
Deprecated, for removal: This API element is subject to removal in a future version.
since 9.1 use
ConfluenceSitemeshNoDecoratorA Confluence/Atlassian-flavoured SMTP server that stores authorization and username
information for OAuth2
Confluence's agnostic shim for the Soy Template Renderer
Deprecated, for removal: This API element is subject to removal in a future version.
since 9.1
Listener responsible for handling event
ConfluenceLdapDirectoryClearingClusterEvent about LDAP directory updates in cluster.An analitics event which is fired when Confluence starts, and which contains various statistics and bits of
metadata on the Confluence instance.
Responsible for creating a
ConfluenceStartAnalyticsEventPublisher beanResponsible for creating
ConfluenceStartAnalyticsEvent instances.Responsible for publishing a
ConfluenceStartAnalyticsEvent when the application starts up.Provides a map of Velocity context items that are statically initialised once.
Just extend a Filter from Struts to apply access annotation
A filter that modifies
StrutsPrepareFilter to use the
ConfluenceStrutsDispatcher bean.A
StrutsVelocityContext that is
OutputMimeTypeAwareContextConfluence transaction sycnhronization manager.
Query the status of various Confluence system properties
Customize the default rendering logic of a table.
Confluence specific
TableReader.A file name generator that will create directories and filenames appropriate for the configured Confluence temporary
directory.
Manages all thread local state for Confluence
Manual calculation of session timeout that can take into account "excluded urls" which do not prolong the life of
the session
Spring Bean based filter for monitoring web request times.
Integration of Seraph's trusted application filter with Confluence's trusted applications manager
Provides Confluence-specific types builders for graphql.
This class loader tries to load classes from the application class loader
first before delegating to the plugins class loader.
An analyzer that groups non-stemming language analyzers, and delegates to the appropriate one
depending on the indexing language (
Settings.getIndexingLanguage().Just extend a Filter from
UrlRewriteFilter to apply access annotationMain class which provide Confluence usage statistic via Instrument.
Describing a Confluence user.
A DAO for manipulating ConfluenceUser objects (which essentially act as a mapping between a user key and a User
object retrieved externally e.g.
Finds users by lower usernames for server imports.
An implementation of the ConfluenceUser which wraps an atlassian-user User
A UserManager which is aware of ConfluenceUser's and will take care of the ConfluenceUser specific
persistence requirements before delegating to the "standard" UserManager
Authenticates a user against UserAccessor in Confluence.
Deprecated.
since 7.17.0
Deprecated.
since 7.17.0
Provides strongly-typed accessors for Confluence user preferences.
Principal that contains a user key.
Deprecated, for removal: This API element is subject to removal in a future version.
since 9.2.1, read-only from 10.0, for removal in 11.0.
Provides operations to resolve
ConfluenceUsers.Confluence implementation of the SAL
UserSettingsService.Bean that configures the confluence resource manager with the injected cache manager
Lightweight variant of the Struts
VelocityManager.Clearable velocity cache.
Specialisation that allows for a hot swappable ResourceCache.
This factory will return template that can be used to detect the presence of HTML in the template if required
Exposes template details that are of interest to the Confluence Velocity template rendering subsystem.
A confluence specific wrapper for the
WebIconStores and manages flexible web interface sections available in the system.
Confluence specific extension for
DefaultWebItemModuleDescriptor.A confluence specific wrapper for the
WebLabelA confluence specific wrapper for the
WebLinkRetrieves menu details from plugins via a
ConfluenceWebInterfaceManager.Confluence implementation of WebResourceIntegration, for use with the static resource caching code.
This interface adds Confluence specific functionality to
WebResourceManager.Named for 'grep-ability' to quickly glance at product overrides
Provides services related to writing Confluence html resource tags.
Style of a page.
Confluence implementation of the SAL
WebSudoManager.ApplicationWeights implementation for Confluence.Confluence-specific wysiwig converter for rendering wiki markup in XHTML and vice versa.
This "Confluence" implementation of
XMLEventWriter was introduced primarily to deal with
STAX-58.This "Confluence" implementation of
XmlOutputFactory was introduced primarily to deal with
STAX-58.An implementation of XML RPC that effectively delegates to an underlying SOAP implementation.
XStream wrapper to provide Object's XML based serialization and deserialization.
Default Confluence XStream implementation which adds an XStream 1.1.1 storage compatibility layer.
Interface to allow configuration of ConfluenceXStream in terms of security, aliases or converters.
XStream Manager responsible for lifecycle management of Confluence XStream.
An interceptor that wraps the action execution in a single Hibernate transaction.
Represents a connection between a follower and a followee.
DAO for connections between followers and followees.
A function that returns a constant score
v2 primitive query
Check if a constraint exists.
Create a unique constraint.
represents content that has an owner
A Model object that can hold one or more other objects.
This will represent a collection of attachment
Provides unit tests with a mechanism to register components with the
ContainerManager.Provides a summary of the container for a search results entity.
A builder for GraphQLObjectType objects, generated for api
Container objects.Search for an entity contained within content of a particular type.
Represents all the different kinds of content that can be housed in Confluence: pages, blog posts, comments and so
on.
Placeholder for an improved API for handling Content.
Deprecated.
since 7.0.1 , use
ContentBuilds
Content objects.Provides property names that can be used to expand
Content objects.Represents a high level content action breadcrumb.
Model for Content Blueprint Id
ContentId-like wrapper with everything required to specify a given Blueprint
Blueprint Id resolved by Module key and Space key
Model for Blueprint specific rest data to create a content out of a blueprint template
The object passed in the POSTs for draft and page creation.
Deprecated.
since 7.20 Use
ContentBlueprintInstanceFactoryPublishes the draft of Content created from a ContentBlueprint.
Model for blueprint specific data come together with ContentBlueprintStance
Everything required to identify a Blueprint and its execution context.
Builder class
Container class to hold the various rendered representations of a
Content body.Deprecated.
since 7.0.1 , use
ContentBodyUsed to convert a
ContentBody to a different representation
format.Provides methods for converting
ContentBody instances to other ContentRepresentations.Used for converting ContentBody objects from one format to another.
SearchQuery that finds content where content type is from the list of specified categories
An instance of
CommandFactoryImpl specifically for Content Management.Declares that the implementing class can be converted to an api
Content.A command which handles common space content create events (PageCreateEvent, BlogPostCreateEvent, CommentCreateEvent)
ContentCreator contains logic to validate CREATE / UPDATE content operations which involves sanity checks like
access permission and blank titles.
A class which could be used to generate cursor for the next/previous content pagination request or get cursor from string
DAO to allow us to load content objects by id for migration.
DAO to allow us to load content objects by id for migration.
Extracts Content links map from specific "hidden" _links map entries.
Identifies actions on the details of a Page/Blog, like Info, Attachments or History.
The purpose of this adapter is to switch between different attachment storage structures implementations
AttachmentDataFileSystem.Deprecated.
since 8.1.0.
An implementation of
AttachmentDataFileSystem which stores the
attachment data as files on a filesystem, using the standard File API.DMZ manager for common handling of drafts; see the package-info.java for rationale.
Content draft service for creating and manipulating drafts
The conflict resolution policy to apply when a conflict occurs.
Validate the operations for a piece of content
An event that references a Content object.
Modifies RestEntities that wrap Content objects in preparation for being serialized
A simple bean to represent
ContentEntityObject.Class provided by a content type plugin to allow the resulting CustomContentEntityObject to return the right
responses to various methods.
Default implementation of ContentEntityAdapter.
Responsible for adding auto-watch notifications to new content via an event listener.
Responsible for exporting all content entitity objects.
A recursive EntityExpander to expand
ContentEntity objects.A List wrapper for
ContentEntity objectsDMZ version of the
ContentEntityManager interface; see the package-info.java for rationale.An
Extractor2 which generates indexed fields for a number of ConfluenceEntityObject metedata fields.Attempts to migrate a contentEntityObject with a legacy content body to XHTML.
Wraps a
ContentEntityMigrationBatchTask and ensures that the flush mode of the session is set
to commit.Provides coordinated thread-safe logging of progress across multiple executing threads.
A Dao for ContentEntityObjects.
Deletes records from CONTENT table.
An ID that uniquely identifiers a Confluence content entity (a database ID on the CONTENT table of Confluence).
Represents something that has happened to a particular piece of content
Content REST Doc examples for the atlassian rest api browser
Defines common functions that obtain excerpts of content (e.g.
Event is triggered when page or blog post is exported to word.
Convenience class that provides default values for macros which retrieve
content from somewhere else in Confluence.
Produces a ContentFinder for the ContentServiceImpl
This finder will fetch one or many contents based on different criteria,
for example by their IDs or content types (PAGE, BLOG_POST, COMMENT, etc.)
or by their content status
This condition checks if there are any content permissions applied
to the current page.
Event fired when a non-current version of a content object is removed from Confluence.
Identifies a
Content instance.Sort content by its id that is stored as part of the handle field in Lucene index.
A simple ThreadLocal stack to prevent circular content includes.
IndexRecoverer for the content index.
Journal index task queue for the content index
API Service for interacting with labels on Content
Provides methods for validating actions on the ContentLabelService
A GraphQL provider for the 'labels' field of the Content entity.
REST wrapper for the
ContentLabelService.Provides Likes metadata for Content entities supplied via the Confluence API.
Deprecated.
since 7.0.1 , use
LinkCriteria for looking up a piece of content.
Deprecated.
since 7.0.1 , use
ContentLocatorBuilder that ensures ContentLocator instances are only constructed in ways that allow the ContentService to find
the content in question.
Deprecated.
since 7.0.1 , use
ContentLocatorBuilderProvides methods for interacting with instances of macros on Content.
A finder for locating instances of macros on content
Defines common functions that are carried out for macros that display list of content (e.g.
Interface for Content Management incremental sync service
Service class for managing content event related incremental sync operations with Bandana store.
Model class representing the data structure and attributes of Content incremental sync.
Based multi command class for Content Management
Listener for handling content-related events
Hamcrest matchers for asserting against properties on Content
A builder for GraphQLOutputType objects, generated for
Content metadata.Exception during migration of content.
<class-comment/>
A BulkExtractor which extracts the
SearchFieldMappings.LAST_MODIFIERS from ContentEntityObjects.A json bean for an individual result from performing the name search.
Deprecated.
since 5.2.
A context of the environment that is passed to
ContentNameSearchSectionsProvider.getSections(java.util.List, ContentNameSearchContext).Search for Confluence content by its name (for Pages we search title, for users, we search full names, etc.).
The json bean for performing a ContentNameSearch.
Defines a section in the results of the quick nav dropdown.
Specifies how a
ContentNameSearchSection is populated.Content name search section spec module descriptor.
Provides a map of
ContentNameSearchSectionSpec that are available in the system.This interface must be implemented by plugins who wish to include results in the Confluence quick nav.
An search service that will take a query String and apply it as a search across the 'universal title'
field within the Confluence search index.
Represents an abstraction of content (page/blogs) watch events.
Allows a user to lock content against editing and/or viewing by other users.
Event is triggered when permission is added to content
Calculates encoded string of content permission.
Handling content permission change for current content and descendants content as well
This will listen on event
ContentPermissionEvent and
ContentTreePermissionReindexEventDao for ContentPermissions.
Event triggered when the permissions change on an ContentEntityObject.
A utility class for helping with the extraction and indexing of content permissions.
Internal interface for content permission manager
An interface implemented by a class that can provide ContentPermissions.
Event is triggered when permission is removed from content
Audit listener for content permission events.
Extracts the content permissions set on searchable objects.
A helper class for ConfluenceSchemaCreator to get content permission constraints
This is a container for
ContentPermissions linked to some ContentEntityObject.Dao for ContentPermissionSets.
Field mapping for a field containing
ContentPermissionSet which can be queried with ContentPermissionsQuery.Extracts the content permissions set on a searchable object.
Lucene Filter that filters out indexed documents the user is not permitted to search on or to see as a search result.
This factory creates a new
ContentPermissionsQuery instance if the user is not a superuserContainer for all information which are needed for Content permission check
Persists all content entity objects.
Some useful operations for Content persister.
Encapsulates the properties of a content object.
Extracts v2 API Field Descriptors from content properties associated with given content, based on a dynamic schema.
Persists contentProperties.
Extracts content property.
Encapsulates the logic of extracting v2 API Field Descriptors from a given JSON, based on a content property schema.
Provides handling for the 'content.property' field in CQL.
Export from 6.x may include content properties such as synchrony related ones,
which need to be filtered out on import.
Deprecated, for removal: This API element is subject to removal in a future version.
since 8.3.0
Makes
ContentPropertyService.ContentPropertyFinder instances.Indicate whether to do permission check for queries in ContentPropertyFinderImpl
Read-only view of content property index schema.
Access point for information about content properties dynamic index schema.
Dynamically constructs a content property index schema based on enabled modules
ContentPropertyIndexSchema.Exposes read content property index schema as a module, bound to an add-on lifecycle.
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
ContentPropertyService instead.Deprecated.
since 7.17.0
Deprecated.
since 7.17.0
A GraphQL provider for the 'properties' field of the Content entity.
A REST resource for manipulating content properties.
Contains information how part of content property value (arbitrary JSON document) should be extracted into
a cql field.
Constructs instances of content property search queries based on given schema field type.
Provides methods for creating, reading, updating and deleting Confluence
JsonContentProperty objects attached to
Content objects.Provides methods for validating the create, update and delete methods.
Server implementation of the
ContentPropertyService.Encapsulates validation logic for content property query.
Event is triggered when an
AbstractPage is purged from the trash either manually or via XML-RPCA query to be performed against the underlying database to retrieve some content.
Responsible for triggering and managing content reconciliation for different save operations.
Content migration action displays a count of the number of pages with unmigrated macros and provides access
to the MacroMigrationService to migrate them.
A command which handles common space content Remove events (PageRemoveEvent, BlogPostRemoveEvent, CommentRemoveEvent)
Enumeration of the different built-in ways that Confluence content bodies can be represented.
Deprecated.
since 7.0.1 , use
ContentRepresentationREST wrapper for the ContentService.
A utility for pre-fetching and caching any resource identifier found in a piece of content.
This is UI and ServiceLayer representation of
com.atlassian.confluence.security.ContentPermission Defines
per-content level "Restrictions" (for blogposts and pages only).Provides property names that can be used to expand
ContentRestriction objects.Produces
ContentRestriction from provided ContentPermissionSetsValidator interface.
Defines how pre-existing and passed
ContentRestrictions are getting merged during mutative operationsSpecial implementation of
PageResponse for ContentRestriction objects.Event is triggered when content is reverted to previous version.
Represents a search against Confluence content.
Identifies a
Content instance with a specific status and version.Provides methods for creating, reading, updating and deleting Confluence
Content objects such as
Pages, BlogPosts and Comments.Deprecated.
since 7.0.1
use
ContentService
and ContentLabelService where applicableA content fetcher that also allows fetching many, this exists as a separate interface
to allow the type system to only offer fetchMany methods when appropriate.
A finder for locating content
A content finder allowing various parameters to be set to restrict the fetched content.
Provides methods for validating the create, update and delete methods.
Server implementation of the
ContentService.The state of a piece of content.
SearchQuery which matches content by their content status.
Request class for subscribing to content management incremental sync
Specification class for defining and configuring subscription parameters for content incremental sync
Model object for CRUD operation on template.
Deprecated.
since 7.20 use
ContentTemplateFactoryModel class for Content Template Id Similar to ContentBlueprintId, defines a content template.
Content template resolved by Id
Content template resolved by full Module Key and Space Key
Content template resolved by UUID
Matchers for ContentTemplate
ContentTemplateNameMatcher
This is the interface contains all the methods common between Page and Blueprint template service.
Represents a type of template, such as Page or Blueprint, This class is a simple wrapper around a string.
TODO replace with httpcore exception of the same name when that's widely available to plugins
Compound key which includes content id and sid id.
Calculator which analyses real permissions and build a collections of relations between pages and sids.
Interface of a factory class that creates
Transformer objects, typically used by macro developers to obtain
and optionally modify macro tags (as MacroDefinition objects) in a page of macro body content.Controls trashing, restoring and purging
Content from the instance.Provides methods for validating the trash, restore and purge methods.
Default implementations of
ContentTrashService.Deprecated.
since 7.0.1 , use
ContentA graph of
ContentNode.This event is fired by
DefaultContentPermissionManager when the permissions of
some content (page, attachment, comment, file comment) have been changed and require a reindex.Iterates over all descendants (including pages, comments, attachments, drafts etc) and sends ContentTreePermissionReindexEvent
for each item.
Represents a type of content.
Interface for defining a pluggable content type.
Deprecated.
since 7.0.1 , use
ContentTypeInterface providing extensible content type support in the api
Provides
ContentTypeApiSupports that are either bundled, or registered with OSGiUsed to mark classes that expose a content type
An enum representing the different content types that may be specified in a search.
Deprecated.
since 7.17.0.
Converts
ContentTypeEnums to and from strings in the DB.Module descriptor for pluggable content types.
Providers oprations for locating
ContentTypeModuleDescriptors and their ContentTypes.Presents content type parameters as
ContentTypeQuery or CustomContentTypeQuery implementations.Search for content of a particular type.
Map Confluence content types to display information such as a CSS type or an Icon URL.
Provides metadata about content objects that might be useful in the web tier: the location of icons, relevant
CSS classes, links and so on.
A command which handles common space content update events (PageUpdateEvent, BlogPostUpdateEvent, CommentUpdateEvent, PageMoveEvent)
Triggered when a change to content has been made.
Provides services for extracting
UserKeys from the body content of ContentEntityObjects.Defined this as an interface as we might want to change the way we would want to
update the userKeys in the bodyContent.
ContentVersionService supports find, restore and delete operations on versions of content.
Finder interface that allows to fetchMany(PageRequest) operation
Validator provide validation on operations of this service.
Finder interface that allows to fetchOne() to find A versioned content.
Implement ContentVersionService
A work source that provides batches of
ContentEntityObjects that have XHTML formatted bodies.
A DiffPostProcessor that will mark blocks of content around the diff to aid the identification of context.
Chains a list of
VelocityContextItemProviders, providing a map that
is the aggregation of all providers.Holds and serves the servlet context path.
Responsible for looking at all Java threads still running after the servlet context has been shut down, looking
for any that might be blocking a clean shutdown.
Utilities for manipulating Velocity contexts.
A record of a recent contribution made by a user to a specific piece of content.
Creates a query to find content a user has contributed to (any edit or create is considered a contribution)
Creates
Contributors instances.Makes
Contributors instances.Creates
Contributors instances.A class that is used in notification rendering to create a ConversionContext from a supplied
ContentEntityObject.
XHTML Successor to
RenderContextOutputType.The set of property names used to access
ConversionContext properties.Encapsulates the result of a path conversion.
A type that may be convertible to a
JournalEntry.This filter intercepts HTTP responses to modify cookies by adding the "SameSite" attribute
to enhance security and control the cookie's behavior in cross-site requests.
Indicates that the implementation represents a copy event.
TODO: Document this class / interface here
TODO: Document this class / interface here
An enumeration which defines various caches used in Confluence Core.
Provides the core
ContentNameSearchSectionSpec.Deprecated.
since 5.10.
Consolidates named metrics used by Confluence core into one place.
Builds API validation results.
An interface for the implementations which contain the amount of labels.
A counter to create a unique version for web resources
Represents an atomic counter that can be increased in value.
Represents a snapshot of the counter.
EventThreadPoolConfiguration implementation that creates configuration for
ThreadPoolExecutor based on cpus available.Entry point into CQL Search.
An abstract base class for create commands for AbstractPage subclasses such as Page or BlogPost
An interface for a command that will create a new BlogPost.
An implementation of the CreatePageCommand that will create a page, and assign any provided permissions
then perform the clean up of any Drafts and raise the necessary event.
Service command to create a new comment
Deprecated.
since 5.11.
Allows the context of the page creation process to be retrieved (e.g.
Indicates that the implementation represents a creation event.
Order search results by time created
Decorates
CreateIndexRequest with BM25 default similarity settings.BM25 similarity parameters
Create an index snapshot after a successful reindex in DC
Create an index snapshot after a full reindex in DC.
A simple PageProvider that returns the Page that has been set on it.
An interface for a command that will create a new page.
An implementation of the CreatePageCommand that will create a page, and assign any provided permissions
then perform the clean up of any Drafts and raise the necessary event.
An action that performs relevant authorisation checks when trying to enter the 'add page' screen.
This command is only necessary because
CopyPageAction has different authorisation and
validation logic from CreatePageAction.Determines if the current user can create a page or blogpost somewhere in Confluence.
Responds to a personal space being created.
Deprecated.
Since 5.3 - use the new rest APIs from the Create Content plugin
SpaceBlueprintResourceThis command can be used for enforcing uniqueness of non-null values in nullable columns.
Deprecated.
since 7.6.0, use confluence-notifications-api instead
Query for the original creator of content.
A model object to represent credentials (Password)
Validates a cron expression, and returns the future executions.
Utility class for managing users in Crowd directories.
Implementation of DisabledUserManager which uses the Embedded Crowd service.
Represents a cache of
TimestampedUsers.A Command which handles
UserCreatedEventHelper class for accessing information about Crowd user directories
Enumeration of possible Crowd user directory implementation classes for analytics
A user type used to map a cyptographic key to a set of database fields.
The following are valid values for a CSS colour declaration:
A resource transform that substitutes variables in css files.
The descriptor of relations capturing both direct and indirect contributors of a content.
Provides the ID for the current application in trusted apps.
Allows unit tests for system time dependant functions.
An interface which could be used to generate cursor for the next/previous pagination request
Factory to create cursor entities
Type of the cursor
Test code to reach into CEO and pull out useful properties.
Bean to provide the parameters for the CustomContentApiSupport class this allows us to continue
using the constructor injection on the CustomContentTypeApiSupport SPI.
Generic ContentEntityObject that plugins can use to extend Confluence's content system.
Allows tests to create CustomContentEntityObjects for testing purposes.
Extracts some base "all content needs this" fields from the CustomContentEntityObject.
Implementors should extend BaseCustomContentType support.
This V2 query is used for filtering custom contents based on their types.
A wrapper class to promote ContentTypes to CustomContentTypes
This event is fired when an admin resets a custom dark logo to the default.
This event is fired when an admin uploads a custom dark logo to the instance.
An interface implemented by a Macro that wishes to provide its own HTML placeholder
to the Confluence Editor.
An exception thrown if there is a problem in generating the custom placeholder.
Marshal a Macro that implements the
EditorImagePlaceholder interface and therefore
displays a custom image in the editorManager for layouts -- theme-like Velocity templates that can be edited from within the Confluence administrative UI.
This event is fired when an admin resets a custom light logo to the default.
This event is fired when an admin clicks "undo" to reset the colour scheme that was set upon uploading a light theme logo.
This event is fired when an admin uploads a custom light logo to the instance.
Factory class for creating a Lucene connection to the custom index
A plugin macro in Confluence with metadata and notation guide help.
The CustomPageSettingsManager is used to retrieve and store custom page settings.
Marshal a macro that provides its own HTML representation for the editor.
CustomResourceLoader extends the ClasspathResourceLoader to provide custom resource loading functionality.
This interface is available to plugins and allows 3rd-party vendors to add their own custom indexes
Provides custom jackson serializers for our model.
This action will retrieve the customer stylesheet for a space or if not applicable the global style.
Provides ValueInstantiator overrides, such as the one used for ApiEnum.
Czech language analyzer provider
Daisy HTML diff implementation.
Danish language analyzer provider
BooleanSupplier that returns true when the dark feature key is enabled.Loads a web resource based on a dark feature being enabled
Soy function to check whether a specific dark feature is enabled.
Represents the current state of the dark features for a particular user.
A REST resource that will enable, disable and report the status of a site/system wide dark feature
in Confluence
Creates
DarkFeatures instances from the PropertySet associated with the ThreadLocal user.A REST resource that will enable, disable and report the status of a dark feature
for the currently authenticated user
Deprecated.
since 5.0, we don't display the Dashboard breadcrumb.
This support class provides common functionality used by the macros that are used on the dashboard.
Collection of keys used to store dashboard preferences
Provides a pattern capture token filter to split tokens on -.
Provides hibernate and database helper operations.
Provides access to several underlying Hibernate and JDBC data access objects, which are commonly
used in database-related upgrade tasks.
An implementation which uses a separate table for storing persisted data
A plugin loader implementation that copies plugins from the
PluginDataDao
to a working directory on the filesystem, then delegates to ScanningPluginLoader
which performs the actual class loading from this directory.A
HealthCheck that checks whether the database collation is supported.Verify the database collation.
Reads the Database configuration.
Indicates the database connection setup was failed due to non-sql exception, such that jdbc driver could not be found.
IPD Job that measures amount of database connection failures.
IPD Job measuring active and idle connections in database.
Deprecated.
since 8.0.0
IPD Job that measures current database state.
Service providing information about current database connection state.
Enum representing the database type
Converts a database specific message to more human readable message.
The helper is used by database exporters.
A simple bean encapsulating information about Confluence's database configuration and behaviour.
IPD Job that measures current database latency, when triggered by
IpdJobRunner.Measures database latency.
Updates likes in the persistent store in response to events on the system
This class is responsible for loading a list of possible databases
Stores prepared imported objects in the database.
Scans the database for plugin data.
A
HealthCheck that checks whether the database setup is correct.Manages a SID backed by Bandana.
Stores the test result of connection at database setup.
A marker interface to be implemented by upgrade tasks that perform operations on the database.
This class contains database related utilities.
This task implements the changes in CONFSRVDEV-17301.
Encapsulates a Database Verification result.
Verify the database connection at setup stage.
Indicates the database connection verification was failed due to non-sql exception, such that collation is not appropriate.
Validates that if the license is for data center, the expiry date has been supplied.
Validates that if the license is for data center, the number of users have been
specified, if it is not an evaluation license.
Indicate that a test class should be run with a data center instance, with either single or multiple nodes
Compress and decompress
InputStreamSource and byte[].Exception class for all exceptions related to data conversions in backup/restore process.
If Confluence has been configured to use a DataSource, this component provides access to attributes of the
datasource configured in conf/server.xml.
Constructs DataSources for use in mail notifications.
Decrypts an encrypted
hibernate.connection.passwordThrown when decryption of the property
hibernate.connection.password fails for any reason.A
HealthCheckRule which checks to see if Hibernate is configured to use a JNDI DataSource, and to log
a Johnson warning if so.Represents a date value with various formats
Field mapping for date values.
A service to help format dates
Formats dates and times into a given timezone in a variety of formats.
Constructs
DateFormatter instances for use throughout Confluence core.Provides date formatting beans.
Add css class to the <time> element, depend on the relative distance between current date and the date
stored in the element
Enum representing the 'friendly' date ranges presented on the criteria filter on the search results screen.
Query for search results that have been modified within the specified range of dates.
Helps create a
DateRangeQuery objectDeprecated.
since 5.10, use
Range insteadUtility class for formatting and parsing date and date/time objects in ISO8601 format.
A Field handler for a datetime content property field alias.
Deserializers DateTime instances from the String representation using the TIME_FORMAT in
DatesSerializes DateTime to string using the TIME_FORMAT in
DatesChecks whether Confluence can connect to the database.
Determines whether the Db Connection Pool configuration is correct.
This exception is thrown when DB Exporter fails to export the database.
Handles identifier quoting in raw SQL queries for different DBMS.
Common methods needed by several DB related Health Checks
It is a pair of two IDs, ID of a parent (referencedId) and ID of a child (dependantId).
The same as DbRawData, but also has content type (required for JDBC operations).
Just contains the raw db object data (names and values)
Helper for collecting database statistics.
This upgrade task is necessary for any customer who upgraded to Confluence 8.3.0 and then performed a site restore.
By our requirements, file auditing should be enabled only for DC license
A command to edit SQL data definitions.
Executes any set of
DdlCommands thrown its way.Administrative action to disable a user
Emits diagnostic info about the response.
Creates a logging-friendly string for a space permission check, including the permission itself, the space (or
global), and the user (or anonymous).
Adds debug logging when accessing the wrapped
PropertySet.Deprecated, for removal: This API element is subject to removal in a future version.
since 8.6
Parameters for decay function.
Returns empty list of
Extractor2.Check custom decorators for lang macro usage and replace with inline equivalent.
Implements the
<decorator> plugin module.Encapsulates the logic around creating and parsing decorator path names.
A builder for a search object that decorates another search object.
Provides a mechanism to record and report on invocations of Sitemesh decorators.
This class provides helper methods for deferred rendering of page sections in main decorator
Remove duplicated rows from a table before a unique constraint can be added.
Decide how to remove duplicates so a unique constraint can be added
Note: Tables with composite keys are not supported.
This class is used as amps configuration endpoint point where settings could be overridden first time database is provisioned
JDBC methods for operations with CONFANCESTORS table
Helper class which helps to check if checked class contains required annotation or not
Implementation of
ApplicationCache that delegates to CacheFactory
for caching.Class to Marshall an image attachment.
Note that as extracted text is stored in the filesystem in compression format, changing
DataCompressor
will require the migration of extracted text into new compression format.Simple wrapper of an attachment
Default implementation of
AttachmentManager.Default implementation logs to a logger
AuditService.Default implementation of
AutoCorrectRawQueryTransformer which relies on LuceneQueryParserFactoryDao for backup/restore jobs.
Service responsible for accepting backup/restore operations.
Deprecated, for removal: This API element is subject to removal in a future version.
since 9.3, for removal in 10.0.
A single-threaded batch indexing implementation.
Provides access to those DB tables whose data is required during bootstrap
BootstrapManager is responsible for initializing the dependencies of Confluence environment.
Utility class for various types of BuildNumberConditions (Condition/UrlReadingCondition)
Allow deleting attachment based on difference
AttachmentIdentifieroptions to guide bulk page operations usage
An implementation of
CacheSettingsManager which delegates to another CacheSettingsDefaultsProvider to
provide the default cache config, and another CacheSettingsManager to handle the site-specific settings
overrides.This is providing similar functionality of
RebuildChangeDocumentsIndexTask
and AddChangeDocumentIndexTask which was used by DefaultBatchIndexerDefault implementation of the
Clock interface that
simply returns a new Date instance.An implementation of
ClusterConfigurationHelper which assumes that a cluster of some sort is being used.A
ClusterJoinManager which first authenticates new connectionsDefault implementation for non-clustered confluence.
Manager for page comments.
Common link attributes writer writes target and aria-label attributes when
required, and any classes that should be added to the link.
Configuration for an
ILuceneConnection, with the default values as used by Confluence.Main
ConfluenceAccessManager implementation, using simple global permissions checks.Internal interface for consumption by access manager;
an implementation detail, intentionally not a top-level interface.
Default implementation of the ConfluenceCache interface.
Default implementation of
ConfluenceMailOAuth2Credentials.Responsible for controlling the Confluence Monitoring.
When debugging this code, see SimpleMarkupTest for test cases.
This gets set on content if the plugin content adapter for that content type can't be found (it's broken,
disabled or deleted)
Factory to convert CEO into ContentBlueprintInstance
Generic DAO for hibernate objects.
Provides metadata for content objects.
The default section provider for quick nav that searches through pages, blogs, attachments, peoples and spaces.
Responsible for triggering and managing content reconciliation for different save operations.
Default implementation of
ContentRestrictionService.Validator
Contains per-service-operation methods as we used to in other services/validators.DefaultContentTemplateFactory creates ContentTemplate from PageTemplate
Default implementation of the
ContentTransformerFactory, typically used by macro developers to obtain
and optionally modify MacroDefinition objects in page of macro body content.A
ContentTypeManager implementation backed by a ContentTypeModuleResolver.Serves the context path stored/managed by the
BootstrapManager (this value
is kept up to date with every request that comes into the server).A non-thread safe implementation of the ConversionContext suitable for use in the single threaded XHTML output process.
The set of features that are fundamental to Confluence working, and can only be enabled or disabled during installation.
Default implementation of a counter stores its data in bandana by a supplied key.
Default implementation of the CurrentApplicationIdProvider.
Generic manager for pluggable content.
Creates
DarkFeatures instances from the PropertySet associated with the ThreadLocal user.Production implementation of
DatabaseConfigHelper.Stores cached database connection latency and state information.
Measures database latency by measuring time of a simple sql query.
Compress/uncompress
InputStreamSource using Snappy if it is safe otherwise falling back to trusted
java.util.zip.Decorator for the all the default decorators bundled with Confluence
This implementation supports anonymous drafts using session-based storage.
Note that this implementation of the DraftService does not perform any permission checking.
Class intended to help during the transition period from legacy drafts to shared drafts.
Performs reindexing for the edge index.
Instigate the conversion of HTML received from the Confluence editor to a format suitable for storage.
The active editor is the first editor found in the plugin system.
Deprecated, for removal: This API element is subject to removal in a future version.
since 9.4
Implementation of EstimatedReadTimeService for calculating the read time for a given page/blog
Represent hibernate entity that has to be exported.
Deprecated.
since 7.17.0.
Class that passes on the rendering of an EmbeddedResource to the correct export renderer
Provides list of
Extractor2 that are declared either as @ExportAsService(Extractor2.class) or as
Extractor2ModuleDescriptor module.Default
ExtractorContext which will be shared for all extractors within a SearchableAn implementation that uses the default module factory to produce modules.
The default implementation of the Favourite Manager which uses a label on
the entity to mark it as a favourite.
Deprecated.
since 7.0.1.
Implementation of
FormatSettingsManager which persists the date format settings in Bandana.Deprecated.
since 7.17.0
This can be thought of as the top-level Transformer since it includes the behaviour of writing out any
events that have no specific handling configured.
A factory class that can be used to construct a
DefaultFragmentTransformer configured in a particular
way.Default implementation of function scoring, currently based on content-type and modification recency.
An implementation of
GlobalDescriptionManager that deleates to a GlobalDescriptionDao.Default service for interacting with the GlobalRetentionPolicy settings
Utility that allows you to reach the underlying hazelcast instance of confluence for certain actions.
The
HealthCheckExecutor implementation.Stores the checks in a directed acyclic graph, based on their prerequisites.
Provides methods for finding and deleting Confluence Historical Content
An HrefEvaluator which knows how to generate href values for
ConversionContextOutputType.DISPLAY
and generates relative links for the browser.Responsible for fetching internationalised text given a key.
Produces
I18NBeans which will return a bean either for the default or setup locale.Stores and retrieves
ImageDetails via Hibernate.Calculates, stores and retrieves
ImageDetails for Attachments.Deprecated.
since 7.17.0.
Deprecated.
since 7.17.0.
Deprecated.
since 7.17.0.
Deprecated.
since 7.17.0.
This class is responsible for ensuring that index flush is requested at most
once per transaction, and that it will only be scheduled once the
transaction has been committed.
Implementation of
IndexJournalService.The implementation of
IndexLockService which initialises all lock in memory.Provides functionalities to retrieve information about the number of items added and processed in the index queue.
Provides functionalities to retrieve the metrics for the sizes of the current index queues.
This is the default implementation of
IndexRecoveryService.Creates index tasks and provides conversion into queue entries for implementations of IndexTaskQueue
Override some behaviour of the JSON library JSON object to allow mapped fields to be converted to JSON objects before
adding to map.
This implementation is for Johnson
Events that have the additional attributes necessary for display on the
new Johnson page layout introduced in Confluence 6.5.This is the default implementation of
JournalManager.Settings for ignoring journal entries added within the last given milliseconds.
This is the default implementation of
JournalService.Converts a Java Bean to a JSON object.
Default implementation of the label manager interface.
Responsible for the decoding of a license using the v2
LicenseManager.Default Confluence implementation of
LifecycleManagerBuilds instances of DefaultLink
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.
Deprecated.
since 7.20 Replaced by
DefaultLocaleManagerDefault LoginManager that keeps track of login activity.
Manage all Lucene index snapshots.
Default MacroBrowserManager implementation.
Aggregates macro usages by macro name
The default implementation of
MacroIdSupplier which uses a randomly generated UUID to generate a unique
MacroId.Manager providing
MacroMetadata about the Macros in Confluence.DefaultMacroMetadataProvider<T extends com.atlassian.plugin.ModuleDescriptor<Macro> & MacroMetadataSource>
Listens for plugin events and registers / unregisters the macro migration tasks with itself.
Serializes and deserializes macro parameters in the following format a=b|c=d.
A MacroReplacementRendererRepository that looks up MacroReplacementRenderers based on the class
of the macro to be replaced.
Delegates to a list of other MailContentProcessor implementations.
Checks to see whether a default SMTP mail server has been created.
Default implementation that manages the static job data (i.e.
Default implementation of
MarshallerMetricsAccumulator.The cache maps a
CachedCrowdMembershipCacheKey representing a user (or group) in a particular directory
to a Map<String, String> where each entry in the map represents a group that the user (or group)
is a member of.A cache to make access to the merger provided by the plugin framework fast.
A global message (aka.
Combines different message managers into one
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.
Default OpenSearch HealthCheckUtil which uses the cluster health endpoint to check cluster health
OpenSearch implementation that provides searching functionality on core indexes.
Default page name conflict resolver.
Default (memory-based) PathConverterManager.
Default implementation of PermissionManager.
The provider returns a list of valid PermissionOverrideExtension instances.
The view administrator used jointly by global and space permissions actions
Deprecated.
since 7.17
Used for both anonymous and "all authenticated user" permissions categories
A default implementation for a plugin repository which simply
delegates to a
PluginDataDao.An sub-class of SAL's
DefaultPluginUpgradeManager that specifically manages the lifecycle of
PluginUpgradeFinalizationTasks in the context of ZDU,
i.e.Deprecated.
since 8.8 no replacement
Thread-safe class for tracking progress.
Deprecated, for removal: This API element is subject to removal in a future version.
since 8.9, for removal in 10.0.
A default implementation of QueryFactory that maps query type keys to plugin module complete keys.
This class uses DB Exporter library to create an upgrade recovery file.
This implementation of
ReIndexJobManager listens to indexing-related events and update re-index status accordinglyA component responsible for refactoring the relationships between pages.
Implementation outputting XHTML suitable for display in browsers.
Generates resource identifiers that contain some of the actual state of the resource.
Match a ContentEntityObject against the supplied ResourceIdentifier.
Default implementation of the
RestSpaceManager.Enforce permission model for retention policies as described here.
Default service for getting a user's permission to edit a space's retention policy
An implementation of
RetentionRulesChecker using search index to scan space policiesImplementation of the ScheduledJobManager, co-ordinates access to the scheduler,
persisted configuration (in Bandana),
transient status (in caches), and static data (in the job registry).
Default implementation.
The default implementation of the
SchedulerRunDetailsManager interface.Deprecated, for removal: This API element is subject to removal in a future version.
since 8.7.0
An extractor responsible for extracting the body content from various Confluence content types and
adding it to the defaultSearchableText.
Loaded as a spring bean and is the default renderer that
DelegatedSearchResultRenderer falls back on when no other renderer can be found.
Default implementation of SearchResults
Deprecated.
since 7.7, replaced by
DelegatingLegacySettingsManagerHandles easy-user creation in its myriad forms.
Validates whether a new User (assumed to be itself valid) can be self-signed up for
this instance.
This factory creates the appropriate
SearchQuery for filtering the documents based on the permissions granted
to a user.Relocation from confluence-search plugin.
Default service for interacting with VersionsRemovalStatus object
Deprecated.
since 7.0 use
FieldSortMapper.Deprecated.
in 5.9.
Returns a store that uses bandana.
investigate and improve the performance as per comments in
SpacePermissionFilteredQueryFactory.Default Space Property Provider which allows interaction with OSGI Exported SpacePropertyServiceProvider
Default service for interacting with the SpaceRetentionPolicy settings.
A default implementation of the standard tag which also provides the methods to set attribute values.
Deprecated.
Since 5.9.1
This default implementation is a front for various existing util classes in Confluence.
Originally from org.apache.nutch.searcher.Summarizer v 0.7 (Revision: 179640)
Runs operations on synchrony tables (EVENTS, SNAPSHOTS) and Confluence <-> Synchrony mapping in content properties
This component notifies synchrony to lock entities via network call.
Default implementation of the
SystemInformationService.TODO - this class and interface really necessary? On the plus side, it abstracts the site-locale decision away
from the main TemplateHandler.
Represents the default Confluence theme with stylesheets.
For CONF-9959, this manager will only retrieve theme settings from bandana if the system has been
successfully upgraded.
Production implementation of
TomcatConfigHelper.This class provides utility methods for operating on the Trash
Manager to support trusted communications between applications
Deprecated, for removal: This API element is subject to removal in a future version.
since 7.0.1 will be removed in 9.0
Deprecated.
since 6.10.0.
This implementation of UserAccessor takes care of all the Confluence-related actions around user management:
checking permissions, publishing events, and ensuring the integrity of data in Confluence related to users.
Simple immutable
ValidationError implementation.Provides
DefaultValues for REST resource parameters.Deprecated, for removal: This API element is subject to removal in a future version.
since 8.6 replaced by
VelocityEngineRenderingServiceImplementation which stores everything in a map for easy conversion and copying, if not type safety.
See
WebSudoManager for further documentation.Criteria for checking that we have a directory we can add users to.
Criteria for checking that we have a directory we can add groups to.
Deprecated.
since 7.17.0.
Default implementation of the XmlOutputFactoryProvider interface.
Encapsulates the boiler plate around creating a stream writer.
Defines global XSRF token validation rules.
An action that performs some operation at the end, when everything else is persisted.
Creates actions for deferred operations (for space/site restore).
Collects all deferred operations.
Deletes files or directories that were scheduled for deletion.
A queue for files that are scheduled for deletion.
A
ConfluenceUser implementation based on a UserKey object, and which looks up the "real"
ConfluenceUser lazily as necessary to fulfil the method contract.Deprecated.
since 7.17.0.
An implementation of
Cache that records changes to a delegate cache, only actually
performing them when DeferredOperationsCache.sync() is called.Deprecated.
since 7.17.0.
An action that updates a particular field in a particular record in the database.
An upgrade task that has a property indicating that it's run should be deferred until some later time.
The class includes the logic to loop through the available search result renderers
and pick on that can render the result and use it to render.
This class acts as an adapter between the StAX
XMLOutputFactory abstract class and the Confluence
XmlOutputFactory interface.Implemented by
AttachmentDaos that delegate so that clients
can get to the underlying implementation.Classes that implement this interface perform some sort of delegation of AttachmentManager calls
The entry point for all attachment text extractors.
An implementation of
BootstrapConfigurer that delegates to a BootstrapManager.A
CacheManager implementation that delegates all method calls to another CacheManager.Delegates all calls to the Condition passed to the constructor.
A
Marshaller of MacroDefinitions to editor format, which applies schema migrations before delegating
to the EditorMarshaller depending on the MacroDefinition.Deprecated.
since 8.6, but cannot be removed due to references in existing installed confluence.cfg.xml files.
An implementation of
LanguageAnalyzerProvider interface which delegates language specific analyzer provider.An implementation of thelegacy
SettingsManager interface which delegates to its component interfaces.Provides metadata about macros for use in the macro browser.
A simple delegating implementation of
MigrationAware and FragmentTransformer.Delegating Dao for Notifications.
Deprecated.
since 7.17.0.
A mapper that maps a Confluence
SearchQuery to an OpenSearch Query
by delegating it to the appropriate OpenSearchQueryMapper implementation.
A Macro Manager which looks for named macros in an ordered manner through a list of delegate MacroManager's it
maintains.
An abstract delegating
SearchIndexAccessor that can be extended by a custom accessor.A mapper that maps a Confluence
SearchSort to a list of OpenSearch SortOptions
by delegating it to the appropriate OpenSearchSortMapper implementation.A
Marshaller of MacroDefinitions which decided which macro storage format to marshal,
depending on the MacroDefinition.TODO: Document this class / interface here
Template renderer that tries to find a configured renderer that is able to handle the supplied template by its file
extension
Thumbnail renderer that uses different strategies to render a thumbnail.
Deprecated.
since 7.4 unused
This class delegates attachment manager requests to the appropriate attachment manager implementation based on certain
Confluence configuration options
Delegates to the appropriate download resource manager for resource retrievals.
Service command for removing a blog post.
Removes all change documents for a particular searchable.
Service command for removing a comment.
Context for managers to call upon when making decisions about how to delete
an object.
Index task that removes a searchable from the content index.
Class that represents a user that has been deleted from Confluence post-RTBF (CONFSRVDEV-7360).
Service command for removing a page.
TODO: Document this class / interface here
TODO: Document this class / interface here
Deprecated, for removal: This API element is subject to removal in a future version.
since 8.8
Deprecated, for removal: This API element is subject to removal in a future version.
This upgrade task removes all
attachment-*.tmp files from java temp directory.Removes user in a long running task
Action for removing current and historical profile pictures uploaded by a user
Patches the
ApacheHttpRequestFactory from AWS SDK to allow sending HTTP DELETE requests with entity.Extract 2 fields to tell whether a space retention policy may delete historical versions or trash.
Data deletion result.
Dao for DenormalisedServiceStateChangeLog which keeps information about service state change
Base class for listeners which read records from denormalised change logs (space and content) periodically.
Represents content change log (records are inserted by triggers).
DAO for retrieving and updating content change log records
Handles the events about changed content or content permissions and reads data from logs periodically
It's required to maintain denormalised permissions up-to-date
Re-creates all required triggers and functions for denormalised permissions.
Updates denormalised content view permissions in accordance with real permissions.
Creates all required triggers, functions and indexes for denormalised content permissions.
Removes all records and populates denormalised_content table again if service was enabled to fix problem with content status
Supports a denormalised relation between content id and sid id (sid represents user or group
or authenticated user or anonymous user.
Dao for working with denormalised content view permissions.
Keeps a record which could be exclusively locked (for writing) to avoid parallel execution
Allows to acquire DB locks.
An analytic event which is sent when state of Denormalised permission service is changed.
An analytic event which is sent when one of the methods from Denormalised Permissions service is failed.
Provides fallback methods for denormalised permissions
When denormalised permission service is in "not ready" state,
fallback methods will be called.
This class is a proxy that wraps the
DenormalisedPermissionServiceImpl allowing permission override extensions
to be added to the service.A router which either sends requests to real denormalised permissions service or to "fallback" service.
Executes DDL operations on supported databases for creating/dropping triggers and functions
Abstract class for ddl operations with denormalised DB objects
State of the service (does not include the state of API)
Manages service state, and state change logs
Denormalised permission state manager is responsible to managing the service state,
including starting, stopping, enabling/disabling API, maintaining list of the past events etc
Re-creates all required triggers and functions for denormalised permissions.
Information about the service state change.
DAO for creating/updating
DenormalisedServiceStateRecordRepresents the state of the space or content service.
Entity for storing sids (security id) which could be either user or group or anonymous or authenticated user
All tables with denormalised data refers to sids instead of real users groups etc
DAO for working with user/group sids
Sid (security id) represents either user or group or "any authenticated user" or "anonymous"
All denormalized records have references to sids
Creates and retrieves denormalised sids.
Sid type, used by DenormalisedSid.
Represents DAO for working with the space change log
DAO for retrieving and updating space change log records
Handles the events about changed spaces or space permissions and reads data from logs periodically
It's required to maintain denormalised permissions up-to-date
Supports a denormalised relation between space id and sid id (sid represents user or group
or authenticated user or anonymous user.
DAO for denormalised space permission table.
Updates denormalised space view and edit permissions
Creates all required triggers, functions and indexes for denormalised space permissions.
A graphql extension to deny field queries for anonymous access, unless
AnonymousSiteAccess is applied to the provider class.Deprecated.
Listens to PluginModuleEnabledEvents and logs a warning if the plugin module is a deprecated class,
or subclasses or implements a deprecated type.
This Plugin State Store will override the original state
so that we could decorated it with a list of deprecated plugin (plugin which is disable by default on new version but
if user upgrade Confluence from older version then it will keep the previous state)
The depth to which sub-content should be returned.
REST wrapper for the
ChildContentService, when Depth is ALL.A renderer which is aware of the registration of
DeviceTypeRendererComponentModuleDescriptor
within the system and will keep track of these modules.Computes a diff between the specified left and right input.
This DiffInlineTaskMarshaller outputs inline task lists in a diffable way:
As little whitespace/CRs as possible, because it disturbs the diff,
DaisyDiff doesn't diffs lists properly when they contain multiple spans, and it puts spans
outside the LI and inside the UL, which doesn't produce a workable output.
An interface implemented by classes that want to process the output of the Confluence Diff prior to it being
returned as complete.
Deprecated.
since 5.3 Use
ImageDimensions insteadCustom entity info for cwd_directory_attribute table.
We do not have a dedicated class for cwd_directory_attribute, so we use this fake class basically for logging or methods like equals etc
Command for handling
DirectoryCreatedEvent.A message that represents a directory.
Custom entity info for cwd_app_dir_operation table.
We do not have a dedicated class for cwd_app_dir_operation, so we use this fake class basically for logging or methods like equals etc
A persister for
DirectoryMapping entity.Custom entity info for cwd_directory_operation table.
We do not have a dedicated class for cwd_directory_operation, so we use this fake class basically for logging or methods like equals etc
Wrapper class for
ApplicationDirectoryOrderUpdatedEvent.Persists
DirectoryImpl.The 'DirectoryScanningPluginFactory' generates a directory scanning pluginLoader which provides the functionality to
load plugin jars from a custom defined path.
Enumeration of the possible states the internal directory can be created in.
This event is exactly like
UserRenamedEvent,
with the exception that it is always guaranteed to be published.This action will present the specified space as a tree view of all its pages.
Marker directive to indicate that this template does not wish to have Anti-XSS run on its contents.
Deprecated, for removal: This API element is subject to removal in a future version.
since 9.3
Manages the underlying changes to enable and disable users.
Disables collaborative editing and turns off the Synchrony process (if internally managed)
Provides getter methods for a Label that can be displayed.
An interface to expose the ContentTypesDisplayMapper bean to plugins.
Represents the first field of a content-disposition header
The captcha as used by FishEye/Crucible.
A command to generate data manipulation SQL statements
Represents a DML statement consisting of a DML statement with placeholders and the arguments that go with it.
Deprecated.
since 5.8.
Constructs a link to the instance's documentation
Factory interface for retrieving documentation link beans.
A user interface documentation link consisting of a key.
A Jsonator for DocumentationLink objects.
Creates a Lucene
Document from the supplied Searchable.Deprecated.
since 8.6.
Deprecated, for removal: This API element is subject to removal in a future version.
since 8.7, not supported on OpenSearch.
This filter tokenises filenames using .
Deprecated.
since 8.6.
Field mapping for double-precision floating point numbers
Represents field its value is of type
double.v2 primitive query
A mapper for
DoubleRangeQuerys.GateKeeper for the Confluence downloads directory.
An interface for managers that support reading of downloadable resources.
Enum of all the supported prefix of Download Resource Manager (except the prefix of WebImagesDownloadResourceManager)
An analytics event that captures information about streaming a download to the client.
This is the old way of dealing with drafts in Confluence and will be deprecated soon.
A link to an attachment that is attached a draft object.
The result of a successful Draft save.
Stores Confluence drafts in a data store.
Saves, retrieves and merges drafts of Confluence content.
This delegate verifies permissions for the old
Draft object.Identifies a draft resource.
The result of a successful Draft save.
A Service responsible for Draft related operations during editing in Confluence.
REST resource to allowing saving and retrieving of a draft against a particular Confluence user.
Class intended to help during the transition period from legacy drafts to shared drafts.
Used to authenticate a web sudo session.
USE WITH CAUTION!
This filter will drop any request that comes in when Confluence is not finished setting up.
This upgrade task drops the table "incremental_sync_subscription"
We only have to drop this table for Postgres because the feature has never been rolled out
for production yet but staging environments such as Bulldog wiki and EAC
Drops a unique constraint by column name.
Drops a unique constraint.
Dummy implementation of
RenderingEventPublisherTrivial implementation of the interface which just invoked the action directly.
A RuntimeException thrown when an operation is being called with some duplicate data
Removes all duplicate nested tags, see
the corresponding CONFSERVER-54754 ticket
Removes all duplicate nested tags, see
the corresponding CONFSERVER-54754 ticket
Hold a duplicate record.
Create a
DuplicateRowHolder from a ResultSet
Note: Tables with composite keys are not supported.Helper class that is used to check whether time that has passed since previous event is exceeding a threshold
A helper class for code that wishes to perform timing of how long an arbitrary operation lasts, and for warnings to
be logged if the elapsed time exceeds a configurable threshold.
Simple start/stop timing interface to be used by clients.
A factory for creating
DurationThresholdWarningTimingHelper objects.Dutch language analyzer provider
Provides a map of Velocity context items computed anew for each constructed context but cached within it (as backed
by
LazyMap).Produces the best
I18NBeans it can at the point it is first called upon.Adds items to the render context for EasyUser web panels.
Deprecated.
since 5.6.1, use
AdditionalAnswers.returnsArgAt(int) instead.Entity name processor that does not change the entity names.
If pages and blog posts are targets, then user actions on them are edges.
Responsible for creating an Atlassian document that represents an edge.
This class contains the mappings of all fields that an edge document can have
Responsible for indexing edges.
An event to indicate that a flush of the edge index queue has completed with at least 1 item in the queue.
A
PluginUpgradeTask which forces a rebuild of the edge index.Deprecated.
since 8.6.
Similarity class for edge index
This interface is the same as the
ConfluenceIndexTask.Listens for application events and responds by creating an edge and persisting it
the index for querying.
Performs reindexing for the edge index
A
SearchIndexAccessor specific to the edge index.An abstraction over the id used to uniquely identifer the target of an edge.
Creates instances of the
EdgeTypeModuleDescriptor.An interface which extends the immutable interface of Labelable with functionality to be
able to add and remove labels.
Service command for editing an existing comment.
Flags an event for edited content, means that the content is
Updated and may be a minor edit.This class is used by the doeditsettings action
Used to edit the logged in user's preferences (homepage, timezone, and language)
This interface allows Wysiwyg editors to be plugged in to Confluence.
Marshal macros that don't have a body to editor format.
Marshal macros that have a body to editor format
Writes out the tag for an embedded image; invoked in the editor context.
As with the other editor marshallers and unmarshallers, this code should actually live in the TinyMCE plugin.
Responsible for converting the editor representation of a transform error back into a storage formatted xml.
Provides methods that convert between edit and storage formats.
Helper class to read the attributes of an img or ac:image tag into the supplied DefaultEmbeddedImage object.
Unmarshal the body of a link
Encapsulates all the extra marshalling concerns that are common to marshalling all links for the editor.
Responsible for unmarshalling links in editor XML.
Transform the macro definition from the XHTML received from the editor into a holding object which can then be output into different formats such as
storage format.
Factory class for getting the current editor
Transform the Page Layout 2 definition from the XHTML received from the editor into a holding object which can then be output into different formats such as
storage format.
Handles the viewing and editing of a user's Editor settings.
A
ContextProvider for all the settings required by the editor wherever it is, which may or may
not depend on the current user.Responsible for unmarshalling time in editor XML.
Wraps a
ViewUnidentifiedAttachmentMarshaller and adds extra attributes for the editor.A soy server function that retrieves web-panels for a given location.
Transformer editor formatted XHTML to storage format XHTML.
Handles the editing of a
PageTemplate description.Provides the logic required by the actions to edit the permissions
for both global and spaces
This interface is used by all actions that need to edit permissions
Deprecated.
since 7.0.1 , use
VersionAn action to edit a trusted application record
Helps to calculate effective space permissions.
Handles the process of compacting EHCache caches by forcing eviction of expired elements.
A file-based store of EhCache config information.
Class that allows Confluence's ehcache configuration to be modified programmatically.
Represents stored EhCache configuration.
Deprecated.
since 5.9
Confluence-specific implementation of
CacheManager which delegates to an atlassian-cache
EhCacheManager, decorating it with Confluence-specific functionality.Defaults provider to tell atlassian-cache that all ehcache caches should be local
An analytics event which contains a snapshot of the basic statistics of an ehcache.
Provides CacheStatistics for EhCache.
Deprecated.
since 5.9.
Implemented by a class that can create id's for Elements suitable for use in the context of a particular
ConversionContext.An interface implemented by an object that will handle a StartElement or EndElement and transform it
in some manner.
A FragmentTransformer that can be configured to transform individual Elements it reads.
An XMLEventReader that can be configured with multiple ElementTransformers potentially
changing the start and end elements returned by the reader.
Provides elision token filter.
Creates some common Email context entries.
Deprecated, for removal: This API element is subject to removal in a future version.
since 9.4 use
DispatchServiceAn implementation of
ApacheDS which manages a locally embedded LdapServer.Adds hibernate mapping for externalId property of
InternalGroup or rather logs
that the crowd schema got updated, because Hibernate should take care of updating things for usDeprecated.
since 7.0.1 because atlassian-embedded-crowd-atlassian-user module was removed.
Provides convenient methods to create the crowd application and internal directory optionally if one isn't found.
Deprecated.
since 7.0.1 because atlassian-embedded-crowd-atlassian-user module was removed.
Deprecated.
since 7.0.1 because atlassian-embedded-crowd-atlassian-user module was removed.
Deprecated.
since 7.0.1 because atlassian-embedded-crowd-atlassian-user module was removed.
Deprecated.
since 7.0.1 because atlassian-embedded-crowd-atlassian-user module was removed.
Adds required multi-column unique constraints to the Crowd database tables
Deprecated.
since 7.0.1 because atlassian-embedded-crowd-atlassian-user module was removed.
Deprecated.
since 7.0.1 because atlassian-embedded-crowd-atlassian-user module was removed.
Represents an embedded resource.
A LinkBody representing an EmbeddedImage.
Writes out the tag or tags for an EmbeddedImage.
Represents an object to be embedded onto a page
Interface for embedded resource renderers.
Interface to represent the concern of resolving of a v2 embedded resource into a persistent Attachment object.
Emoticons are represented explicitly in Confluence storage format.
Describes a component responsible for mapping an emoticon to data suitable for display.
Deprecated, for removal: This API element is subject to removal in a future version.
since 8.2
Copied from
DocIdSet's EMPTY_DOCIDSET constant (lucene 4.3 version).Represents a link with no link text.
Represents plugin state that is never persisted.
This class is used during bootstrap, and contains no configuration -- all plugins will be in their default state.
A V2
SearchQuery implementation which only finds custom content which have been enabled, or non-custom content.Encoder used in
OpenSearchSearchResultStruts Velocity result that adds automatic HTML entity encoding support to the result context if the final content
type is "text/html".
English language analyzer provider
The implementation of
StandardAuditResourceTypes which uses English names.Confluence override version of
ServletModuleManager which will wrap all DelegatingPluginFilter for access checkingA map with the RestEnrichable annotation, indicating that this map should be converted to a RestEntity
and enriched by the REST stack.
Deserializes maps that have been enriched with extra properties such as _links and _expandable.
Extends the graph-ql type system with enrichment functionality from
ApiRestEntityFactory.This flag can be used to check whether Enterprise features are available to current Confluence instance
A subclass of
DefaultNodeExtension which re-enables member socket interceptor support.Creates a builder for converting an object into a REST entity
Extracts the creation and last modification dates.
Enriches entities with extra properties that participate in json or graph-ql serialization.
Interface for erasers which ere responsible for removing data from tables.
Helps to generate SQL queries (INSERT, UPDATE etc).
Converts a User or Group into a JSON object prior to serialization.
Wrapper for a lazy query for model objects.
Provides access to the current request's JPA
EntityManager object from Confluence.Contains all entity object's information needed for making backup.
Represent a collection of elements.
Implementation of EntityObjectsWriter that coverts objects to XML stream (the same way as the legacy XML writer does).
Entity persister interface.
Creates persisters for entities.
Provides operations for removing entities in bulk.
Thrown during a user or group operation where the user or group does not exist
Use this converter when you need to convert properties which aren't included by default or when you need to add a collection
Result of entry processing operation.
A builder for GraphQLOutputType objects for maps with
ApiEnum as the key type.Deprecated.
since 7.17.0.
Deprecated.
since 7.17.0
Converter class that converts strings in the request to the correct enum types.
Deprecated, for removal: This API element is subject to removal in a future version.
since 9.3, use
EnumTypeConverter instead.Published by
EventPublishingAppender when an error is logged by the system.Provides specific error messages.
Extend the V2Render with a new method where a writeable List can be supplied to collect
any exceptions thrown during renderering.
A progress meter to be used in situations where the total cannot be determined efficiently or conveniently up front.
Service for calculating the read time for a given page/blog
A analyzer for European languages which will tokenize, apply the standard filter and lower case.
Provides a European unstemmed language analyzer for OpenSearch.
Changed subclassing as of version 7.11 to remove select bundles from setup process
Result of applying current trash retention rules to a trashed entity
Delegates each control operation to a
PluginController then
fires an event to replicate operations across the Confluence cluster.An interface indicating that a given action has a related event it wants to be published once the action completes.
Composite id key class for
Events.Used to manage references to latches that are used to support the ability for test clients to register an event
listener on the server side and to block until that event is published.
This bean keeps actual value of a particular dark feature
It is faster than DarkFeatureManager
This bean keeps actual value of atlassian-profiling dark feature that filters out known metrics
Collects events from
Evented actions after they've executed , and publishes them via the EventPublisher.Sends health check analytics events via the
EventPublisher.This component attempts to tightly control the thread pool executor used by the Confluence event dispatcher mechanism.
Faux class for the synchrony schema
The event is sent when query regions should be evicted.
Custom analyzer designed for supporting exact matching.
Analyzer that supports exact matching.
Provides OpenSearch analyzer for
ExactAnalyzerDescriptor to support exact matching.Custom analyzer designed for supporting exact matching on file names.
Provides OpenSearch analyzer for
ExactFilenameAnalyzerDescriptor to support exact matching on file names.Only Tokenizer by space
This is only tokenize query string using space
This class controls when we should enable Exact Search.
The REST client-side conversion between HTTP Response codes (per )
from Jersey
WebApplicationExceptions, and Confluence REST API model ServiceExceptions.The REST server-side conversion between Confluence REST API model
ServiceExceptions
and HTTP Response codes (per http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html).Response.StatusTypes for HTTP response codes not supported directly by Response.Status.Converts Confluence REST API model
ServiceExceptions into RestError entities,
the standardised error response format produced by our REST resources.Provides a mechanism for capturing exceptions.
A thread safe repository of exceptions that occurred during the site migration.
Utilities for logging exception details in an
ExceptionReport.A trivial servlet filter which just throws an exception.
Migrates / converts text from one format to another.
Migrates / converts text from one text format to another.
Represents the results of an attempted migration.
Class Excerpt represents a single passage found in the
document, with some appropriate regions highlighted.
Allows fine grained configuration over what and how much content is included in an excerpt produced
by an
Excerpter.Defines common functions that obtain excerpts of content (e.g.
Indicates the current status of a managed job.
Allows to find objects already existing in the DB.
Builds map of finders that can be used to find existing entities (like users or labels) during space restore
Interface that allows classes implemented it to be transformed into composition of primitive ones.
An expanded reference has a value, call get() will return that referent value.
Represents a property on a model object and the sub-properties of that property that
should be filled in by the service when returning the model object.
Deprecated.
since 7.0.1 , use
ExpansionA graphql extension that makes sure fields of type Reference, List and Map are
included in the expand= parameter.
Deprecated.
since 7.0.1 , use
ExpansionsConverts
Expansions to and from a String for use with REST calls.An exponential decay function.
Non-admin operations for user groups
Experimental Group Resource, delete this once GroupResource is published
Like BasicTheme, but allows you to do some truly evil stuff like overriding Velocity results and
turning off Sitemesh.
Non-admin user operations
Experimental resource, delete this once UserResource is published.
This job runs daily and clean up the expired user verification tokens in the bandana table.
Represent hibernate entity that has to be exported.
Creates exportable entity infos.
Deprecated.
since 8.0.0
The Spring bean definitions for the exported OSGi services..
Deprecated.
since 7.17.0.
Describes an export, based on the exportDescriptor.properties.
A
WritableDownloadResourceManager that stores and reads macro output from a temporary location.Wrapper for internal
JournalStateStore.Deprecated.
since 7.10, use
ExportedTestClass instead.Created by IntelliJ IDEA.
Deprecated.
since 7.17.0.
Sub-interface of AnyTypeDao, not available to plugins, that ties the result type of findAllPersistentObjectsHandles
to the implementation relied on by export.
Just a helper for Space and site exporters creator.
Creates exporters on demand.
An interface for a class which can generate meaningful and unique (for a single VM) names that may be used as file
names in the export process.
Deprecated.
since 5.10.
Deprecated.
since 8.0.0
A descriptor for an exported image.
This is model class for
EntityObjectReadyForExport.ReferenceDeprecated.
since 7.17.0.
Used when we need to include additional data into entity which is not added there by default
Represents the valid scopes for an XML Export.
Indicates an invalid export scope.
Deprecated.
since 7.17.0.
Deprecated.
since 7.17.0.
Export a page as HTML which Microsoft Word will understand.
The
XsltTransformerResolver used for export purposes.Thrown when trying to make changes to a page outside an editing session (e.g.
Allow customising of the external process builder.
Checks if any User directories in additional to the Internal one are currently active.
Actions implementing this are external user management aware actions.
This interface provides clients with the ability add additional fields and body text to the index documents produced
for each searchable object in Confluence.
A module descriptor that allows plugin to add an
Extractor2 into indexing pipeline.Provides list of
Extractor2.A context which is available for all
Extractor2 for Content Index
The instance will be prepared by Extractor2DocumentBuilder
BulkExtractor is not supportedWill be used with
Extractor2 and BulkExtractor to indicate
that extractor instance want to access ExtractorContextAn interface which prefill information into
ExtractorContextAble to set attribute into
ExtractorContextIpdJob that checks connection state to external user directories.
IpdJob that checks latency to external user directories.
This fake
HealthCheck allows the operator
to simulate a health check failure, for example to test:
The Johnson infrastructure (manually or via automation), or
The "hide.system.error.details" flag.
Creates map of an empty objects for id generation for all entities that could be restored during space restore
TenantContext with a fixed name for defining TenantContext
in Spring XML for tests.Enables fast permissions after site restore or on fresh setup.
A resource that allows tests to flush fast permissions queue.
Contains the status of the Versions Removal job
Default service for interacting with VersionsRemovalStatus object
Status of a fast soft removal job
FastTrashRemovalManager is a service that removes trashes based on retention policies.
Fast version removal service for removing versions based on retention policies.
Wrapper for
Expansions that can be passed to a ModelFactory to indicate both expandability at the top
level, and any sub-expansions.Manages the favourite spaces and pages of a user.
The built-in relationship type for favourites.
Order search results by favourite date.
Maps sort capability from FavouriteSort to lucene.
Implements the "Favourite Spaces" tab, which displays updates from a user's favourite spaces.
Deprecated, for removal: This API element is subject to removal in a future version.
since 8.3 no replacement
Deprecated.
since 8.3 unused, no replacement
Allows plugins to provide custom content types to the feed builder
Allows users to specify properties of the feed.
Allows plugins to provide builders for items in an RSS/Atom feed served by Confluence.
An event sent when a
Timeout occurs when rendering a com.sun.syndication.feed.synd.SyndEntry.The type of feed.
Deprecated, for removal: This API element is subject to removal in a future version.
since 9.1
Represents a field change in the settings.
Represents an index field.
Deprecated.
A V2
SearchQuery implementation which finds documents which contain a specific field.This mapper maps a V2
FieldExistsQuery to the relevant Lucene queryDefines how an index field is stored and indexed.
Contains the field-mappings associated with a particular index.
Writer for creating field mappings physically on the underlying index.
This interface provides plugins with the ability to define additional field mappings onto the search index.
A module descriptor that allows plugin to add an
FieldMapping into the search index.Registers all
FieldMapping from field-mappings-provider modulesA visitor to resolve a
FieldMapping based on its implementation.Exception thrown when an attempt is made to access a search field when it was not included in the
collection of requested fields.
Sort based on value of a field.
Represents a
ValidationError that is associated with a field of user input.The Type class encapsulates the modification types that can be applied
to the score/value product.
Originally an inner class of
LuceneSearchIndexAccessor, but extracted as a first-citizen class here
for better clarity.Specifies a numerical field from which data will be drawn for score function.
Deprecated.
since 8.6.
Deprecated.
since 7.17.0.
Classes that implement this interface are exported as files,
rather than the native format (XML, HTML, etc)
Search for content with a particular file extension.
File Information
Collects some data of the files in the index folder.
Deprecated.
since 7.14
Custom analyzer designed for supporting matching on file names.
Provides OpenSearch analyzer for
FilenameAnalyzerDescriptor.This filter tokenises filenames using .-_ as delimiters.
Sort based on an attachment's filename.
Serves files from Confluence: attachments, custom resources, thumbnails, plugin resources, etc.
Deprecated.
since 7.19 Replaced by
ApplicationConfigurationFileStoreFactoryProvides a mechanism to substitute placeholders representing the various Confluence home directories.
Deprecated, for removal: This API element is subject to removal in a future version.
since 9.4, use
AttachmentUploadHelper instead.An implementation of
AttachmentDataDao which stores the
attachment data as files on local filesystem, using the standard File API
or as blob on remote filesystem, using com.atlassian.filestore.client.api.FileStoreClient API
via the AttachmentDataFileSystem interface.Deprecated.
Since 5.5 Use
com.atlassian.confluence.pages.persistence.dao.filesystem.FileSystemAttachmentDataDaoPersists journal state in the local home directory on each node.
Deprecated.
since 7.14 Replaced by
AbstractFileXmlExporterSkips objects of entities that do not have any incoming referenced.
A function that delegates to the provided function if the document satisfies a filter, otherwise it will return an empty score.
Hibernate 2 version of a query to find all content properties by owner id
Hibernate 2 version of a query to find a content property by owner id and key
Hibernate 2 version of a query to find all space properties by space key
Find and Replace text in page title to resolve conflict
Hibernate 2 version of a query to find a content property by owner id and key
Hibernate 2 version of a query to find a space property by space key and key
Predicates used by finders to filter Content
Allow to create a proxy for the given finder.
Accepts potential users and/or group names with an optional entity type and returns the entities found.
A utility class that centralises the 'hackyness' involved during the period
we support both username related APIs and the change to user keys.
Finnish language analyzer provider
Retry policy that only retries if it is the first encounter of this retry policy instance on the call stack.
The score of the first matching component functions is used.
Permits unauthenticated updates to the Confluence license if there are upgrade problems with the instance.
Flash Scope allows one request to pass data to the next request if it's a redirect.
Deprecated, for removal: This API element is subject to removal in a future version.
since 9.3, use
FlashScope instead.Takes Flash scope objects out of the session and makes them available to the current request.
Deprecated, for removal: This API element is subject to removal in a future version.
since 9.3, use
FlashScopeInterceptor instead.Deprecated.
since 8.6.
Field mapping for single-precision floating point number.
Represents field its value is of type
float.Temporary clone of
FlowRequestService for providing Jakarta compatibility.This interface defines the behaviour for DAO instances that provide
some sort of caching of objects, which need to be flushed at times.
Deprecated, for removal: This API element is subject to removal in a future version.
since 8.8, use com.atlassian.confluence.cache.rest.CacheManagementResource instead
Flushes the changes index queue
Flushes the content index queue
Deprecated.
since 7.9 because Confluence now has multiple index queues.
A simple statistics object that holds details for an index flushing.
Listens for
LicenceUpdatedEvents in order to reset the cache in UserChecker.resetResult().An event fired when a user is followed
Returns true if the logged in user is following the target user
Manages the followers and followees of a user
Deprecated.
since 7.18 Use
FollowManager or NetworkServiceProvides the first available
Font on the system.Provides the first available
Font on the system.Forces an upgrade task to run.
This event is triggered when the 'forgot password' form is
submitted and there is no corresponding user found
Used by the
RequiresFormat annotationProvides a convenient service for transforming to and from the storage format into the editor and view formats.
Soy function for formatting dates.
Soy function for formatting dates.
Persistent storage and retrieval of format settings.
A String with a
ContentRepresentation.Fluent builder for body content and formatted Content.
Soy function for formatting dates.
This interface has to be implemented if the new AUI form styles are being used.
Class delegates all calls to an {code}XMLEventReader{code} passed to the constructor.
Action to handle 405 error - Method Not Allowed.
Simply sets 404 status and returns 404 page to the user.
Servlet that always returns a 404.
Represents a read-only XML fragment.
Deprecated.
since 7.17.0
Handler that responds to problems in fragment transformation.
French language analyzer provider
Formats a date in a relative, friendly way.
Deprecated.
since 8.8 use
DateFormatService.getFormattedRelativeTime(Instant)Soy function for formatting dates.
Deprecated.
since 7.20
Sort by a user's full name
Responsible for triggering full reindex operation with necessary state management.
Listens to job control events published by the
FuncTestRpcHandlerImpl.v2 primitive query that modifies the wrapped query score of a retrieved document by combining it according to
FunctionScoreQuery.BoostMode with an value provided by ScoreFunction.A factory to apply function scoring on search queries
A mapper for
FunctionScoreQuerys.GarbageCollectorTimeAnalyticsEvent is fired when GC overhead exceeds the specified limit.
Manages the granting of temporary permissions to retrieve resources.
A gaussian decay function.
An event indicating that o batch of one or more attachments have completed
uploading.
This AttachmentCopier copies Attachments from one AttachmentManager instance to another, in the case where there are
different storage implementations for data and/or meta-data.
An event indicating that one or more attachments have been added to a piece of content.
Event sent *before* the removal of an attachment.
This is published when an attachment is restored from the trash.
An event indicating that an attachment has been updated
Event sent *before* the removal of an attachment version.
Extension of
VelocityUtil that contain methods that are not needed or safe for use in Velocity templates.Character tokenizers that tokenizes on a specified list of delimiters.
Eraser that can remove data from most of the tables.
A generic persister for most of the entity objects.
Generic exporter that works for most of Hibernate entities.
A configurable and generic macro that renders a Velocity template as part of its execution.
German language analyzer provider
A soy server function that retrieves the i18n text of an action message.
Implements the ContentUiSupport helper method
GetDisplayNameFunction to get the display name from the language Manager.
Returns the future schedules as a JSON response.
Contains the future schedules for a particular cron expression, or an error (and reason) if the
schedules cannot be determined.
A soy server function that return a list of map so that we can iterate list map in soy.
GetPageDiffFunction to get the page diff and render as html markup in soy template.
Given a username, return the user object.
This is the interface for global color scheme service
Content Entity Object that is associated with the whole confluence rather
then a specific space/page/user.
Dao for the GlobalDescription.
Web Panel for showing spaces, pages and people
This is a simplified model object representing a global permission
Event sent when any global permission is changed.
Command for handling
GlobalPermissionRemoveEvent and GlobalPermissionSaveEventEvent sent for any global permission related operation.
Journal entry types used for global permission events
Journal message used for all global permission journal entries
Interface for Permission Management incremental sync service
Service class for managing global permissions event related incremental sync operations
Model used by all global permission incremental sync events
Listener for handling global permission events to create entries for incremental sync
Operations supported by permission incremental sync
Types of events supported by global permission incremental sync
Event sent whenever a global permission is removed.
REST API for global permission.
Event sent when any global permission is saved.
Provides mutable operations for SpacePermissions
Represents a change to global permissions.
Represents a user viewing the global permissions.
Deprecated.
since 7.14.0
Service for interacting with the GlobalRetentionPolicy settings
Current values of application-wide settings.
Builds
GlobalSettings objects.Event announcing a change in the global configuration of Confluence.
Backdoor REST resource for editing global settings.
Represents an administrator viewing the global settings.
This event is fired when global time zone is updated
Thrown when things that are expected to be found are GONE.
Provides helper methods for implementing a GraphQL API.
A graphql formatted pagination response.
A graphql formatted pagination response.
A subclass of
Expansion that provides a graphql query instead of a field expansion list.A simple query limiting mechanism for the GraphQL endpoint, to avoid DoS attacks.
The JSON response object for a graphql API.
ChildContentService implementation that communicates with Confluence remotely using the Confluence GraphQL API.ContentLabelService implementation that communicates with Confluence
remotely using the Confluence GraphQL API.ContentService implementation that communicates with Confluence remotely using the Confluence GraphQL API.RemoteWebView implementation that communicates with Confluence
remotely using the Confluence GraphQL API.WebViewService implementation that communicates with Confluence
remotely using the Confluence GraphQL API.Helper methods for building GraphQL request strings.
REST API for GraphQL.
Greek language analyzer provider
Represents a group that may contain zero or more users.
Command class for
GroupCreatedEventParent class for commands that process group events
Factory class for building api group objects from corresponding atlassian user groups
Event sent when a user signs up via the group invite link.
Internal interface for group manager
Provides operations for resolving
Groups.A direction agnostic cache of maps from directory ids and group names to groups.
GroupMembershipsEventCommand<T extends com.atlassian.crowd.event.DirectoryEvent>
Util methods that build
MembershipQuery that can be used to get the group memberships for a specific Crowd entityClass for checking operations on groups.
This event is similar to
GroupDeletedEvent but it will be fired before the group is deletedCommand class for
GroupRemovingEventProvides operations for resolving
Groups.Non-admin operations for user groups
Searches for groups.
Builder for a
GroupSearchRequest.This is an Entity that is meant for rest calls.
API service for finding user groups in confluence.
A finder for locating groups
This rest plugin is capable of returning admin only information about groups in the confluence instance.
Generates links to Confluence groups
Classes implementing this interface will be serialized into JSON using
GsonJsonator.A Jsonator implementation that uses Gson under the covers to serialize an object to JSON.
Contains methods for creating/removing triggers for content table
Contains methods for creating/removing triggers for content_perm table
Contains methods for creating/removing triggers for content_perm_set table
H2 triggers for content_perm_set table.
H2 triggers for content_perm table.
H2 triggers for content table.
An
EmbeddedDatabaseManager implementation for H2.Empty trigger.
Contains methods for creating/removing triggers for spaces table
Contains methods for creating/removing triggers for space permission table.
H2 triggers for space permission table.
H2 triggers for space table.
see https://hibernate.atlassian.net/browse/HHH-13711
TODO : remove when upgrading hibernate-orm, org.hibernate.version to 5.4.13 or 6.0
A token by which the AnyTypeObjectDao (for example) can resolve any persistent object.
An interface that should be implemented by
IndexTasks that are intended to be persistent and whose work
depend on a persistent object - one which can be loaded by using the handle provided by an implementation of HandleAware.getHandle().Resolves a
Handle from a persistent ObjectDescribes how Hard Synchrony Eviction should be performed.
Simple bean holding information about the hardware specifications of the system on which Confluence is running
Checks if the page in this context has any attachments
Only display the link if the user is viewing a blog post (as opposed to a page or some other content type)
Caches the calculations (the computed hash value of every file) as it is expensive to calculate this every time it is
required, and is unlikely to change at runtime.
Deprecated.
Since 5.9.1
Only display the link if there is a label in the context
Content classes implementing this interface can be linked to by wiki markup.
Only display the link if the user is working with a page (as opposed to a blog post or some other content type)
Search for content belonging to a user who has a personal space.
Only display the link if the user is working within a space.
Only display the link if there are templates to use
An implementation of
HazelcastConfigurationAccessor backed by an ApplicationConfiguration.Clears Hazelcast caches that exceeded 2x of their maximum size.
Hazelcast implementation of
CacheStatistics.Deprecated, for removal: This API element is subject to removal in a future version.
since 8.3 Use
ClusterEventServiceHazelcast specific implementation of the ClusterEventWrapper.
Hazlecast implementation of the ClusterEventWrapperService
Deprecated, for removal: This API element is subject to removal in a future version.
since 8.2
Hazelcast implementation of
ClusterManagerClusterMonitoring implementation which relies on hazelcast to get information from other nodes
Deprecated.
since 8.3 Replaced by
TopicEventPublisherUtility that allows you to reach the underlying hazelcast instance of confluence for certain actions.
Responsible for crearing Hibernate
RegionFactory objects based on Hazelcast.HazelcastMemberAddedAnalyticsEvent is fired when a node was added to the cluster
HazelcastMemberRemovedAnalyticsEvent is fired when a node was removed from the cluster
Registers the OsgiListener once the main spring context is up
Deprecated, for removal: This API element is subject to removal in a future version.
since 8.2
Deprecated, for removal: This API element is subject to removal in a future version.
since 8.2
Hazelcast Implementation of
CacheStatisticsManager.An implementation of
TopicEventCluster representing the Hazelcast cluster.Contains HZ Member <-> NodeIdentifier conversion utils
A health check performed by Confluence during some phase (or phases) of its lifecycle.
A server-side analytics event raised after executing a health check.
Factory for analytics events arising from health checks.
Sends analytics events relating to the results of health checks.
A
Supplier for the HealthCheckAnalyticsSender.Well-known keys and values of Johnson attributes used by startup health checks.
Executes the given
HealthChecks and returns their unique results.Create HTML and raw text messages simultaneously.
Registers the desired
HealthChecks
along with their prerequisite checks.Allows
HealthChecks to be registered.The result of a
HealthCheck.Provides rule validation for a specific Health Check.
The entry point for running
HealthChecks.Simplies the implementation of
HealthChecks.The
HeartbeatAction provides methods used by the client side editor
to detect concurrent changes to a single CEO.An action for supplying a help link based on the given properties.
Hibernate 5 implementation of the batch finder.
Hibernate 5 Implementation of the BatchProcessor
A consumer that accepts a single input argument and returns a boolean indicating if further
inputs are wanted.
Executes all the various database-specific table altering commands.
Deprecated.
since 7.17.0.
This implementation retrieves the correct instance of AttachmentDao for the
AttachmentDataDao that is given, and wires the instance with the necessary
attributes.
Deprecated, for removal: This API element is subject to removal in a future version.
since 8.8, no replacement
Deprecated.
since 7.5.0.
Hibernate implementation of the BlogPost DAO
Simple interface for bulk action on Hibernate
Wrap low layer transaction management for bulk action.
Make sure Hibernate L2 caches are flushed correctly in Data Center.
Hibernate cache regions in integration tests are not managed by atlassian-cache thus we *must* flush Hibernate cache regions manually here.
It creates a predicate for checking whether constraint of specified name exists or not.
Holder for DB connection that keeps the connection open.
Deprecated.
since 7.17.0
Deprecated.
since 7.17.0
Interface that needs to be implemented by a HibernateContentQuery plugin module.
Module descriptor to allow plugins to provide custom queries for looking up pluggable content.
Exposes information about the capabilities and types of the database being used by Hibernate.
Executes any set of
DdlCommands thrown its way.Hibernate 5/Spring implementation of directory persistence
Database storage for drafts.
This filter verifies whether the imported object has the corresponding Hibernate entity or not.
Provides access to the current hibernate Session object.
Information about Hibernate field.
A
Filter which intercepts calls to ConnectionProvider.getConnection() and throws an exception if,
and only if, the inbound request is trying to render an HTTP 500 error when the DB connection pool is exhausted.Hibernate 5/Spring implementation of group persistence
Deprecated.
since 7.20.
Resolves a
Handle for a persistent object.Deprecated.
since 7.17.0.
Hibernate implementation of
IncrementalSyncSubscriptionDaoAllows bulk membership changes via database IDs rather than by name.
The implementation of
InternalRunDetailsDao interfaceJournalDao that uses Hibernate for
persistence.Basically an
JCacheRegionFactory but shares an instance of EhCache CacheManager with Atlassian CacheManager.Hibernate data transfer object for cryptographic keys
Deprecated.
since 7.17.0
Deprecated.
since 7.17.0
Hibernate implementation of the
KeyStore interfaceDefines operations for obtaining references to
ManagedCaches that represent Hibernate cache regions.Responsible for creating
ManagedCache implementations based upon Hibernate Regions.Deprecated, for removal: This API element is subject to removal in a future version.
since 8.4 use
HibernateManagedCacheSupplierHibernate representation of a membership that uses actual foreign keys and joins instead of trusting that
database integrity will be maintained by a team of unicorns.
Deprecated.
since 7.17.0, use
HibernateMembership insteadImplementation of
MembershipDaoDeprecated.
since 7.17.0
Deprecated.
since 7.17.0
Helps to retrieve all information about Hibernate entities.
Implements the Hibernate
Integrator SPI in order to obtain access to the Metadata.Provides operations for accessing the Hibernate
Metadata and derived properties.Wrapper around
HibernateSessionManager5HibernateObjectDao<T extends com.atlassian.core.bean.EntityObject>
Generic DAO for hibernate objects.
Stores page ancestors in the ANCESTORS table in the database.
Hibernate implementation of a PluginDataDao, which stores plugin JARs in a database
for distribution among clustered application nodes.
The keys of custom Hibernate-related properties.
Load resources via Hibernate.
An implementation of
SchemaComparisonService which
uses the Hibernate mapping as the "expected" schema, and compares it with the actual database schema.An implementation of
SchemaInformationService which
uses the Hibernate SessionFactoryImplementor to get database related information.A HibernateCallback that executes an
HQLQuery against the database, converting parameters
and results to the correct types.Provides methods to manage objects in the current Hibernate
Session.
This implementation was created instead of just using the existing SpaceDao and SpacePermissionsDao for a few reasons
-
Retrieving space objects from a named query results in you being returned Space proxies.
A Servlet Filter which uses a
HibernateSqlCollector to capture all SQL by Hibernate on the current request thread,
and optionally stores that SQL for later retrieval.Records all SQL issued by Hibernate by hooking into the org.hibernate.SQL log4j logger.
Spring Factory Bean which will create Hibernate Statistic
Hibernate implementation of the
TrustedApplicationDao.Unwraps Hibernate proxies reflectively, without adding a compile-time
dependency on Hibernate itself.
Implementation of
UserDao which uses Hibernate 5.Base class for Hibernate UserType objects in Confluence.
Manage the ZduStatusEntity table.
An event indicating that o batch of one or more hidden attachments have completed
uploading.
An event indicating that one or more hidden attachments have been added to a piece of content.
Event sent *before* the removal of a hidden attachment.
This is published when a hidden attachment is restored from the trash.
An event indicating that a hidden attachment has been updated
Event sent *before* the removal of a hidden attachment version.
Please do not use this interface.
Provides utilties for creating hierarchical directory structures for storing Confluence content-related files.
Parameters for highlighting in search.
Sets proper current ids for all tables, based on the information from entities.xml
Encapsulates information about the login history of a particular user.
Provides methods for finding and deleting Confluence Historical Content
Contains the history of a piece of
Content.Provides property names that can be used to expand
History objects.Creates
History instances.Makes
History instances and references.Deprecated.
since 7.0.1 , use
HistoryFinds search hits in content based on a given Lucene query.
Creates a
HitHighlighter which finds search hits in content based on a given Lucene query.Finds search hits in content based on a given Lucene query.
Implementation of
CacheSettingsDefaultsProvider that uses a read-only Configuration
file that specifies the cache defaults.Checks that a Confluence home directory has been specified, and either exists or can be created.
Gives the reason why the HomeHealthCheck failed.
Indicates the reason why the home check failed.
Creates human readable messages from a given
HomeHealthCheckFailure.Represents the homepage on which a user should land when they enter Confluence.
Deprecated.
since 5.9.
Extracts Home Page status.
An service which uses the global and user settings to determine the homepage for any given user.
Provides operations for resolving home directory placeholders in path strings.
Interceptor to do the equivalent of
DefaultComponentRegistrar
for objects dynamically returned by Host components.Hibernate query translator for our non-crowd-standard table structure for group membership.
The marshalling of links involves creating the actual href attribute describing the destination of the link.
Cleans up an embedded HSQL instance by opening it and shutting it down.
The hibernate Dialect that's used for HSQLDB.
Predicate to tell whether we're running in HSQLDB or not.
Takes xhtml fragments for raw text elements (as a matching pair of elements) and
returns it as a pair of open and close tags (as required by the HTML 5 spec).
Takes xhtml fragments for void elements (either as empty elements or as a matching pair of elements) and
returns it as a single self closing tag (as required by the HTML 5 spec).
A non-thread safe class used to create HTML ids within a render 'context'.
Encoder to encode text for html
Portions of this class copied from Apache commons-lang StringEscapeUtils -- it was easier to copy the relevant
bits than it was to upgrade commons-lang to 2.0 :)
An HrefEvaluator that will generate links appropriate for HTML exported content.
Deprecated.
since 6.5.
This class parses html and extracts all the image tags required for exports
using the given image processing rule.
Processes image tags for html exports.
Responsible for stripping paragraph tags.
Deprecated, for removal: This API element is subject to removal in a future version.
since 6.5, for removal in 10.0.
Deprecated, for removal: This API element is subject to removal in a future version.
since 9.0, for removal in 10.0 alongside
HtmlSafe.Marker directive to indicate that this template has been designed to work correctly with Anti-XSS measures.
A utility class that will take a String formatted as HTML and remove all tags and attributes leaving only the text
nodes and CData content intact.
Represents a raw html string.
Strip html tag.
Convert a String supplied in HTML to well formed XML that can be handled by an XML parser.
Utility class for encoding and decoding HTML and URL strings.
IPD Job that measures the number of active HTTP user sessions
Actions that wish to be served to browsers/clients with http cache validation headers
(Last-Modified and etag) should implement this interface.
This class retrieves a trusted application certificate via http.
Deprecated, for removal: This API element is subject to removal in a future version.
since 8.6.0 will be removed in 9.0
Provides access to the key objects provided by the servlet API when processing an HTTP request.
Deprecated.
since 7.2.0.
Deprecated, for removal: This API element is subject to removal in a future version.
since 9.3, use
HttpMethodValidationInterceptor
instead.Filter that applies a HTTP caching strategy over the Likes REST API.
IPD Job that measures the number of recent HTTP user sessions.
Deprecated, for removal: This API element is subject to removal in a future version.
since 7.0.1 will be removed in 9.0
Deprecated, for removal: This API element is subject to removal in a future version.
since 7.0.1 will be removed in 9.0
Filter that monitors http request duration.
Holder for statistics specific to an HTTP request.
Analytics events that contains statistics for a single HTTP request.
Filter that will gather HTTP request statistics and publish them as an
analytics event.
Interceptor that, when applicable, adds a key that matches the keys
used in confluence-browser-metrics projects to http request stats.
Deprecated, for removal: This API element is subject to removal in a future version.
since 9.3, use
HttpRequestStatsInterceptor instead.Deprecated, for removal: This API element is subject to removal in a future version.
since 7.0.1 will be removed in 9.0
Deprecated, for removal: This API element is subject to removal in a future version.
since 7.0.1 will be removed in 9.0
Use
RequestFactory or ReadOnlyApplicationLink
instead.Deprecated, for removal: This API element is subject to removal in a future version.
since 7.0.1 will be removed in 9.0
The HttpSessionTracker keeps track of the "users" that have a "session" with Confluence.
Determines whether the ratio of HTTP Threads to Database Connection Pool for all connectors is correct.
A
HealthCheck that checks whether there are enough DB connections
in the pool relative to the maximum number of HTTP threads.Utility class to extract http time out parameter info.
Utility class to extract http time out parameter info.
Hungarian language analyzer provider
Responsible for fetching internationalised text for a given key.
Factory interface for retrieving i18n support beans
This analytics event is fired whenever
CachingI18NBeanFactory has had
a cache miss and needs to initialise a new I18NBean.Production implementation of
ErrorMessageProvider.A Jsonator for i18n Message objects.
Rest resource for accessing translations in Confluence.
Simulates the behaviour of ResourceBundle.getBundle() and searches for all bundles for a locale from most specific to least specific
Deprecated.
since 5.2 Use
I18NBeanFactory.getI18NBean()Provides fields to the 'Icon' GraphQL type
Unmarshals resource identifiers using the resource id and resource type attributes on an anchor tag (if they're present).
Resource identifier containing the the id and type of a resource.
A page locator that uses the page Id to find an identified version of a page.
A blog post locator that uses the blog post Id to find a blog post
This will allow to get attachment by ids.
Responsible for keeping all required id mappings between the old ids and the new ones.
Creates id mapper based on job scope.
A class that will take a long Confluence Id and converted it to a multi-part hash with a particular number of parts.
A page locator that uses the page Id to find a page
Criteria for Admin Tasks which can be dismissed.
This filter exists to work around an issue with plugins that use SpringMVC.
Removes illegal XML attributes.
Exception thrown from a service when the permissions of the application are not in the correct state to allow
the permission change requested to be performed.
Custom Exception thrown when a URL is outside the whitelisted URLs
A connection to a Lucene index.
Provide configuration for the index writers used by implementations of this interface.
A class encapsulating the commonality in parsing the attributes on an img or ac:image tag.
A class encapsulating the commonality in marshalling the attributes for an image in view, edit and storage.
Class containing the image details of a single version of an
Attachment.Data Access Object for database storage and retrieval of
ImageDetails.Calculates, stores and retrieves
ImageDetails for Attachments.Provides a mechanism to prefetch imagde details entities.
The height and width of an image or thumbnail.
Due to CONFSERVER-52441, instances may have emoticons which have been incorrectly stored as images.
PLEASE NOTE: This interface was designed to work closely with the ThumbnailInfo object, to provide a way
to vary the path it uses to generate the ![]()
data.
A
TagRule that is responsible for processing image tags.Convenient utility methods for rendering of images.
Deprecated, for removal: This API element is subject to removal in a future version.
since 9.4, use
AttachmentUploadHelper instead.Deprecated.
since 7.17.0.
Represents the key of a persisted object.
The Spring bean definitions for the ActiveObjects Confluence SPI Plugin.
Deprecated.
since 7.17.0.
Deprecated.
since 7.17.0.
Interface for filter that can exclude imported objects.
This is a model for imported object from xml file
Deprecated.
since 7.17.0
Deprecated.
since 7.17.0.
Interface for preprocessors that modify imported objects.
Deprecated.
since 7.17.0.
Accepts objects and sends the object to the proper persister.
Factory for
ImportedObjectsDispatcherAllows to temporarily "stash" imported objects and read them later.
Creates an instance of ImportedObjectsStash which is responsible for temporarily keeping plenty of imported objects.
Creates an instance of ImportedObjectsStash.
Allows to temporarily "stash" imported objects and then read them.
Converts legacy ImportedObject to the new ImportedObjectV2.
This is the replacement for legacy
com.atlassian.confluence.importexport.xmlimport.model.ImportedObject class.Deprecated.
since 7.17.0.
Deprecated.
since 7.17.0.
Deprecated.
since 7.17.0
Deprecated.
since 7.17.0.
Deprecated.
since 7.17.0.
This class listens for ImportFinishedEvent and triggers plugin upgrades
when site import has been performed.
Deprecated.
since 7.17.0.
Deprecated.
since 7.17.0.
This action can be used to import a bunch of text files as pages.
Deprecated.
since 7.17.0.
Deprecated.
since 7.17.0.
Deprecated.
since 7.17.0 because of Hibernate 2 usage.
Serialises resource(s) contained within modules.
Service responsible for running all additional tasks that should be executed before and after restore.
Factory for
ImportTaskRunnerReplaces EditorUnknownMacroMarshaller to handle both body and bodiless macros.
Defines the contract for an inbound mail server.
Enumeration of types of IN clauses used in an SQL query.
{include} macros are actually treated as links by the renderer.
Match tokens that describe what search constraint should be applied to a
parsed
SearchQuery.This manager is responsible for manipulating single Lucene directory and single index queue.
Provides a contract for
JournalCleaner to clean journal dataA class which could be used to generate cursor for the next incremental sync pagination request
Class that listens for onApplicationStartedEvent and adds and option to create incremental sync cursors to CursorFactory
Model class for an Incremental Sync Cursor so it can be used to return string format cursors in APIs.
Retrieve incremental sync data based on the page request.
Retrieve incremental sync data based on the page request.
A marker interface which indicates incremental sync is not available
marker interface for all incremental sync model
Page response class for incremental sync models.
Interface of incremental sync service
Model object for subscription
Hibernate entity object
An interface to work with
IncrementalSyncSubscriptionEntityWe need this to workaround issue with REST HK2 IoC
A service that performs operations with backup/restore jobs, their settings and statistics in separate transactions
to ensure proper concurrent processing.
This class represents an index, which replaces the deprecated
SearchIndex
A developer can only define a new custom index via Index.custom(String) method.A wrapper around an
Attachment that implements the SearchableAttachment interface.Contains logic to determine which
ContentPermissionSets should be stored in an index field.Factory class to create OpenSearch index analysis settings needed at index creation time.
Check if an index exists.
Indexes the data stored in an object for fast+flexible search querying.
Allows clients to enable/disable indexing.
Responsible for listening for published
IndexerEventListener.VisitorEvents and passing them an ConfluenceIndexer for processing.A utility for class for publishing events to
IndexerEventListener via an EventPublisher.Listens to RequestIndexFlushEvents and routes the flush request to the correct
IndexFlushSchedulerThis class is responsible for requesting scheduling index flushes.
Requests that the supplied
IndexFlushScheduler flushes the relevant index queueEach time a flush is requested, this class will schedule a job to flush the
index queue in 5 seconds, unless a flush has already been scheduled.
Collects information about an index to quickly determine where in a process we are
A decorating batch task, re-indexing the searchable that the task is applied to.
IPD job that measures the accumulated processing time for batches in the main queue, change queue, and edge index queue.
A specialised version of
JournalService for the purpose of indexing, e.g.Confluence has multiple indexes and some operations on them are mutually exclusive.
The entry point to the Indexing Subsystem.
Enum indicating the mode in which to flush the queue.
An event to indicate that a flush of the index queue has completed with at least 1 item in the queue.
IPD Job that measures the current number of items added and processed in the main, change and edge index queue.
Service providing information about number of items added and processed in the index queue.
IPD Job that measures the size of the main, change and edge index queue.
Service providing information about current index queue sizes.
Deprecated.
since 7.0.1, there is no substitution for it.
This service will support the recovery of a Lucene index.
Modifies the Journal.
This class represents an event that is triggered when the creation of index snapshots
is successful.
Various error in creating/restoring index snapshots
Spring config for beans related to search and indexing
Indexing task.
Public interface to create a new
ConfluenceIndexTaskConfluence queues all of its index requests and then executes them in bulk.
Enumeration of index task types.
A velocity-oriented helper class for constructing deep-link index URLs
IPD Job which copy already existing index writer metric
IndexWriterLatencyIpdJob.COMMIT_JMX_OBJECT_NAME to IPD metric.Builder for dealing with query strings using the IN clause (or NOT IN clause).
Containing both direct
ContentPermissionSet and all ancestor ContentPermissionSetQuery for matching a single
Label that was inherited from a piece of
parent content, for example, searching for comments attached to pages with a certain labelResource used by the test
com.atlassian.confluence.InheritedPagePermissionsAcceptanceTest#testInheritedPermissionRemoval()This is type of
com.atlassian.confluence.api.model.content.Content.Expansions#INHERITED_READ_RESTRICTIONS
Listener that generates the initial content of a space when it is first created.
Responsible for cleaning up cursor target paragraphs and moving <ac:macro> fragments that output inline markup when rendered, into any nearby paragraphs.
The in-memory representation of an inline comment marker for working with storage format
An <ac:macro> fragment that represents a macro that outputs inline markup.
Helper class to wrap content with in-lined space styling
The in-memory representation of an inline task list - only to be used during
editor / storage marshalling and unmarshalling.
The in-memory representation of an inline task - only to be used during
editor / storage marshalling and unmarshalling.
Utilities to parse Inline Tasks
An in memory implementation of the Index Task Queue.
Keeps persisted objects with their database ids in memory.
Backed by a
Set, to be used in integration tests in lieu of the real SpacePropertyServiceRepresents an attachment resource that is supported by an input stream.
Implementors consume an
InputStream.A datasource that provides access to an input stream of data.
Decorator for potential
IOExceptions thrown by an InputStream.Deprecated.
since 7.17.0.
Composes
InputStreams.Provides an
InputStream.Search using a set of space keys for content that occurs within some set of spaces.
REST API for fetching instance metrics.
Serializes DateTime to string using the TIME_FORMAT in
DatesHibernate 2 mapping type for the new java 8
Instant class.Runtime exception that is thrown when a user tries to perform an operation without the required privileges.
v2 primitive query
A mapper for
IntegerRangeQueryInternalGroupDao<T extends com.atlassian.crowd.model.group.InternalGroup>
Private-ish interface for methods that should only be called by other DAOs.
This class contains deserializers for the package protected classes in the content model.
Implements bulk membership changes via database IDs rather than by name.
Reads a file with expected OSGi-exposed packages
Internal DAO class for manipulating the scheduler_run_details table
A ServiceException wrapper for a general runtime exception.
A persister
InternalUserCredentialRecord entity.InternalUserDao<T extends com.atlassian.crowd.model.user.User>
Private-ish interface for methods that should only be called by other DAOs.
Exception thrown when the diff timed out or failed, possibly in another thread.
Deprecated.
since 8.6.
Field mapping for integer values.
Represents field its value is of type
int.Converts a Java bean to a set of String-to-Object mappings by enumerating all get* and is* methods on the bean.
Deprecated, for removal: This API element is subject to removal in a future version.
since 9.3
Skips Bandana records if their context or key fields are empty.
Exception thrown when a macro parameter cannot be parsed for any reason.
Thrown when a Request Parameter contains an invalidly encoded parameter.
Thrown when a smart list query could not be converted to an index query.
Thrown when an operation is attempted that is not valid for the kind of ContentBody you are providing.
Deprecated.
since 7.0.1 , use
InvalidRepresentationExceptionException thrown during add-on descriptor parsing, if content properties schema definition is invalid.
Superclass for exceptions thrown due to errors converting from a Search to the native search type.
Exception thrown when an invalid session token is supplied to an RPC method.
Creates
NotificationData instances for User Invite events.Like a regular Function but allows to throw IOException
This class represents the result of an IP Allow List validation for websudo action.
Feature flag for In-product Diagnostics functionality.
This class is responsible for creating executors used by IPD and closing them on Confluence shutdown.
Small wrapper on IPD metrics registry to manage metrics for incoming mail servers.
Measures latency between nodes in the cluster.
Small wrapper on IPD metrics registry to manage metrics for inter-node communication.
Extends
IpdInterNodesStats with a delay for removing latency/connection.state metrics from JMX for nodes that are no longer in the cluster.Makes measurements of file write duration to local file system with guaranteed persistence.
Event that is emitted for change of state in In-product diagnostics toggle from
ConfigureMonitoringAction.Flushes In Product Diagnostics metrics to JMX.
Makes measurements of file write duration to shared file system without guaranteed persistence.
A representation of a search to be performed.
Builder interface to create new search instance with the specified values
Fascilitates conversion from
SearchResult to SearchableDeprecated.
since 5.9.
Defines a condition for Web UI modules being shown if a mail server is defined.
A constraint that will test whether the build number configured on the constraint is newer
than the build number passed to
IsNewerThan.test(int).
A constraint that will test whether the build number configured on the constraint is newer
than the build number passed to
IsNewerThanAndConfiguredNumberHighEnough.test(int) AND the application configured
build number is higher than a configured value.Only display the link if the user is not working with a homepage of a space (Also need to be a Page)
Italian language analyzer provider
A soy server function that retrieves web-items for a given web-section.
Updates the IT server state with Spaces, Pages, etc for use with tests.
A subclass of the standard
ServletFilterModuleDescriptor which detects if the provided module is of type
Filter, and if so, wraps it with a JavaXFilterAdapter.A subclass of the standard
ServletModuleDescriptor which detects if the provided module is of type
HttpServlet, and if so, wraps it with a JavaXHttpServletAdapter.A analyzer for European languages which will tokenize, apply the standard filter and lower case.
An immutable set of JARs, specified by their URLs on the classpath.
A
GraphQLTypeBuilder that provides support for types in the java.time package.Defines the method to get the database url give the connection details.
Factory object for returning a builder for database url.
Utility class to normalize a JDBC URL
This job runs every minute and logs app-related JMX data to atlassian-confluence-app-monitoring.log file under the home directory.
This event gets published everytime the JMX configuration has been updated on one node and can e.g.
This interface provides methods to handle the configuration of JMX across the cluster.
This filter will profile incoming requests to measure :
Total of requests served
Number of requests currently being served
Average execution time of the last ten requests
Number of requests received in the last ten seconds
Wrapper to expose statistics for
IndexManager.This job runs every minute and logs JMX data to atlassian-confluence-jmx.log file under the home directory.
Event that is emitted for change of state in JMX monitoring toggle from
ConfigureMonitoringAction.Wraps the
SMTPMailServerImpl to provide metrics for
The number of emails sent in total
The number of emails succesfully delivered
The time the last successful email was sent
Connectivity without sending a test email
Also allows the from name of emails to be set.Delegated to
SystemInformationService to provide a subset
of the information provided on the ViewSystemInfo page.Exposes various utility methods to simplify the process of registering / ungregistering MBeans.
Implements simple actions for a job - enable/disable/run.
Defines an atlassian-scheduler
JobConfig within a plugin.Creates instances of the
JobConfigModuleDescriptor.General information about Backup/Restore job
Filter used to find backup/restore jobs
atlassian-scheduler doesn't support job listeners like Quartz, we create an equivalent.
Deprecated.
since 5.10, use
JobConfigModuleDescriptor instead.Backup/restore job operation.
Backup/restore job scope.
Backup/restore job source.
Backup/restore job state.
Statistics for backup/restore job
Interface that allows to retrieve information about job statistics (but does not allow to modify it!)
Handles requests from the Johnson page to send analytics events.
Handles the user clicking the link for a KB article that relates to a specific event.
Handles the user clicking the link for a general (non-event-related) KB article.
Responds with a JSON-ified version of the current Johnson
Events.REST endpoint to dismiss Johnson events.
On Johnsoned Confluence instance, we may still want some plugin filters to be executed (f.e.
Enumeration of error messages for the Johnson page.
Transforms a Collection of Johnson
Events into the JSON Array needed by the Johnson page.Creates Johnson events for site restore.
The Johnson event levels defined by this product.
Predicates relating to Johnson events.
Marshals Johnson
Events into JSON for display on the Johnson page.Creates
JohnsonEventSerializer instances.The supported Johnson event types, as configured in
johnson-config.xml.Provides data for the Johnson page.
Provides the endpoint URLs required by the Johnson page.
Provides the translations required by the Johnson page (
errors.jsp).Utility methods relating to the Johnson framework.
Utility methods relating to the Johnson framework.
Bandana context that acts as a namespace for key value pairs for the journal system.
Creates index backups and removes old index journal entries.
Provides access to
JournalEntry objects.Entry in a journal.
Entry in a journal.
Journal Entry Factory creates JournalEntry instances to avoid boilerplate code in IndexTask classes
Journal entry type enum.
Identifier that contains journal name.
Converts
JournalIdentifiers to and from strings in the DB.A queue of
ConfluenceIndexTasks.This manager is an entry point to the journal subsystem.
Methods for making it easier to run acceptance tests which use journalling.
Represents a message that can be used in a journal entry for incremental synchronisation.
Modifies the Journal.
This service is an entry point to the journal subsystem.
Resets journal state on remote nodes after site import.
Provides per node persistence for saving the id of the most recent
entry that has been retrieved from the journal.
An implementation of the
SystemMaintenanceTaskQueue that is backed by the Journal.Represents Javascript data with a serialize method to convert the data to a JSON string.
Deprecated.
since 2.10 - Use
DefaultJsonator with an AbstractCommandAction instead.Interface to implement if you want to provide a method to create
a JSON representation of an object
Container for arbitrary JSON data attached to some
Content.Provides property names that can be used to expand
JsonContentProperty objects.Identifies a
JsonContentProperty instance.A custom content type for storing JSON properties under arbitrary content.
Evaluates json expression following dot notation.
A mutable
Json implementation.Adapter for content properties.
Factory for ContentProperty objects
Checks permissions for a json property
Creates ContentQuery objects for finding
CustomContentEntityObject instances
that are managed through JsonContentPropertyType.Constants for the Content Property Storage Plugin
Deprecated.
since 8.6.0.
Container for arbitrary JSON data attached to some
Space.Provides property names that can be used to expand
JsonSpaceProperty objects.Holds a JSON formatted string.
Deserializes
JsonStrings.Serializes
JsonStrings.A builder for GraphQLStringType objects, generated for
JsonString types.Use JSON to marshal/unmarshal tasks
Converts JSON object to BackupRestoreJobResult
Converts JSON string to BackupRestoreSettings object
Do nothing.
Deprecated.
since 7.20
An abstraction around the system resources-lated methods in
Runtime, to allow easier testing.Deprecated, for removal: This API element is subject to removal in a future version.
since 9.3 for deletion before 10.0
A JMX MXBean implementation that makes available the application cache statistics.
This will do not do anything
Keep the record with biggest Id
Keep only one record.
Keep the record with smallest Id
A token filter that only keeps tokens with text contained in a predefined set of words.
BandanaContext which provides a string key.
Deprecated.
since 7.17.0.
Compares
KeyPairs for equality based on the equals method of the public and private keys.Initialises system key pairs
A space locator that uses a space key to find a space.
A simple keystore supporting the retrieval and storage of public keys and public/private key pairs.
Allows conversion to and from serialized form.
Provides OpenSearch analyzer for
KeywordAnalyzerDescriptorThe keyword tokenizer is a “noop” tokenizer that accepts whatever text it is given and outputs the exact same text
as a single term.
The analytics event sent when the user clicks the link for a knowledge base (KB) article
explaining why event details have been suppressed on the Johnson page.
Indicates problems with (parts of) the
ConfluenceLicense.Common Confluence license validation failures.
Deprecated.
since 7.0.1 , use
KnownUserA
ClusterJoinConfig for Kubernetes environments.Indicates that a test should be selected to run against Confluence running inside Kubernetes, for example because it
exercises functionality that is particularly senstive to the Kubernetes environment.
Deprecated, for removal: This API element is subject to removal in a future version.
since 7.5.
Deprecated.
since 7.0.1 , use
LabelInterface for objects that can have labels applied to them.
Represents the different kinds of content that can have labels.
Thrown when an existing label is associated with piece of content (as opposed to be newly created).
Represents Label breadcrumbs.
Thrown when a label is created and comes into existance.
Dao for Labels.
Thrown when a label itself is removed (as opposed to being disassociated from a piece of content).
Represents a Label object
List of labels visible to a user for an entity
<class-comment/>
Extract label data from content entity objects.
Simple converter factory converts a Entity Label to Model Label object
Finds existing labels (on xml restore).
This class is responsible for validating content label permission for a space
An ostensibly immutable object that represents the link between labels and the content they label.
Server side function to generate links to label pages.
Represents a user viewing any of the label listview actions.
The label manager provides all that is necessary for interacting with labels.
Responsible for listening to
LabelManagerEventListener.VisitorEvents and resolving them against the LabelManager.Internal version of the
LabelManager interface; see the package-info.java for rationale.LabelManagerMetricsEvent is used to collect analytics for some methods in DefaultLabelManager
Presents label parameters as
BooleanQueryFactory implementations.The Label parser understands the formatting of label strings.
A permission enforcer interface for labels.
Performs permission checking for label editing actions
Deprecated.
since 6.9.0.
Query for matching a single
Label.Thrown when a label is disassociated from a piece of content (as opposed to itself being removed).
REST wrapper for the LabelService.
<class-comment/>
Provides operations for Labels.
Provides methods for validating inputs to create, retrieve, update or delete labels.
Simple servlet to map requests to /label/<spaceKey>/<labelName/> or /label/<labelName> to /labels/viewlabel.action
The label name is mandatory, the space key is optional, restricting the view of the label to a specific space.
Provides content metadata pertaining to labels on a Content entity.
Allows querying by multiple labels.
Creates label commands
Responsible for suggesting labels.
A utility class that helps to:
1.
This task adds a unique constraint on columns NAME, OWNER and NAMESPACE in LABEL table.
Helps to build urls for labels.
Utility class designed to assist dealing with the client interface.
An analyzer, that can behave differently depending on a given language.
Interface for analyzer provider which is language specific
Created by IntelliJ IDEA.
Language is used to define an analyzer that is language dependent see
LanguageAnalyzerDescriptor.Extracts the language cookie, or if it is not present the browser language string
Extracts the last modifier of a
ConfluenceEntityObject as a stored field.Extracts the last modifier of a
ConfluenceEntityObject as a unanalyzed, indexed field for the change index.SearchQuery to find the content where the
SearchFieldMappings.LAST_MODIFIER field
has to match one of the users in the provided last modifiers listEvent listener used to perform waits in tests.
Only display if the user is viewing the latest version of a page or blog post.
Similar to
AllLatestVersionAttachmentIdentifier but allow to filter by attachment file name and mine type
A work source that provides batches of
ContentEntityObjects that have XHTML formatted bodies.Event for PageLayouts 2 layout being created, extends LayoutCreatedEvent with the number of rows and columns created.
A layout event is used to define when a page/blog post is created using
page layouts.
This class provides helper methods to retrieve layout templates and handles a few basic theme tasks.
A FragmentTransformer which delegates to another FragmentTransformer identified by bean id.
A wrapper for a
Macro that is lazily loaded.Required to allow us to break a circular dependency of the subRenderer back to the renderer.
A Spring
TargetSourceCreator which creates a lazy reference TargetSource around a proxied beans.This class provides support logic for legacy
AttachmentDataDao implementations that only support
AttachmentDataStreamType.RAW_BINARY, and that already have implementations of the deprecated
InputStream-based methods.Deprecated.
since 5.10.
Deprecated.
since 7.0.1 , use
ContentLabelServiceDetects for old cluster licenses, which had the conf.NumberOfClusterNodes attribute.
Deprecated.
since 7.0.1 , use
ContentBody.ContentBodyBuilderDeprecated.
since 7.0.1 , use
Content.ContentBuilderDeprecated.
since 5.10.
Deprecated.
since 7.0.1 , use
ContentServiceDeprecated.
since 7.0.1 , no replacement
Deprecated, for removal: This API element is subject to removal in a future version.
since 9.3.
Deprecated.
since 5.9.
This implementation is for old-style Johnson
Events, i.e.Deprecated.
since 7.0.1 , no replacement
Deprecated.
since 7.0.1 , no replacement
Deprecated.
since 7.0.1 , use
com.atlassian.confluence.rest.serialization.OptionSerializerDeprecated.
since 7.0.1 , use
KnownUser.BuilderDeprecated.
since 5.10.
Deprecated.
since 7.0.1 , use
PersonServiceDeprecated.
since 7.7 Use
PluginSettingsFactoryDeprecated.
since 7.0.1 , no replacement
Validates that if the license is data center one (server license is no longer supported from 8.6).
Deprecated.
since 7.0.1 , use
ContentLabelServiceDeprecated.
since 5.10.
Deprecated.
since 7.0.1 , use
Space.SpaceBuilderDeprecated.
since 7.0.1.
Deprecated.
since 5.10.
Deprecated.
since 7.0.1 , use
ContentServiceDetects for old v1 style licenses, which are not allowed anymore.
Initialises the ConversionContext such that the encapsulated v2 RendererContext is populated as would
be expected in the old v2 rendering subsystem.
The letter tokenizer breaks text into terms whenever it encounters a character which is not a letter.
A utility class for converting non-string values into string values with a
lexicographic order that preserves the orginal order of the values.
This condition checks if a feature related to read-only mode should be accessible in the instance.
Allow access to enterprise features for DC licenses.
Calculates the number of Users in a Confluence instance.
Analytics event fired when license check fails (license is expired or user limit exceeded)
while user tries to perform "licensed actions".
Models the license details response
Base exception used to indicate that either the de-cryption, de-serialisation or validation of the license failed.
Handler for the exceptions thrown by
LicenseService.Supplements
LicenseResource.A REST endpoint that exposes info about users of this instance.
Unifies the interaction with the v1 (still used for store) and v2 license code.
Encapsulates storing and validating a license.
Thrown when no more licenses available to perform an operation
as per the semantics of the HTTP 402 'Payment Required' status code.
Event listener that tracks license changes and force disables read-only mode and the banner if they're not supported by the new license.
Listens for confluence events indicating license change and republishes them as SAL events
A
HealthCheck that checks for a valid confluence license.Web frontend facade for the
LicenseService.The phases of the Confluence application lifecycle.
Descriptor for lifecycle plugin modules.
Deprecated, for removal: This API element is subject to removal in a future version.
since 8.8
Represents a data transfer object for like data.
Likes content, usually called from an email where a RESTful response just won't do.
Events where a like is created.
Represents a like entity.
Persists and retrieves likes.
A like event.
Controls all access to Like-ing and Unlike-ing content.
Represents a like notification.
A GraphQL provider for the 'likes' field of the Content entity.
Sorts a collection of likes - moving likes from followees higher.
A
PageRequest guaranteed to have a limit capped to a developer provided value rather than a user provided
value.A subclass of
BaseAttachmentContentExtractor which places a limit on how many bytes of the input stream
are read into memory.ContainerRequestFilter that limits the maximum size of the REST request it will receive.
Specifies that the annotated method (or all methods in the class, or all the methods in all the classes in the package)
should have a request size limit applied.
A graphql extension that limits the size of field argument strings when
com.atlassian.confluence.plugins.restapi.annotations.LimitRequestSize is applied to a provider class.Linear decay function applied to a field value.
Represents a link with a type.
Represents a link.
A type representing the different link bodies in Confluence
Dao for OutgoingLinks.
TODO: Find out if we still need this for legacy imports or something like that.
Responsible for listening to
LinkManagerEventListener.VisitorEvents and resolving them against the LinkManager.This interface is only required so that implementations can be exposed to plugin 2 plugins.
A MarshallingFactory that returns Link marshallers and unmarshallers.
This is a helper class to extract links.
Updates all links in the copied page to refer to the new page.
Allows links to content to be rendered without exposing our marshalling architecture.
Resolves wiki text to an xhtml link.
Checked exception thrown when there is an error updating the links on a piece of content (normally in response to a renaming
of moving of content to a different space).
Used to update the links on a piece of content.
The type of a link.
A lazy builder that allows clients to retrieve individual pages of potentially long (and performance-degrading)
lists of entities.
Calculates pagination indexes using a com.atlassian.confluence.core.ListBuilder.
NOTE: This class has to be constructor injected since it's the only way moduleFactory can be set at its parent.
This subclass is needed so that listglobaltemplates in the admin console is covered by websudo
Calculates value in list_index column.
Deprecated, for removal: This API element is subject to removal in a future version.
since 9.3.0 for removal in 10.0.0.
Returns a list of the people watching a page as two lists: one for space watchers, one for page watchers.
It's a replacement for LabelSearchResult.
Replacement for SearchResultCacheEntry
LiteSearchResultCacheEntry does not have links to Hibernate objects
It occupies less memory in RAM and do not require detaching objects before serialising
Service that processes attachment text extraction requests such that the requests on the same attachment will be
processed sequentially.
Converts a locale String like "en_GB" into a Java Locale object.
Captures local-home latency to IPD metric 'home.local.write.latency.synthetic' by measuring time to write small amount of data to a file.
Listens to the MaxCacheSizeChangedEvent events and adjust max cache size for local region caches.
Used to update max sizes of Caffeine caches via reflection.
Provides an adapter between Log4j 2.x and the legacy
AtlassianJsonLayout provided by
atlassian-logging.This class is responsible for instantiating burst filters on loggers by parsing the burstFilterConfig.properties
file and creating the filters through code.
An implementation of
LoggingConfigService backed by Log4j 2.xA log4j2 pattern layout that escapes any control chars in a log message, i.e.
A Log4j 2.x
Plugin which creates a Log4j1.x Appender that emulates ConfluenceHomeLogAppender
as used under log4j 1.x.A Log4j2.x
Plugin that constructs a Log4j1.x Layout that emulates ConfluencePatternLayout
as used under log4j1.x.A Log4j 2.x
Plugin which creates a Log4j1.x Appender that emulates FluentdAppender
as used under log4j 1.x.A Log4j2.x
Plugin that constructs a Log4j1.x Layout that emulates PatternLayoutWithContext
as used under log4j1.x.A Log4j2.x
Plugin that constructs a Log4j1.x Layout that emulates PatternLayoutWithStackTrace
as used under log4j1.x.Record the logging output for a given log4j2 logger.
Deprecated.
since 7.20 no replcement
An implementation of
LogConsumerService backed by the Log4j 2.x runtime.Provides a control mechanism for the various log4j appenders in the system.
This class is to enable/disable logging for a class and get the log messages (in tests)
A service which provides access to log events generated by the underlying logging runtime.
Represents a log event sent via
LogConsumerService.A simple implementation of the backup progress monitor that logs progress to SLF4J.
A Spring
WebApplicationInitializer which configured and bootstraps the Log4j 2.x and SLF4J logging
frameworks.Represents a Log4j Config entry, corresponding to a Class or Package mapped to a Level.
Provides an abstraction for reconfiguring the logging system.
Manages contextual information in the Log4J Mapped Diagnostic Context.
Servlet filter that adds some relevant contextual information to the Log4J Mapped Diagnostic Context
XWork interceptor that adds some relevant XWork context to the Log4J Mapped Diagnostic Context
Logs the output to the given logger.
Output stream that redirects all writes to provided logger.
Adds logging and profiling to lock and unlock methods.
A simple implementation of the backup progress monitor that logs progress to SLF4J.
Simple listener which logs whenever a retryable method fails, or succeeds following a retry.
Supports logging zipkin spans with the Zipkin JSON V2 format, for easy consumption through log analysers.
Logs uncaught exceptions.
POJO class to help include additional details with login events
Common logic to check request/session attributes relevant to user login
Event representing the act of a user successfully logging into Confluence
Helper to handle login exemption from a properties file for 404 status resulting URLs.
Published to indicate failed login - useful to listeners wanting to count n instances
of attempt and act on it.
Information about a user's login history
The LoginManager keeps track of users login activities.
Web service is used by SSO plugin to get the data in order to render the login screen (par of the 2SV flow).
Result of an authentication attempt.
Registers a consumer of
LogEvents via LogConsumerService and records all error events in a collection.Will report progress to log
Specifies if the request URI should be logged
ContainerRequestFilter that logs the request URI
Deprecated.
since 8.6.
Field mapping for long values.
Represents field its value is of type
long.v2 primitive query
A mapper for
LongRangeQuerys.LongRunningTaskAnalyticsEvent is fired when long running task runs longer than configured threshold
Fired from
LongRunningTaskMonitorOpaque identifier for a long-running task.
Coordinates the creation and maintenance of batch jobs that last longer than a single web
request
Internal version of the
LongRunningTaskManager interface; see the package-info.java for rationale.Long running task monitor that uses
MonitoringService.A Decorator for existing MovePageCommands to be run synchronously as a LongRunningTask.
Deprecated.
since 4.0.
Converts internal LongRunningTask model objects into API ones.
Identifies a
LongTaskStatus.REST wrapper for the LongTaskService.
Manages
LongTaskStatuss.Default implementation of
LongTaskService, a shallow wrapper for LongRunningTaskManager.Represents a long-running task in the system.
A pointer to a long-running task, the result of submitting a task for processing.
Marker interface for Look-and-Feel administrative actions.
Abstract class for events related to themes, colour-schemes and layouts.
LowDiskSpaceAnalyticsEvent is fired when free disk space is less then specified threshold
Sort based on lower case value of a keyword field.
A token filter of type lowercase that normalizes token text to lower case.
Provides lowercase token filter for a specific language
LowFileDescriptorCountAnalyticsEvent is fired when free file descriptor count is less then specified threshold
LowMemoryAnalyticsEvent is fired when free memory is less then specified threshold
This interface will allow to allow transition from atlassian-bonnie.
Used in confluence-cql-plugin's AbstractCQLSubsystemTest.java
Maps
MappingAnalyzerDescriptor to Lucene Analyzer.This class will help to parse raw query to Lucene by transforming an invalid raw query into a valid one
Extract default fields for a CHANGE index document that represents the change of a content
The implementation of
ILuceneConnection that allows concurrent searching/reading and
writing/deleting.Thrown when trying to use a closed
ILuceneConnection.Responsible for creating new
LuceneConnection instances.Extracts default fields for a CONTENT index document that represents the content
Thrown when a disaster happens in the underlying Lucene layer.
Implementation of
FieldMappings.FieldMappingWriter for Lucene, which is no-opEntry point to the majority of the Lucene indexing subsystem.
Many classes located on
*.lucene or having lucene in their name have been refactored to be
independent of Lucene.Helper methods to deal with Lucene index in Confluence
Provides timer for capture metrics for low level Lucene library call.
A Lucene snapshot created for a particular index, at a particular time.
Make sure number of snapshots created for each index does not exceed certain limits.
Exception when creating or restoring a new Lucene snapshot
Manage Lucene index snapshots.
Deprecated.
since 7.0.1.
Exception thrown when a mapper (
LuceneSortMapper, LuceneQueryMapper
cannot be found.Deprecated.
since 7.0.1.
When returned from FieldComparatorSource.newComparator, a LuceneMultiTermFieldComparator compares hits so as to
determine their sort order when collecting results, using a custom sort comparator that operates on
terms that may have multiple values per document.
Deprecated.
since 7.20 use
BooleanQuery.Builder instead or TermQuery.A lucene query mapper represents an object that is able to map from a Confluence
SearchQuery to a Lucene Query.The purpose of this class is to wrap the tokens emitted from lucene analysis inside our own
QueryTokens so
that we can tag some additional meaning.Utility class to help with creating queries.
Basic implementation of LanguageChecker which always returns true as Lucene supports all
SearchLanguage optionsClass that is responsible for converting a v2 search abstraction like
SearchQuery or SearchSort into the equivalent technology specific object.The Lucene implementation of
SearchQueryTokenizer.Deprecated.
Deprecated.
since 5.9.
Deprecated.
since 7.0 use
SearchSort.expand() instead.Spring config that provides Lucene implementation of our search and indexing API
When returned from FieldComparatorSource.newComparator, a LuceneTermFieldComparator compares hits so as to
determine their sort order when collecting results, using a custom sort comparator.
Utilities for Lucene-related functionality in applications.
Specifies the time granularity.
Represents a Confluence macro.
Used to determine which macros are safe to render in an async context, e.g.
A type to represent macro bodies.
Represents body metadata for a macro.
Specifies the conditions by which the body of a macro should be transformed.
Represents a macro body type used in macro transformation.
Aggregate macro usages
Used to count macro usages through the rendering process.
Event related to macro counting.
Persists the number of each type of macro present on the page, and calculates the number of newly added macros
by comparing current macro counts with those from the previous version of the page.
Publishes a
MacroCountEvent for each type of newly added macro.An object that encapsulates the state for a macro.
A builder that will create the a complex
MacroDefinition.Responsible for deserializing to a MacroDefinition.
Will parse body content for macro definition then cache it in
ExtractorContext
This will contain the logic similar to MacroExtractorHandler for
MacroDefinitions found in storage format.Provides strategies for marshalling MacroDefinitions.
Replacer of
MacroDefinitions in storage format with other content.Responsible for deserializing the encoded representation of a MacroDefinition
produced by
MacroDefinitionRequestSerializer.Serializes a MacroDefinition first into wiki markup and then base64 encodes the wiki markup.
Responsible for serializing a MacroDefinition.
Provides oprations fo transforming macro definitions, typically used by macro developers to obtain
and optionally modify macro tags (as
MacroDefinition objects) in a
page of macro body content.An implementation of
MacroDefinitionTransformer based upon a ContentTransformerFactory.Updater of
MacroDefinitions in storage format.Deserializes a wiki markup format macro declaration to a MacroDefinition.
Serializes a
MacroDefinition to string in wiki markup.Creates a Map containing the details of an specific Macro.
Container for the execution context of a macro (i.e., the state passed
to it on
Macro.execute(java.util.Map, String, com.atlassian.renderer.RenderContext)).Thrown when there is an error executing a macro.
Extractor that indexes macro usages on a content entity object
* @since 7.17
Provides access to the descriptor information retrieved from an xml file for macro
meta data.
A Bean that encapsulates the detailed metadata of a macro.
Adds icons and friendly titles to diff headers in macros.
Allows retrieval of appropriate icons from
MacroMetadata.Servlet to produce just the icon of a macro, rather than the icon and full attribute information.
A macro Id is used to identify a macro within a version of a page.
A generator of macro UUIDs.
Represents an instance of a Macro in a piece of Content.
Creates
History instances.Interface for the XHTML macro manager.
Retrieval, registration and unregistration of macros.
An interface defining a component that can return MacroManagers.
Implemented by a MacroMarshaller that handles a particular type of Macro.
This interface is only required so that implementations can be exposed to plugin 2 plugins.
A MarshallingFactory that will return MacroDefinition Marshaller and Unmarshaller instances.
A Bean that encapsulates the 'metadata' of the macro.
Builder class for
MacroMetadata.This event is fired when macro metadata is changed
Manage clien cache key
Provide macro metadata client cache key.
Bind to all events that related to macro to refresh key
Provides metadata about macros such as what parameters they expect and how to represent them visually.
Parses XML formatted macro metadata.
Implementations of this class will be used by the
MacroBrowserManager to provide additional
MacroMetadata.A key used for the accumulation of metrics of macro creation and rendering.
Represents a task that will transform a MacroDefinition for migration.
Defines points at which a
MacroMigration may be performed.Provides a way to find and migrate pages with the unmigrated wiki markup macro.
Marker interface for module descriptors that produce macros.
Represents parameter metadata for a macro.
Builder class for
MacroParameter.Represents the value of a macro parameter.
Serializes and deserializes macro parameters.
The type of a macro parameter that will appear in the Macro Browser.
Parses raw macro parameters to typed macro parameters
Default implementation of MacroParameterTypeParser
Utility methods for macro parameters
Macro rendering monitor that uses
MonitoringService.Generates a rendering that is to replace or override the default rendering of a macro to XHTML storage format.
Representing a component that maintains a list of
MacroReplacementRenderer to be used during migration of macros.Performs macro schema migrations as part of the rendering pipeline.
Defines a migration for a macro schema, where a macro schema is the shape of a macro's parameters in a
MacroDefinition, and a MacroMigration transforms that MacroDefinition.A search query that finds usages of a macro in a content entity object by the
macro name.
Class responsible for storing information about macro views (for thread limiter analytics service).
An interface defining a component that will process email content.
This event is triggered when admins click "Delete error queue" button in admin panel
This event is triggered when admins click "Resend error queue" button in admin panel
Deprecated, for removal: This API element is subject to removal in a future version.
since 9.4
This event is triggered when admins click "Flush Mail Queue" button in admin panel
Manages the queue for outgoing mail.
Handles the creation and deletion of MailServers to expose / hide their metrics via JMX.
This action is to test if the connection to a mail server is successful.
Stores the test result of mail server connection
A Spring
ContextLoaderListener responsible for creating and installing the "main" Confluence Spring context.Analytics event fired when the banner feature is turned on or off while read-only mode is not being used,
e.g.
Analytics event fired when read-only mode is enabled or disabled
This class is responsible for the maintenance logic in Confluence
An exception thrown when
SystemMaintenanceTask#execute() encounters an unrecoverable error.A Marshaller for ResourceIdentifiers which will first attempt to make the ResourceIdentifier as relative as
possible before delegating for actual marshalling.
A
ManagedCache implementation backed by a Hibernate Region.Managed job definition for cron based jobs.
Encapsulates the static configuration of a managed scheduled job.
Exceptions for errors or invalid use of the ScheduledJobManager.
Constructs ScheduledJobConfigurations, ScheduledJobStatus and JobConfig objects, and saves/schedules them
based on preconfigured (i.e.
Responsible for constructing managed scheduled jobs and scheduling them with the scheduler.
Defines the service for registering and unregistering ManagedScheduledJob, e.g.
The registry of jobs in the system under management.
Manages the initialisation and shutdown of the managed jobs.
Managed job definition for interval based jobs.
Determines if a Like link should be present in a change notification email.
Deprecated.
since 6.10.0.
Deserialize either a map json object, or a key-value pair json array as a map.
Encapsulates information about a Struts action which a given request maps to.
Lucene agnostic class for representing concrete, individual representations of Lucene
AnalyzerA char filter that maps one string to another.
This action allows users with administrator permissions to write comments directly into the log and also
rollover logs (more info on what that means can be found here)
Resource that will accept wiki content and return its XHTML equivalent.
Responsible for marshalling an XML fragment.
An immutable class representing collected metrics.
To be implemented by any classes who wish to be used as metrics accumulation keys.
Provides operations to allow the accumulation of marshaller execution metrics.
A utility class which maintains a "stack" of MarshallerMetricsAccumulators.
Encapsulates information gathered via the marshaller metrics framework as an analytics event.
A
RenderingEventPublisher which should be invoked whenever a rendering process is completed.A interface against which execution metrics can be recorded.
An interface to allow clients to stop the timing
A utility class for obtaining
MarshallerMetricsCollector instances for the current context.Consumes
MarshallerMetrics as they are published.An interface describing a factory capable of returning a
Marshaller or Unmarshaller
suitable for particular usages.Lazily resolves the marshaller and unmarshaller to use for transforming objects of the specified type.
Gets Marshallers and Unmarshallers, so you don't have to wire them yaself.
The type of a Marshaller or Unmarshaller.
Deprecated.
since 7.20.
Sometimes you want a "match nothing" query, for example to take the place in a search of something that could
not be resolved, and therefore can never be found (i.e.
Encapsulates data from the Bill Of Materials
Represent a possible sub-product.
Send MAU events in each servlet request
MAU events are sent as analytics events per product per user after a fixed interval,
if there are any activities in the product from the user during that interval.
Event that indicates that max cache size for a particular cache needs to be changed.
Applies automatic flush to a delegate
BulkOperationBuffer whenever the number of enqueued documents have reached the specified limit.Applies automatic flush to a delegate
BulkOperationBuffer so that it does not exceed the specified RAM limit (MB).Parameter that resolves an
Integer as the maximum number
of results to return to a query.Maximum score of component functions is used.
Deprecated.
since 7.0.1.
This interface has been created to allow us to perform additional necessary operations that are not provided
via Spring's JMX support classes.
Extends Spring's MBeanExporter to provide server state checks around any JMX registration changes.
Measures the execution times of individual upgrade tasks.
Provide utility feature for MediaType handling
This class can be used to create functions that calculate results only once.
Lazily loads the component from the
ContainerManager and memoize the result.A predicate which can decide whether a given image stream is "safe" to render as a raster, given the
currently available amount of free memory.
Deprecated.
since 9.3 do not use
Simple bean encapsulating information about the system's memory usage.
Represents some number of bytes.
Deprecated.
Since 5.3.
A
ModuleDescriptor type allowing plugins to declare Merger modules.A REST resource to allow testing of
Merger modules provided by the plugin system.2 steps:
1.
Hold information about a table having a foreign key referencing current table
This implementation only support simple foreign keys i.e.
A validation result that also encapsulates the result of a merge operation.
An
AtlassianDocumentBuilder implementation that merges multiple AtlassianDocuments
built by other AtlassianDocumentBuilders.Contains an key and array of arguments for conversion to an internationalised string.
A user interface message consisting of a message key with optional arguments.
A message to display on a page
An i18n- and character-escaping-agnostic collection of action and field error
Messages.Actions implementing this interface can have
MessageHolders loaded into the
action's ValidationAware implementation.Produces
MessageHolder instances.Sets a new
MessageHolder instance into all MessageHolderAware actions.The level that a
Message will be displayed at.Loads
MessageHolder messages into a ConfluenceActionSupport instance
after Action execution but before Result execution.Manages messages to display in pages
Filter that adds global messages to the templates that use #displayGlobalMessages() macro.
Describes a meta-data property that's returned from
ModelMetadataProvider.JSON Serializer that converts metadata field
JSON Serializer that converts metadata field
Responsible for creating
MeteredBandanaPersister instances.Customizes how spans are named to include the http method and path.
A
Marshaller which delegates to another marshaller, whilst collecting metrics about the execution and
streaming of that delegate.Responsible for registering a bunch of standard meters with Micrometer, gathering and publishing metrics on
the JVM, Tomcat, Hibernate and others.
Migrates Bandana values stored in the ScheduledJobConfiguration context
Specifically, it changes the key from the legacy "QUARTZGRP#JOBID" format to "JOBID"
As Quartz jobs are unsupported in 8.0, the job group property no longer exists.
Set trash date for pre-7.14 items in the trash
To be implemented by those
FragmentTransformers,
Unmarshallers and Marshallers
which are aware of when they've made a transformation that constitutes a "migration" from one format to another.Wraps the
MigrationAware interface in a Predicate.The base exception extended by any exceptions thrown during migration.
Overrides the default behaviour to prevent the last modified user being
changed when migrating.
Listens for plugin enabled events and requests the macro migration service to
update the migration required flag when one is encountered.
DataSource decorator that custom-URL-encodes the name for use with a MimeBodyPart.
Records the usage of images which are meant to be embedded in a MIME email.
A reference to a designated MIME body part and an RFC 2392 compliant
way to locate it within the HTML body part the same email.
Minimum score of component functions is used.
Mobile utility class.
Trivial implementation to test our usage of
AuditServiceA dummy
ContentPropertyService for integration tests.A No-op implementation to temporarily allow integration tests to run
Empty Space Property Provider to allow integration tests to run
An factory for producing API model objects.
Assists in building fields that may be either a list of items or an explicit CollapsedList.
A Map builder for
CollapsedMap and EnrichableMap instances.Provides additional metadata such as Likes and Watches to API Model objects.
Describes a plugin module for adding metadata to API Model objects
Define an object that when given some model instance (only
Link supported at the moment) will provide
the HTML/XML class attribute value to be used when rendering the linkClients should implement this interface and modify the passed in reference to
ContentEntityObject as they see fit.Provides the Exponential decay scoring script for the last modified field
Provides the Gauss decay scoring script for the last modified field
Order search results by time last modified
Represents the fully qualified key of a plugin module.
ModuleDescriptorCache<T extends com.atlassian.plugin.ModuleDescriptor<?>>
Deprecated.
since 7.0.1.
Implementations of this interface are used to initialize a
ModuleDescriptorCacheThreadPoolExecutor.CallerRunsPolicy implementation which logs messages
if there are no more threads or queue slots available to process all eventsThis class holds all analytic events which are used for monitoring config.
Listens to monitoring event from and create audit log records from them.
Analytic event fired daily with current state of monitoring features.
Daily scheduled job publishing analytic event
MonitoringStatsAnalyticEvent.Checks whether there is at least two active users registered in Confluence.
Represents a cache records stored in DB
Move a blog post to a new space.
A command that moves a blog post to a top level of a given space.
Base class for commands which are responsible for page moving
Move a page and its children to a new location in the system.
An interface for a command that implements the logic to move a page to another parent or space.
An action for suppling panels in the MovePageDialog as they are required.
A command that moves a page to a top level of a given space.
Determines whether the MS SQL Collation is correct.
This healthcheck looks at the JDBC URL, and will fail if the URL is a URL which uses the jtds driver.
A class for performing diagnostics on the multicast routing table of the current host
Log4J reporting strategy
Reporting strategy interface for reporting problems encountered during the test
This class imitates lucene connection, but works for arbitrary subset of indexes
Based command for all command which could handle multiple events
Helper class used for building multiparts to be attached to support request emails.
Scores of component functions are multiplied.
This class is a wrapper on top of
ConfluenceLicense with some additionsThis special connections acts as a readonly version of
ILuceneConnection and searches the union of several
indexes on the flyThis composite SearchSort that allows sort by multiple fields.
Relocated from confluence-cql-plugin.
Journal identifier which based on both journal name and subscription id
Lucene filter that finds documents that match any of the supplied
Term.Represents a query against multiple fields.
Represents a macro parameter that can accept a multiple delimited values.
Monitors for the state of the server.
A base class for Mutable
ConfluenceHttpSessionsInterface to define method for RegistryConfiguration modification
<class-comment/>
Verifies that the MySQL database has been correctly configured
Determines whether the MySQL Collation is correct.
Contains methods for creating/removing triggers for content table
Contains methods for creating/removing triggers for content_perm table
Contains methods for creating/removing triggers for content_perm_set table
Contains operations required for MySql database objects creation
The hibernate Dialect that's used for MySQL.
If Confluence is using MySQL, this HealthCheck checks whether the JDBC URL contains the deprecated parameter 'storage_engine'.
Contains methods for creating/removing triggers for spaces table
Contains methods for creating/removing triggers for spacepermissions table
A Hibernate Interceptor to validate MySQL Content Support as per its collation setting.
Simple implementation of
RelationDescriptor, which allows to create simple named relation descriptors.Defines a resource identifier for which a name can be determined.
Represents an XML namespace.
Created by IntelliJ IDEA.
A comparator makes string comparisons based on their natural order.
A page response that can be navigated.
A page response that can be navigated.
NavBuilder facilitates building URLs from our model objects.
ExperimentalContentNav will change as new resources are added and promoted to production.
ExperimentalNav will change as new resources are added and promoted to production.
Provides methods to create
Navigation.Builder instances.An injectable service that provides a nav builder which can be used to generate URLs from confluence api model
objects.
Dummy implementation, as Confluence doesn't allow maintenance of Custom Content Links at present
Dummy implementation, as Confluence doesn't allow maintenance of Custom Content Links at present
Servlet filter level, strong security protections for request parameters, WebSudo requirements, and user privileges.
This interceptor removes duplicate tags.
Field mapping for a field with one nested string field: e.g.
Generates a feed of the people who are being followed by a specified user.
Deprecated.
since 7.0.0, it will be removed in future
Provides methods for reading Confluence network graph.
Server implementation of the
NetworkService.Implements the "Network" tab, which displays updates from users that the current user follows
Used only when Content permissions cannot be determined (such as ancestor table corruption).
Defines operations for deduplicating comments.
Analyzer which uses an NGram tokenizer
A tokenizer that produces a stream of n-gram.
A heading block renderer which places the anchor name in the ID of the heading, rather than generating a separate
empty anchor element.
A NoOpMacro that has no body.
An
AnnotatedPermitChecker which always permits accessA special class for keeping important info for the duplicate tag remover.
Represents the type of the tag.
JMX monitoring config on each node
The status of a node.
A highlight formatter that doesn't highlight.
Converts the old style nolink or nl macro into an XHTML
<span> elementsAn implementation of
ClusterConfigurationHelper for use when clustering is not being used.ZduManager implementation used when Confluence is not clustered.
Generic wrapper service for use in non-clustered confluence.
An implementation of
ClusterManager for use when no clustering is configured.An implementation of
ClusterMonitoring for use when no clustering is
configured.An implementation of
SharedDataManager for use when no clustering
is configured.Helps constructing the left, erroneous case of a
MaybeWrapper around
HibernateSessionManager5Non-transactional version of the AbstractHibernateAttachmentDao, which removes all attachment data
from the data store after removing the attachments from the database.
Deprecated, for removal: This API element is subject to removal in a future version.
since 9.4
A V2
SearchQuery implementation which only finds viewable custom content types or non-custom content.A compactor that does nothing.
Encoder that does nothing on input string.
Encoder that does nothing on input string.
Used in bootstrap code when we don't want to publish any events.
A Fetcher that always returns nothing
A fallback for when we are unable to send analytics, either because the required components
aren't available or because we can't tell whether the product is allowed to send analytics events.
A noop implementation for when index recovery process is not required for nodes to join the cluster, e.g.
Represents a no operation index task.
Crowd libraries currently need an implementation of this, but it's only applicable for Crowd the product.
A class used exclusively for testing.
Deprecated.
since 7.17.0
Sort mapper that returns nothing, defaulting to the index's native sort (which in Lucene's case is by descending order of relevance)
This upgrade task does not perform anything, since OpenSearch was introduced after split-index, thus no upgrade process required.
A stub used when the proper was not retrieved.
Deprecated, for removal: This API element is subject to removal in a future version.
since 9.3
Provides an implementation of the
ActivityMonitor that does nothing.Stub implementation of the Crowd
AvatarProvider interface.A
PermissionDelegate which always refuses permission.Norwegian language analyzer provider
This exception is thrown when a requested cluster node is not present in the cluster.
SearchQuery that filters out anonymous users.
Thrown when user is not authenticated
as per the semantics of the HTTP 401 'Unauthorised' status code.
Exception thrown from a service action when the
execute() method is called in the context of a user
who is not authorized to perform the action.Classes which implement this are not exported as part of exports.
Thrown when things that are expected to be found are NOT found.
Deprecated.
since 7.0.1 , use
NotFoundExceptionThrown when a remote method can't find an object specified by the caller.
A "Notification" is an email subscription or "watch" on some space.
A single enum value representing the combination of notification type, page, space and network settings.
Deprecated.
since 7.6.0 , no replacement
Contains data about an email Notification that is specific to a single Email sent to a single User.
Data Access Object interface for dealing with notifications.
Responsible for persisting notifications.
Dao for Notifications.
Data that is related to a set of notifications about a change in the system.
Responsible for monitoring exported events of ContentEntityObject and Space classes, exporting notifications and sending data to the backup writer.
Deprecated.
since 7.5.0
Finder for content ids.
Represents an event that is to be consumed by the notifications-api :
Responsible for listening to
NotificationManagerEventListener.VisitorEvents and resolving them against the LabelManager.Listens to any permissions changes and removes notifications as necessary
Provides web items and resources for Email Notifications.
Includes the successful and failed email addresses for a notification send.
Deprecated.
since 7.6.0, no replacement
Indicates that a particular service is not yet implemented, maps to a 501 error
It is thrown when a user does not have permissions to perform an action.
Deprecated.
since 7.0.1 , use
PermissionExceptionException thrown when a user attempts to do something they're not allowed to do.
A not permitted link.
Do not show web fragment if we are in a personal space
Represents the null/not null choice for a database column.
A null implementation for comment extension support, no additional extension sproperties
are provided or supported
As we update the logic of `removeStaleSharedDrafts`, we should call it in our upgrading task to make sure
invalid data is cleaned up.
No-op plugin accessor that can be substituted when the plugin system is unavailable.
Represents a null (no) restriction entity.
Number-related utility methods.
A Field handler for a numeric content property field alias.
Deprecated.
since 8.6.
Defines the contract for a mail server that supports OAuth2 authentication.
Contract for managing OAuth 2.0 token generation
An alternative to SAL's
OAuthRequestVerifierFactory, but which isn't coupled
to the javax.servlet API.Deprecated, for removal: This API element is subject to removal in a future version.
since 8.2 unused, no replacement
Provider for creating Jackson
ObjectMapper instances.Composite persister.
Deprecated.
since 7.17.0.
Deprecated.
since 7.17.0.
Objects for persisting would coming one by one and we do not want to persist them one by one.
An implementation of
AttachmentDataFileSystem which stores the attachment data in an object storage
service (for example AWS S3), using the FileStore.Path API.Defines a series of callbacks which can be used to observe internal events occurring within the cache, for purposes
of monitoring or alerting.
This deserializer also handles the UNIX timestamps that are sent as datestrings.
Manages the plugin designated allowlist configuration for Struts OGNL expressions.
Handler for events related to objects processing (persisting, skipping etc)
Sends events related to the restore process (like start/finish etc).
Responsible for indexing of inserted entites on XML restore.
Creates a search indexer that is responsible for reindexing pages after XML restore.
Responsible for rebuilding search index after site restore.
Responsible for indexing added content after or during space restore.
Maps v2 query
AllQuery to OpenSearchProvides an OpenSearch
Analyzer for a specific Confluence MappingAnalyzerDescriptor.Maps v2 query
BooleanQuery to OpenSearchAn index writer that uses OpenSearch bulk API.
Factory to create
OpenSearchClient based on application config.Checks the cluster health of the OpenSearch instance
Application config for configuring OpenSearch
OpenSearch health check for Confluence space limit
OpenSearch health status for Confluence space limit.
Maps v2 query
ConstantScoreQuery to OpenSearchProvides a custom character filter onto OpenSearch indexes which can be used by custom analyzers.
Provides a custom token filter onto OpenSearch indexes which can be used by custom analyzers.
Maps v2 query
DoubleRangeQuery to OpenSearchCommon interceptor for OpenSearch bean to handle detail message of
OpenSearchExceptionContains utility methods to deal with OpenSearchException
Mapper to convert
FavouriteSort to OpenSearch sort optionsMaps
FieldExistsQuery to OpenSearch queryMapper to convert
FieldSort to OpenSearch sort optionsMaps v2 query
FunctionScoreQuery to OpenSearchHealthCheckUtil which is exposed so other plugins (e.g.
OpenSearch health statuses.
This event is raised when an OpenSearch index gets recreated.
Provides operations to manage an OpenSearch index and its settings.
Manages staging index, i.e.
Factory to create
OpenSearchIndexManager instancesTunes OpenSearch index performance for a specific context, following recommendations from https://opensearch.org/docs/latest/search-plugins/knn/performance-tuning
Provides the ability to restore index settings to the original state
Creates new instances of
SearchIndexWriter for OpenSearchMaps v2 query to OpenSearch
Exception thrown when a search request to OpenSearch engine fails
Used to check the journal state after the plugin has started.
ExportedJournalStateStore which stores journal ids in OpenSearchException thrown when the index language is not supported or the required plugin is not installed on OpenSearch.
Maps v2 query
LongRangeQuery to OpenSearchMapper to convert
LowercaseFieldSort to OpenSearch sort optionsMaps
MatchNoDocsQuery to an OpenSearch queryMapper to convert
MultiSearchSort to OpenSearch sort optionsMaps v2 query
PhraseQuery to OpenSearch query.Condition to enable health checks only when using OpenSearch.
Maps v2 query
PrefixQuery to OpenSearch query.A mapper that maps a Confluence
SearchQuery to an OpenSearch Query.Exception thrown when a mapper
OpenSearchQueryMapper cannot be found.Maps v2 query
QueryStringQuery to OpenSearchMaps v2 range queries to OpenSearch RangeQuery.
Provides uniform facade for v2 range queries.
Mapper to convert
RelevanceSort to OpenSearch sort optionsAdding resiliency to OpenSearch operations using Resilience4j.
This factory provides convenient methods that creates a
ScoreFunction that is compatible with OpenSearch.Accessor to read and write from index documents on OpenSearch
A factory to create a new
OpenSearchSearchIndexAccessor for an indexName (core or custom).Checks if necessary plugins are installed for the specified language.
An interface for OpenSearch's SearchManager
An individual search result from OpenSearch hit
Maps v2 query
SiteSearchPermissionsQuery to OpenSearchMaps v2 query
SiteTextSearchQuery to OpenSearchA mapper that maps a Confluence
SearchSort to a list of OpenSearch SortOptions.Exception thrown when a mapper
OpenSearchSortMapper cannot be found.Maps v2 query
SpacePermissionQuery to OpenSearch
Note: SpacePermissionQuery is deprecated so this mapper can be removed when it is removedMaps v2 query
SpanNearQuery to OpenSearchSpring configuration that conditionally loads opensearch-context.xml if search.platform is set to opensearch
Provides operations to manage a staging index on the OpenSearch search platform.
Checks all requirements for OpenSearch to start.
Provides a stored script for OpenSearch
Spring config that import OpenSearch components from the confluence-opensearch plugin.
Maps v2 query
TermQuery to OpenSearchMaps v2 query
TermRangeQuery to OpenSearchMaps
TermSetQuery to OpenSearch queryMaps v2
TextFieldQuery to OpenSearchProvides a
TokenizerException thrown when the user does not have permission to perform an operation.
Maps v2 query
WildcardTextFieldQuery to OpenSearchSimplified variant of
OpenSessionInViewFilterA
HealthCheck that checks whether there are enough free memory to run Confluence safely.Deprecated.
since 7.17.0.
A permission and validation check, for use with
OperationService.Matchers to support tests on
OperationChecks.The result of an operation check on a specific
Target.Context for managers to call upon when making decisions on how to handle a given object operation (create,delete,save)
A delegate defining operation checks for a single
TargetType.Describes an
{operation, targetType} combination that the operations APIs can answer queries for.Matchers to support tests on
OperationDescriptions.An OperationKey is used to identify operations that can be performed on Targets.
Generates
ImportedObjectV2 records for cwd_directory_operation and cwd_app_dir_operation tables, so they could be saved to the DB.Deprecated.
since 7.17.0.
Thrown when an operation times out on the server.
Used to specify how an operation was triggered.
Serialize java Optional classes.
Utility methods relating to Optionals.
Deprecated.
since 7.0.1.
Deprecated.
since 7.0.1.
Contains methods for creating/removing triggers for content table
Contains methods for creating/removing triggers for content_perm table
Contains methods for creating/removing triggers for content_perm_set table
Contains operations required for Oracle database objects creation
The hibernate Dialect that's used for Oracle.
Deprecated.
since 8.0.0
Contains methods for creating/removing triggers for spaces table
Contains methods for creating/removing triggers for spacepermissions table
OrderedEntityObjectBatchableWorkSource<T extends com.atlassian.core.bean.EntityObject>
A
BatchableWorkSource implementation which retrieves batches of EntityObjects by
ordering the entities by their IDs.OrderedEntityObjectBatchableWorkSource.EntitySource<T extends com.atlassian.core.bean.EntityObject>
A simple representation of an original version with minimum data for fast retention version removal,
A REST resource which exposes information about the OSGi bundles currently installed.
A REST resource which exposes information about the OSGi bundles currently installed.
Thrown if a proxied OSGI service is invoked and there's no underlying service available in OSGi host.
Deprecated, for removal: This API element is subject to removal in a future version.
since 9.3.
A factory to produce proxy for OSGi services.
This registry eliminates the boilerplate required for a component in Confluence Core to consume a service that is
not available in the application context, but exclusively published through OSGi.
This implementation will hand out services in the form of
Proxy's that lazily use the
underlying ServiceTracker when invoked.Mock implementation for tests
This util helps plugins to do shady things directly with OSGi.
Analyzer provider for other languages which don't have a dedicated analyzer
Represents a link from a source page to a destination.
Simple DTO object to store link metadata
Extracts
OutgoingLinks from ContentEntityObjects.IpdJob that checks the connection to the outgoing mail server.
A predicate that passes XhtmlMacroModuleDescriptors for specific device-types
Used by Velocity contexts that are aware of the MIME type that will be generated when merging with templates.
Velocity context that allows tracking of its output destination as a MIME type.
An HrefEvaluator which inspects the
ConversionContextOutputType in the ConversionContext and evaluates href
values appropriately for the output type targeted.A thread local to determine what the intended output type of the executing thread will be.
Allows comparison of
ContentPropertyIndexSchemaModuleDescriptor based on their owning plugin names and module
names.Allow plugin to get bundle plugin from others folder inside WEB-INF
A Spring
Configuration that declares a PackageScannerConfiguration.Represents a Page within Confluence.
Manages the storage of page ancestors, primarily to clean up the relationships after a bulk change.
Indicates that an action may have a page set on it by the PageAwareInterceptor.
Encapsulates all the complicated "how are the many ways I can look up a page so the action knows about it?" stuff.
An XWork interceptor which injects a Page into the current Action if that action implements
PageAware.Breadcrumb for a Page.
Breadcrumb for a Page for the 5.0+ default theme (Space IA).
Wrap the page object to expose a subset of the page entity object via JSON.
An event where a page's children are re-ordered.
Could use to transform content during copy
Provides
Pages for the API.Context object that gets passed to the renderer to tell it what circumstances
the page is being rendered in.
Option to guide how we should copy pages
Deprecated.
since 5.5.
Deprecated, for removal: This API element is subject to removal in a future version.
since 8.7 use
PageDaoInternalDao for Pages.
Used to specify how a page delete was triggered.
An action that will perform a search in Confluence returning results suitable as targets for moving a page to a new
parent.
Deprecated.
since 5.5.
Deprecated.
since 7.2.0
Event listener for async events.
Deprecated.
since 5.3 this class is intermittent bridge for safe migration from sync to async event processing
and not intended to long term usage.
Fetcher for pages
since 9.2.5
Note - this is not a helper for the Page object but rather a helper for rendering
pages in Confluence themes in general.
Audit listener transforming and saving page hierarchy events as audit records
Returns all incomings link of a Page that are visible to the given user.
Representation of a Page Layout for xhtml unmarshalling and marshalling.
Representation of cell within a
PageLayoutSection.The available width-types of layout cells.
Sends an event to the analytics server when a page/blog post is created using a page layout
A Page Layout Section is a single "row" of content within a
PageLayout.Available layouts for layout sections
Provides a handler for detecting if a page contains an atlassian page layout.
Represents a user viewing any of the page listview actions.
Manages the retrieval and manipulation both pages and blog entries.
DMZ version of the
PageManager interface; see the package-info.java for rationale.Deprecated.
since 5.5.
Help resolve any conflicts that may arise during a copy.
Redirect to this action if you ever find yourself in a "page not found" situation, it deals with
possible alternative pages, and so on.
If the dark feature confluence.readable.url is enabled, redirect
/display/{space}/{page-slug} to /spaces/{space}/pages/{page-id}/{page-slug} which will eventually forwarded to viewpage.action
Otherwise, this path converter converts it into a viewpage action url.
Provides methods for converting user and group permission strings from web forms into collections of
ContentPermission objects.
An interface implemented by a class that can provide the page to be created.
Context object placed in the HttpServletRequest attributes so that the
PageNotFoundAction can determine which page was targetted by the user.
Responsible for rendering RSS feeds for implementations of
AbstractPage: blog posts and pages.This worker fixes broken pages in separated transactions
It has own queue for broken pages
Specifies the pagination requirements of a request.
REST resource to allowing the creation of a comment against Confluence content.
A response to a page request, used in pagination.
A wrapper around a list of content.
A Serializer that can handle PageResponses, that also includes special case logic to handle RestList's enriched
properties.
A builder for GraphQLOutputType objects for PageResponse, which map to graphql pagination objects.
Deprecated.
since 6.10.0.
in DMZ; see the package-info.java for rationale.
The PageService is a service layer implementation of the
PageManager.Simple class to store statistics data fetched by
PageDao.getPageStatistics()Deletes page templates and their historical versions.
Responsible for monitoring exported events of Space class, exporting historical and non-historical page templates of spaces
and sending data to the backup writer.
Exception during migration of a PageTemplate.
Performs migration of all Page Templates that match a given selector, by passing the templates'
content through an
ExceptionTolerantMigrator and storing the result as a new template version.Persists page templates
Some useful operations to help work with PageTemplatePersister.
A
SiteMigrator that manages the migration of Page Templates.Deprecated.
since 5.5.
Used to specify how a page update was triggered.
Generates links to Confluence pages
Paginated is a containing type that allows consumers to handle paginated data in different ways, depending
on their use case.
A pagination batch is responsible for supplying a pageResponse for a given pageRequest.
Provides pagination max limits for our various types of content.
Enclosing type for the parameters generally required when dealing with a pagination request from the database.
Provides paginated access to Model data.
Additional pagination functionality dealing with PagingIterators / Paginated live here
Until CONFDEV-26743 is resolved and we have a blessed path going forward, the PagingIterator / Paginated types
should not be leaked to consumers.
An indicator to identify whether a subclass of
AbstractPaginatedListAction support
PaginationServiceDeprecated.
since 6.10.0.
Deprecated.
since 6.10.0.
This class will wrap an instance of PageResponse and make it behave like PaginationSupport
Note: we need that so that we could reuse all VM code
Many operations require walking across the entire domain of data available.
A soy server function that retrieves web-panels for a given location.
Represents a paragraph fragment.
Allows to multiple tasks in parallel.
A ParamDirective for Velocity to add parameters to a decorator directive.
Deprecated, for removal: This API element is subject to removal in a future version.
since 9.1 Replaced by
ParamDirectiveProvides a way to retrieve more complex values from macro parameters.
Enforces validations on request parameters such as absence of path traversal sequences.
Thrown when there is a problem while processing a parameter.
A subclass of Hazelcast's
ObjectDataInputStream specifically for use during join
checks which applies bounds to certain operations.The label reference object encapsulates the unique string representation of a label within confluence.
Interface for downloadResourceManagers that support partial downloading of resources
A
DownloadResourceReader that can read a part of the resourceCAVEAT: 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).
Deprecated.
since 7.0.1 , use
PageResponseA model object to represent Password change details.
Specifies the action to take after PathConverter.getPath has been evaluated.
Path converters are used by the
SimpleDisplayServlet to convert friendly URL's to action URLs.A plugin module descriptor used to load path converter plugins.
Tokenizer for path-like hierarchies.
A char filter that replace a string matching the given pattern with the specified replacement.
The pattern tokenizer uses a regular expression to either split text into terms whenever it matches a word separator,
or to capture matching text as terms.
A cluster-wide event indicating that all scheduled jobs should be paused.
A cluster-wide event indicating that a specific scheduled job should be paused.
A cluster-wide event indicating that all scheduled jobs with the specified JobRunnerKey should be paused.
Only enabled if:
the Confluence people directory disable properties have not been set
the user is anonymous but has the VIEWUSERPROFILE permission
Confluence is not running in shared mode
An interface for events which are created by
PeriodicEventSupplier implementations and fired periodically.An interface implemented by plugins that want to broadcast an analytics event periodically.
Deprecated.
since 7.0.1 , use
OperationEnumeration of all possible permission types for use with the PermissionManager.
Model object for
PermissionsResource,
representing a grant or revoke of a single permission.This class is responsible for setting the bulk extractor classes in the extractor context.
Decorator over
SynchronyDataService, which allows only Confluence administrator to launch the operation.This interceptor checks if an action is allowed in read-only mode or in other normal use cases
Each type of target that can have permissions checked against it will have a delegate.
Defines operations to allow registration of
PermissionDelegates.Event sent for any space or global permission related operation.
Raised when a user attempts to perform an action they do not have permission for.
Provides methods to allow the PermissionManager to be more easily called from within Velocity templates
Generalised interface for checking whether a particular action in Confluence is allowed, without any knowledge
of the specific implementation of permissions as they relate to spaces, pages and so on.
A criterion for whether an entity should be permitted or not
Implementations of this module are supposed to provide a decision whether the content is protected for a given
permission and permission target.
Decision outcomes for the permission override.
A module descriptor that allows the adding of a
PermissionOverrideExtension into Confluence.since 9.2.5
The resolver is used to obtain the permissions for a global
or space object
Provides the logic required by the actions to view the permissions
for both global and spaces
Builds the various permissions administrators for the permissions actions.
This interface is used by all actions that need to access permissions.
Modifies space and global permission settings.
This wrapper exposes only those labels and functions of the labelable object that the
specified user is permitted to view.
An analytic event which is sent when method
BulkPermissionService.getPermittedSpaceIds(ConfluenceUser, Set, String) is called.An analytic event which is sent when method
BulkPermissionService.getPermittedSpaces(SpacesQuery, int, int) is called.Object to check user permissions for a specific action instance.
Encapsulates all the data required by the Page Restrictions UI.
Data that is specific to a single email notification sent to a single user.
Persian language analyzer provider
Keeps persisted objects with their database ids.
Helper class to replace lang macro with inline equivalent in decorators.
Exports containing entries in the Decorator table with reference to langmacros in the body will fail to import in 8.8.0+
We need to remove these references and replace them with the inline equivalent.
Persister interface
It verifies if the collection of imported objects should be persisted by this persister and then persists them.
Some useful operations to help with a Persister
Deprecated.
since 9.3 do not use
Deprecated.
since 7.17.0
Creates all persisters (required for space/site restore).
Deprecated.
since 7.0.1 , use
PersonA specialist DAO interface for bulk-fetching
PersonalInformation entities.Personal information creation event
Manages the persistence of personal information objects, containing user properties like
logos, preferences, etc.
Dao for PersonalInformation.
Personal information specific event
Extracts indexed and stored fields relating to personal information.
Personal information deletion event
Details of a Personal Space to be created
Builder for Person objects.
Provides CRUD operation on Persons.
Deprecated.
since 7.0.1 , use
PersonServiceA finder for locating persons.
A searcher for finding people based on a search term.
only here so that the remote person service can proxy it.
Provides methods for validating the CRUD methods.
A query which matches by phrases.
Defines the mapping from a V2 PhraseQuery to it's corresponding Lucene implementation.
Filter responsible for marking all placeholder images as long term public fresh resources.
Generates placeholder images.
Generates placeholder images.
Generates URLs for placeholders.
A PlainTextLinkBody is one that contains nothing but plain textual data.
Holds plain text and preserves white space.
Migration task for migrating plain text
Macros.Static methods for the conversion of text to HTML.
Strategy to get clustered database metadata once the cloud platform Confluence is running on is known.
A
Transformer which passes the input through a series of other transformers provided by enabled plugins'
TransformerModuleDescriptors, in addition to a set of defaults transformers.Ties a bill of materials in with its plugins
Provides a list of available attachment text extractors which are classes implementing
AttachmentTextExtractor and registered according to AttachmentTextExtractorModuleDescriptor.A Spring component which exposes to tests which beans are plugin-available, and which interfaces they make available.
A Servlet which exposes the data from
PluginAvailableBeanIntrospector as JSON.ActionConfig that contains a reference to its originating plugin.
A specialisation of the standard Struts
DefaultActionFactory which adds special handling for
PluginAwareActionConfig, and which delegates loading of the action class from the relevant Plugin.InterceptorConfig that contains a reference to its originating plugin.
A specialisation of the standard Struts
DefaultInterceptorFactory which adds special handling for
PluginAwareInterceptorConfig, and which delegates loading of the Interceptor class from the relevant Plugin.ResultConfig that contains a reference to its originating plugin.
A specialisation of the standard Struts
StrutsResultFactory which adds special handling for
PluginAwareResultConfig, and which delegates loading of the ResultTypeConfig class from the relevant
Plugin.Appends data about plugins to their Struts configuration
The Spring bean definitions for the ActiveObjects Confluence SPI Plugin.
An implementation of
BulkExtractorProvider that locates BulkExtractor instances from
the plugin system.Hibernate Implementation of the CustomContentDao
Interceptor responsible for adding the pluggable content adapter to any content loaded from the database.
This context map provider will return a map of all currently enabled Velocity context item modules.
Value bean to transport plugin data to and from the persistence layer
Interface for storing and retrieving plugin data
Produces
DataSources for plugin module resources.A view on the
ResourceDescriptor.Write plugin data files to a zip archive
Deprecated, for removal: This API element is subject to removal in a future version.
since 9.1
This bean provides access to plugin-specific directories found in the
confluence home.
Listens for Confluence plugin events and logs them.
This is a plugin available interface which compatible with
ExistingEntityFinderAllow plugin to check if imported object is exist or not
Describes how the plugin's ActiveObjects data can be exported to other
versions of the plugin.
An transformer class used to access fragment transformers which are defined in plugins.
Starts the plugin framework when the application starts and shuts it down when it finishes.
Run the upgrade tasks that require that PluginFramework to be available.
Published when the plugin framework has finished starting.
In the event of a
PluginFrameworkStartedEvent runs the PLUGIN_FRAMEWORK_STARTED Johnson health checking phase.Fired when a plugin is detected by scanForNewPlugins
Responsible for initialising all the plugin loaders Confluence needs to start the plugin system.
An event to indicate that a macro has been registered with an XHTML
MacroManager from a plugin.
An event to indicate that a plugin hosted macro has been unregistered with an XHTML
MacroManager.Modifies PluginSettings values
Abstract superclass of all plugin module events.
Deprecated, for removal: This API element is subject to removal in a future version.
since 8.3
Manages the lifecycle of a plugin module of type T that is constructed when the
module is first requested via
getModule() method.Parses
StrutsModuleDescriptor derived Documents for loading by the Struts configuration.Strategy class for the SimplePluginDirectoryProvider to find the parent directory in which to
put all the plugin working directories.
Holds data about the decorator override.
This will allow plugin to find existing id of an object it is interested.
Core checks and analytics depend on the status of plugin sandboxes.
Event fired to signal that the plugin system classloader is available for use.
This application event listener will configure the provided delegation class loader to use the plugins classloader
once the PluginsClassLoaderAvailableEvent is fired.
Deprecated, for removal: This API element is subject to removal in a future version.
since 9.2.1, for removal in 10.0.
Modifies PluginSettings values
This is an
EventListener which responds when the application has finished starting up, and disabled a set of
plugins which should be disabled prior to automated testing.Used to reference a template based on the complete module key, space and referencing plugin key
A theme stylesheet which is a resource in a plugin.
A SAL upgrade task that will get deferred during ZDU mode until ZDU is finalized.
BeanPostProcessor that swaps out Spring's default AspectJExpressionPointcut and substitutes it for
an implementation that is customised to use the Confluence application classloader.
A thread safe xhtml/html/xml Cleaner which is configured via a policy file classpath resource.
Provides the polish analyzer which can only be used if the analysis-stempel plugin is installed in OpenSearch
Represents the position of a piece of
Content among its siblings.Is used to perform any additional actions on entity objects after they have been exported
Determines whether the Postgres Collation is correct.
Contains methods for creating/removing triggers for content table
Contains methods for creating/removing triggers for content_perm table
Contains methods for creating/removing triggers for content_perm_set table
Contains operations required for Postgres database objects creation
The hibernate Dialect that's used for Postgres.
Contains methods for creating/removing triggers for spaces table
Contains methods for creating/removing triggers for spacepermissions table
Deprecated.
since 7.17.0.
Runs all post-import tasks.
This event is published after the
UserDirectoryListener
already handles the DirectoryUserRenamedEvent.Class for building searches that are commonly used.
Deprecated.
since 8.8 no replacement
Will apply a prefix before a conflicting page title
v2 primitive query
Runs all pre-import tasks.
Deprecated, for removal: This API element is subject to removal in a future version.
since 9.4
A builder for
PreRenderedMailNotificationQueueItems.Sets
Cache-Control HTTP headers which prevent caching of ALL responses from REST resources in the plugin,
and forces revalidation when you come back to the page.Sets
Cache-Control HTTP headers which prevent caching of ALL responses,
and forces revalidation when you come back to the page.Deprecated.
since 7.17.0.
Deprecated.
since 7.17.0
Deprecated.
since 7.17.0.
Deprecated.
since 7.17.0
SearchManager implementation that enables profiling metrics provided by atlassian-profiling.Class used for sending statistics about busy search threads for the Thread Limiter.
A macro that shows profile information.
This class handles the difference between an avatar which is a standard icon and one which is an attachment.
JSON Serialiser for the ProfilePictureInfo object
Event fired every time a thumbnail of a profile picture attachment is viewed.
Event fired every time a full sized profile picture attachment is viewed.
Deprecated, for removal: This API element is subject to removal in a future version.
since 9.1 use
ProfilingSiteMeshFilterDeprecated.
since 7.20.
Reindexer which assumes indexes reside locally i.e.
Provides content metadata pertaining to properties on a Content entity.
Represents a property entity.
This job runs every month and clean up the redundant property entries in the os_propertyentry table.
Represents a property restriction entity.
Deprecated.
since 7.17.0
Deprecated.
since 7.17.0
Sets appropriate
Cache-Control HTTP headers for REST resources in this plugin.Deprecated.
since 5.10.
Deprecated.
since 5.10.
Deprecated.
since 5.10.
Deprecated.
since 5.10.
Deprecated.
since 5.10.
Deprecated.
since 5.10.
Key factory for generating asymmetric cryptographic keys.
A Sitemesh
DecoratorMapper which delegates to a Spring bean.Deprecated.
since 9.0.0 please use
UnrestrictedAccess insteadConverts BackupRestoreSettings to JSON object
Used in
ExactAnalyzerProvider to trim
punctuationA soy server function that Adds key-value String pairs to a map to be rendered later.
Query regions are local.
Used by the query deserializer to map between key/parameters and
SearchQuery objects.
Note: Query serialization and deserialization does not work for all possible permutations of query parts
at the moment.
v2 primitive query
A token emitted from tokenization performed by
QueryTokenizer.Tokenizes a query string into
QueryTokens.This is the resource that provides QuickNav search endpoints to Confluence Users.
Manage cached last updated timestamp built by listening to page update event and comment events
as well as update from last built result for REST calls
Filter to quickly return empty data by looking into a cached last contents' (pages')
last updated timestamp built by listening to page update event and comment events
Endpoint for retrieving comments and page content after a specified time.
A wrapper macro that retains compatibility with our old Radeox-style macros
Represent a set of data needed to perform a Lucene range queries.
Represents an integer range suitable for iterating over.
Represents a valid HTTP byte range request
http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.35.1
Simple helper object that associates a Label with a 'rank' value.
A DTO class which adds 'rank' property to LiteLabelSearchResult
which reflects the frequency of labels.
An annotation indicating that access to this REST resource should be rate limited.
Type of the requests that have to be rate limited
Ignores calls to the wrapped consumer if the same key has been called within the minimum interval.
Deprecated, for removal: This API element is subject to removal in a future version.
since 9.1, use
RawTextResult instead.This action is responsible for returning a JSON string or a Read Only page depending on the request's Accept header or path.
Specifies that the annotated method (or all methods in the class, or all the methods in all the classes in the package)
should be bypassed by read-only access check.
Specifies that the annotated method (or all methods in the class, or all the methods in all the classes in the package)
should be blocked by read-only access check.
ContainerRequestFilter assumes that read-only mode is enabled and blocks the REST request with POST/PUT/DELETE method in read-only mode
Provides methods for changing between read/write and readonly transactions.
Read-only wrapper for ApplicationConfiguration
Deprecated, for removal: This API element is subject to removal in a future version.
since 9.1, use
Attachment directly.Deprecated, for removal: This API element is subject to removal in a future version.
since 9.1, use
DefaultAttachmentManager directly.Deprecated, for removal: This API element is subject to removal in a future version.
since 9.1, use
ConfluenceUserImpl directly.This exception is thrown when things that are expected to be read-only
Deprecated.
since 8.6.0.
Calculates the number of Users in a Confluence instance.
For use in the Velocity context.
Read-only wrapper for SetupPersister
Deprecated, for removal: This API element is subject to removal in a future version.
since 9.1, use
Space directly.Deprecated, for removal: This API element is subject to removal in a future version.
since 9.1, use
SpaceManager directly.TransactionExecutor that wraps all
TransactionCallback calls within a read only transaction.For use in the Velocity context.
This class/package was introduced as protection against an SSTI vulnerability which leveraged this class to escalate
privileges.
An implementation of
ReadThroughCache backed by an atlassian-cache Cache.Cache for attachment download paths.
A simple cache interface that supports the use of read-through operations.
Caches the IDs of attachments retrieved with
ReadThroughCachingAttachmentDao.getLatestAttachment(ContentEntityObject, String)
in a cache.Caches the download paths of attachments.
An implementation of
BandanaPersister which caches the data from another BandanaPersister.An implementation of
PropertySetFactory which delegates to another PropertySetFactory, and which keeps
the resulting PropertySets in a node-local cache.An implementation of
ReadThroughCache which caches the IDs of entity objects against arbitrary keys.Maintains a cache of the "most popular things" (globally, and by space).
This condition checks if the current access mode is READ_WRITE
Servlet used to log an application ready message to the lifecycle log, and marks that the last servlet has loaded.
Provides access to content, content_perm and content_perm_set tables.
We need this class to retrieve content permissions without taking all other linked stuff (like content permissions sets)
Helper for retrieving content permission sets
Deprecated.
since 7.17.0.
Responsible for rebuilding all change document(s) for a searchable (removing change documents for all versions of the searchable and then adding them back).
Task to rebuild the edge index
REST service for the RecentlyUpdatedContentMacro
This class represents a request which can be POSTed to
RecentlyUpdatedContentResourceService to retrieve recently updated content
Represents and parses macro parameters for the dashboard recently updated content macro.
Represents all the configuration options passed in via request parameters.
A tab on the dashboard recently-updated list.
Provider for tabs.
Provides the 'recentSpaces' top level field
Structure to represent a recent update.
Represents a single group of recent updates.
A runnable task which could allow to register for reconcile content
This task will trigger reconciliation request multiple times
This class is contained a logic to reconcile multiple content.
A handler for rejected tasks that logs a message and throws a
RejectedExecutionException.Deprecated, for removal: This API element is subject to removal in a future version.
since 9.4.
Deprecated, for removal: This API element is subject to removal in a future version.
since 9.2.6.
This context listener creates the recovery admin user if confluence is running under recovery mode.
This class creates RecoveryException instances for any errors.
Module for generating upgrade recovery files.
Recovery related utility methods.
Abstract bulk recursive action.
Deprecated, for removal: This API element is subject to removal in a future version.
since 9.3, use
ServletRedirectResult instead.Servlet that redirects to the specified
ServletConfig target init-param on the
same context path as the incoming request.Takes Flash scope objects from the current request and puts them on the session.
Deprecated, for removal: This API element is subject to removal in a future version.
since 9.3, use
RedirectWithFlashResult instead.A reference to a model object.
This class will use
PluginFragmentTransformer and ReferencesFromBodyContentExtractorMarkerV2 and scan
body content to extract a list of EntityObjectReadyForExport.Reference
Note: this mainly focus on extracting EntityObjectReadyForExport.Reference for exporting purpose.Hamcrest matchers for
Reference objects.Deprecated.
since 7.17.0.
Deprecated.
since 7.17.0
Deprecated.
Please using class
ReferencesFromBodyContentExtractorMarkerV2 insteadA marker which indicates that Plugin transformer is compatible with
BodyContentDataExporterA builder for GraphQLType objects, generated for api
Reference objects.Deprecated.
since 7.0.1, it will be removed by: https://jira.atlassian.com/browse/CONFSRVDEV-10243
Just fields declare, no need setter for bandana
Reflection-related utility methods.
Deprecated.
since 7.17.0
Deprecated.
since 7.17.0
Provides factory methods for creating
AttachmentRef types.An abstraction around a cache which contains the number of the registered users.
The adapter between fast permissions and Confluence services which allows to retrieve some Confluence entities and check permissions for them.
Update all blogs in the change index
Update all blogs in the content index
Update all spaces in the change index.
Update all spaces in the content index.
Updates all personal information and associated user entries in the change index.
Updates all personal information and associated user entries in the content index.
Responsible for triggering re-indexing / rebuilding of the Confluence search index.
Event emitted when an exception is thrown during reindexing
This job is run periodically (once per cluster) to detect and fix stalled re-index jobs.
IPD Job that measures the full reindex time when it's updated.
Control whether a reindex should happen cluster-wide or within current node only
Hold data about a re-index in Confluence
Simple class to hold progress of either rebuilding index or index propagation
This event is to inform the re-indexing job has been complete on all nodes
Can be used to retrieve status of running or most recent re-index job.
To be used within Confluence''s core to manage re-index job statuses.
Store/retrieve
ReIndexJob.Responsible for handling reindexing events
Trigger a reindex task for site or spaces
This class listens to reindex events generated by confluence core, and uses the
HibernateSqlCollector to
capture and analyze SQL queries issued by the various threads that particiate in the reindexing process.Hold data about a node and its status during a cluster re-index
This state is a node state
NB when adding options, also add to the metric tags in
LuceneFullReindexManagerUpdate all spaces in the content index.
This event must be synchronous so that the maintenance task can be created in the same transaction of the new reindex job
This class represents an event that is triggered when a reindex request fails in the application.
Service for reindexing contents in Confluence
Specifies how to reindex quickly a large amount of contents that is useful for a plugin that creates its own
CustomContentEntityObject.Different stages during a re-index in Server/DC
This is a synchronous event fired when the reindex job starts on a node.
Responsible for reporting on the progress of a reindex operation on the "Search Indexes" triggered
from the content indexing administration UI.
Updates all personal information and associated user entries in the change index for a particular group.
Updates all personal information and associated user entries in the content index for a particular group.
This is marker interface, that is used to mark entities, which can participate in relations, created by
RelationServiceMarker interface for hibernate entities that participate in the relationService
An enum representing the different entity types that may be used in relations.
Converts
RelatableEntityTypeEnums to and from strings in the DB.Resolve hibernate entities from their corresponding relatable model
A listener that is interested in events that could lead to relationships between the Confluence content requiring to be updated.
A helper class for ConfluenceSchemaCreator to get relation constraints
Relation dao interface.
Defines relation name, type and who may have such relations.
Provides static helper methods for RelationDescriptor objects.
This class represents "relation" abstraction, which is used for "marking" different entities as related.
Represents relation between two entities
Manages relations for entities and users.
Relation query contains query parameters for basic relation operations.
A REST resource for manipulating relationships between users, spaces and content.
Favourite relationships between users and space, page or blog post are supported.
Favourite relationships between users and space, page or blog post are supported.
Relation service, which allows to manage relations between entities.
Finder, which is used to perform basic relation operations, such as fetching source or target entities of
particular relation, get total number of related entities etc.
Responsible for validating the create and delete operations that can be performed using the RelationService
Relationship type helps to understand how to process relations.
Order search results most relevant first.
Containing all
ContentRestriction as RelevantViewRestrictionsNavigation for
RelevantViewRestrictionsLifecycle item to run a remigration of pages that have unmigrated macros, this is
only performed if the service deems it is required.
AccessModeService implementation that communicates with Confluence remotely using the Confluence REST API.*
AttachmentService implementation that communicates with Confluence remotely using the Confluence REST API.AttachmentService implementation that communicates with Confluence remotely using the Confluence REST api
Provides operations for Categories.
ChildContentService implementation that communicates with Confluence remotely using the Confluence REST API.ChildContentService implementation that communicates with Confluence remotely.Created by IntelliJ IDEA.
ClusterService implementation that communicates with Confluence remotely using the Confluence REST API.ContentBlueprintService implementation that communicates with Confluence remotely using the Confluence REST API.This service implementation is used in create-content plugin RemoteContentBlueprintServiceAcceptanceTest
ContentBodyConversionService implementation that communicates with Confluence remotely using the Confluence REST api.ContentBodyConversionService implementation that communicates with Confluence remotely.ContentDraftService implementation that communicates with Confluence remotely using the Confluence REST API.ContentService implementation that communicates with Confluence remotely.
ContentLabelService implementation that communicates with Confluence
remotely using the Confluence REST API.A remote service to access macro instances on a piece of Content
ContentPropertyService implementation that communicates with
Confluence remotely using the Confluence REST API.ContentRestrictionService implementation that communicates with Confluence remotely using the Confluence REST API.ContentService implementation that communicates with Confluence remotely using the Confluence REST API.ContentService implementation that communicates with Confluence remotely.
This is a template service interface shared by ContentTemplateService and BlueprintContentTemplateService, so we don't
have to declare similar methods in two places.
Remote test for TemplateResource.
ContentTrashService implementation that communicates with Confluence remotely using the Confluence REST API.ContentTrashService implementation that communicates with Confluence remotely.Remote client for ContentVersionService
Remote service impl for testing ContentVersionService via REST client.
CQLSearchService implementation that communicates with Confluence remotely using the Confluence REST API.GroupService implementation that communicates with Confluence remotely using the Confluence REST API.LabelService implementation that communicates with Confluence remotely using the Confluence REST api.Provides methods for validating inputs to create, retrieve, update or delete labels.
LongTaskService implementation that communicates with Confluence remotely using the Confluence REST API.LongTaskService implementation that communicates with Confluence remotely.Optional arguments for a page edit via remote API.
Deprecated.
Since 2.7.
PersonService implementation that communicates with Confluence remotely using the Confluence REST API.Deprecated.
since 9.0.
Deprecated.
since 9.0.
Relation service, which allows to manage relations between entities.
RelationService implementation that communicates with Confluence remotely using the Confluence REST API.Proxy's a remote service with a local service interface.
Deprecated.
since 5.9.
SpacePropertyService implementation that communicates with
Confluence remotely using the Confluence REST API.SpaceService implementation that communicates with Confluence remotely using the Confluence REST api.SpaceService implementation that communicates with Confluence remotely using the Confluence REST api
Passes if the remote user has permission to use Confluence.
Passes if the remote (current) user is logged in and has licensed access to Confluence.
Created by IntelliJ IDEA.
WatchService implementation that communicates with Confluence remotely using the Confluence REST api.Remote helper class for fetching WebView from the REST API,
This gets its data from /rest/experimental/webfragment
WebView implementation that communicates with Confluence
remotely using the Confluence GraphQL API.Remote service for the WebViewService, this gets its data from /rest/experimental/webfragment
WebViewService implementation that communicates with Confluence
remotely using the Confluence GraphQL API.Different types of removal jobs for Data management
Service command for removing a version of a page or blog post.
A Transformer that removes that apostrophe entity which is invalid in HTML.
Service command for removing a version of a blog post.
Indicates that the implementation represents a removal event.
Removes labels from the page or blog post.
Removes a label from a Page or Blog Post.
Hibernate batch operation to remove a list of entities
Service command for removing a version of a page.
Trigger a reindex of the PersonalInformation object's lucene document.
Represents the user view the remove space state within Space admin.
An action to list the trusted applications.
Action for removing an unsynced user: a user whose account has been disconnected from an external directory, i.e.
Action for removing a user.
Action for removing a user macro
Operation to remove a user and all its related information.
Marker interface representing an event that indicates something is about to be removed, to allow for
clean-up before the actual removal is final.
Used to rename a table
After upgrading WebWork to Struts we need to update 'confluence.cfg.xml' by
renaming property 'webwork.multipart.saveDir' -> 'struts.multipart.saveDir'.
Action used for rendering content, specifically for PREVIEW
A command that can render some content.
A command that renders content for preview mode in the editor.
Responsible for cleaning supplied HTML content into a form that is balanced and free of any insecure markup.
Render from Confluence storage format to XHTML for viewing or editing.
Implemenation of the RendererAttachmentManager that converts thumbnails and attachments into useable objects
for the wiki renderer.
Publishes events related to the rendering process.
Wraps a single
Renderer result, including whether the
render was successful or not.The result of a wiki rendering: the main payload is, of course, the rendered content,
but we may during the course of the render want to collect more information like page
structure, or excerpts or so on, so this gives us a simple metadata facility.
An action for supplying panels for the re-order page of the MovePageDialog.
This task implements the changes in CONFSRVDEV-20791.
Threadlocal for caching objects that must survive the whole HTTP request.
Servlet filter for initialising and cleaning up the RequestCacheThreadLocal.
It is thrown when fast permissions can't process the request.
Removes _links and _expandable fields from request objects.
A
Filter which publishes events when a matching servlet request comes through.This filter is used to record url of any http requests made during a certain period.
This class is used to record url of any http requests made during a certain period.
A message manager that stores messages in the request scope
Bean intended to be exposed via JMX to represent various system health metrics.
Defines a strategy for whitelisting a request parameter so that it is not
explicitly declared clean.
Validates request parameter values so that they cannot contain null characters.
Registers
RateLimitFilter with REST resources, annotated with RateLimited annotationA thread-local for storing the time a request was received.
Stores the time of the request in the
RequestTimeThreadLocal, and clears it once
the request completes.Deprecated.
since 9.0.0 please use
AnonymousSiteAccess insteadClass annotation for
Macro implementations to define what format the
macro body should be passed to the execute method as.Deprecated.
since 9.0.0 please use
LicensedOnly insteadDeprecated.
since 9.0.0 please use
LicensedOnly and/or AnonymousSiteAccess insteadThis upgrade task is necessary for any customer who upgraded to Confluence 8.3.0 and then performed a site restore.
An implementation of a resettable hi/lo
IdentifierGenerator which is compatible with Hibernate 5.2.Ideally we should be using one of the off-the-shelf Hibernate ID generators, bu we need the "reset"
functionality of this custom one.
Simple abstract class with a method to reset the thread local to its initial value
Not thread-safe.
This class makes sure caches in XStream are clean and consistent.
Simple interface to provide access to a resource.
Util class for checking if a code block is annotated
Interface for making
Macros resource aware.Class that:
takes a map of resource bundles (keyed by locale) or single resource bundles
sorts them by locale
combines all bundles keyed by the same locale into one CombinedResourceBundle
and returns a list of CombinedResourceBundles in the correct locale order (most specific locales come first.
Encapsulates all the state that is required to identify or resolve the location of a particular resource.
A utility bean the provides functionality related to manipulating
ResourceIdentifier
during conversion (i.e.Thrown when there is an error creating a resource identifier for a particular resource.
Responsible for generating a resource identifier for a resource.
Match a ContentEntityObject against the supplied ResourceIdentifier.
Responsible for resolving or locating the actual resource identified by a resource identifier.
Wrapper class for writing resource loader filters, delegating the ResourceLoader methods
to the wrapped loader.
Marks the type of tags that is contained in the
WebResourceDependencies fields.Defines how links to resources should be generated
Response header names for responses from Confluence
Wraps the
HttpServletResponse's ServletOutputStream so that it is closed properly.Restarts (and waits) for the Synchrony process
Responsible for managing
AttachmentEntity objects.
Factory for creating jersey Client instances that can deserialize json
returned from the Confluence REST API into confluence java api model objects.
Responsible for managing
ContentEntity objects.An class carries the settings needed for an rest operationKey
This class contains a property bag for REST operationKey that we have to pass extra parameters in Http body.
An event sent by a REST resource.
An annotation indicating that this model object should be enriched when
being serialized.
Annotation indicating that a field should be included in a RestEntity even if it doesn't have
a JsonProperty annotation.
This entity participates in our object serialization by jackson, and allows objects to be enriched with extra
properties during serialization.
Converts a rest entity to an enrichable entity.
Contains a standardised error payload for
ServiceExceptions thrown by REST resources.REST-friendly version of a
SimpleFieldValidationError.The RestList participates in our collection serialization by jackson, and allows collections to be enriched with extra
properties during serialization.
Deserializer for RestList.
Enricher which populates extra links in
ContentRestrictionsPageResponses
At the moment of creation it did not enrich any other RestLists.Extends the
Navigation API with URI-building methods.Extends the
NavigationService to return RestNavigation instances.Common property keys that may be present on a RestObject
Enriches entities and collections with extra properties that participate in json or graph-ql serialization.
Indicates that the implementation represents a restore event.
Deprecated.
since 7.17.0.
Allows to perform all DB operations required for space and site restore.
Contains an insert SQL script and a collection of values for the whole insert batch
Restores a demo space.
An event that is sent when restore process fails
A
SystemMaintenanceTask that is created when a node uploads a snapshot of its index to be used by
other nodes in the cluster to replace their indexes.Hold an index snapshot
An event that is sent periodically with the restore process state.
Class for space and site restore jobs validation
An event that is sent before db drop to lock some database table
Deprecated.
since 7.17.0.
Service responsible for restore operations (used for both space and site restore)
An event that is sent when the restore process finishes successfully.
A JUnit Rule which makes sure that the Thread context Classloader is the same after the test completes as was present before it started.
Deprecated.
since 7.20 no replacement
An event that is sent before db drop to lock some database table
A request for a page of data.
This event is fired when a user trying to access a restricted page/blogpost which they don't have permission to view
Decorator over
SoftCleanupStatusService, which allows only Confluence administrator to launch the operation.Service to implement different search algorithms
Responsible for managing
SpaceEntity objects.Responsible for managing
UserSessionEntity objects.REST-friendly version of a
ValidationError.REST-friendly version of a
ValidationResult.Subclass of default XWork logging interceptor which adds logging of the action result.
Class that allows clients to specify what categories of results to get back from any content name search.
A cluster-wide event indicating that a specific scheduled job should be resumed.
Deprecated.
since 7.5.0.
Provide a single source of truth re - who have permission to view/edit retention policies at global and space level
Check current retention rules at both global and space level for certain conditions
Utils for retention rules
Helper class to validate retention rule fields
Used to mark methods for which the
TransactionRetryInterceptorConfig.transactionRetryInterceptor() should be
applied.Deprecated, for removal: This API element is subject to removal in a future version.
since 6.5, for removal in 10.0.
Removes page position information from the children of the provided page, effectively
reverting their order to alphabetical.
Removes page position information from the children of the provided page, effectively
reverting their order to alphabetical.
A RichTextLinkBody is one that contains XHTML data and may be displayed on an XHTML client without requiring any encoding.
Macro body that contains rich text or HTML markup.
Takes a macro with wiki-markup in its body and converts it to XHTML storage format.
Romanian language analyzer provider
The 'RosterFilePluginLoaderFactory' generates a
RosterFilePluginLoader which is a PluginLoader that loads
plugins according to a list in a provided roster file.Event thrown after successful rpc authentication.
Kicked when RPC authentication fails
This class describes an RSS feed.
An analytics event that is published whenever Confluence executes an RSS feed
Contains the configuration necessary for an implementation of
RssRenderSupport
to render an RSS item.Implementations of this class are reponsible for producing RSS content for a
particular class of Confluence object: page, mail, attachment, etc.
TODO : confluence-7.0 do we even want to keep this around ? currently not used
An experimental command for running services as another user.
A generic atlassian-scheduler
JobRunner which invokes the given Runnable.Answer for simplified mocking of methods accepting
Runnable.Russian language analyzer provider
Factory for creating
AttachmentDataFileSystem instances.Computes a safe content type given an existing content type and filename.
Deprecated.
since 7.20 No replacement.
Simple implementation of SAL event interface
A helper class, defining the utility method
SalRetryConnectionCallback.execute(org.springframework.retry.support.RetryTemplate, com.atlassian.sal.api.rdbms.TransactionalExecutor, com.atlassian.sal.api.rdbms.ConnectionCallback<T>) to call TransactionalExecutor.execute(ConnectionCallback) with a RetryTemplate.Deprecated, for removal: This API element is subject to removal in a future version.
since 8.6
A sandbox is an object responsible for running java code in an isolated OS process.
During the course of work a
SandboxTask which is executed in a sandbox process may need to ask the host for
a specific information or an action.The execution context for a
SandboxCallback.Is thrown when sandbox JVM has crashed
Consumer of a single line of sandbox standard error.
This error is thrown when sandbox failed to start or serve a request (e.g.
This error is thrown when sandbox instance with given spec can't be obtained
The configuration for a sandbox pool of processes.
This is the entry point for usage of sandbox API.
Handles Serialization/deserialization input and output for
SandboxTask.Utility methods for serialization/deserialization.
Responsible for exchanging messages with the host application.
Specification for the sandbox which will be used in searching the most suitable sandbox instance in
SandboxRegistry.If thrown when the sandbox process has been failed to start
Represents a task intended to be executed in a process sandbox.
The execution context for a
SandboxTask.Is thrown when the sandbox process has been killed due to the timeout
Deprecated.
since 7.17.0.
Replaces invalid characters with '?' symbol.
Context for managers to call upon when making decisions about how to save
an object.
Contains the score and a field-value map of the underlying document returned by Lucene.
A
Suite that allows specifying patterns of names classes to include/exclude.This class is for easily setting an atlassian-scheduler cron job from Spring.
This is intended to be the interface for setting atlassian-scheduler jobs
from Spring.
Stores the current configuration of a job managed by the system.
Provides the DAO for storing the various scheduled job objects.
Represent an execution event of a scheduled job.
Natural order is by the natural order of startDate, then endDate (if required).
Deprecated.
since 8.0.
Defines the services provided for manage scheduled jobs.
Manages ScheduledJobs for the local cluster node, rather than the whole cluster.
Listens for changes from atlassian-scheduler in the activity of job being managed and
records their status / history.
This class contains the transient runtime state of a single job.
Finds or creates a schedule job status, based on the current configuration,
and status in the schedules.
This class is for easily setting an atlassian-scheduler interval job from Spring.
See schedulingSubsystemContext.xml.
Modifies the Scheduler.
This is
NotExportable, see CONFDEV-40509.This manager is for internal processing of the scheduler run details (aka.
This job runs every hour and purge the old run details in the scheduler_run_details table.
A general utility class for scheduling.
Return the schema used by current system.
A representation of a comparison between the expected and actual database schemata.
Provides a service for reconciling the actual database schema with an "expected" view of the schema.
Represents a comparison between the "expected" and "actual" representation of a database schema element.
Set of supported index field types.
Provides a service to get database related information.
A subtype of the Hibernate interface that adds
AutoCloseable.see the package-info.java for rationale.
Delegate class for ScopesRequestCache which is provided by the oauth2-scopes-plugin.
This collector stores the score of the document into the v2
ScannedDocument
so that the consumer can do further computation based on itMarker interface for a function providing score for
FunctionScoreQuery.Factory for creating
ScoreFunction which are used in site-wide confluence search.Maps v2
ScoreFunction to OpenSearch FunctionScoreQueryMethods required by the indexing subsystem in order to properly handle object searching.
An object representing some searchable file.
Provides access to
Searchable objects.Provides mapping between content property with custom content type for default searchable text
A module descriptor for appending content property to default search text for Extensible Content Types
Defines search constants.
JSON serializable search context object to allow a user to specify the context they
want a search to execute in.
This class is used to pass in additional information to managers to take care of when
searching.
Decorates a
ISearch with a custom logic e.g.A module descriptor that allows to add a
SearchDecorator into Confluence.Deprecated.
since 5.9.
Builds REST ContentEntity objects from Confluence search results.
Implement this interface to initialise a searcher.
Superclass of all search-related events
search expander that expands query until no longer possible.
A helper class that contains the known set of field mappings for the core indexes.
Deprecated, for removal: This API element is subject to removal in a future version.
This is a temporary solution for backward compatibility purposes, and will be removed in a future version.
Deprecated, for removal: This API element is subject to removal in a future version.
since 8.7.0
An V2 interface which provides the following thread-safe actions on a search index:
Searching by
SearchIndexAccessor.search(ISearch, Set), SearchIndexAccessor.scan(SearchQuery, Set, Consumer)
Writing by SearchIndexAccessor.execute(SearchIndexAction)
Transactional execution of searches and writes via SearchIndexAccessor.withBatchUpdate(BatchUpdateAction)
Resets via SearchIndexAccessor.reset(Runnable)
Snapshotting via SearchIndexAccessor.reset(Runnable)
To hook into core search indexes behaviour (content and change index), inject the exposed beans via Spring.Adapter providing convenient access to Confluence search operations.
A mean to write to or remove a document from a search index.
Information about Confluence's search configuration
Information about Lucene configuration
Information about OpenSearch configuration
Interface which checks if a search language is supported by the current platform.
Provides
SearchLanguage for indexing and search.A V2 interface which provides searching functionality on a search index.
Determines how search results will be converted into entities by
SearchManager.convertToEntities(SearchResults, EntityVersionPolicy) and
SearchManager.searchEntities(ISearch, EntityVersionPolicy).A page response impl for the search service which provides the total size of the
result set, along with the CQL Query that was used to generate the result set.
Event triggered whenever a user performs a search through the search screen or the remote API.
Search platform that can be configured on Confluence via the "search.platform" property in the application config file.
Interface to expose search platform configuration
The annotated element as v2 search primitive means it is a building block for composing higher level search classes.
A query to be performed against the search index.
Provides methods ot create various specialised
SearchQuery instances.Creates a
SearchQuery instance
from the provided String value.Exception thrown by
SearchQueryInterpreter if an error occurs
while creating a SearchQuery.
Encapsulates parameters which describes search terms and additional filtering.
Exception thrown by the SearchQueryParser if it runs
into trouble converting a criteria string into a SearchQuery.Breaks a text of a text field into tokens.
Helper class to assist with any operations that require traversing the tree of
SearchQuerys.Common fields for a user management search.
Class responsible for storing information about search requests (for thread limiter analytics service).
API REST Resource for searching for entities in Confluence.
Search restriction entity classes should extend this abstract class.
Utility class to convert from a SearchRestriction interface to one of SearchRestrictionEntity classes.
Represents a supported value type.
A result of a search.
Represents a search result from a content name search.
An individual search result.
A single search result
Entity representing a search result
Represents a HTML link constructed from data contained in a search result (and ultimately the search index).
Render context for search results.
Interface for plugins that will provide a customized rendering of a search result should implement.
The class caches the list of search result renderers installed in the system.
The class listens for plugin changes and notifies the search result renderer
cache of any changes made to plugins.
The results of a search.
Provides a worksource from a searchQuery, the query should return searchResults that can be converted
ContentEntityObjects
JSON Serialiser for SearchResult objects
Represents a confluence search result type.
An error occured during a search
Deprecated.
since 5.9
A Class used to represent the different criteria restriction links that are displayed along with the search
results.
Represents some method for sorting search results, and the order in which to search them.
Enum defining the types of ordering supported.
Parameter that resolves a
SearchSort instance from parameters named
"sort" and "reverse".This enum is to classify search terms in the user management search box.
Thrown when the search token has expired.
An exception thrown when the search token has expired.
Tracks search tokens in memory, and associates them with the corresponding OpenSearch PIT (Point in Time) id.
This event is fired each time "Search" is hit on the admin user management page, to search for users.
A search that additionally specifies a search token.
Listens for SecretService related events and translates them into AuditEvents.
An event that is emitted when a secret is deleted.
Faux class for synchrony
Decrypts an encrypted
hibernate.connection.passwordAn event that is emitted when a secret is created / modified.
Sends an event to the analytics server when a page/blog post is created using the section and column
macros
A layout event is used to define when a page/blog post is created using
the section and column macro.
A soy server function that retrieves web-sections for a given location.
Entry point to
SecureAccessFilterChain.Provide a flexible way to manage filter chain based on current user access level
Simple service which manage filter path.
This will ideally is a last filter which check target servlet to have proper access or not.
Wrapper FilterConfig for SecureAccessFilter
All filter define in here will be check for 3AF for
LicensedOnly by defaultAn upgrade task to secure the secret properties configured in local home as defined in
the
Set ConfluenceApplicationConfig.propertiesToSecureAn upgrade task to secure plaintext mail server passwords that have been previously
configured.
An upgrade task to secure the secret properties configured in shared home as defined in
the
Set ConfluenceApplicationConfig.propertiesToSecureInterface for enforcing security policy criteria given a request and supplementary information for that request such
as the authenticated user and mapped Struts action.
Raised to return an http 303 'see other' to the client.
A simple action, the goal of which is to redirect the user to the correct setup step
Helps generate SQL code to select rows with an offset and limit for all supported databases.
Builds a
SelectWithOffsetLimitCommandHolds the semaphore used to enforce a limit on the number of simultaneous quick nav searches.
Listener that listens for changes to the global configuration.
An annotation indicating that this REST resource would is enabled to send analytics ( Sends RestEndpointAnalyticsEvent
for every whitelisted (see below) method in this REST resource).
Event sent when a user wants to invite a set of users to use Confluence.
A
UserResolver is used by the TrustedApplicationsFilter to find
a user based on the application certificate.Module containing the custom serializers required to serialize the entities in the REST API
This abstract download strategy allows implementors to gather necessary information from a database and set HTTP
headers within a database transaction.
REST API for fetching server information.
A Journal State Store which will store the state based on Subscription Id
A command forming part of Confluence's service layer.
Proxy for wrapping service commands in Spring-managed transactions.
All thrown API Service-level exceptions should extend this exception.
Deprecated.
since 9.4 obsolete, no replacement
ServiceException supplier for use with
SimpleValidationResult.Deprecated, for removal: This API element is subject to removal in a future version.
since 9.3, use
ServletActionContext instead.Wrapper for
ServletActionContext which ensures compatibility with Struts 6.7, specifically
the usage of JavaX APIs rather than Jakarta APIs.An implementation of
ResourceAccessor that gets resources via the servlet context.Filter implementation which delegates to plugin filters.
This class was mark with
UnrestrictedAccess because it will handle the check by itselfA Spring
WebApplicationInitializer which registers and configures various Servlets and Filters.A thread local that stores the CacheMode during use of a session.
Implementation of
RowCallbackHandler which clears the session after processing a configurable
number of rows.Stores drafts in the session, primarily for anonymous users.
Deprecated.
since 9.3
All of the keys used to store Confluence information in the user's session.
A List wrapper around an ordered Set.
Sets the order of a page's children to the order specified by the provided child IDs.
Called for a existing Page via AJAX, sets new
ContentPermissions for the Page, overwriting any existing ones.Commands for setting a user's profile picture
Class that checks whether a user has sufficient privileges to set a
SpacePermission.Defines a setter for a weblink
Allows to configure the
DownloadPolicy used by Confluence to be selected via
the global system setting 'attachmentSecurityLevel'.Deprecated.
since 7.7 Use one of the more specific super-types
An exception thrown for any problems during migration of any wiki formatted settings.
Application-wide settings.
Server implementation of API
SettingsService.Configures the beans of the setup spring context.
Ensure we don't try to hit the setup step after setup is complete.
Used in the setup context only as a way of retrieving the AUI default colour scheme and nothing more.
An implementation of TimeZoneManager for use during setup phase.
A stripped-down web resource integration sufficient to serve resources during setup when most of Confluence is not
available.
Named for 'grep-ability' to quickly glance at product overrides
Static holder for setup Spring context.
SetupDataAction: Sets up data within Confluence behind the scenes, i.e.
Tests the database connection given a datasource.
This action allows user to select database type.
Interceptor that checks whether or not Confluence has been setup yet (that is the setup wizard has been completed).
Deprecated, for removal: This API element is subject to removal in a future version.
since 9.3, use
SetupIncompleteInterceptor instead.Minimum implementation for the setup context.
Provide locks for actions so that they don't get run multiple times at once.
Cut-down plugin manager for the setup wizard, since it only need to load a limited number of plugins.
Tests the database connection with the JDBC settings.
A stripped-down web resource manager sufficient to serve resources during setup when most of Confluence is not
available.
Interceptor to check that shared access is allowed to
ContentEntityObjectDeprecated, for removal: This API element is subject to removal in a future version.
since 8.2
Deprecated, for removal: This API element is subject to removal in a future version.
since 8.2
Deprecated, for removal: This API element is subject to removal in a future version.
since 8.2
Captures shared-home latency to IPD metric 'home.shared.write.latency' by measuring time to write small amount of data to a file.
Validates that the remote node contains the same password as the cluster.
A token filter that constructs shingles (token n-grams) from a token stream.
Defines a shortcut link in a serializable way.
Returns a Full list of Shorcut Link Configurations
Determines if a Like link should be present in a change notification email.
Checks whether we should display the view blog post link in the action items section of a like added email
for pages.
Checks whether we should display the view page link in the action items section of a like added email
for pages.
A form where new users may create accounts for themselves, given a valid token.
Builds rendered MailQueueItems for a newly signed up user.
Provides methods for adding users easily.
Checks that users can sign up for Confluence with the supplied credentials.
Checks that users can sign up for Confluence with the supplied credentials.
Simple or default breadcrumb just wraps a i18n key and path.
Simple implementation of
BulkOperationBuffer that sends a bulk API request to OpenSearch when SimpleBulkOperationBuffer.flush() is manually triggerred.Lite representation of content table used by denormalised permissions.
A ContentPermissionProvider which simply returns the ContentPermissions that have been set on it.
This servlet uses the
PathConverterManager to convert the incoming (friendly) url into a url that maps to an
struts action.Writes out the tag for an embedded image.
An EmoticonImageMapper which makes use of the type of the emoticon supplied when building the URL to use.
Responsible for exporting objects that should not be exported as a part of the space
unless other objects have references to them.
Represents the simplest kind of validation error on a particular field.
This implementation allows a string to be passed in to set the File location.
Provides methods for performing batch operations in a series of independent transactions.
A simple representation of a historical version with minimum data for fast retention version removal,
which allows to set spaceId after creation, so to avoid joining space table when querying content table.
A predicate that decides whether or not an image stream should be rendered as a raster, depending on the size of the
resulting raster.
Represents a simple, immutable link with only text and an href.
A simple implementation of
ResourceBundle which stores the key-value pairs as a map.Simple immutable implementation of
Message.Simple representation of a content table used by denormalised permissions.
A simple immutable implementation of PageRequest
Creates the standard set of plugin directories as subdirectories of a provided parent directory.
Parses
Strings into SearchQuery implementations
according to the SearchQueryInterpreter provided at construction
time and returns a BooleanQueryFactory.This is just a simple subscription spec
Represents the simplest kind of ValidationError.
Represents the simplest kind of ValidationResult.
Methods to assist in the creation of SimpleValidationResult Errors
Opens a single on-demand DB connection.
Generic data exporter depends on another single entity type.
EntityLocator that will only ever find either zero or one objects.
Helper class for Actions that want to return a single action error as a JSON result.
A fetcher that retrieves individual model objects from a datastore.
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.
This class is a wrapper on top of
ConfluenceLicense with some additionsThis will identify that we will have 1 Journal per Subscription
Struts uses a Guice container to manage its beans, the VelocityManager being one of them.
An
Iterable wrapper for an iterator.Information about Site Backup job
Service responsible for site backup operations.
Site Backup settings
Defines operations to persist site dark features.
Creates a collection of extractors for site backup.
Service responsible for running all additional tasks that should be executed before and after site restore
Deprecated.
since 5.10.
A helper wrapper around
SiteLogoManager for use by Velocity templatesDeprecated, for removal: This API element is subject to removal in a future version.
since 9.1
Deprecated, for removal: This API element is subject to removal in a future version.
since 9.1
A component responsible for performing the conversion of content within Confluence to the latest format.
Creates various flavours of
SiteMigrator.Represents a site-wide watch event, for example the Daily Report.
Responsible for keeping id mappings between the xml ids and the database ids during site restore.
Information about Site Restore job
Resurrects the backup restore job (including settings) after database recreation.
Service responsible for site restore operations.
Site Restore settings
Event used to log site search audits
Relocation from confluence-search plugin.
This is used in conjunction with the
SiteSearchPermissionsQueryMapper,
which map it to a FilteredQueryThis factory class creates a
SearchQuery instance for filtering the documents by permissions.This mapper is to map
SiteSearchPermissionsQuery to a FilteredQuery, which is more performant
than the query generated by SiteSearchPermissionsQueryFactory.Allows plugins to provide additional capabilities for Confluence search.
Relocation from confluence-search plugin.
Factory to expand query string from
SiteTextSearchQuery into a primitive SearchQuery.Relocation from confluence-search plugin.
Relocation from confluence-search plugin.
Deprecated, for removal: This API element is subject to removal in a future version.
since 7.0.1 will be removed in 9.0
This will allow to skip
Surrounds the body in skiplinks so that the content can be skipped by screen readers
USAGE:
#skiplink (sectionName startLabel endLabel)
body
#end
This pre-processor ensures we are not importing objects that reference types we no longer support
An example would be backup files with
BodyContent referencing a content of
the legacy Mail typeReason for skipping objects on backup or restore.
Adapts Lucene's logging mechanism,
InfoStream, to SLF4J.Allows to generate ids in bunches.
Snappy byte array format compression/decompression implementation of
DataCompressor.An implementation of ConfluenceUserSession that snapshots the value of another
ConfluenceHttpSessionFaux class for synchrony
Contains the status of the Versions Removal job
Service for interacting with VersionsRemovalStatus object
Describes how Soft Synchrony Eviction should be performed.
Deprecated.
since 8.6
Types of sorts supported by
SearchSortParameter.Utils for OpenSearch sort
The SourceNodeExitAction enum defines the various actions
that can be taken when a source node exits the cluster.
Represents an event that occurs when a source node leaves the cluster during
the propagation of index snapshot.
Represents a soy result.
Deprecated, for removal: This API element is subject to removal in a future version.
since 9.3, use
SoyResult instead.Representation of a Confluence Space.
Provides property names that can be used to expand
Space objects.Provides property names that can be used to expand metadata
Builds
Space objects.Dummy
Action object with a space, only used for rendering decorators.Represents the breadcrumb "Remove Space" in "Dashboard > Demo Space > Space Admin > Remove Space"
Deprecated.
since 2.8.
Represents a user viewing the top level screen of the space admin console.
Indicates that an action may have a space set on it by the SpaceAwareInterceptor
Encapsulates all the complicated "how are the many ways I can look up a space so the action knows
about it?" stuff.
Information about Space Backup job
Service responsible for space backup operations.
Space Backup settings
NOTE: Spaces that adhere to the new space information architecture (default theme spaces in Confluence 5.0)
don't display this breadcrumb.
Breadcrumb for the Space when the context of the space is not visible anywhere else on the page.
An enum representing the different categories of space that may be specified in a search.
Represents a space category name.
Search for content within spaces of a particular category (or categories).
Implements the space category tab, which displays updates in spaces that have a space category label
This is the interface for space color scheme service
This is the model for color scheme api
Order spaces by name, or by key if the names are the same.
It is responsible for hiding a space, so the space key could be re-used again immediately.
Defines space constants.
DAO to delete records via native queries (used in Fast Space Deletion functionality)
A ContentEntityObject that is a first-class member of a Space (i.e.
Factory that can create different types of erasers (used in space deletion).
Creates all erasers for all depending on the SPACES table.
Event published when a space's content (pages, blog-posts) is about to be removed, but has not been removed.
A class which could be used to generate cursor for the next/previous space pagination request or get cursor from space
An interface indicating that a given class has a related space.
Dao for Spaces.
Extract space and send data to the backup writer.
An Action object to render a decorator in context of a space, with some webInterface context.
Can remove space content via a set of small iterations (each in its own transaction).
Responsible for sending events during space deletion
Manager responsible for space deletion.
Prepares SQL scripts for data deletion and retrieving.
Adding the "content-name-unstemmed" field to the index document for a
SpaceDescription objectSpaceDescriptionManagers should not be used directly except by the
SpaceManager.Adding the "username" field to SpaceDescription index documents will allow them to be sorted together with PersonalInformation documents in People Directory search.
Extracts Space links map from specific "hidden" _links map entries.
Deprecated.
since 7.0.0, it will be removed in future.
Represents a user viewing the space details screen of the space admin console.
This Space Entity is designed to hold the most amount of space data without
affecting performance.
A simple bean to represent
Space.A recursive EntityExpander to expand
SpaceEntity objects.A List wrapper for
SpaceEntity objectsRepresents the context for which
SpaceEntityLists are queried in.A list of permissions that the viewing user has on a given space
Expands the SpaceEntityUserPermission entity
Details about the space that are in the perspective of the current user.
Expands a
SpaceEntityUserProperties during the REST entity expansion.Removes records from the space table and all dependant tables.
A command which handles common Space Events (Created, Archived, Unarchived)
Create all exporters responsible for extracting data from the database during space backup.
Extracts and indexes a
Space represented by the searchable object.Filters content that is in, or not in given space(s).
A condition for checking the space function level permissions such as create space.
Deprecated.
in 5.9.
Deprecated.
since 5.9.
Deprecated.
in 5.9.
Command to process Space restore finish event for content management
Helps create the space page-import directory for acceptance tests.
Service responsible for running all additional tasks that should be executed before and after space restore
Extracts and indexes the space key and name for searchables that belong to a space.
It is thrown when spaces are existing in database already.
The spaceKey is sufficient to serve as the handle for spaces stored in the index.
Renames space key and name by adding some random suffixes so the original space key can be re-used.
Parameter that presents space key search restrictions as
SpaceCategoryQuery or InSpaceQuery
implementations.An analytic event which is sent when method
BulkPermissionService.getAllSpaceKeysWithPermissionStatuses(ConfluenceUser, String) is called.Contains two values: space key and a flag which indicates whether the space permitted or not
Provides operations for Space labels.
Deprecated.
since 7.0.1 , use
ContentLabelServiceProvides methods for validating create, update and delete methods.
Represents a user viewing the space labels screen of the space admin console.
This class represents logos displayed for a space or even for the global context where no space is available.
Manages logos for spaces.
Represents a change to the logo of a space.
DMZ space manager interface.
A builder for GraphQLOutputType objects, generated for
Space metadata.Represents a space watch event.
This path converter takes a friendly space url and converts it into a viewspace action url.
This is a simplified model object representing a space permission
A SpacePermission restricts access to different functions on a space.
Centralised logic to determine how permissions should be checked, depending on a user's type of access to
Confluence (see
ConfluenceAccessManager).This class will prime space permission cache for all spaces that not archived or
personal.
Command which handles
SpacePermissionChangeEventEvent sent when any space permission is changed.
This is a simplified model object that serves as a container for holding permissions of a specific space
An update context for any edits to space permissions.
Space permission manager that adds a layer of security over the write operations in this class.
A store for managing the space permissions that new spaces receive by default.
Factory of SpacePermissionDefaultsStores.
This light object allows to retrieve space permission records with user keys without retrieving data from other tables
(for example from spaces).
Event sent for any space permission related operation.
Deprecated.
since 8.0, use
DefaultSpacePermissionQueryFactory instead.Journal message for space permission changes.
Responsible for the addition, modification and removal of space permissions.
Deprecated, for removal: This API element is subject to removal in a future version.
since 9.4.
Internal version of the
SpacePermissionManager; see package-info.java for rationale.Model for space permission changes.
This class is for generating the navigation url of all space permission of given space key
Converts between confluences SpacePermission type and an
OperationDescriptionDeprecated.
since 8.0, use
SpacePermissionQueryFactory.create(ConfluenceUser)A centralised place for construction of database query conditions to filter or join on the "spacepermissions" table.
This factory class creates a
SearchQuery that takes the user's space permissions into account.Helps build database queries for
SpacePermissions, without interpreting the logic of the spacepermissions
table in multiple DAO's.Deprecated.
since 7.20, see
SpacePermissionQuery which will also be removed.Event sent whenever a space permission is removed.
REST API for adding and removing a space permission.
Event sent when any space permission is saved.
Internal version of the
SpacePermissionSaver; see package-info.java for rationale.Provides mutable operations for SpacePermissions
Class that filters results by the spaces the current user is allowed to see.
A DAO used exclusively by the SpacePermissionsFilter for performance reasons.
This defines the operations granted to a user or a group in a space.
Event sent whenever all space permissions are removed for a group.
Event sent whenever all space permissions are removed for a user.
Event sent whenever all space permissions are removed from a space.
A space permission subject type grants permissions to a user.
Represents a change to space permissions.
Represents a user viewing the space permissions screen of the space admin console.
Required for supporting different denormalised space permission types
Each supported permission requires its own table
Persists space objects.
Deprecated.
since 8.0, use
SpaceService instead.Makes
SpacePropertyService.SpacePropertyFinder instances.Finder for
ContentProperty objects.A REST resource for manipulating space properties.
Provides methods for creating and reading Confluence
JsonSpaceProperty objects attached to
Space objects.Provides methods for validating the create, update and delete methods.
Server implementation of the
SpacePropertyService.Provider which allows interaction with OSGI Exported SpacePropertyServiceProvider
An interface implemented by a class that can provide the space.
Provides the 'space' top level field
Removes a space as a long-running task.
Command which handles
SpaceRemoveEventREST API for
Space management actions that require elevated privileges.REST wrapper for the SpaceService.
Responsible for keeping all required id mappings between the xml ids and the database ids during space restore.
Information about Space Restore job
Service responsible for space restore operations.
Space Restore settings
Listen to space retention policy events and update the index
Deprecated.
since 7.14.0
Deprecated.
since 7.14.0
Service for interacting with the SpaceRetentionPolicy settings
Provides CRUD operations on Spaces.
A finder interface to encapsulate finding content in a particular space
A finder for locating spaces.
Provides methods for validating the create, update and delete methods.
Show the web fragment if the space sidebar is available.
An attempt to remove some of the proliferation of almost-identical space listing queries from Space.hbm.xml.
see the package-info.java for rationale.
This is the soap service that handles all of the 'space' type methods.
Represents the status of a space, such as CURRENT or ARCHIVED.
Deprecated.
since 7.0.1 , use
SpaceProvides the list of the 2 levels of web-sections/web-items to display in the Space Tools tabs
Compound key which includes space id and sid id
Used by denormalised space permission tables
A base class for space trash events that relate to a singular content in the space trash.
Represents when the trash is emptied, either by a user or by a remote administration call.
This event gets fired when the empty trash action is executed to "purge all" content in a space trash.
This event gets fired when a specific content is purged from the space trash via the purge trash item action.
This event gets fired when a specific content is restored from the space trash via the restore trash item action.
Represents a user viewing the trash contents screen of the space admin console.
Represents a type of space, such as GLOBAL or PERSONAL.
Extracts and indexes the
SpaceType of
the space given searchable object belongs to.Listing of the triggers for various space update events
Generates links to Confluence spaces
Event published when a space is about to be removed, but has not been removed.
Spanish language analyzer provider
v2 primitive query
Represents a split time associated with a timer.
Manager to help with copying files and getting statistics or reporting on sizes.
Determines the phase we're in.
This class is helping
SplitIndexUpgradeTask to manipulate snapshots from Shared HomeDoes 2 things:
Updates the journalentry table to move items from main_index to change_index if they are:
DELETE_CHANGE_DOCUMENTS
DELETE_CHANGE_DOCUMENTS
ADD_CHANGE_DOCUMENT
REBUILD_CHANGE_DOCUMENTS
writes the most recent id from the main_index journal to the change_index journal so that the change_index
will continue at the same item as the main_index as the will already have copied
the relevant changes to the new index.
LobType that spools data when getting and setting lob data types.
The Spring bean definitions for the ActiveObjects Confluence SPI Plugin.
Servlet that defers all its execution to a Spring-bean.
Renderer component factory that looks the component up in the application Spring context.
This configuration enables the use of
Scheduled annotations
on Confluence core Spring beans, and configures a TaskScheduler to go with it.Contains methods for creating/removing triggers for content table
Contains methods for creating/removing triggers for content_perm table
Contains methods for creating/removing triggers for content_perm_set table
Contains operations required for MS SQL database objects creation
The hibernate Dialect that's used for SQL Server.
Deprecated.
since 8.0.0
Determines whether the SQL Server setup (isolation level_ is correct.
Contains methods for creating/removing triggers for spaces table
Contains methods for creating/removing triggers for spacepermissions table
Indicate that a test class should be run against a Confluence instance over SSL
Defines the contractual obligation of a component which provides the ability to manage a staging index
which can potentially be used as a primary index.
Defines the contractual obligation of a staging index.
Exception that is thrown when you attempt to make a change to a Versioned object that is inconsistent with its version
history, for example modifying something other than its current version.
Provides OpenSearch analyzer for
StandardAnalyzerDescriptor.Standard
AuditResource types to be used in Confluence audit events.Allows OS built-in language analyzer to be used.
An interface representing the standard attributes supported by almost all HTML tags.
A standard token filter.
A standard tokenizer based on unicode segmentation standard.
Triggers the dump of all threads stack traces to the logs if the application hasn't started up within a given time.
This class extends the ObjectInputStream class and overrides the resolveClass method.
Reads objects from a storage and returns instances of ImportedObjectV2.
Implementation of StashObjectsReader that reads data from the file where each object is stored in the format:
4 bytes: object length (N)
N bytes: object itself
When the end of stash is reached, the stash is closed and the file is removed automatically.
Serialises and deserializes instances of ImportedObjectV2 to the byte arrays.
Writes ImportedObjectV2 objects to a storage.
Implementation of StashObjectsWriter that stores data to the file where each object is stored in the format:
4 bytes: object length (N)
N bytes: object itself
Contains the information about the denormalised service state change
Provides static access to the enrichment stack, this is provided to allow our
rest doc to generate accurate examples
Makes static calls to Struts then ServletContextThreadLocal to retrieve the relevant objects for the current HTTP request.
Action that statically renders the specified Velocity template via
VelocityHelperService.getRenderedTemplate(String, java.util.Map)Returns the static web resources URL prefix as a string.
Responsible for collecting statistics about backup/restore jobs, plus updating the db records (without affecting the performance).
Allows to create statistic collector factory.
Deprecated.
Since 5.9.1
Responsible for converting status text into displayable HTML.
Marshals the specified object to a StAX stream.
Provides stemmer override token filter
Provides stemmer token filter
An exception to indicate that we should stop batch processing
Provides stopwords token filter
Responsible for cleaning supplied XML content into a form that is balanced and free of any insecure markup.
A description of a rule that was applied during the cleaning of content.
The complete results of a clean up operation.
Provides facilities for extracting and rewriting storage format content that contains
UserKeys as components
of UserResourceIdentifiers.Represents the results of the content rewrite operation.
Checks to see if the 'link.openInNewWindow' dark feature is enabled, and if it is not, then it removes any stray
target attributes for storage.
Extend the EditorImageAttributeParser to handle some additional attributes that are found in storage format.
Manages the actual loading and storing of content and space properties stored in CustomContentEntityObjects.
Converts the divs uses by the old format into shiny new Page Layouts Two objects.
Marshall a LinkBody to storage format.
An interface to logic that parses macro data, extracting the correct form of the body.
A factory for producing macro-related macro storage format
FragmentTransformers.Parses XHTML containing ac:macro elements and their parameters.
Marshals a
MacroDefinition into macro v2 storage format.Parses XHTML containing ac:structured-macro elements and their parameters.
XML constants for storing
PageLayouts.Handle a link body that is expected to contain only HTML encoded character data.
A link body unmarshaller that will handle any 'rich-text' style link bodies.
Marshals
UserResourceIdentifiers to storage format.Validates storage XHTML.
Deprecated.
since 8.6.
Represents some data that may be streamed out to a writer.
Macro that consumes and produces Streamables instead of Strings.
Adapter for the
StreamableMacro interface that provides a default implementation of the redundant
execute method.Convenience class for common operations to construct or convert
Streamable instances.Stream based ZIP extractor
Compresses a data stream into a zip archive.
Writer that writes to given StringBuilder.
A Field handler for a string content property field alias.
Deprecated.
since 8.6.
Field mapping for keywords or non analyzed text.
A CreateContextProvider which returns a context based on a supplied query string.
Strips daisydiff specific attributes from document.
CONFDEV-6604 A DiffPostProcessor that removes any empty span elements from the document, since these are invalid html and make
IE8 fail to render the page correctly.
A DiffPostProcessor that will return a document containing only the blocks of content that are either containing a diff or are
context for a diff.
Deprecated, for removal: This API element is subject to removal in a future version.
since 9.3, use
MappedAction instead.A plugin module from which a Struts ConfigurationProvider is constructed, it can provide actions and results to add
to Confluence's web UI layer.
An event listener which responds to
XWorkStateChangeEvents and invokes reload() on the ConfigurationManager.Deprecated, for removal: This API element is subject to removal in a future version.
since 9.4, use
StrutsHelper instead.A
String that can be styled.Listens for events that denote a change to the stylesheet, and ensures people start loading new CSS
A data class representing a sub clause within a query designed to easy traversal a query tree.
Model object for
PermissionsResource,
representing a grant or revoke of a single permission for a user, group, or anonymous.Though SubjectType.USER and SubjectType.GROUP are singleton, do NOT assume you can compare an arbitrary SubjectType
with one of those via an equality (==) check.
Represents the available Expansions when dealing with a Map<SubjectType, PageResponse<Subject>>
A
NewCommentDeduplicator which uses a submission token, represented by a UUID,
to determine if a new submitted comment is a duplicate of any existing comments.Allow us to break a single ProgressMeter to several ProgressMeter.
Represent a Subscription ID
A specification interface how we want to subscribe
This event is triggered when websudo authentication fails
during an attempt to gain administrative access
This event is triggered when websudo authentication fails
during an attempt to gain administrative access due to the client IP not being in the allowlist.
This event is triggered when websudo authentication succeeds
during an attempt to gain administrative access
This event is triggered when administrator access is dropped
Summarise storage format XHTML making it suitable for display where a short summary of the content is required.
Originally from org.apache.nutch.searcher.Summary v 0.7 (Revision: 179640)
An ellipsis fragment within a summary.
A fragment of text within a summary.
A highlighted fragment of text within a summary.
ScoreFunction which sums composed functions and constants.
Eventlistener to invalidate the plugins resource counter when a plugin in the super batch is modified in any way.
Represents the set of superbatch web resources required for rendering a
FormattedBody.Holds the string representable of the expandable fields of
SuperBatchWebResources.Builder for
SuperBatchWebResourcesHelper to build a
SupportHealthStatusEvent fired when the create support zip is called.
Builds a zip of important files for use in a support request.
An annotation indicating that this model object should be enriched when
being serialized.
An annotation indicating that this model object should be enriched when
being serialized.
Swedish language analyzer provider
Sessions created by this factory always have cacheMode set to
CacheMode.IGNORE
when SessionCacheModeThreadLocal is set to CacheMode.IGNOREA Hibernate integration hook, responsible for creating
SwitchableCachingSessionFactory objects.Manages transaction synchronizations: a list of actions to be done when
the transaction completes on the current thread.
Allows to force the synchronous dispatch of given events.
Provides a flag to tell the front end if it should display an error banner
for when Synchrony is down but Collaborative Editing is turned ON.
Helper which will expose Synchrony configuration status into Confluence core
Measures connectivity to synchrony instance/cluster
REST resource to execute data eviction functionality.
Synchrony uses DBMS as a persistent storage.
Builds
SynchronyDatasetSize objects.Represents each possible Synchrony environmental variable, and optionally a default value.
Responsible for synchrony environment setup
Since 7.12.3
Deprecated.
since 7.17.0
Find and remove content from synchrony tables.
The event representing eviction procedure.
A state of the single eviction procedure.
The component that is being called back during the eviction.
Type of eviction search
The type of eviction procedure.
Bootstraps the Synchrony process after plugin startup.
Locks a set of pages and flushes all caches related to those pages.
Provides methods for monitoring the Synchrony service, whether managed by Confluence or external.
Deletes synchrony.pid file as it's not used by Confluence anymore.
Responsible for creating new synchrony process
Since 7.12.3
Responsible for starting up, stopping, or restarting the Synchrony process
Utility class used for manipulating Synchrony's properties
Monitor the running state of the internal Synchrony Proxy
Triggered when collaborative editing requires some extra steps to put confluence and synchrony back in sync.
A handler for rejected tasks that logs a message and throws a
RejectedExecutionException.Encapsulates the size of synchrony tables.
Deprecated.
since 7.17.0
Service that caches the result of the SynchronyStatusCheckJob to
check if Synchrony is running or not.
A job that checks the Synchrony Status and saves it in a cache for later consumption.
Published when the SynchronyStatusCheckJob finds that Synchrony is down without user action.
Published when Synchrony was down but has come back up.
Returns the status of Synchrony.
Event listener used to wait for a particular directory's sync event
Builds a syndication feed (Atom or RSS) from a search query.
Condition that restricts access to users with system administrator permission.
Loads a web resource based on whether the user is a system administrator.
A service for retrieving information about the platforms supported by Confluence.
This class does little more than write the information which is contained on the 500 page to a log file.
Bean holding simple System information.
Deprecated.
Takes the Confluence system information and represents it as various ordered maps of key-value pairs.
A service for retrieving information about the system.
Interface representing tasks to be performed by the
SystemMaintenanceTaskQueue.Marshal a
SystemMaintenanceTask into a string and vice versaA queue containing
SystemMaintenanceTasks.Scheduled job that periodically flushes entries in the system_maintenance journal.
Hold the mapping between
SystemMaintenanceTask and SystemMaintenanceTaskRunnerRun a
SystemMaintenanceTask.Types of
SystemMaintenanceTasks.Handles permission checks for operations deem to have an effect on the system and hence require sys admin perrmissions
Deprecated.
since 7.20 use
RestoreSystemPropertiesSet the system property before the test and then clear it later
Walks through known ServiceLoader interfaces, and ensures that the implementations available from the system bundle
are loaded before any other OSGi bundles might load.
Get system settings
Deprecated, for removal: This API element is subject to removal in a future version.
since 8.6
Defines an Action that has a related tab in a list of navigation tabs.
Validates table and field names for illegal characters.
It contains info about the field name having a foreign key to another table.
Represents a comparison between the "actual" and "expected" representations of a database table schema
An XMLEventTransformer that will ensure that table, th and td elements have the Confluence classes
removed.
An XMLEventTransformer that will ensure that table, th and td elements have the necessary Confluence classes
appended to allow them to be styled for display.
Deprecated.
Since 5.9.1
Callback to receive tags and their positions
Deprecated.
Since 5.9.1
The target for an operation permissions check.
A target for a container being used to check operations on a different target type within it.
A light weight target that only contain id of the object.
A target that points to a single model object, e.g.
Proxy factory bean that extends
TransactionProxyFactoryBean to use the class loader that the class of the
target object was loaded from.Note that if this is used to verify permissions for drafts the delegate will verify permissions on the version the draft points to.
The type of object subject to an operation, for permissions checks.
Returns true if the target user has the "can use confluence" permission.
Returns true if the target user has a personal space.
Returns true if the target user is a valid user.
Job runner responsible for flushing the queue with the name specified.
Wraps
AbstractErrorQueuedTaskQueue to expose its more interesting statistics via JMX.Helper class to centrally handle the creation of temporary directories
Processes templates.
Deprecated, for removal: This API element is subject to removal in a future version.
since 8.6
Handles i18n in
PageTemplates.Represents a user viewing the page template listview action.
Generic interface for rendering templates where the templating engine may be provided by a plugin.
Module descriptor for plugin modules that provide a TemplateRenderer implementation for a particular templating
language
Exception thrown when some error occured while trying to render a particular template.
Deprecated.
since 7.0.1 , use
ContentLabelServiceCreated with IntelliJ IDEA.
Provides working directories for the plugin manager in a temp directory specifically created for this manager
instance.
Ensures all jobs with cron-based triggers are rescheduled in the tenant's timezone.
Ensures that our current tenant or future tenant jobs have their jobs prodded into the correct timezone by
TenantAwareJobRescheduler.
Deprecated, for removal: This API element is subject to removal in a future version.
since 8.6
Lucene filter that finds documents that match a particular
Term.Cluster event that requires to cancel the job on other nodes (if they are found).
v2 primitive query
v2 primitive query
This query represents the underlying TermsQuery (built into Confluence at the moment), which doesn't calculate score
and acts merely as a filter.
A copy from
org.apache.lucene.search.join.JoinUtil.TermsQuery.Helper class to generate test data for bulk action tests.
Deprecated.
since 7.20 no replacement
Deprecated.
since 7.20 no replacement
Print timing information for JUnit4 tests.
Logs timings around all tests run.
When fragment has style attribute with legacy color, it will be transformed to design token color
A Field handler for a text content property field alias.
Class wraps another {code}XmlEventReader{code} to extract text from the XML that has been read.
Deprecated.
since 8.6.
Field mapping for analyzed text.
Represents a raw query from the user that may be parsed.
A mapper for
TextFieldQuerys.A multi text field query that searches across a range of text fields for the query string
This query represents a text search on a Lucene field.
Fired when a new theme is selected, either globally or for an individual space.
Used for rendering theme stylesheets which are Velocity templates.
Context object placed in the HttpServletRequest attributes that the theme manager can use to determine what the
'context' of the current request might be.
Interceptor to put information in the Http Request object that can be used by the themeing subsystem to determine
which theme to apply to the request.
A utility class for examining the servlet request and setiing up the
ThemeContext.Defines operations for retrieving theme keys from a data store.
Gets and sets global and space themes.
Represents a custom stylesheet or javascript associated with a theme.
It is thrown when another space backup/restore operation is in progress or in the queue.
Condition that checks if threaded comments is allowed in global settings.
Job responsible for sending analytics events for the thread limiter.
Interface for the thread limiter analytics service.
Class responsible for collecting and sending analytics which will be used by the thread limiter analytics service.
Event used for thread limiter statistics.
A generic cache for "stuff" that is only needed for the lifetime of a web request or scheduled job.
A type-safe way of accessing the threadlocal cache
Filter that sets up and destroys the per-web-request generic threadlocal cache.
A TransactionSynchronization which can clean up ThreadLocal data after it is finish
Allows the enabling and disabling of indexing for the current executing thread.
A thread local, resettable hash map
Provides a mechanism to register thread-local interceptors for arbitrary method calls.
This implementation relies on a
ThreadLocal to keep track of embeddable images.Wrapper around the
ThreadLocalCache to deal with caching space permissions and application access.Wrapper around the ThreadLocalCache to deal with caching user profilepictures
Wrapper around the
ThreadLocalCache to deal with caching read-only access.Allows the enabling and disabling of scheduler for the current executing thread.
Deprecated, for removal: This API element is subject to removal in a future version.
since 8.6
Serves date formats from thread local storage to avoid synchronisation.
Implements recording of webresource dependencies via a thread local mechanism.
Just propagates the exception thrown in fragment transformation as a runtime exception.
Callback for a Transaction that supports throwing exceptions.
Callback for a Transaction that supports throwing exceptions.
TransactionTemplate that supports throwing checked exceptions.
Responsible for setting the height and width of thumbnails appropriately and generating the HTML
for rendering them in a page.
Exposes internal implementation details of
ThumbnailManager.Removes thumbnails when an attachment is removed or updated.
Retrieves or constructs
ThumbnailInfo objects for a list of
image Attachments, and determines the maximum height and width of the
thumbnails and images so that the rendered columns and rows can be sized
appropriately.Deprecated.
since 7.14 unused
Event fired every time an attachment's thumbnail is viewed.
Transforming model for <time> element.
Provides a singleton
TimedAnalytics instance that's available even before the application has loaded anything,
and then wire it to Atlassian Analytics plugin when the latter becomes available.Used in cluster jobs and defines job behaviour when cluster synchronisation lock is timed out
Deprecated.
Since 5.4.
Returns the time in the unit specified.
An event with a timestamp, most likely implemented by a subclass of
ApplicationEvent.Represents an instance of an valid time zone, wrapping a
TimeZone.An
EventPublisher implementation that times how long it takes to publish an event,
and logs a warning if the time is above a threshold.Block Runner that ensures we're generating basic timing logging as we run.
Log test timing info while running Spring wired tests.
Action that the TinyUrlServlet redirects to, as we want to do (testable) things
with permissions and page availability.
Provides tiny urls.
Returns the page with the given space key and title.
Listens for
ConfluenceEntityUpdated events that represent changes in the display title.Responsible for extracting titles for various entities.
Order search results by title
Servlet filter that blocks all requests, should be used in combination with implementation of
something like:
An interceptor to handle token based authentication and login/logout.
Manages tokens used to authenticate users for Confluence's remote API.
A token filter must be predefined in Confluence.
A tokenizer must be predefined in Confluence.
A simple map with a timeout on the get/put methods.
Reads the Tomcat configuration.
Determines whether the Tomcat max HTTP Threads configuration is correct.
It is thrown when fast permissions can't process the request due to too many sids (for MSSQL and Oracle only).
Collector that groups edges by target, and aggregates all the scores for each edge against that target.
Represents an event sent by
TopicEventPublisherRepresents a view of the Confluence cluster as used by
TopicEventPublisher.A mechanism for publishing arbitrary application events to all Confluence nodes in the cluster, and providing a way
to block until all nodes have acknowledged republishing the event.
Represents that a user has modified content, regardless of whether that change has been reverted.
This class encapsulates all the logic required to maintain touch relations in the correct state.
Deprecated, for removal: This API element is subject to removal in a future version.
since 8.8, no replacement
A
BandanaPersister implementation that adds Transactional annotations.A cache factory that produces transactional caches.
A helper which ensures that any thread-bound transactional caches (as managed by
TransactionalCacheFactory)
are properly cleaned up and not allowed to pollute subsequent usages of the same thread.A servlet filter which ensures that any thread-bound transactional caches (as managed by
TransactionalCacheFactory)
are properly cleaned up and not allowed to pollute subsequent usages of the same request thread.AN implementation of
UnfilteredCrowdService which exists solely as a place to hang Transactional
annotations on, since we cannot add them to UnfilteredCrowdService.Transactional version of the AbstractHibernateAttachmentDao, which removes the Attachment data
as the Attachment itself is being removed, since it can be rolled back by the transaction
Adds extra transaction control features from the underlying product.
Transaction permission
Transaction propagation, equivalent to the corresponding values of javax.ejb.TransactionAttributeType
A
PluginLoader implementation that adds Transactional annotations.An implementation of
WikiStyleRenderer that exists purely as a place to hang Transactional
annotations on.A hamcrest
Matcher for Spring TransactionAttribute objects.A subset of the
Cache interface that contains those operations that support transactional isolation.Allows that wrapping of
TransactionCallbacks so that they may
occur in a separate context (e.g.Provides utility methods for creating Transaction objects, emulating hibernate v2 behaviour.
The
TransactionRetryInterceptorConfig.transactionRetryInterceptor() can be used to intercept transactional methods which may fail due to an
optimistic locking failure or similar.Wraps all the
SingleFetcher and
ManyFetcher methods in a
transaction template, so that we ensure all results are returned in (at least) the same read only
transaction.A class that provides
DateFormats used to format and parse dates when transforming between Confluence formats (such as editor and storage formats).The base class for all exceptions arising from XHTML transformation.
Parses one format and outputs as another.
Takes an ordered list of transfomers and runs each of them serially, passing the transformation output of one
transformer as input into the next.
Transforms erroneous fragment into an error placeholder which can be displayed in the editor and on view.
Returns true if the specified macro is not a user macro.
Deprecated.
since 8.0.0
This transform will occur dynamically when the translation is requested.
Event fired when there is a change in i18n translation transform state
Status of a soft removal job
Provide status of current soft removal job.
Set trash date for imported content after a space/site import
Indicates that the implementation represents a trashed event.
Run a hard removal job for trash
Operations on the Trash
DMZ operations on trash; see the package-info.java for rationale.
Listen to trash removal events and update current statistics accordingly
Summarise the result of a trash removal job
Delete trashed entities per trash retention rules set out in
GlobalRetentionPolicy or SpaceRetentionPolicy
Entities can be deleted gradually in batches (soft removal) or all at once (hard removal)Hold trash removal statistics
Hold trash removal statistics for global and space scopes
Hold statistics for a running trash removal job
Apply current trash retention rules to a list of trashed entities
Run a soft removal job for trash
Sorts collections that represent trees.
List of supported trigger events.
A node-local event indicating that a specific scheduled job should be resumed.
Deprecated.
since 5.10, use
JobConfigModuleDescriptor insteadSimple velocity directive for trimming whitespace from the rendered body.
Data Access interface for TrustedApplication data.
A trusted application restriction type that uses the source IP address.
A trusted application restriction type that uses the target url.
Deprecated, for removal: This API element is subject to removal in a future version.
since 7.0.1 will be removed in 9.0
Deprecated, for removal: This API element is subject to removal in a future version.
since 7.0.1 will be removed in 9.0
A token for trusted communications between Atlassian applications
A factory for generating trusted tokens
Turns fast permissions on for all customers.
Descriptor for an analyzer that uses a 2-gram tokenizer
Creates an Analyzer which use
TwoGramAnalyzerProvider as the tokenizerCreates an ngram tokenizer with min and max gram equal to 2
Predicate to check if the given object is an instance of one of the given types.
Tokenizer is like the standard tokenizer except that it recognises URLs and email addresses as single tokens.
JVM Cache that can be cleared without blocking.
Provides a pattern capture token filter to split tokens on underscore.
Filter all unicode whitespace to normal space
Write out an image tag for an Unidentified Attachment placeholder to an xmlStreamWriter.
Removes documents with the specified content type from the change index
Removes documents with the specified content type from the content index
Task to unindex a space in the change index.
Task to unindex a space in the content index.
Add a unique constraint if not exist.
Thrown if an unknown feature is referenced.
Deprecated.
since 7.0.1 , use
UnknownUserImplementation of
User which represents a user that no longer exists, perhaps because the repository which
contains it is no longer accessible, or the user has been removed from an external repository.Schedules unmanaged jobs on
ApplicationStartedEvent.Responsible for unmarshalling an XML fragment.
A
FragmentTransformer that transforms by unmarshalling and then re-marshalling the fragment.This macro will render it's body using the V2 Renderer.
This macro will render it's body using the V2 Renderer.
A
ResourceIdentifier used for usernames that cannot be resolved to existing users.Provides an OpenSearch analyzer for
UnstemmedAnalyzerDescriptor for the current language.Exception thrown by
OperationCheck methods.Extracts and indexes an untokenized title for sorting.
An exception indicating that there was a problem moving the storage of attachments.
A listener interested in page and blog post move events which will ensure any attachments associated with a page/blog
post being moved are also moved to the new location.
Indicates that the implementation represents an update event.
Updates the label information in the change index whenever a label has been associated or disassociated with a piece of content.
Responsible for updating space information (such as space key and space names in the change index) when a
page is moved to a different space.
Action for updating a user macro
A simple class that tracks an occurrence of an Upgrade Event during startup.
Finalization result
Information with the execution of upgrade finalization and its outcome
Specifies the contract for errors related to the running of a Finalization
UpgradeTaskEncapsulates Finalization Upgrade task information related to a Zero Downtime Upgrade.
Encapsulates errors related to the running of a Finalization
UpgradeTaskThis event is published when a Confluence upgrade has completed successfully.
Gate the upgrade progress across nodes so that only one node will perform plugin dependent upgrades.
UpgradeManager is responsible for creating a list of UpgradeTasks.
This event is published when a Confluence upgrade has started.
Upgrade task.
Deprecated.
since 3.5.9 Use
HibernateDdlExecutor and associated DdlCommands, or HibernateConfig if your code
still needs to know which DB type its using.Resource wrapper for uploaded files.
A builder which can construct URLs by adding parameters.
A Marshaller specifically used in handling links for
UrlResourceIdentifier.
URL based identifier.
Contains url utility methods.
Confluence usage information gathered from a few simple database queries.
Simple POJO class which use to store cached data
Deprecated.
since 7.0.1 , use
UserContain the binding logic to check 3AF for new annotations
Deprecated.
since 6.10.0.
This interface will be deprecated and removed in a future release once alternatives are made available.
DMZ version of the
UserAccessor interface; see the package-info.java for rationale.Represents an action made available to a user.
Represents "Users > testguy > Edit" in "Dashboard > Administration > Users > testguy > Edit"
Utility class for UserAgents sniffing.
Deprecated, for removal: This API element is subject to removal in a future version.
since 8.9 because it's very inefficient on Lucene, and is not supported on OpenSearch.
Indicates that the action has a user set against it.
Grabs the user from the action and determines whether the user is valid and the logged-in
user has permission to view the action.
This condition will return true if a user had permission to create a personal space
It will return false, if the user is null.
Object to query to manage user content
Event sent when a user is created in Confluence.
This is an object that represents a create user request (for JSON request unmarshalling).
Listens for user credential update events
Event sent when a user is made inactive in Confluence.
Details of a User to be created
Represents the details of a user that can be updated.
Retrieves extra details about a user
Holds a map of dynamic parameters for user fields used to store extended properties.
Service for checking connection state and latency of user directories.
An upgrade task to encrypt plaintext user directory passwords that have been previously
configured.
Interface for events that can be a direct result of an action by a user, such as creating or removing a page.
Interface for events that can be a direct result of an action by a user, such as creating or removing a page.
Add email property to ConfluenceUserImpl entity
The entity that represents a user.
Responsible for expanding some optional properties of a
UserEntity.REST entity to hold a list of users, specifically space admins.
Abstract event for all user creation, deletion, activation and deactivation events in confluence.
Static examples of user and group model objects for the rest api documentation
Returns true if the user has the target user's personal space favourited
A GraphQL provider for additional fields on Person or User objects.
Represents a User form from the UI.
Validation logic for all User forms.
Represents a JSON model for an incremental synchronisation status event.
Parent class for all Json model for all user management sync API
Returns true if the user has a personal space.
Convenience class to to provide utlity methods for Velocity templates.
Contains all the information about a user's history:
The X most recent pages viewed
The X most recently used labels
X being defined by
UserHistory.maxHistoryLength.Provides methods for retrieving and processing
UserHistory objects.I18N bean factory which will return an I18N bean configured for the
current user's locale.
Creates/indexes PersonalInformation as users are added or have their activation status modified.
SearchQuery for user info.
Represents the current state of the various toggle-able parts of the user interface for
this user.
Marks a test covering User Journey scenario
User key
This is a default transformer which will be used in export.
Supply new instance UserKeyExtractorFragmentTransformer everytime is is called
A Hibernate 5
IdentifierGenerator which generates UserKey objects.Converter class that converts strings in the request to the correct UserKey types.
Deprecated, for removal: This API element is subject to removal in a future version.
since 9.3, use
UserKeyTypeConverter instead.A Hibernate 5
UserType which allows UserKey objects to be persisted
as mapped properties.Beans wishing to have a user locale sensitive
I18NBeanFactory
should implement this interfaceBean post processor responsible for injecting an
I18NBeanFactory for any
beans served by spring that implements UserLocaleAware.Returns true if the user is not anonymous (i.e.
A condition to check whether user can change their password in Confluence
Loads a web resource based when user is logged in.
Servlet filter that adds the currently logged in user to the Log4J Mapped Diagnostic Context
Utility class which exposes user search by username/userkey as a function.
Super class for updating the user macro library and the action for viewing the library
This event is fired when user macro is added/updated
Defines a user macro.
A library of user defined macros, stored in and retrieved from Bandana on request.
An Xhtml MacroManager implementation that delegates to an encapsulated UserMacroLibrary.
Serves metadata for user macros managed by the
UserMacroLibrary.Allows simple macros to be defined inline
A MacroManager responsible for keeping track of user macros loaded via the plugin subsystem.
This event is fired when user macro is removed
Interface for User Management incremental sync service
Default implementation of IncrementalSyncService for User Management
User Management Incremental Sync base model
Base class for user management related events.
Thrown when adding a user fails due to unknown reasons
Helper class for handling tasks related to reindexing content containing user mentions.
The interface defines the mechanism for extracting mentions from a storage format.
A class that represents a username.
Adds the current remote user as a header (X-AUSERNAME) to the response.
A special pagination support class to translate results of membership search to user objects.
This path converter requests for a username to either their personal space (if they have one and the
viewer has permission) or their user profile.
Class for checking operations on users.
Renders the user popup boxes that appear when you hover over a user link.
Read-representation of a
BucketPropertySetItem, as returned by a
{link UserPreferencesDao}.Each key can only have one value, irrespective of the type of the value.
Deprecated.
since 8.8 no replacement
Provides operations to access a user's preferences.
UserPreferences implementation backed by a UserPreferencesDao.An implementation of
ResourcePrefetcher for UserResourceIdentifiers.Rather than use something like
InternalUserDao.findByNames(long, Collection)
to perform bulk load and pre-caching we define a more narrow interface that returns only the user count, rather than the
user collection.An event indicating that user prefetch was attempted.
Breadcrumb for actions extending AbstractUserProfileAction.
Deprecated, for removal: This API element is subject to removal in a future version.
since 8.8
Event sent when a user is made active in Confluence.
Listens for user removal events.
Event sent once a user has been removed in Confluence.
Analytics event fired when a user is removed
Event sent when a user is removed in Confluence.
Analytics event fired when a user is removed
This event is similar to
UsersDeletedEvent but it will be fired before user is deletedA Command which handles
UserRemovingEvent in different scenarios:
Removing a canonical user who exists in only one directory.
Removing a canonical user in one directory un-shadows another user another directory.
Removing a shadowed user in one directory.
User management features missing from core Confluence today.
Non-admin user operations
Until
LongTaskSubmission is converted to rest v2, we have this to allow us
to serialize one.Search for users.
Builder for a
UserSearchRequest.Searches for users, either by properties on the user, or by membership of groups.
Searches for users using the
CrowdService.This entity represents a group of users.
Returns a user entity builder.
JSON Serialiser for a UserWithoutEmail object
Deprecated.
since 7.6.0, use confluence-notifications-api instead
Command to process Space restore finish event for user management
A message that represents space restore finish event for user management.
Represents a JSON model for space restore finish event for user management.
This provides rest URLs to get Admin only user data from the system.
The state of a user.
Searches for text within common user-related text fields: full name, email address and username
Makes sure the current user is always in the AuthenticatedUserThreadLocal at the beginning of a request, and is cleared
at the end.
A builder for GraphQLObjectType objects for api
Person objects.An event will be fired when user update
Generates links to Confluence users
Represents a verification token issued to a user or potential user.
Provides "secure token" services that can be assigned to users and later verified.
Represents the types of secure tokens that can be issued to users for security purposes
Returns true if the user has a watch specifically on the current page.
Returns true if the user is watching the current space.
Returns true if the user is watching content in the space for a particular type - e.g.
A wrapper macro that retains compatibility with our old V2 macros.
Predicate class that encapsulates the logic of determining whether a particular module descriptor should be accepted
as a v2 compatibility module descriptor.
Responsible for wrapping a string containing a wiki macro declaration (say "{foo}bar{foo}") inside an XHTML wiki markup macro.
An adapter class to allow XHTML user macros (i.e.
Used when
AttachmentV3toV4MigrationAction runs a migration used to send analytics if V4 migration is disabledUsed when
AttachmentV3toV4MigrationAction starts a migration.Deprecated, for removal: This API element is subject to removal in a future version.
since 8.6
A
RelationDescriptor which provides a method to perform validation on descriptor operations.Registry for mapping
RelationDescriptor to a corresponding
ValidatingRelationDescriptor.This class is basically an
Either where left represents fail and right represents success.Represents a single validation error within a
ValidationResult.Used to deserialise validation errors.
A checked exception thrown when there is an XML validation error.
Stores the results after an API Service validateX() method is called.
Matchers to support tests on
ValidationResults.This class was copied from the atlassian-util-vcache library,
The methods are direct copies from this library at version 1.1.3
A Spring
FactoryBean which creates a VCacheFactory suitable for use by Confluence.An implementation of
CacheFlusher which flushes VCache instances.A Servlet
Filter which ensures that a VCache request context is setup for each
request, and also logs the cache metrics.An implementation of
VCacheRequestContextOperations which provides a simple interface to client code.Defines essential Velocity beans.
A module descriptor to add items to the Velocity contexts used everywhere.
A provider of items for a Velocity context
Shim class to allow various
PageBuilderService and WebResourceUrlProvider methods to be accessed from
Velocity, which does not have the luxury of being able to pass in enum constants.A template renderer shim with an interface suitable for use from VelocityTemplates.
Renders Velocity resources - intended for i18n only, not dynamic Velocity content.
Defines any additional beans constructed primarily for use in
VelocityContextItemProvider's.Defines all
VelocityContextItemProvider beans and therewith constructs the ContextItemProviderChain.Simple SUCCESS returning action with associated template path and exploit string to be
used for Anti-XSS setting testing.
A Velocity-safe Sitemesh
HTMLPage implementation that also implements DecoratablePage.Deprecated, for removal: This API element is subject to removal in a future version.
since 9.1 use
VelocitySitemeshPageRenders Velocity resources - intended for i18n only, not dynamic Velocity content.
Utility class for use in Velocity templates.
Deprecated, for removal: This API element is subject to removal in a future version.
since 8.6 for removal in 9.0 Use
VelocityHelperServiceRepresents the version of a piece of
Content.Creates
Version instances.This enum dictates the policies used when saving children for CEOs and CCEOs in regard to the version of the parent they belong to
Appends the version comment of a ContentEntityObject to its searchable text.
Value transfer object for the results of hibernate query 'confluence.content_findEditContributors'.
A Confluence object that can exist in multiple versions.
Creates
Version instances from hibernate objects.Factory create a VersionFinder for ContentVersionService
A record of an upgrade performed on Confluence.
A Dao for VersionHistory.
That bit of a ContentEntityObject relevant to a version history
Represents a collaborator and the version history of a piece of content they have worked on.
Exception thrown when a user tries to save a page (or other content object) that has been
modified by somebody else.
Comparator that attempts to place software version numbers (i.e.
Extracts and indexes content version
Version Restore requires a few parameters, these parameters are used by ContentVersionService.restore() method.
Constructs a version specific link to Confluence's documentation.
DocumentationBeanFactory which returns VersionSpecificDocumentationBeans for the Confluence instance.
Encapsulates all the extra marshalling concerns of a link to attachment for the view context.
Action to support viewing the changes index queue
Action to support viewing the content index queue
In the Editor, if you are working on a new page then the context object is the Draft for this page.
Indicates that the implementation represents a view event.
Wraps another EmbeddedImageTagWriter and ensures that a title attribute is written if required.
Marshal an emoticon for display.
Action used by the follow tab
Transforms headings ({@code <h1>..<h2>) tags in the storage format into the view format which ads an id to the tag
so that it may be used in Table of contents or other references.<p>
Deprecated.
since 7.9 because Confluence now has multiple index queues.
Only display the link if the user is viewing content (pages or blogs) but *only* viewing it - not editing, viewing
info, attachments, etc.
A condition to check whether you are currently viewing your own profile or
not.
Action for viewing a label.
This event is fired when admin visits license details page.
Marshals link bodies for view.
A factory specifically for creating Marshaller involved in the view rendering of Links.
A
MarshallerMetricsAccumulationKey for use by the various view link marshallers.A factory for creating the Marshallers required by the ResourceIdentifier specific "higher level" link marshallers.
An interface for a component that can render an error message when a failure occurs during macro execution.
A factory specifically for creating Marshaller for MacroDefinitions involved in the view rendering of Links.
Wrapper Macro into div element if fragment contains more than 1 level xml elements otherwise update class and add attributes to root element.
getMailQueue() returns an ErrorQueuedTaskQueue.
Allow a user to view there personal labels.
Cloned from
com.atlassian.confluence.user.actions.ViewMyLabelsAction in confluence-coreAction to view the logged in user's preferences (homepage, timezone, and language).
View and update the license key for this Confluence installation
Renders the placeholder for templates, but for pages / blogs nothing rendered for a placeholder.
extend super class so we can set cookie
Gets the job history for a specific job.
Action for the View System Classpath page
When tables are displayed they should be wrapped in a div.
An action to list the trusted applications.
Writes out placeholder images for an unidentified images in view mode.
Display a provided MacroDefinition as an 'unknown macro' (in view).
Encapsulates the logic on how to marshal the delegate / wrapped link inside an
UnresolvedLink.Used by the activity tab
An analytics event which is sent when method
BulkPermissionService.getVisibleChildPages(ConfluenceUser, Set, boolean) is called.This filters a list of label objects, returning those labels from the list that the specified user
should see.
An analytics event which is sent when method
BulkPermissionService.getAllVisiblePagesInSpace(ConfluenceUser, long) is called.An analytics event which is sent when method
BulkPermissionService.getVisibleTopLevelPages(ConfluenceUser, long) is called.Deprecated, for removal: This API element is subject to removal in a future version.
since 8.6
API service for managing content watchers.
Provides methods for validating the permissions to watch / unwatch space / content / labels.
Check that the web app context path is set properly
Rest wrapper for the WebViewService.
An object that produces a WebInterfaceContext for rendering web fragments.
When rendering web fragments, this context is used for retrieval of Confluence content information.
A model object representing a web link in Confluence content as opposed to a Confluence resource link.
Represents a menu in the Confluence web interface.
Represents a section in a Confluence menu in the web interface.
Context map provider for information from the WebResourceManager and its kin.
A model for web resources that a
FormattedBody's various ContentRepresentation might require to render properly on the client.Holds the string representable of the expandable fields of
WebResourceDependencies.Builder for
WebResourceDependenciesFactory for
WebResourceDependencies, containing logic for calculating expansions.Records the usages of various web resources when they are rendered.
Holds the various resources that are recorded from
WebResourceDependenciesRecorder.recordResources(Callable).Delegate to
Router to dispatch web resource requestAn interface for building the uris and tags for web resource expansions.
Enforces a WebSudo session for actions annotated by
WebSudoRequired.This class allows to check if the client's IP address is in the IP allowlist for websudo action
Manages the WebSudo related access to Request, Response and Session objects and provides a method to determine
if an XWork action should be treated as a WebSudo resource (
WebSudoManager.matches(String, Class, java.lang.reflect.Method).Message used to feedback to the user of an open websudo session
Exception thrown when a user needs a websudo session before a RPC method can be used.
WeightedPluginModuleTracker<M,D extends com.atlassian.plugin.ModuleDescriptor<M> & com.atlassian.plugin.web.api.descriptors.WeightedDescriptor>
Tracks module descriptors in sorted order, based on their weights.
Creates
NotificationData instances for new users.A service to retrieve the welcome message
An implementation of
AccessManager SPI which is then used by OutboundWhitelist
This class then plays a role in filtering outbound URLs.Provides an OpenSearch analyzer for
WhitespaceAnalyzerDescriptor.The whitespace tokenizer breaks text into terms whenever it encounters a whitespace character.
Implementation allows to export all the records from the table.
A Differ implementation that will inspect the
BodyType of the content being diff'd and convert
any wiki content to HTML prior to diffing using the supplied DaisyHtmlDiffer delegate.A resource identifier representing just the raw data of the link to preserve links which could not be resolved.
Source that provides batches of
ContentEntityObjects that require migration.SOAP API for wikimarkup formatted input and output.
Convert a wiki formatted String into Confluence Editor format HTML.
Defines operations for converting wiki format to storage format.
The data required to request conversion of wiki data to XHTML.
Convert all wiki formatted content to XHTML content as part of the upgrade.
Convert wiki formatted text to the XHTML format used for storage from Confluence 4.0.
Resource that will accept wiki content and return its XHTML equivalent.
This class is typically the basis for upgrade or migration tasks that need to manipulate a large amount of content.
A highlight formatter that wraps the term with two strings, before and after.
A base Query class for custom Query subclasses, especially in plugins, so that they can be handled properly during
term extraction in highlight scoring.
An interface for managers that support reading and writing of downloadable resources.
Convert between XHtml and wiki markup.
An implementation of the XslTransformer interface which will perform transforms using the Xalan Transformer.
Handles conversion of camelCase links to XHTML links during migration.
Deprecated.
since 5.1.4 See
StorageFormatCleaner and RenderedContentCleaner instead.Deprecated.
since 5.1.4 See
StorageFormatCleaner instead.Deprecated.
since 5.1.4 See
StorageFormatCleaner instead.A Hibernate interceptor that will silently cleanup security issues with XHTML content on saving to the database.
Provides methods that manipulate XHTML storage format content, convert between view and storage formats or from
old style wiki markup to storage format.
Migrate images and convert any other embedded types to the multimedia macro.
A migration renderer component that will convert emoticon's in wiki format to the new Xhtml storage format.
An entity resolver for XHTML entities which will read the entities from the classpath (not the web) and is suitable
for use in both STaX and SAX based parsing of XHTML.
An event sent when a
XhtmlTimeoutException occurs when rendering a fragment.Updates all canonical links in an XHTML document to reflect a modified space key or title or both.
An event sent when a
XhtmlTimeoutException occurs when rendering a Macro.Converts wiki link text to xhtml link objects for migration.
You should note that this implementation of the OutgoingLinksExtractor is actually a 'reference' extractor.
Scans storage format content and extracts any resource identifiers found within.
Migrate content to the current storage format using a simple storage to storage fragment transformer.
Processes XHTML templates.
Helper to make it easier to convert between the storage format and different types of
variables.
Renders wiki markup template variables as XHTML template variables.
A checked exception indicating that an Xhtml Conversion has exceeded its allocated time limit.
A visitor is used to capture XML events that occur during a parse of
an XHTML document.
A Migrator that accepts storage format XHTML and will attempt to convert any instances of
unmigrated-wiki-markup macros found to be direct storage XHTML format and therefore
replacing the unmigrated-wiki-markup block.
An XslTransformer that expects to transform XHTML input documents and will be automatically configured to resolve
XHTML entities (without going out to the W3C site).
A Cyberneko filter to cope with a common mistake made by plugin developers in Confluence.
This class is used to create a zip container with XML formatted backup files.
Reads content properties index schema from a XML document.
An entity resolver will read the entity definitions from the classpath (not the web) and is suitable
for use in both STaX and SAX based parsing of XHTML.
This exists to provide a 'safe' way to access , without it there may be weird classloader issues.
Factory to create event readers over different types of Confluence XML (namely editor and storage XML).
Converts XMLEvent to the instance of the special class Node required for duplicate tag processing.
Deprecated.
since 7.14 Replaced by
com.atlassian.confluence.impl.importexport.SpaceBackupExporterExposes the events of the body of a fragment, but does not include any events for the start and end tags of the fragment.
Exposes the events of the body of a fragment including the start and end element of the fragment.
Deprecated.
since 7.17.0.
XMLNodeSkipper receives an iterator of xmlEvents with the first element an XML startEvent,
this node and all child nodes are skipped by advancing the iterator past the corresponding
endEvent.
This was introduced mainly because
XMLOutputFactory is an abstract class :(An interface for the XmlOutputFactoryProvider.
Deprecated.
since 7.20 no replacement
Validates XML.
A DiffPostProcessor that will apply a configured XSL stylesheet to the Document.
Transform email content by applying an XSL transform to it.
Implemented by a component that can apply an XSL transform to provided XML input.
Resolves a
TransformerFactory which can be used for XSLT processing and parsing.Enforces XSRF token checks for protected actions.
Global result for an xsrf token timeout.
Service for generating and validating XSRF tokens for any given request.
Defines global XSRF token validation rules.
Unfortunately XStream's implementation has broken compatibility with new converters post 1.1.1
This class provides backward compatibility to XML format from XStream version 1.1.1
XStream Bandana serializer implementation.
Implementation of
BandanaSerializerFactory which returns XStream
based serializers.Deprecated.
since 7.10.0 Use ConfluenceXStreamManager's bean(DefaultConfluenceXStreamManager) instead
Configures allow-list security framework.
Module Descriptor to allow plugins to provide multiple options to configure security allow types in XStream.
Confluence event to control XStream resets when a plugin with xstream security goes through lifecycle phases.
Deprecated.
since 8.7.0
An event to indicate a Struts runtime configuration reload is required.
Helps push API level Service
ValidationResult values into
MessageHolders.Cluster event triggered when ZDU state has changed i.e.
This is a publicly available component used by the ZDU plugin
Local event triggered when ZDU state has changed to enable.
POJO for returning ZDU state
These do not map one to one to ZDU states, they just provide enough information for
Confluence to interact with the ZDU Plugin
Values of this type are stored in the DB via ZduStatusEntity
Dao for storing state related to Zero Downtime Upgrades
State of Zero Downtime Upgrades
Zip compression/decompression implementation of
DataCompressor.Manager for obtaining the HttpClient interceptors required for handling Zipkin communications.
Filter for using Brave for using Zipkin to trace requests.
Copied from Fisheye com.cenqua.fisheye.util.Zipper
User: pkamal
Date: Oct 16, 2009
Time: 1:46:08 PM
To change this template use File | Settings | File Templates.
Callback that allows to transform/exchange the file to be added to the zip file.