All Classes and Interfaces
Class
Description
Base class for
AssetProcessors.Base class for all audit authentication listeners
Provides common profile operations used by all services.
Base class for all services that access user information
Base implementation of
UpgradeOperation for all content-type related upgradesBase implementation of
UpgradeOperation for all site content upgradesImplementation of
FileVisitor that collects files matching any of the given patternsBase abstract class for
Deployers.Provides access to system components for all upgrade operations.
Base implementation of
UpgradeOperation for all operations related
to an XSLT template.Holds the access token information for a user
Implementation of
AbstractPreAuthenticatedProcessingFilter to support token authenticationListener for Spring's
AuthenticationSuccessEvent that generates an access token for the userController that handles the refresh of the tokens
Defines all operations related to access and refresh tokens
Default implementation of
AccessTokenServiceDefines all operations related to access and refresh tokens
Default implementation of
AccessTokenServiceInternalRepresents a content action that needs to be validated
Annotation used by
SitePolicyAspect to detect the content-type for an actionAnnotation used by
SitePolicyAspect to detect the source filename for an actionAnnotation used by
SitePolicyAspect to detect the source path for an actionAnnotation used by
SitePolicyAspect to detect the target filename for an actionAnnotation used by
SitePolicyAspect to detect the target path for an actionImplementation of
UpgradeOperation that adds a new file to
a repository.Implementation of
AuthenticationEntryPoint that returns a JSON object matching Studio's API specsRepresents the response of an API operation.
Represents an asset that can be processed (image, pdf, Word document, etc.)
Reads the configuration from an input stream or a Apache Commons Configuration object and maps it to actual asset processing
configuration objects like
ProcessorPipelineConfiguration and ProcessorConfiguration.Default implementation for
AssetProcessingConfigReader.Exception thrown when a asset processing configuration related error occurs.
General exception used by classes related to asset processing.
Service to run an asset through processor pipelines.
Default implementation of
AssetProcessingService.Processes an asset (input) and returns the transformed asset or a new asset (output).
Represents a pipeline of
AssetProcessors.Default implementation of
AssetProcessorPipeline.Resolves a
AssetProcessorPipeline based on configuration.Default implementation of
AssetProcessorPipelineResolver.Resolves a
AssetProcessor based on configuration.Default implementation for
AssetProcessorResolver.Listener for Spring's login that records events using Studio's audit service
Listener for Spring's logout that records events using Studio's audit service
Audit Service
Listener for Spring session destroyed event to record session timeout
Represents a
User that has been authenticated.Base exception for authentication operations.
Contains the different type of authentications that Studio can handle.
Exception thrown when an error occurs while transcoding a video.
Rest controller for AWS MediaConvert
Service that provides access to AWS MediaConvert.
Default implementation of
AwsMediaConvertServiceRest controller for AWS S3 service.
Service that provides access to AWS S3.
Default implementation of
AwsS3Service.A base class of content processor
Implementation of
UpgradeOperation that updates multiple files using
an XSLT template.Implementation of
ContentRepository, ContentRepository
that delegates calls to a StudioBlobStore when appropriateException thrown when a blob pointer exists in the repository
but the actual asset does not exist in the blob store.
Blob store configuration details.
Exception to be thrown when a write operation is attempted on a
blob store configured in read-only mode.
Implementation of
UpgradeOperation that syncs the blueprints in the
global repository from the bootstrap repo.Implementation of
VersionProvider for the built-in blueprints.Event used to mark the end of the bootstrap process
Central point to control the event-based bootstrap process.
Implementation of
UpgradeOperation to update item descriptors that use the Box File Upload controlDefines the operations available for handling files in Box
Base interface for events that should be broadcast to the WS clients
Utility class to configure a
CacheControl instanceDefines the operations for cache invalidation
A search service that is aware of
TooManyNestedClausesSearchException
and will retry failing queries with a lower number of max expansions.Event used to trigger repositories cleanup on startup
Event used to trigger temporary files cleanup on startup
Defines all clipboard related operations
Default implementation of
ClipboardServiceDefines all clipboard related operations
Default implementation of
ClipboardServiceInternalComposite
Deployer that calls CompositeDeployer.createTargets(String) and CompositeDeployer.deleteTargets(String)
in multiple Deployers.Exception that wraps multiple exceptions
GitCliOutputExceptionResolver that uses a list of other resolvers
to determine which exception to throw.Implementation of
PermissionResolver that resolves user permissions based on Studio's
SecurityService.Extension of
BasicAuthenticationFilter that can be disabledImplementation of
CacheInvalidator that only performs the invalidation if the key matches a patternImplementation of
AbstractContentUpgradeOperation that upgrades encrypted properties in configuration files.Holds the data about a configuration update during a plugin installation
Custom constraint annotation to validate that a string does not exceed a maximum size,
while allowing to configure the maximum value via Studio configuration.
Custom validator for the
ConfigurableMax annotation.Event triggered when a configuration file is changed
Exception thrown when there's an error while reading a configuration.
Service that helps access different Studio configuration.
Internal implementation of
ConfigurationService.Extension of
PrototypeUpgradePipelineFactoryImpl for configuration files, the name of the pipeline
is build based on the configuration file provided in the upgrade context.Constant values used by the Marketplace API
This class contains content asset information that exists in the repository
content comparater base class
Event triggered when there is a change in one or more content items
util methods for parsing/converting data
This class compares two DmContentItem based on their order values specified
by order name
This class contains content item metadata
used by the UI
Extension of
ServiceLayerException thrown when a user tries to lock an item that is already lockedException thrown when a content move to an invalid location is attempted.
occurs when the content provided does not meet preconditions
Annotation to mark the parameter containing the value of the path
occurs when failed to process content
interface for processing wcm content upon creating or updating the content
Implementation of ContentProcessorPipeline that runs the content give through the pipeline
This interface represents the repository layer of Crafter Studio.
Implementation of
Resource that wraps site contentContent Services that other services may use
Content Services that other services may use
DM Content type configuration
Implementation of
PolicyValidator for content-type aware actionsprovides content type configuration
Defines all operations related to content-types
Default implementation for
ContentTypeServiceHolds all data of items related to a content-type
Manages all
Context objects for sitesDefault implementation of
ContextManagerholds the configuration for copy dependency
Request to create an access token
Holds the information needed to create a site from a Marketplace Blueprint
Holds the parameters for a Create User request
Utility class for DAL related operations.
Service that process requests for Dashboard API
Utility methods for handling dates
Extension of
DaoAuthenticationProvider that returns an instance of AuthenticatedUserImplementation of
DbAuthenticationUserDetailsService that uses Studio's UserDAOImplementation of
UpgradeOperation that upgrades encrypted values in
the database.Implementation of
UpgradeOperation that executes a database script.Implementation of
UserDetailsService that uses Studio's UserDAOImplementation of
VersionProvider for the database.Implementation of
CacheInvalidator that invalidates a single itemExtension of
ContentEvent triggered when content is deleted.holds the configuration for delete dependency
Extension of
AccountStatusException thrown when a deleted user tries to authenticate.Extension of
AccountStatusUserDetailsChecker that checks for deleted users too.Implementation of
UpgradeOperation that deletes files and folders in the
repositoryDiffRequest used for providing info to the Diff Executor
DiffResponse is returned by Diff executor with added and removed dependenices
Resolves dependencies
Dependency Service is the sole custodian of the dependency database
and provide the interface to add, sync, delete and retrieve dependencies
across the system.
Utility class for Dependency related helper methods
Helper/client class for doing Crafter Deployer operations.
Configurations for deployer related beans
// document
General constants for WCM
content operations
contains the dependent file names of the content specified by the URI
DmFolderConfig that specifies how each folder in UI maps to the folder
structure in DM web project
This class represents the sorting order of DM Content Item
Order Service for Navigation Pages
Tag names used by CrafterCMS XML representation of content objects
Holds all the data needed to duplicate an item
Holds the parameters to a duplicate site request
Request body for Deployer API to duplicate a target.
Proxy to AWS Elastic Transcoder (and S3) that enables the creation of transcoder jobs based on a
TranscoderProfiles.Default implementation of
ElasticTranscoder.Service that provides access to the AWS Elastic Transcoder to sites for video transcoding.
Default implementation of
ElasticTranscoderService.ForgotPasswordTaskFactory implementation that creates a task to send
the user a password reset linkHolds the data for encryption
Implementation of
EventListener that broadcasts events to the message brokerController advice that handles exceptions thrown by API 2 REST controllers.
Holds the data for an item that is close to or has already expired
Holds a set of expiring or expired content items
extracts parameters such as file name from the content being processed
Holds the data for a single facet range
Holds the data for a search facet
set the file folder path in params
Holds data for a single file installed from a plugin
Implementation of
PolicyValidator for file size aware actionsImplementation of
UpgradeOperation that replaces text in the content repository.Factory to create a task to handle the forgot password request
Holds the parameters for the getChildrenByPaths request
Holds data for the getChildrenByPath request
Holds data for the getSandboxItemsByPath request
Holds the data returned by the getSandboxItemsByPath operation
Allows doing Git operations throw the CLI.
Root exception for the Git CLI.
Thrown when the Git CLI exits with a non-zero value.
Parses the output of the CLI to determine the
GitCliOutputException
that should be thrownCreated by Sumer Jabri
Created by Sumer Jabri on 12/6/16.
Exception thrown when a Git repository has been locked (a .git/index.lock file was found)
Implementation of
AbstractResource that wraps an ObjectLoader from JGitCommon operations related to git
Marker interface for events that should be broadcast to the global
WS topic.
Implementation of
UpgradeOperation that updates files on the global repository.Contains all items that are deleted.
Annotations that applications can use to indicate that a certain method or all methods of a class
require all permissions from the list.
Aspect that handles
HasAllPermissions annotations,
by doing appropriate permission checking.Annotations that applications can use to indicate that a certain method or all methods of a class
require any permissions from the list.
Aspect that handles
HasAnyPermissions annotations,
by doing appropriate permission checking.Transformer that calls ImageMagick from the command line with the options specified in the parameters.
Exception thrown by image transformation classes.
Perform image transformation from the source path to the target path.
AssetProcessor that uses and ImageTransformer to transform an
the input image.Exception thrown when trying to install an incompatible plugin
Holds the information needed to install a plugin from the Marketplace
Instance Service
Invalidate cache of the content being processed
TODO: currently this is only being used for assets. should refactor the code to use for form contents as well
Exception thrown when an invalid configuration is detected
Exception thrown when there is an error with the parameters received by a controller.
Exception to be thrown when an operation is attempted on a site with an unsupported state
Represents a version of a content item.
Simple interface for performing a task (scheduled or unscheduled)
Event triggered when content is locked or unlocked
Exception thrown when an authentication attempt is rejected because the account is locked.
Log4j implementation for
LoggerService.Annotation to trace execution time of methods.
Handles the
LogExecutionTime annotation.Holds a Logger name and its configured priority level.
Simple extension to
LoggerConfig to allow extra parameters. e.g.: createIfAbsent.REST controller that provides access to Logger related operations.
Exception thrown then trying to retrieve or perform an operation on
a Logger that does not exist.
Provides access to loggers configuration.
Default implementation for
LoggerService.Listener that handles login attempts and adds a delay to the response.
This listener will add a random delay to all login attempts, successful or not.
It will notify the
This listener will add a random delay to all login attempts, successful or not.
It will notify the
LoginAttemptManager of the login attempt result.Keeps track of login success and failures per user.
LoginAttemptManager implementation that keeps track of login failures in memory.Filter in login page before form login
Base class for all controllers that use the management token to protect public urls
REST controller that provides access to Marketplace operations
Base for all Marketplace related exceptions
Exception thrown when the
MarketplaceService is not
initializedExtension of
Plugin that adds properties related to installable pluginsException thrown when there is an issue reading or updating the plugin registry for a site
Provides access to all available Marketplace operations
Default implementation of
MarketplaceService that proxies all request to the configured MarketplaceProvides access to all available Marketplace operations
Default implementation of
MarketplaceServiceInternal that proxies all request to the configured MarketplaceException thrown when the connection with the Marketplace fails
Defines the operations available for AWS MediaConvert.
Default implementation of
MediaConvert.Holds the information about a transcoding job from AWS MediaConvert.
Holds the necessary information to request a transcoding job for AWS MediaConvert.
MediaConvert implementation of
ConfigurationMapper.Holds the data for a triggered MediaConvert job
Deprecated.
Deprecated.
This service has been replaced with
AwsMediaConvertServiceImplRepresents an item that is displayed in a UI menu.
Holds the result of a merge from a remote repository
Implementation of
PolicyValidator for MIME type aware actionsException thrown when a required parameter is not provided for a plugin
Contains a collection of
String representing the model definitions.Rest controller to provide monitoring information
Provides access to log monitoring
Default implementation for
MonitorService.Default internal implementation for
MonitorService.Event triggered when there is a content move change
Implementation of
UpgradeOperation that replaces text in the content repository
according to multiple 'pattern/replacement' rules.Exception thrown when there are no changes found in a commit for a given path.
Exception thrown when a Git commit is attempted but there's nothing to commit.
GitCliOutputExceptionResolver that tries to find a pattern
in the Git output to see if it corresponds to a NoChangesToCommitException.Implementation of
BlobStoreResolver that does nothingNormalized group to deal with case-insensitive while working with roles/permissions mappings
Normalized role to deal with case-insensitive while working with roles/permissions mappings
site notification configuration
Describe the types of notifications available.
New Interface for Workflow Notification Service.
All supported clipboard operations
Utility class that wraps multiple
RegexRequestMatchers with an OrRequestMatcherA paginated
ResultList.Utility class with methods for pagination.
Implementation of
PasswordEncoder using Studio's hashingHolds the data for a single item to be copied/moved
Holds all data needed for a clipboard operation
Implementation of
PolicyValidator for path aware actionsAPI paths used by the Marketplace
Implementation of
CacheInvalidator that invalidates all keys matching a patternBase class for
GitCliOutputExceptionResolvers that want to determine the error produced by a Git command
by finding a special regex pattern in the output.Implementation of
OpenSearchWrapper specific for authoring indexesImplementation of
PermissionResolver that resolves user permissions based on Studio's
SecurityService and content ownership.Implementation of
PermissionResolver that resolves user permissions based on Studio's
SecurityService.Transfer object for containing the Document object for the file in question.
Extension of
AccessToken that holds additional metadataSimplified version of
Userwrapper to content that is being processed through the content processor pipeline
Exception thrown when installing a plugin that already exists in a site
Controller that executes Rest scripts from plugins
Controller that provides the UI with plugin related files
Exception thrown when there is an issue installing a plugin in a site
Exception thrown when a plugin descriptor is not found
Holds the data for an installed plugin
Holds the data of all installed plugins
Extension of
TreeCopier that collects information about the files to be used for the plugin registryValidates changes on content
Default implementation of
PolicyServiceValidates changes on content
Default implementation of
PolicyServiceInternalValidates actions against the given configuration
Implementation of
Deployer that interacts with the
Preview Deployer in Authoring.Provides operations to processed_commits table
Represents the configuration of a processor.
Represents the configuration of an asset processor pipeline.
Extension of
DefaultUpgradePipelineFactoryImpl that creates
instances of pipelines using Spring beans.Controller to proxy request to preview & add the management token if needed
Provides functionality to proxy request to Crafter Engine
Default implementation for
ProxyService.Default internal implementation for
ProxyService.Request to publish all content in a site
Extension of
ServiceLayerException thrown when a site doesn't have a published repositoryEvent triggered when items are published
document
Exception thrown when there is an issue removing a plugin from a site
Implementation of
UpgradeOperation that renames/moves files and
folders in the repository.rendering template
Repository Repair Request
Holds the set of changed files during a publishing operation
Triggers a cleanup for all repositories on all existing sites.
Event triggered when there is a change in the repository of a site
GitCliOutputExceptionResolver that tries to find a pattern
in the Git output to see if it corresponds to a RepositoryLockedExceptionResolver.Clean up git repositories on startup
The RepositoryWatcher is responsible for watching the file system for changes
to registered sites' repositories.
RepositoryWatcher default implementation.Handles the
RequireContentExists annotation.Handles the
RequireSiteExists annotation.RequireSiteState specialization that requires the site state to be 'READY'.Indicates that the annotated method requires the site state to match
the state specified in the annotation value.
Handles the
RequireSiteState annotation.Contains the response body of an API operation.
The result of an API operation.
Keys used for the results in the Rest API.
A
Result where the actual result is a list of entities.A
Result where the actual result is a single entity.Service call result object to be used in javascript API
A special ring buffer implementation that allows unlimited writes
keeping only a preset size of buffer, followed by reading of what
was written in the order it was written ignoring what was overwritten
when writing beyond the preset size.
Holds the data for an S3 item.
Represents metadata of an AWS S3 Upload.
Deprecated.
This service has been replaced with
AwsS3ServiceDeprecated.
This service has been replaced with
AwsS3ServiceImplRegister and de-register sites for repository events.
Holds the
GroovyScriptEngine instances for all sitesDefault implementation of
ScriptEngineManagerDefines all operations related to scripts
Default implementation of
ScriptingServiceDefines all operations related to scripts
Default implementation of
ScriptingServiceInternalController to access the search service
Holds the data for a single facet
Holds the data for a single range in a facet
Holds the data needed to perform a search operation
Holds all the data for a search operation
Holds the data of a single search result
Provides access to OpenSearch for authoring indexes
Default implementation for
SearchServiceInternal implementation of
SearchServiceGeneral constants for accessing user properties.
Rest controller that provides access to security operations
This class provides the repository configuration information
Implementation of ServicesConfigImpl.
Represents a Crafter site from the database.
Reads a configuration profiles file for a specific site and loads a specific
ConfigurationProfile.Base class for all events related to a specific site
Base interface for events that should be broadcast to
a site-specific WS topic.
This class stores Site Configuration
Triggered where a site is deleted
Triggered where a site deletion starts
Site details.
Annotation to mark the parameter containing the value of the site id
Base class for site lifecycle events
Interceptor that validates content actions before executing the actual changes.
Event triggered when there is a change in a site
Implementation of
UpgradePipeline that handles a git repository
to work on a temporary branch for upgrades.Note: consider renaming
A site in Crafter Studio is currently the name for a WEM project being managed.
Note: consider renaming
A site in Crafter Studio is currently the name for a WEM project being managed.
Site-related operations
Extension of
XmlFileVersionProvider that also creates the version file if missing.Event used to trigger all cluster related beans during bootstrap
Event used to trigger all upgrade related beans during bootstrap
Implementation of
SessionInformationExpiredStrategy that only returns an unauthorized status code.Implementation of
FileVisitor that replaces values in the found filesImplementation of
StudioBlobStore for AWS S3ContentRepository extension that provides blob aware operations.Extension of
BlobStore that adds support for Studio content repository operationsBase class for all implementations of
StudioBlobStoreExtension of
BlobStoreResolver that adds site multi-tenancyImplementation of
StudioBlobStoreResolverStudio Constants
This class is an implementation of the CsrfTokenRequestHandler interface.
Interface for running SQL scripts in the Studio database.
Implementation of
EntitlementUsageProvider for Crafter Studio module.ESAPI
DefaultSecurityConfiguration extension to allow overriding
validation regex patterns.Base class for all events
Extension of
MessageSecurityExpressionRoot that adds Studio specific security expressions.Simple POJO to read JSON parameters
Extension of
DefaultMessageSecurityExpressionHandler that allows to integrate Studio security expressionsExtension of
UpgradeContext that holds all relevant information for a system or site upgrade.Extension of
UpgradeManager that adds Studio specific operations.Default implementation for
StudioUpgradeManager.CStudio Xml constants
Implementation of Crafter Commons'
SubjectResolver that returns Crafter Studio's current username
as the Subject.Implementation of
CacheInvalidator that appends a suffix to the keyEvent fired to request a 'sync database from repo'.
Listens to
SyncFromRepoEvent events and performs the sync from repository.Implementation of
PolicyValidator for system restrictionsProvides information about the state of the system.
Extension of
RenameUpgradeOperation that can rename multiple files based on path patternsThis task sets up the temporary files directory for Crafter Studio.
An action that can throw an exception
Transformer that used the Java client of TinyPNG to compress JPEG/PNG images.
Provide different types of transactions to the site
Provide different types of transactions to the site
Represents the metadata of an AWS Elastic Transcoder job.
Holds the information for a specific output a transcoder should generate.
Holds the necessary information to request a transcoding job to the AWS Elastic Transcoder.
ElasticTranscoder implementation of
AbstractAwsProfileMapper.Holds the configuration for translations
Created by Sumer Jabri
Supported types for content actions
Controller that provides the UI elements the current user has access to.
Service that provides the UI elements the current user has access to.
Default implementation of
UiService.Internal version of the
UiService.Default implementation of
UiServiceInternal.Convenience generic decorator that unwraps (this means the result properties will be serialized
as if they were properties of its containing object) the result entity.
Holds the parameters for an Update Group request
Holds the data required to update a site
Includes all data required to update or add user properties
Holds the parameters for an Update User request
General values related to the upgrade process.
Security filter that tracks the user activity in the API
A
UserDetailsChecker that delegates to a list of other UserDetailsChecker instances.Holds the data for a single user property
Represents a
User with only the necessary fields that are required to be sent in the responseEvent fired when a user is updated.
Annotation to mark operations that need to be validated against the site policy configuration
Holds all data for requesting a site policy validation
Base exception for all data validations
Holds the result of a site policy validation
Utility class to perform parameter validations.
a version record
AbstractFactoryBean implementation to configure a WebContentInterceptor instance
to handle paths including etag header.Rest controller for WebDAV service
Exception for all errors related to WebDAV
Holds the basic information about WebDAV resources.
Deprecated.
This service has been replaced by
WebDavServiceDefines the operations available for a WebDAV server.
Deprecated.
This service has been replaced by
WebDavServiceImplDefault implementation of
WebDavService.Spring Websocket Configuration
Spring Security Websocket Configuration
Event triggered when items go through the different workflow states
workflow service implementation
Implementation of
VersionProvider for XML files.Extension of
XmlFileVersionProvider that consumes a XMLEventReader
in order to stop reading the XML once the version tag has been found.This class provides common methods for handling XML
Implementation of
UpgradeOperation that updates a single file using
an XSLT template.Utility class for XSLT related operations
AwsMediaConvertService