All Classes and Interfaces
Class
Description
Base class for implementations of
AuthConfiguratorBuilder
Factory class that creates AWS clients based on
AbstractAwsProfile
s.Holds the basic information required by all AWS connections.
Base class for configuration mappers that map to
AbstractAwsProfile
s.Base class for all implementations of
BlobStore
Internal class used when loading the configuration
Base class for all
VersionProvider
that use filesRoot exception for any
Exception
that wants to be localized.Root runtime exception for any
Exception
that wants to be localized.Simple interface to interact with Jongo/MongoDB.
Changes MongoException in to MongoRepositoryException (which is a checked exception).As well if Command result is not ok (CommandResult#isOk) return false a exception will be thrown the message for that exception will be CommandResult#getErrorMessage.
Some of the find and insert methods use a template queryName. this means that the string can contain placeholders ('#') this will allow the user to have predefine json strings that will be substitute with the given params.Params are not Name therefor if the same value is needed multiple times for now it has to be send multiple times.Order of the params should match the same in the json string.
Changes MongoException in to MongoRepositoryException (which is a checked exception).As well if Command result is not ok (CommandResult#isOk) return false a exception will be thrown the message for that exception will be CommandResult#getErrorMessage.
Some of the find and insert methods use a template queryName. this means that the string can contain placeholders ('#') this will allow the user to have predefine json strings that will be substitute with the given params.Params are not Name therefor if the same value is needed multiple times for now it has to be send multiple times.Order of the params should match the same in the json string.
Base class for Permission Annotation Handlers.
Base
RemoteFileStore
for stores that are aware of configuration profiles that should be used to connect
to the remote store.Base class for configuration mappers that read configuration profiles and map them to profile classes.
Base class for all Crafter REST clients.
GitAuthenticationConfigurator
that configures the TransportCommand
to use SSH, but without providing
any authentication functionality.Base
Validator
implementation for String validation.Base class for all
UpgradeManager
implementationsBase class for all
UpgradeOperation
implementations that provides access to system resources
Supported YAML properties:
currentVersion: (required) the version number that will be upgraded
nextVersion (required) the version number to use after the upgrade
Base class for all
VersionProvider
implementationsAbstract implementation of
KeyBasedLockFactory
that uses a WeakHashMap
to store the locks.Thrown when the execution of an action on an object has been denied to a subject.
Filter to add headers to all responses
Implementation of
TextEncryptor
that uses AES as it's cipher algorithm and
Base 64 to encode raw bytes.Implementation of
EnumerablePropertySource
where a source is an Apache Commons Configuration 2 Configuration
.Wraps an instance of
ApplicationContext
and provides simple access to beans for Groovy & FreemarkerHolds the metadata of a single asset
Audit Constants.
Ebus Listener to create the Audit entries.
Defines the minimum attributes needed in a generic audit entry.
Audit Reaper Service. this class is meant to be run periodically.
Defines Basic Audit Service.
Builder class for
GitAuthenticationConfigurator
objectsUtility class used to create
AuthConfiguratorBuilder
objectsConstants for git authentication types
Implementation of
BlobStore
for AWS S3Provides utility methods for AWS services
Deprecated.
A
Base64.InputStream
will read data from another
java.io.InputStream
, given in the constructor,
and encode/decode to/from Base64 notation on the fly.A
Base64.OutputStream
will write data to another
java.io.OutputStream
, given in the constructor,
and encode/decode to/from Base64 notation on the fly.Class that provides the basic
ExceptionHandler
s for Crafter REST services.GitAuthenticationConfigurator
that uses basic username/password authentication.Spring factory bean that creates a list of beans based on a list of bean names.
Holds the reference to a file in a blob store
Defines the operations to handle blob files
Exception thrown when the blob store configuration is not found
Base Exception for all blob store specific errors
Exception thrown when a blob store id found in the configuration is not found in the application context
Provides access to all known implementations of
BlobStore
Default implementation of
BlobStoreResolver
Defines operations for blob file urls
Default implementation of
BlobUrlResolver
Deprecated.
Represents a general callback that can be used almost in any method that needs this pattern.
Filter to provide support for AWS Cloudfront specific request headers.
Represents a permission that is a collection of other permissions.
Simple Spring factory bean that only returns an actual bean if the specified flag is true.
Exception thrown by classes that handle configuration.
Interface for classes that map configuration data to Java bean classes.
Represents a collection of configuration properties that are commonly used together, for example, to open a
connection or accessing a server.
Generic interfaces for classes that provide a way to load specific configuration profiles.
Exception thrown by classes that handle configuration if the profile Id does not exist
Defines the operations to access configuration files
Provides access to configuration files taking into account the active environment
Default implementation of
ConfigurationResolver
Utility methods for Apache Commons based configuration.
Holds the information of a single contact
Converts objects of S type to T type.
Utility class to create and delete cookies with common domain, path and max age.
All available editions of CrafterCMS
Extends
FreeMarkerView
to support rendering variables in Spring 6Extends
FreeMarkerView
to support rendering variables in Spring 6Extends JacksonAnnotationIntrospector so it will always a filter (so @JsonFilter) annotation is not needed.
General error thrown when a crypto related error occurs.
Utility methods for encryption/decryption and message digest.
Extended
ObjectMapper
that lets you provide your own
serializers/deserializers.Exception thrown when there's an error while parsing a date.
Defines the operations to validate a database.
Implementation of
Lookup
that decrypts the variable.Default Implementation of
DbIntegrityValidator
.Default Implementation of
EntitlementValidator
.Default
Permission
that uses a set of allowed actions to
check if a subject is allowed to perform a specific action.Default implementation of
UpgradePipelineFactory
Default implementation for
UpgradePipeline
.Holds all metadata about the developers
Extension of
Constructor
to disable any class from being loadedMongo exception thrown when a document can't be inserted because there's already a document with the same key.
Represents an email (possibly with from, to, body, etc., depending of the implementation).
Thrown when an email address in wrong format is encountered.
Thrown when an email can't be sent for some reason.
Factory for creating
Email
s.Default implementation of
EmailFactory
.Default implementation of
Email
, which uses Spring Mail to send a message.Thrown when an email message couldn't be prepared properly.
Thrown when an email couldn't be sent for some reason.
Utility methods for email related stuff.
Base class that loads configuration files handling encrypted properties
Main class that allows encryption/decryption of data using AES with PBK.
Holds the value for a given entitlement type.
Exception thrown when the validation of an entitlement fails.
Base class for all entitlement related errors.
Holds the available entitlements when requesting an entitlement validation.
Defines the operations to support entitlement usage data in a module.
Defines the operations to perform entitlement validations.
Parameters annotated with
EsapiValidatedParam
will be validated by
EsapiValidator
using the
specified type.Supported ESAPI validator "types".
StringValidator
extension that validates the parameter value
against ESAPI
validator(), using the annotation 'type' property.Exclude (Suppress) the Annotated field from been process it will be ignore.
Grid Fs File Information
General file manipulation utilities.
Implementation of
CorsConfigurationSource
that setup and returns a single instanceImplementation of
PublishingTargetResolver
that always returns the configured targetRemotePathParser
that uses a fixed store type and the complete path string to build the
RemotePath
.Extension of
ForwardedHeaderFilter
that can be disabled via configurationA Gdata like property filter (aka selector) gets the information from .
Utility class that configures a Git connection based on an authentication strategy.
Common operations related to git
Spring
FactoryBean
used to create Guava caches as beans.Annotations that applications can use to indicate that a certain method or all methods of a class require
permission checking.
Aspect that handles
HasPermission
annotations,
by doing appropriate permission checking.ResponseErrorHandler
that converts the body of a response with error status
code using HttpMessageConverter
s, and then throws a
RestServiceException
with the deserialized response body as the errorDetails
.Writes the response using a
HttpMessageConverter
chosen depending on
the acceptable media types from the request (most of the code is just a copy from Spring's
AbstractMessageConverterMethodProcessor
).Utility methods for HTTP related stuff.
Localized logger, which wraps an slf4j logger.
MethodLogger
using I10n logging.Utility class for localization stuff.
Holds the data required to install a plugin in a configuration file
Represents an XML attribute
Represents an XML element
Exception thrown when monitoring API is called with invalid authorization token
Utility methods for
Iterable
.Utility methods for Jackson.
Creates a Jongo singleton for application wide use.
Holds a Map of all the register MongoQueries.
Factory for getting locks that can be used for concurrent thread synchronization based on keys.
Holds the data about a single link
BeanFactoryPostProcessor
that allows to add additional elements to a list property value of an already
defined bean.Utility class for handling locale codes
Annotation used to indicate that a method (or all methods of a class, if used in a class) should be logged.
Aspect that uses a
MethodLogger
to log methods with
Logged
annotation (or all methods of a class, if used in a class).REST client request interceptor that logs the whole request and response.
Utility methods for maps.
Holds all data about assets for a plugin
Holds basic JVM memory.
Utility for logging a method entry/exit.
ConfigurationException
thrown when a specific configuration property or sub-configuration is missing.Holds the available modules when requesting an entitlement validation.
Creates a Mongo Client based on a connection String
FactoryBean
that besides creating a MongoClient
from a Mongo URI,
closes the client when it's destroyed.Spring helper for Create a MongoClient
Checked Exception to wrap around MongoException.
Utility class for running Mongo scripts in JS.
Base controller for all monitoring related APIs
Implementation of
GitAuthenticationConfigurator
that doesn't perform any actionTextEncryptor
that does not actually encrypt or decrypt the text at all.Custom Jackson deserializer for
ObjectId
s, which deserializes a String as an ObjectId by
creating the ObjectId through ObjectId(String)
.Custom Jackson serializer for
ObjectId
s, which serializes an ObjectId as a String by
calling ObjectId.toString()
.Holds the information for a parameter
Possible types for the parameters
RemotePathParser
that builds ProfileAwareRemotePath
s based on the parts of the given path,
returned by the groups of the regex matcher.Wrapper for
AesTextEncryptor
that generates the encryption key based
on a password and salt.Represents a permission that allows or denies a subject (a user, an application, etc.) the execution of an action
or set of actions on a resource.
Evaluates or checks permissions.
Default implementation of
PermissionEvaluator
RuntimeException
version of PermissionException
.Resolves the permissions for a particular type of subjects and resources.
Utility class to perform encryption and decryption using PGP keys.
Holds the metadata for a plugin
Holds all the metadata for a plugin
Parses a
PluginDescriptor
from various sourcesDefault implementation of
PluginDescriptorReader
that parses YAML files.Exception related to plugin descriptors
All available plugin types for Crafter CNS
Extension of
RemotePath
that adds the concept of a remote configuration profile to the path.Used in a method parameter to indicate the resource or main ID of the resource to be protected.
Base for protected resources that provide already attached permissions.
Used in a method parameter to indicate an ID (of several) of the resource to be protected.
Provides access to the current publishing target
Extension of Spring's
Resource
that provides random access to the content.UrlResource
extension that implements RangeAwareResource
in order to provide
random access to content (range content queries).Utility methods for regex related operations.
Represents a file stored remotely.
Resolves special paths to files in remote stores.
Default implementation of
RemoteFileResolver
.Interface for "proxies" to remote file stores.
Represents the path of a remote file.
Internal helper interface that parses a matched remote path.
Holds the current HTTP servlet request and response.
Binds a new request context to the current thread before the chain is called, and then removes it after the chain
is called.
Implementation of
RemoteFile
that basically is facade to a Spring Resource
.Extension of
GenericApplicationContext
that only allows access to beans in the site config whitelistException thrown when an error is received from a REST service.
Utility methods for RESTful services.
Simple extension of
RestTemplate
that adds the following custom
functionality:
Forces the use of HttpComponentsClientHttpRequestFactory
,
to avoid issues with 40x responses.
HttpMessageConvertingResponseErrorHandler
is used by default.
Very simple class that can be returned by REST API methods to indicate a result with a message, generally for success.
AbstractAwsClientCachingFactory
for S3 async clients.AbstractAwsClientCachingFactory
for S3 clients.A
RemoteFileStore
to S3.Holds the information to connect to AWS S3.
Configuration mapper for
S3Profile
s.Implementation of
Resource
for S3 files.Utility methods for S3.
Implementation of
FactoryBean
for SandboxInterceptor
All available search engines for CrafterCMS
Spring factory bean used to easily inject a secret key from a
SecretKeyRepository
.Repository for storing/retrieving encryption keys.
Default implementation of
SecretKeyRepository
, which uses JCE Key Store.Check if this property will be serialize depending of the result of
SecurePropertyHandler.suppressProperty(Object, String[])
Defines how the SecureProperty Should be handel.
RuntimeException
version of SecurityException
.Utilities for the
Set
collection.Deprecated.
Utility class for simplifying encryption/decryption with the
Cipher
class.Utility class for simplifying message digest generation, using the
MessageDigest
.Represents a sort field-order pair.
Validates a
SortField
object.Elements annotated with
SqlSort
will be validated by SqlSortValidator
.Validates that a String is a list of "column order(optional)" pairs, where column
is one of the allowed values in columns parameter.
GitAuthenticationConfigurator
that configures the TransportCommand
to use SSH with username/password
authentication.GitAuthenticationConfigurator
that configures the TransportCommand
to use SSH with private key
authentication.Extension of
SshSessionFactory
to use a given private key for SSH authenticationExtension of
SshdSessionFactory
that overrides the default SSH configurationExtension of
UsernamePasswordCredentialsProvider
to use in SSH authenticationGets current basic JVM status
Converts String to Boolean.
Converts String to Date, with a custom pattern and time zone.
Converts String to Double.
Converts String to Float.
Converts String to Integer.
Converts String to Long.
Converts String to Short.
Simple dummy converter that just returns a String value.
Thrown to indicate that the current subject couldn't be found.
Resolves the current subject to be used for permission checking.
Thread-safe service that facilitates easy encryption and decryption of text.
Implementation of
AbstractAuthConfiguratorBuilder
that creates GitAuthenticationConfigurator
objects
based on a given authentication type.Exception thrown when an invalid module or entitlement is requested during a validation.
Created by alfonsovasquez on 13/6/16.
Implementation of
UpgradeOperation
that updates the current version for
the given targetProvides the configuration for an upgrade process
Holds all data related to a given upgrade process.
Base class for all exceptions related to the upgrade process.
Manages the current version and applies the required upgrades
Extension of
UpgradeException
thrown when the current version of a target can't be upgraded automatically.Defines the basic operations for a single upgrade
Groups any number of
UpgradeOperation
instancesBuilds an
UpgradePipeline
with all the required operationsImplementation of
AbstractAuthConfiguratorBuilder
that creates GitAuthenticationConfigurator
objects
based on the scheme of a given URLSimple
RemoteFileStore
where the paths are basically URLs from where
the files can be accessed.Utility methods for paths and URLs.
Exception thrown when validation fails.
Basic interface for exceptions that contain a
ValidationResult
Runtime exception thrown when validation fails.
Holds the data about a version
Get's current version information about:
1.
Provides the current version of a specific target
Actual implementation of
AbstractWeakKeyBasedLockFactory
that uses ReentrantLock
s.Implementation of
RemoteFileStore
for WebDAVHolds the necessary information to connect to a WebDAV server.
Configuration mapper for
WebDavProfile
s.Implementation of
Resource
for WebDAVUtility methods for WebDAV
Implementation of Apache Commons HierarchicalConfiguration that parses a YAML configuration file and loads
the configuration in memory for easy access.
UpgradeConfigurationProvider
implementation that loads a YAML configuration file.Implementation of
VersionProvider
that handles YAML filesUtility for zipping files.
PluginDescriptor