Index
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form
A
- AbstractAuthConfiguratorBuilder - Class in org.craftercms.commons.git.utils
-
Base class for implementations of
AuthConfiguratorBuilder
- AbstractAuthConfiguratorBuilder(File) - Constructor for class org.craftercms.commons.git.utils.AbstractAuthConfiguratorBuilder
- AbstractAwsClientCachingFactory<P,
C> - Class in org.craftercms.commons.aws -
Factory class that creates AWS clients based on
AbstractAwsProfile
s. - AbstractAwsClientCachingFactory() - Constructor for class org.craftercms.commons.aws.AbstractAwsClientCachingFactory
- AbstractAwsProfile - Class in org.craftercms.commons.config.profiles.aws
-
Holds the basic information required by all AWS connections.
- AbstractAwsProfile() - Constructor for class org.craftercms.commons.config.profiles.aws.AbstractAwsProfile
- AbstractAwsProfileMapper<T> - Class in org.craftercms.commons.config.profiles.aws
-
Base class for configuration mappers that map to
AbstractAwsProfile
s. - AbstractAwsProfileMapper(String, ConfigurationResolver) - Constructor for class org.craftercms.commons.config.profiles.aws.AbstractAwsProfileMapper
- AbstractBlobStore<T> - Class in org.craftercms.commons.file.blob.impl
-
Base class for all implementations of
BlobStore
- AbstractBlobStore() - Constructor for class org.craftercms.commons.file.blob.impl.AbstractBlobStore
- AbstractBlobStore.Mapping - Class in org.craftercms.commons.file.blob.impl
-
Internal class used when loading the configuration
- AbstractCrafterPropertyFilter - Class in org.craftercms.commons.jackson.mvc
- AbstractCrafterPropertyFilter() - Constructor for class org.craftercms.commons.jackson.mvc.AbstractCrafterPropertyFilter
- AbstractFileVersionProvider<T> - Class in org.craftercms.commons.upgrade.impl.providers
-
Base class for all
VersionProvider
that use files - AbstractFileVersionProvider() - Constructor for class org.craftercms.commons.upgrade.impl.providers.AbstractFileVersionProvider
- AbstractI10nException - Exception Class in org.craftercms.commons.i10n
-
Root exception for any
Exception
that wants to be localized. - AbstractI10nException() - Constructor for exception class org.craftercms.commons.i10n.AbstractI10nException
- AbstractI10nException(String, Object...) - Constructor for exception class org.craftercms.commons.i10n.AbstractI10nException
- AbstractI10nException(String, Throwable, Object...) - Constructor for exception class org.craftercms.commons.i10n.AbstractI10nException
- AbstractI10nException(Throwable) - Constructor for exception class org.craftercms.commons.i10n.AbstractI10nException
- AbstractI10nRuntimeException - Exception Class in org.craftercms.commons.i10n
-
Root runtime exception for any
Exception
that wants to be localized. - AbstractI10nRuntimeException() - Constructor for exception class org.craftercms.commons.i10n.AbstractI10nRuntimeException
- AbstractI10nRuntimeException(String, Object...) - Constructor for exception class org.craftercms.commons.i10n.AbstractI10nRuntimeException
- AbstractI10nRuntimeException(String, Throwable, Object...) - Constructor for exception class org.craftercms.commons.i10n.AbstractI10nRuntimeException
- AbstractI10nRuntimeException(Throwable) - Constructor for exception class org.craftercms.commons.i10n.AbstractI10nRuntimeException
- AbstractJongoRepository<T> - Class in org.craftercms.commons.mongo
-
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. - AbstractJongoRepository() - Constructor for class org.craftercms.commons.mongo.AbstractJongoRepository
- AbstractPermissionAnnotationHandler - Class in org.craftercms.commons.security.permissions.annotations
-
Base class for Permission Annotation Handlers.
- AbstractPermissionAnnotationHandler(Map<Class<?>, PermissionEvaluator<?, ?>>) - Constructor for class org.craftercms.commons.security.permissions.annotations.AbstractPermissionAnnotationHandler
- AbstractProfileAwareRemoteFileStore<T> - Class in org.craftercms.commons.file.stores.impl
-
Base
RemoteFileStore
for stores that are aware of configuration profiles that should be used to connect to the remote store. - AbstractProfileAwareRemoteFileStore(ConfigurationProfileLoader<T>) - Constructor for class org.craftercms.commons.file.stores.impl.AbstractProfileAwareRemoteFileStore
- AbstractProfileConfigMapper<T> - Class in org.craftercms.commons.config.profiles
-
Base class for configuration mappers that read configuration profiles and map them to profile classes.
- AbstractProfileConfigMapper(String, ConfigurationResolver) - Constructor for class org.craftercms.commons.config.profiles.AbstractProfileConfigMapper
- AbstractRestClientBase - Class in org.craftercms.commons.rest
-
Base class for all Crafter REST clients.
- AbstractRestClientBase(String, RestTemplate) - Constructor for class org.craftercms.commons.rest.AbstractRestClientBase
- AbstractSshAuthConfigurator - Class in org.craftercms.commons.git.auth
-
GitAuthenticationConfigurator
that configures theTransportCommand
to use SSH, but without providing any authentication functionality. - AbstractSshAuthConfigurator(File) - Constructor for class org.craftercms.commons.git.auth.AbstractSshAuthConfigurator
- AbstractStringValidator - Class in org.craftercms.commons.validation.validators.impl
-
Base
Validator
implementation for String validation. - AbstractStringValidator() - Constructor for class org.craftercms.commons.validation.validators.impl.AbstractStringValidator
- AbstractStringValidator(List<String>, List<String>, boolean) - Constructor for class org.craftercms.commons.validation.validators.impl.AbstractStringValidator
- AbstractUpgradeManager<T> - Class in org.craftercms.commons.upgrade.impl
-
Base class for all
UpgradeManager
implementations - AbstractUpgradeManager() - Constructor for class org.craftercms.commons.upgrade.impl.AbstractUpgradeManager
- AbstractUpgradeOperation<T> - Class in org.craftercms.commons.upgrade.impl.operations
-
Base 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 - AbstractUpgradeOperation() - Constructor for class org.craftercms.commons.upgrade.impl.operations.AbstractUpgradeOperation
- AbstractVersionProvider<T> - Class in org.craftercms.commons.upgrade.impl.providers
-
Base class for all
VersionProvider
implementations - AbstractVersionProvider() - Constructor for class org.craftercms.commons.upgrade.impl.providers.AbstractVersionProvider
- AbstractWeakKeyBasedLockFactory<L> - Class in org.craftercms.commons.concurrent.locks
-
Abstract implementation of
KeyBasedLockFactory
that uses aWeakHashMap
to store the locks. - AbstractWeakKeyBasedLockFactory() - Constructor for class org.craftercms.commons.concurrent.locks.AbstractWeakKeyBasedLockFactory
- acceptManagementToken() - Element in annotation interface org.craftercms.commons.security.permissions.annotations.HasPermission
-
Indicates if the presence of a valid management token should grant access to the protected resource/action
- accessKey - Variable in class org.craftercms.commons.config.profiles.aws.AbstractAwsProfile
-
The AWS access key (if using static credentials)
- action() - Element in annotation interface org.craftercms.commons.security.permissions.annotations.HasPermission
-
The action the current subject is trying to execute.
- ActionDeniedException - Exception Class in org.craftercms.commons.security.exception
-
Thrown when the execution of an action on an object has been denied to a subject.
- ActionDeniedException(String) - Constructor for exception class org.craftercms.commons.security.exception.ActionDeniedException
- ActionDeniedException(String, Object) - Constructor for exception class org.craftercms.commons.security.exception.ActionDeniedException
- actualLogger - Variable in class org.craftercms.commons.i10n.I10nLogger
- add(Map<String, Object>, String, Object) - Method in class org.craftercms.commons.mongo.UpdateHelper
- add(Map<K, Object>, K, Object) - Static method in class org.craftercms.commons.collections.MapUtils
-
Adds the value under the specified key in the map.
- addCookie(String, String, HttpServletResponse) - Method in class org.craftercms.commons.http.CookieManager
-
Add a new cookie, using the configured domain, path and max age, to the response.
- addError(String, String, Object...) - Method in class org.craftercms.commons.validation.ValidationResult
- addParam(String, String, String, String) - Static method in class org.craftercms.commons.lang.UrlUtils
-
Adds a query string param to the URL, adding a '?'
- addPermission(P) - Method in class org.craftercms.commons.security.permissions.ProtectedResourceBase
- addQueryStringFragment(String, String) - Static method in class org.craftercms.commons.lang.UrlUtils
-
Adds a query string fragment to the URL, adding a '?'
- AddResponseHeaderFilter - Class in org.craftercms.commons.web
-
Filter to add headers to all responses
- AddResponseHeaderFilter(Map<String, String>) - Constructor for class org.craftercms.commons.web.AddResponseHeaderFilter
- addValue(String, Object, MultiValueMap<String, String>) - Static method in class org.craftercms.commons.http.HttpUtils
-
Adds a param value to a params map.
- addValues(String, String[], MultiValueMap<String, String>) - Static method in class org.craftercms.commons.http.HttpUtils
-
Adds an array of param values to a params map.
- addValues(String, Collection<String>, MultiValueMap<String, String>) - Static method in class org.craftercms.commons.http.HttpUtils
-
Adds a collection of param values to a params map.
- AES_CIPHER_ALGORITHM - Static variable in class org.craftercms.commons.crypto.CryptoUtils
- AES_KEY_BYTE_SIZE - Static variable in class org.craftercms.commons.crypto.CryptoUtils
- AesTextEncryptor - Class in org.craftercms.commons.crypto.impl
-
Implementation of
TextEncryptor
that uses AES as it's cipher algorithm and Base 64 to encode raw bytes. - AesTextEncryptor(Key) - Constructor for class org.craftercms.commons.crypto.impl.AesTextEncryptor
- afterPropertiesSet() - Method in class org.craftercms.commons.aws.AbstractAwsClientCachingFactory
- afterPropertiesSet() - Method in class org.craftercms.commons.converters.impl.StringToDateConverter
- afterPropertiesSet() - Method in class org.craftercms.commons.crypto.impl.NoOpTextEncryptor
- afterPropertiesSet() - Method in class org.craftercms.commons.crypto.impl.SecretKeyRepositoryImpl
- afterPropertiesSet() - Method in class org.craftercms.commons.entitlements.validator.impl.DefaultEntitlementValidatorImpl
- afterPropertiesSet() - Method in class org.craftercms.commons.jackson.CustomSerializationObjectMapper
- afterPropertiesSet() - Method in class org.craftercms.commons.mongo.MongoScriptRunner
- afterPropertiesSet() - Method in class org.craftercms.commons.rest.RestTemplate
- ALGORITHM - Static variable in class org.craftercms.commons.crypto.PGPUtils
- alias - Variable in class org.craftercms.commons.jackson.mvc.GDataPropertyFilter
- aliasParsedCache - Variable in class org.craftercms.commons.jackson.mvc.GDataPropertyFilter
- allow(String) - Method in class org.craftercms.commons.security.permissions.DefaultPermission
- allow(String...) - Method in class org.craftercms.commons.security.permissions.DefaultPermission
- allowAny() - Method in class org.craftercms.commons.security.permissions.DefaultPermission
- allowedActions - Variable in class org.craftercms.commons.security.permissions.DefaultPermission
- allowedBeans - Variable in class org.craftercms.commons.spring.context.RestrictedApplicationContext
- allSupportedMediaTypes - Variable in class org.craftercms.commons.rest.HttpMessageConvertingResponseWriter
- ALPHANUMERIC - Enum constant in enum class org.craftercms.commons.validation.annotations.param.EsapiValidationType
- ANY_ACTION - Static variable in class org.craftercms.commons.security.permissions.DefaultPermission
- AopUtils - Class in org.craftercms.commons.aop
- ApacheCommonsConfiguration2PropertySource - Class in org.craftercms.commons.spring
-
Implementation of
EnumerablePropertySource
where a source is an Apache Commons Configuration 2Configuration
. - ApacheCommonsConfiguration2PropertySource(String, Configuration) - Constructor for class org.craftercms.commons.spring.ApacheCommonsConfiguration2PropertySource
- appendLocale(String, Locale) - Static method in class org.craftercms.commons.locale.LocaleUtils
- appendLocales(String, Locale, Locale) - Static method in class org.craftercms.commons.locale.LocaleUtils
- applicationContext - Variable in class org.craftercms.commons.file.blob.impl.BlobStoreResolverImpl
- applicationContext - Variable in class org.craftercms.commons.spring.BeanListFactoryBean
- applicationContext - Variable in class org.craftercms.commons.upgrade.impl.AbstractUpgradeManager
- applicationContext - Variable in class org.craftercms.commons.upgrade.impl.operations.AbstractUpgradeOperation
-
The application context
- applicationContext - Variable in class org.craftercms.commons.upgrade.impl.pipeline.DefaultUpgradePipelineFactoryImpl
-
The application context
- ApplicationContextAccessor - Class in org.craftercms.commons.spring.context
-
Wraps an instance of
ApplicationContext
and provides simple access to beans for Groovy & Freemarker - ApplicationContextAccessor() - Constructor for class org.craftercms.commons.spring.context.ApplicationContextAccessor
- ApplicationContextAccessor(ApplicationContext) - Constructor for class org.craftercms.commons.spring.context.ApplicationContextAccessor
- args - Variable in exception class org.craftercms.commons.i10n.AbstractI10nException
- args - Variable in exception class org.craftercms.commons.i10n.AbstractI10nRuntimeException
- ASC - Enum constant in enum class org.craftercms.commons.rest.parameters.SortField.Order
- asSet(T...) - Static method in class org.craftercms.commons.collections.SetUtils
-
Creates a set from the array elements.
- Asset - Class in org.craftercms.commons.plugin.model
-
Holds the metadata of a single asset
- Asset() - Constructor for class org.craftercms.commons.plugin.model.Asset
- asyncClientFactory - Variable in class org.craftercms.commons.file.blob.impl.s3.AwsS3BlobStore
-
The async client factory
- Attribute() - Constructor for class org.craftercms.commons.plugin.model.Installation.Attribute
- attributes - Variable in class org.craftercms.commons.plugin.model.Installation.Element
- audit(T) - Method in class org.craftercms.commons.audit.AuditService
-
Sets date and persist the Audit in the repository.
- Audit - Class in org.craftercms.commons.audit
-
Audit Constants.
- AUDIT_EVENT - Static variable in class org.craftercms.commons.audit.Audit
-
Name/Key of the Listener Audit event.
- AUDIT_REACTOR - Static variable in class org.craftercms.commons.audit.Audit
-
Name of the AuditReactor Missing required @.
- auditDate - Variable in class org.craftercms.commons.audit.AuditModel
-
Date when the audit was entry.
- AuditListener - Class in org.craftercms.commons.audit
-
Ebus Listener to create the Audit entries.
- AuditListener() - Constructor for class org.craftercms.commons.audit.AuditListener
- AuditModel - Class in org.craftercms.commons.audit
-
Defines the minimum attributes needed in a generic audit entry.
- AuditModel() - Constructor for class org.craftercms.commons.audit.AuditModel
- AuditReaper - Class in org.craftercms.commons.audit
-
Audit Reaper Service. this class is meant to be run periodically.
- AuditReaper() - Constructor for class org.craftercms.commons.audit.AuditReaper
- auditService - Variable in class org.craftercms.commons.audit.AuditReaper
-
Audit Service implementation.
- AuditService<T> - Class in org.craftercms.commons.audit
-
Defines Basic Audit Service.
- AuditService() - Constructor for class org.craftercms.commons.audit.AuditService
- AuthConfiguratorBuilder - Interface in org.craftercms.commons.git.utils
-
Builder class for
GitAuthenticationConfigurator
objects - AuthConfiguratorFactory - Class in org.craftercms.commons.git.utils
-
Utility class used to create
AuthConfiguratorBuilder
objects - AuthConfiguratorFactory(File) - Constructor for class org.craftercms.commons.git.utils.AuthConfiguratorFactory
- AuthenticationType - Interface in org.craftercms.commons.git.utils
-
Constants for git authentication types
- authType - Variable in class org.craftercms.commons.git.utils.TypeBasedAuthConfiguratorBuilder
-
The authentication type to use
- AwsS3BlobStore - Class in org.craftercms.commons.file.blob.impl.s3
-
Implementation of
BlobStore
for AWS S3 - AwsS3BlobStore() - Constructor for class org.craftercms.commons.file.blob.impl.s3.AwsS3BlobStore
- AwsUtils - Class in org.craftercms.commons.aws
-
Provides utility methods for AWS services
- AwsUtils() - Constructor for class org.craftercms.commons.aws.AwsUtils
B
- Base64 - Class in org.craftercms.commons.crypto
-
Deprecated.
- Base64.InputStream - Class in org.craftercms.commons.crypto
-
Deprecated.A
Base64.InputStream
will read data from anotherjava.io.InputStream
, given in the constructor, and encode/decode to/from Base64 notation on the fly. - Base64.OutputStream - Class in org.craftercms.commons.crypto
-
Deprecated.A
Base64.OutputStream
will write data to anotherjava.io.OutputStream
, given in the constructor, and encode/decode to/from Base64 notation on the fly. - basePath - Variable in class org.craftercms.commons.config.ConfigurationResolverImpl
-
The path pattern for the default environment
- BaseRestExceptionHandlers - Class in org.craftercms.commons.rest
-
Class that provides the basic
ExceptionHandler
s for Crafter REST services. - BaseRestExceptionHandlers() - Constructor for class org.craftercms.commons.rest.BaseRestExceptionHandlers
- baseUrl - Variable in class org.craftercms.commons.config.profiles.webdav.WebDavProfile
- baseUrl - Variable in class org.craftercms.commons.rest.AbstractRestClientBase
- BASIC - Static variable in interface org.craftercms.commons.git.utils.AuthenticationType
- BasicUsernamePasswordAuthConfigurator - Class in org.craftercms.commons.git.auth
-
GitAuthenticationConfigurator
that uses basic username/password authentication. - BasicUsernamePasswordAuthConfigurator(String, String) - Constructor for class org.craftercms.commons.git.auth.BasicUsernamePasswordAuthConfigurator
- BeanListFactoryBean - Class in org.craftercms.commons.spring
-
Spring factory bean that creates a list of beans based on a list of bean names.
- BeanListFactoryBean(String[]) - Constructor for class org.craftercms.commons.spring.BeanListFactoryBean
- beanNames - Variable in class org.craftercms.commons.spring.BeanListFactoryBean
- BIG_FILE_THRESHOLD_CONFIG_PARAM - Static variable in class org.craftercms.commons.git.utils.GitUtils
- BIG_FILE_THRESHOLD_DEFAULT - Static variable in class org.craftercms.commons.git.utils.GitUtils
- blacklist - Variable in class org.craftercms.commons.spring.groovy.SandboxInterceptorFactory
-
Resource containing the restrictions
- blacklistedPatterns() - Element in annotation interface org.craftercms.commons.validation.annotations.param.ValidateStringParam
- blacklistEnabled - Variable in class org.craftercms.commons.spring.groovy.SandboxInterceptorFactory
-
Indicates if the blacklist should be enabled
- blacklistRegexes - Variable in class org.craftercms.commons.validation.validators.impl.AbstractStringValidator
- Blob - Class in org.craftercms.commons.file.blob
-
Holds the reference to a file in a blob store
- Blob() - Constructor for class org.craftercms.commons.file.blob.Blob
- Blob(String, String) - Constructor for class org.craftercms.commons.file.blob.Blob
- BlobStore - Interface in org.craftercms.commons.file.blob
-
Defines the operations to handle blob files
- BlobStoreConfigurationMissingException - Exception Class in org.craftercms.commons.file.blob.exception
-
Exception thrown when the blob store configuration is not found
- BlobStoreConfigurationMissingException() - Constructor for exception class org.craftercms.commons.file.blob.exception.BlobStoreConfigurationMissingException
- BlobStoreConfigurationMissingException(String) - Constructor for exception class org.craftercms.commons.file.blob.exception.BlobStoreConfigurationMissingException
- BlobStoreConfigurationMissingException(String, Throwable) - Constructor for exception class org.craftercms.commons.file.blob.exception.BlobStoreConfigurationMissingException
- BlobStoreException - Exception Class in org.craftercms.commons.file.blob.exception
-
Base Exception for all blob store specific errors
- BlobStoreException() - Constructor for exception class org.craftercms.commons.file.blob.exception.BlobStoreException
- BlobStoreException(String) - Constructor for exception class org.craftercms.commons.file.blob.exception.BlobStoreException
- BlobStoreException(String, Throwable) - Constructor for exception class org.craftercms.commons.file.blob.exception.BlobStoreException
- BlobStoreMissingException - Exception Class in org.craftercms.commons.file.blob.exception
-
Exception thrown when a blob store id found in the configuration is not found in the application context
- BlobStoreMissingException() - Constructor for exception class org.craftercms.commons.file.blob.exception.BlobStoreMissingException
- BlobStoreMissingException(String) - Constructor for exception class org.craftercms.commons.file.blob.exception.BlobStoreMissingException
- BlobStoreMissingException(String, Throwable) - Constructor for exception class org.craftercms.commons.file.blob.exception.BlobStoreMissingException
- BlobStoreResolver - Interface in org.craftercms.commons.file.blob
-
Provides access to all known implementations of
BlobStore
- BlobStoreResolverImpl - Class in org.craftercms.commons.file.blob.impl
-
Default implementation of
BlobStoreResolver
- BlobStoreResolverImpl() - Constructor for class org.craftercms.commons.file.blob.impl.BlobStoreResolverImpl
- BlobUrlResolver - Interface in org.craftercms.commons.file.blob
-
Defines operations for blob file urls
- BlobUrlResolverImpl - Class in org.craftercms.commons.file.blob.impl
-
Default implementation of
BlobUrlResolver
- BlobUrlResolverImpl(String) - Constructor for class org.craftercms.commons.file.blob.impl.BlobUrlResolverImpl
- blueprint - Variable in class org.craftercms.commons.plugin.model.PluginDescriptor
-
Used by a previous version, kept for backwards compatibility
- Blueprint() - Constructor for class org.craftercms.commons.plugin.model.BlueprintDescriptor.Blueprint
-
Deprecated.
- BLUEPRINT - Static variable in interface org.craftercms.commons.plugin.model.PluginTypes
-
Site blueprints
- BlueprintDescriptor - Class in org.craftercms.commons.plugin.model
-
Deprecated.
- BlueprintDescriptor() - Constructor for class org.craftercms.commons.plugin.model.BlueprintDescriptor
-
Deprecated.
- BlueprintDescriptor.Blueprint - Class in org.craftercms.commons.plugin.model
-
Deprecated.
- BlueprintDescriptor.Build - Class in org.craftercms.commons.plugin.model
-
Deprecated.
- BlueprintDescriptor.Company - Class in org.craftercms.commons.plugin.model
-
Deprecated.
- BlueprintDescriptor.CraftercmsVersionSupported - Class in org.craftercms.commons.plugin.model
-
Deprecated.
- BlueprintDescriptor.Developer - Class in org.craftercms.commons.plugin.model
-
Deprecated.
- BlueprintDescriptor.License - Class in org.craftercms.commons.plugin.model
-
Deprecated.
- BlueprintDescriptor.Media - Class in org.craftercms.commons.plugin.model
-
Deprecated.
- BlueprintDescriptor.Person - Class in org.craftercms.commons.plugin.model
-
Deprecated.
- BlueprintDescriptor.PersonWrapper - Class in org.craftercms.commons.plugin.model
-
Deprecated.
- BlueprintDescriptor.Screenshot - Class in org.craftercms.commons.plugin.model
-
Deprecated.
- BlueprintDescriptor.ScreenshotWrapper - Class in org.craftercms.commons.plugin.model
-
Deprecated.
- BlueprintDescriptor.Version - Class in org.craftercms.commons.plugin.model
-
Deprecated.
- BlueprintDescriptor.Video - Class in org.craftercms.commons.plugin.model
-
Deprecated.
- BlueprintDescriptor.VideoWrapper - Class in org.craftercms.commons.plugin.model
-
Deprecated.
- BlueprintDescriptor.Website - Class in org.craftercms.commons.plugin.model
-
Deprecated.
- bucketName - Variable in class org.craftercms.commons.config.profiles.aws.S3Profile
-
Name of the bucket.
- build() - Method in interface org.craftercms.commons.git.utils.AuthConfiguratorBuilder
-
Creates an instance based on the current configuration
- build() - Method in class org.craftercms.commons.git.utils.TypeBasedAuthConfiguratorBuilder
- build() - Method in class org.craftercms.commons.git.utils.UrlBasedAuthConfiguratorBuilder
- Build() - Constructor for class org.craftercms.commons.plugin.model.BlueprintDescriptor.Build
-
Deprecated.
- buildConfig(Map<String, Object>) - Method in class org.craftercms.commons.config.YamlConfiguration
- buildConfigFromCollection(String, Collection<Object>, ImmutableNode.Builder) - Method in class org.craftercms.commons.config.YamlConfiguration
- buildConfigFromKeyValuePair(String, Object, ImmutableNode.Builder) - Method in class org.craftercms.commons.config.YamlConfiguration
- buildConfigFromMap(Map<String, Object>, ImmutableNode.Builder) - Method in class org.craftercms.commons.config.YamlConfiguration
- buildTemplateModel(Map<String, Object>, HttpServletRequest, HttpServletResponse) - Method in class org.craftercms.commons.freemarker.CrafterFreeMarkerView
- buildTransferManager(S3AsyncClient) - Static method in class org.craftercms.commons.aws.AwsUtils
-
Builds the
S3TransferManager
using the sharedExecutorService
- buildTransferManager(S3AsyncClient, ThreadPoolExecutor) - Static method in class org.craftercms.commons.aws.AwsUtils
-
Builds the
S3TransferManager
using the providedThreadPoolExecutor
- BUNDLE_NAME - Static variable in exception class org.craftercms.commons.security.exception.SecurityException
C
- CACHE_CONTROL_HEADER_NAME - Static variable in class org.craftercms.commons.http.HttpUtils
- Callback<T> - Interface in org.craftercms.commons.lang
-
Represents a general callback that can be used almost in any method that needs this pattern.
- checkManagementToken(HasPermission) - Method in class org.craftercms.commons.security.permissions.annotations.HasPermissionAnnotationHandler
-
Checks if there is a valid management token param in the request.
- checkPermissions(Method, HasPermission, Object) - Method in class org.craftercms.commons.security.permissions.annotations.AbstractPermissionAnnotationHandler
-
Checks the permissions to perform the action configured in the
HasPermission
to the securedResource (if any) - checkPermissions(ProceedingJoinPoint) - Method in class org.craftercms.commons.security.permissions.annotations.HasPermissionAnnotationHandler
- checkProperty(String) - Method in class org.craftercms.commons.jackson.mvc.GDataPropertyFilter
- checkPropertyAgainstPattern(List<String>, String) - Method in class org.craftercms.commons.jackson.mvc.GDataPropertyFilter
- children - Variable in class org.craftercms.commons.plugin.model.Installation.Element
- clazz - Variable in class org.craftercms.commons.mongo.AbstractJongoRepository
- cleanup(String) - Static method in class org.craftercms.commons.git.utils.GitUtils
-
Executes a git gc.
- cleanUrlForLog(String) - Static method in class org.craftercms.commons.lang.UrlUtils
-
Clean a url for logging purposes.
- clear() - Static method in class org.craftercms.commons.http.RequestContext
-
Removes the context from the current thread.
- client - Variable in class org.craftercms.commons.spring.resources.WebDavResource
- clientFactory - Variable in class org.craftercms.commons.file.blob.impl.s3.AwsS3BlobStore
-
The client factory
- clientFactory - Variable in class org.craftercms.commons.file.stores.impl.s3.S3FileStore
- cloneRemoteRepository(String, String, String, GitAuthenticationConfigurator, File, String, Integer, Boolean) - Static method in class org.craftercms.commons.git.utils.GitUtils
-
Clones a remote repository into a specific local folder.
- close() - Method in class org.craftercms.commons.crypto.Base64.OutputStream
-
Deprecated.Flushes and closes (I think, in the superclass) the stream.
- CLOUDFRONT_PROTO_HEADER_NAME - Static variable in class org.craftercms.commons.web.CloudfrontForwardedHeaderFilter
- CloudfrontForwardedHeaderFilter - Class in org.craftercms.commons.web
-
Filter to provide support for AWS Cloudfront specific request headers.
- CloudfrontForwardedHeaderFilter(boolean) - Constructor for class org.craftercms.commons.web.CloudfrontForwardedHeaderFilter
- collectionName - Variable in class org.craftercms.commons.mongo.AbstractJongoRepository
- collectionName() - Element in annotation interface org.craftercms.commons.mongo.Document
-
Name where all Documents will be save.
- columns() - Element in annotation interface org.craftercms.commons.validation.annotations.param.SqlSort
- COMMUNITY - Static variable in interface org.craftercms.commons.plugin.model.CrafterCmsEditions
-
The community edition
- company - Variable in class org.craftercms.commons.plugin.model.Developer
-
The company that worked on the plugin
- Company() - Constructor for class org.craftercms.commons.plugin.model.BlueprintDescriptor.Company
-
Deprecated.
- CompositePermission - Class in org.craftercms.commons.security.permissions
-
Represents a permission that is a collection of other permissions.
- CompositePermission(Collection<Permission>) - Constructor for class org.craftercms.commons.security.permissions.CompositePermission
- CompositePermission(Permission...) - Constructor for class org.craftercms.commons.security.permissions.CompositePermission
- COMPRESSION_CONFIG_PARAM - Static variable in class org.craftercms.commons.git.utils.GitUtils
- COMPRESSION_DEFAULT - Static variable in class org.craftercms.commons.git.utils.GitUtils
- concat(String, String) - Static method in class org.craftercms.commons.lang.UrlUtils
-
Concats two urls, adding any "/" needed between them.
- concat(String, String...) - Static method in class org.craftercms.commons.lang.UrlUtils
-
Concats two or more urls, adding any "/" needed between them.
- ConditionalFactoryBean - Class in org.craftercms.commons.spring
-
Simple Spring factory bean that only returns an actual bean if the specified flag is true.
- ConditionalFactoryBean(boolean, Object) - Constructor for class org.craftercms.commons.spring.ConditionalFactoryBean
- config - Variable in class org.craftercms.commons.spring.cors.FixedCorsConfigurationSource
- CONFIG_KEY_CONFIGURATION - Static variable in interface org.craftercms.commons.file.blob.BlobStore
- CONFIG_KEY_CURRENT_VERSION - Static variable in interface org.craftercms.commons.upgrade.UpgradePipelineFactory
- CONFIG_KEY_DEFAULT_LOCALE - Static variable in class org.craftercms.commons.locale.LocaleUtils
- CONFIG_KEY_FALLBACK - Static variable in class org.craftercms.commons.locale.LocaleUtils
- CONFIG_KEY_ID - Static variable in interface org.craftercms.commons.file.blob.BlobStore
- CONFIG_KEY_MAPPING - Static variable in interface org.craftercms.commons.file.blob.BlobStore
- CONFIG_KEY_MAPPING_PREFIX - Static variable in interface org.craftercms.commons.file.blob.BlobStore
- CONFIG_KEY_MAPPING_PUBLISHING_TARGET - Static variable in interface org.craftercms.commons.file.blob.BlobStore
- CONFIG_KEY_MAPPING_STORE_TARGET - Static variable in interface org.craftercms.commons.file.blob.BlobStore
- CONFIG_KEY_NEXT_VERSION - Static variable in interface org.craftercms.commons.upgrade.UpgradePipelineFactory
- CONFIG_KEY_OPERATIONS - Static variable in interface org.craftercms.commons.upgrade.UpgradePipelineFactory
- CONFIG_KEY_PATTERN - Static variable in interface org.craftercms.commons.file.blob.BlobStore
- CONFIG_KEY_READ_ONLY - Static variable in interface org.craftercms.commons.file.blob.BlobStore
- CONFIG_KEY_REQUIRES - Static variable in interface org.craftercms.commons.upgrade.UpgradePipelineFactory
- CONFIG_KEY_STORE - Static variable in interface org.craftercms.commons.file.blob.BlobStore
- CONFIG_KEY_SUPPORTED_LOCALES - Static variable in class org.craftercms.commons.locale.LocaleUtils
- CONFIG_KEY_TYPE - Static variable in interface org.craftercms.commons.file.blob.BlobStore
- CONFIG_KEY_TYPE - Static variable in interface org.craftercms.commons.upgrade.UpgradePipelineFactory
- CONFIG_KEY_VERSIONS - Static variable in interface org.craftercms.commons.upgrade.UpgradePipelineFactory
- configExists(String) - Method in interface org.craftercms.commons.config.ConfigurationProvider
-
Checks if the given configuration path exists
- configListDelimiter - Variable in class org.craftercms.commons.config.EncryptionAwareConfigurationReader
- configModule - Variable in class org.craftercms.commons.file.blob.impl.BlobStoreResolverImpl
-
The module of the configuration file
- configPath - Variable in class org.craftercms.commons.file.blob.impl.BlobStoreResolverImpl
-
The path of the configuration file
- CONFIGURATION_PATH - Enum constant in enum class org.craftercms.commons.validation.annotations.param.EsapiValidationType
- ConfigurationException - Exception Class in org.craftercms.commons.config
-
Exception thrown by classes that handle configuration.
- ConfigurationException(String) - Constructor for exception class org.craftercms.commons.config.ConfigurationException
- ConfigurationException(String, Throwable) - Constructor for exception class org.craftercms.commons.config.ConfigurationException
- ConfigurationMapper<T> - Interface in org.craftercms.commons.config
-
Interface for classes that map configuration data to Java bean classes.
- ConfigurationProfile - Class in org.craftercms.commons.config.profiles
-
Represents a collection of configuration properties that are commonly used together, for example, to open a connection or accessing a server.
- ConfigurationProfile() - Constructor for class org.craftercms.commons.config.profiles.ConfigurationProfile
- ConfigurationProfileLoader<T> - Interface in org.craftercms.commons.config.profiles
-
Generic interfaces for classes that provide a way to load specific configuration profiles.
- ConfigurationProfileNotFoundException - Exception Class in org.craftercms.commons.config.profiles
-
Exception thrown by classes that handle configuration if the profile Id does not exist
- ConfigurationProfileNotFoundException(String) - Constructor for exception class org.craftercms.commons.config.profiles.ConfigurationProfileNotFoundException
- ConfigurationProfileNotFoundException(String, Throwable) - Constructor for exception class org.craftercms.commons.config.profiles.ConfigurationProfileNotFoundException
- configurationProvider - Variable in class org.craftercms.commons.upgrade.impl.pipeline.DefaultUpgradePipelineFactoryImpl
-
Path of the configuration file
- ConfigurationProvider - Interface in org.craftercms.commons.config
-
Defines the operations to access configuration files
- configurationReader - Variable in class org.craftercms.commons.config.ConfigurationResolverImpl
- configurationResolver - Variable in class org.craftercms.commons.config.profiles.AbstractProfileConfigMapper
- configurationResolver - Variable in class org.craftercms.commons.file.blob.impl.BlobStoreResolverImpl
- ConfigurationResolver - Interface in org.craftercms.commons.config
-
Provides access to configuration files taking into account the active environment
- ConfigurationResolverImpl - Class in org.craftercms.commons.config
-
Default implementation of
ConfigurationResolver
- ConfigurationResolverImpl(String, String, String, EncryptionAwareConfigurationReader) - Constructor for class org.craftercms.commons.config.ConfigurationResolverImpl
- configureAuthentication(TransportCommand<?, ?>) - Method in class org.craftercms.commons.git.auth.AbstractSshAuthConfigurator
- configureAuthentication(TransportCommand<?, ?>) - Method in class org.craftercms.commons.git.auth.BasicUsernamePasswordAuthConfigurator
- configureAuthentication(TransportCommand<?, ?>) - Method in interface org.craftercms.commons.git.auth.GitAuthenticationConfigurator
-
Configures the authentication of the given
TransportCommand
based on a specific authentication strategy, like HTTP basic authentication, SSH username/password authentication and SSH RSA key pair authentication. - configureAuthentication(TransportCommand<?, ?>) - Method in class org.craftercms.commons.git.auth.NoopAuthConfigurator
- configureAuthentication(TransportCommand<?, ?>) - Method in class org.craftercms.commons.git.auth.SshPasswordAuthConfigurator
- configureAuthentication(TransportCommand<?, ?>) - Method in class org.craftercms.commons.git.auth.SshPrivateKeyAuthConfigurator
- ConfigUtils - Class in org.craftercms.commons.config
-
Utility methods for Apache Commons based configuration.
- ConfigUtils() - Constructor for class org.craftercms.commons.config.ConfigUtils
- Contact - Class in org.craftercms.commons.plugin.model
-
Holds the information of a single contact
- Contact() - Constructor for class org.craftercms.commons.plugin.model.Contact
- CONTENT_PATH_READ - Enum constant in enum class org.craftercms.commons.validation.annotations.param.EsapiValidationType
- CONTENT_PATH_WRITE - Enum constant in enum class org.craftercms.commons.validation.annotations.param.EsapiValidationType
- contentLength() - Method in class org.craftercms.commons.spring.resources.S3Resource
- contentLength() - Method in class org.craftercms.commons.spring.resources.WebDavResource
- contentNegotiationManager - Variable in class org.craftercms.commons.rest.HttpMessageConvertingResponseWriter
- continueOnFailure - Variable in class org.craftercms.commons.upgrade.impl.AbstractUpgradeManager
-
Indicates if errors during a target upgrade should stop the process
- continueOnFailure - Variable in class org.craftercms.commons.upgrade.impl.pipeline.DefaultUpgradePipelineImpl
-
Indicates if the pipeline should continue executing after an operation fails
- convert(String) - Method in class org.craftercms.commons.converters.impl.StringToBooleanConverter
- convert(String) - Method in class org.craftercms.commons.converters.impl.StringToDateConverter
- convert(String) - Method in class org.craftercms.commons.converters.impl.StringToDoubleConverter
- convert(String) - Method in class org.craftercms.commons.converters.impl.StringToFloatConverter
- convert(String) - Method in class org.craftercms.commons.converters.impl.StringToIntegerConverter
- convert(String) - Method in class org.craftercms.commons.converters.impl.StringToLongConverter
- convert(String) - Method in class org.craftercms.commons.converters.impl.StringToShortConverter
- convert(String) - Method in class org.craftercms.commons.converters.impl.StringToStringConverter
- convert(S) - Method in interface org.craftercms.commons.converters.Converter
-
Converts the source object from S type to T type.
- Converter<S,
T> - Interface in org.craftercms.commons.converters -
Converts objects of S type to T type.
- CookieManager - Class in org.craftercms.commons.http
-
Utility class to create and delete cookies with common domain, path and max age.
- CookieManager() - Constructor for class org.craftercms.commons.http.CookieManager
- copyObjects(S3AsyncClient, ThreadPoolExecutor, String, String, String, String, List<String>, Consumer<Throwable>) - Static method in class org.craftercms.commons.aws.AwsUtils
-
Copy a list of objects from a source bucket to a target bucket
- CORE_CONFIG_SECTION - Static variable in class org.craftercms.commons.git.utils.GitUtils
- count() - Method in class org.craftercms.commons.mongo.AbstractJongoRepository
- count() - Method in interface org.craftercms.commons.mongo.CrudRepository
-
Returns the number of all documents in the collection.
- count(Iterable<T>) - Static method in class org.craftercms.commons.collections.IterableUtils
-
Returns the number of elements the iterable contains.
- count(String) - Method in class org.craftercms.commons.mongo.AbstractJongoRepository
- count(String) - Method in interface org.craftercms.commons.mongo.CrudRepository
-
Returns the number of documents that match the query
- count(String, Object...) - Method in class org.craftercms.commons.mongo.AbstractJongoRepository
- count(String, Object...) - Method in interface org.craftercms.commons.mongo.CrudRepository
-
Returns the number of documents that match the query
- CRAFTER_SEARCH - Static variable in interface org.craftercms.commons.plugin.model.SearchEngines
-
Deprecated.since 4.0.0
- crafterCmsEditions - Variable in class org.craftercms.commons.plugin.model.Plugin
-
The supported CrafterCMS editions of the plugin
- CrafterCmsEditions - Interface in org.craftercms.commons.plugin.model
-
All available editions of CrafterCMS
- crafterCmsVersions - Variable in class org.craftercms.commons.plugin.model.Plugin
-
The supported CrafterCMS versions of the plugin
- CraftercmsVersionSupported() - Constructor for class org.craftercms.commons.plugin.model.BlueprintDescriptor.CraftercmsVersionSupported
-
Deprecated.
- CrafterFreeMarkerView - Class in org.craftercms.commons.freemarker
-
Extends
FreeMarkerView
to support rendering variables in Spring 6 - CrafterFreeMarkerView() - Constructor for class org.craftercms.commons.freemarker.CrafterFreeMarkerView
- CrafterFreeMarkerViewResolver - Class in org.craftercms.commons.freemarker
-
Extends
FreeMarkerView
to support rendering variables in Spring 6 - CrafterFreeMarkerViewResolver() - Constructor for class org.craftercms.commons.freemarker.CrafterFreeMarkerViewResolver
- CrafterJackson2MessageConverter - Class in org.craftercms.commons.jackson.mvc
- CrafterJackson2MessageConverter(FilterProvider) - Constructor for class org.craftercms.commons.jackson.mvc.CrafterJackson2MessageConverter
- CrafterJacksonAnnotationIntrospector - Class in org.craftercms.commons.jackson.mvc
-
Extends JacksonAnnotationIntrospector so it will always a filter (so @JsonFilter) annotation is not needed.
- CrafterJacksonAnnotationIntrospector(String) - Constructor for class org.craftercms.commons.jackson.mvc.CrafterJacksonAnnotationIntrospector
- createAsyncClient(AbstractAwsProfile) - Static method in class org.craftercms.commons.file.stores.S3Utils
- createClient(AbstractAwsProfile) - Static method in class org.craftercms.commons.file.stores.S3Utils
- createClient(AbstractAwsProfile, boolean, T, Function<T, U>) - Static method in class org.craftercms.commons.file.stores.S3Utils
-
Creates an S3 client (sync or async) based on the given profile config.
- createClient(S3Profile) - Method in class org.craftercms.commons.aws.S3AsyncClientCachingFactory
- createClient(S3Profile) - Method in class org.craftercms.commons.aws.S3ClientCachingFactory
- createClient(WebDavProfile) - Static method in class org.craftercms.commons.file.stores.WebDavUtils
-
Creates a WebDAV client based on the given profile config
- createClient(P) - Method in class org.craftercms.commons.aws.AbstractAwsClientCachingFactory
- createCookiesMap(HttpServletRequest) - Static method in class org.craftercms.commons.http.HttpUtils
-
Creates a map from the cookies in the specified request.
- createDefaultCipher() - Method in class org.craftercms.commons.crypto.SimpleCipher
- createHeadersMap(HttpServletRequest) - Static method in class org.craftercms.commons.http.HttpUtils
-
Creates a map from the headers in the specified request.
- createInstance() - Method in class org.craftercms.commons.cache.GuavaCacheFactoryBean
- createInstance() - Method in class org.craftercms.commons.jackson.mvc.SelectorFilterFactory
- createInstance() - Method in class org.craftercms.commons.mongo.JongoFactoryBean
- createInstance() - Method in class org.craftercms.commons.mongo.MongoClientFactory
- createInstance() - Method in class org.craftercms.commons.mongo.MongoClientFromUriFactoryBean
- createInstance() - Method in class org.craftercms.commons.mongo.MongoClientOptionsFactory
- createInstance() - Method in class org.craftercms.commons.spring.groovy.SandboxInterceptorFactory
- createKeyPair(int, String, char[], OutputStream, OutputStream) - Static method in class org.craftercms.commons.crypto.PGPUtils
-
Creates a private/public PGP key pair.
- createMessage(String, String[], String[], String[], String, String, String, boolean, File...) - Method in class org.craftercms.commons.mail.impl.EmailFactoryImpl
- createModule(List<JsonSerializer<?>>, Map<Class<?>, JsonDeserializer<?>>) - Static method in class org.craftercms.commons.jackson.JacksonUtils
-
Creates a module from a set of serializers and deserializes.
- createPipeline(String, List<UpgradeOperation<T>>) - Method in class org.craftercms.commons.upgrade.impl.pipeline.DefaultUpgradePipelineFactoryImpl
- createProfile() - Method in class org.craftercms.commons.config.profiles.aws.AbstractAwsProfileMapper
- createProfile() - Method in class org.craftercms.commons.config.profiles.aws.S3ProfileMapper
- createRelative(String) - Method in class org.craftercms.commons.spring.resources.S3Resource
- createRelative(String) - Method in class org.craftercms.commons.spring.resources.WebDavResource
- createRequestAttributesMap(HttpServletRequest) - Static method in class org.craftercms.commons.http.HttpUtils
-
Creates a map from the request attributes in the specified request.
- createRequestContext(HttpServletRequest, HttpServletResponse) - Method in class org.craftercms.commons.http.RequestContextBindingFilter
- createRequestParamsMap(HttpServletRequest) - Static method in class org.craftercms.commons.http.HttpUtils
-
Creates a map from the parameters in the specified request.
- createSessionFactory() - Method in class org.craftercms.commons.git.auth.AbstractSshAuthConfigurator
- createSessionFactory() - Method in class org.craftercms.commons.git.auth.SshPasswordAuthConfigurator
- createSessionFactory() - Method in class org.craftercms.commons.git.auth.SshPrivateKeyAuthConfigurator
- createSessionMap(HttpServletRequest) - Static method in class org.craftercms.commons.http.HttpUtils
-
Creates a map from the session attributes in the specified request.
- createSortQuery(List<DefaultKeyValue<String, Boolean>>) - Method in class org.craftercms.commons.mongo.AbstractJongoRepository
-
Creates a Sort query based on the fields.
Key of the map is the field False=Desc,True=asc for the field, Respect order of the keys - createUpgradeContext(T) - Method in class org.craftercms.commons.upgrade.impl.AbstractUpgradeManager
- CrudRepository<T> - Interface in org.craftercms.commons.mongo
- CryptoException - Exception Class in org.craftercms.commons.crypto
-
General error thrown when a crypto related error occurs.
- CryptoException(String, Object...) - Constructor for exception class org.craftercms.commons.crypto.CryptoException
- CryptoException(String, Throwable, Object...) - Constructor for exception class org.craftercms.commons.crypto.CryptoException
- CryptoUtils - Class in org.craftercms.commons.crypto
-
Utility methods for encryption/decryption and message digest.
- currentValue - Variable in exception class org.craftercms.commons.entitlements.exception.EntitlementExceededException
-
The actual value provided by the module.
- currentVersion - Variable in class org.craftercms.commons.upgrade.impl.operations.AbstractUpgradeOperation
-
The current version.
- CustomSerializationObjectMapper - Class in org.craftercms.commons.jackson
-
Extended
ObjectMapper
that lets you provide your own serializers/deserializers. - CustomSerializationObjectMapper() - Constructor for class org.craftercms.commons.jackson.CustomSerializationObjectMapper
D
- dateFormat - Variable in class org.craftercms.commons.converters.impl.StringToDateConverter
- DateParseException - Exception Class in org.craftercms.commons.exceptions
-
Exception thrown when there's an error while parsing a date.
- DateParseException(String, String, Throwable) - Constructor for exception class org.craftercms.commons.exceptions.DateParseException
- datePattern - Variable in class org.craftercms.commons.converters.impl.StringToDateConverter
- DbIntegrityValidator - Interface in org.craftercms.commons.entitlements.validator
-
Defines the operations to validate a database.
- debug(String, Object...) - Method in class org.craftercms.commons.i10n.I10nLogger
- debug(String, Throwable, Object...) - Method in class org.craftercms.commons.i10n.I10nLogger
- decode(byte[], int, int, int) - Static method in class org.craftercms.commons.crypto.Base64
-
Deprecated.Very low-level access to decoding ASCII characters in the form of a byte array.
- decode(String) - Static method in class org.craftercms.commons.crypto.Base64
-
Deprecated.Decodes data from Base64 notation, automatically detecting gzip-compressed data and decompressing it.
- decode(String, int) - Static method in class org.craftercms.commons.crypto.Base64
-
Deprecated.Decodes data from Base64 notation, automatically detecting gzip-compressed data and decompressing it.
- DECODE - Static variable in class org.craftercms.commons.crypto.Base64
-
Deprecated.Specify decoding.
- decodeFileToFile(String, String) - Static method in class org.craftercms.commons.crypto.Base64
-
Deprecated.Reads
infile
and decodes it tooutfile
. - decodeFromFile(String) - Static method in class org.craftercms.commons.crypto.Base64
-
Deprecated.Convenience method for reading a base64-encoded file and decoding it.
- decodeToFile(String, String) - Static method in class org.craftercms.commons.crypto.Base64
-
Deprecated.Convenience method for decoding data to a file.
- decodeToObject(String) - Static method in class org.craftercms.commons.crypto.Base64
-
Deprecated.Attempts to decode Base64 data and deserialize a Java Object within.
- decrypt(byte[]) - Method in class org.craftercms.commons.crypto.SimpleAesCipher
-
Deprecated.
- decrypt(byte[]) - Method in class org.craftercms.commons.crypto.SimpleCipher
- decrypt(InputStream, OutputStream, InputStream, char[]) - Static method in class org.craftercms.commons.crypto.PGPUtils
-
Performs decryption of a given stream using a PGP private key.
- decrypt(String) - Method in class org.craftercms.commons.crypto.impl.AesTextEncryptor
- decrypt(String) - Method in class org.craftercms.commons.crypto.impl.NoOpTextEncryptor
- decrypt(String) - Method in class org.craftercms.commons.crypto.impl.PbkAesTextEncryptor
- decrypt(String) - Method in interface org.craftercms.commons.crypto.TextEncryptor
-
Decrypts the specified encrypted text.
- decryptBase64(String) - Method in class org.craftercms.commons.crypto.SimpleCipher
- decryptData(PGPPrivateKey, PGPPublicKeyEncryptedData, BcKeyFingerprintCalculator, OutputStream) - Static method in class org.craftercms.commons.crypto.PGPUtils
-
Performs the decryption of the given data.
- DecryptionLookup - Class in org.craftercms.commons.config
-
Implementation of
Lookup
that decrypts the variable. - DecryptionLookup(TextEncryptor) - Constructor for class org.craftercms.commons.config.DecryptionLookup
- deepMerge(Map, Map) - Static method in class org.craftercms.commons.collections.MapUtils
-
Deep merges two maps
- DEFAULT_AES_CIPHER_TRANSFORMATION - Static variable in class org.craftercms.commons.crypto.CryptoUtils
- DEFAULT_ALGORITHM - Static variable in class org.craftercms.commons.crypto.SimpleDigest
- DEFAULT_BLACKLISTED_REGEXES - Static variable in class org.craftercms.commons.validation.validators.impl.NoTagsValidator
- DEFAULT_BLACKLISTED_REGEXES - Static variable in class org.craftercms.commons.validation.validators.impl.SecurePathValidator
- DEFAULT_ENCODING - Static variable in class org.craftercms.commons.config.ConfigUtils
- DEFAULT_ENCODING - Static variable in class org.craftercms.commons.mail.impl.EmailFactoryImpl
- DEFAULT_ENCRYPTED_VALUE_PREFIX - Static variable in class org.craftercms.commons.config.EncryptionAwareConfigurationReader
- DEFAULT_ENVIRONMENT - Static variable in class org.craftercms.commons.config.ConfigurationResolverImpl
- DEFAULT_ERROR_MESSAGE_BUNDLE_NAME - Static variable in class org.craftercms.commons.i10n.I10nUtils
- DEFAULT_ERROR_MESSAGE_BUNDLE_NAME - Static variable in class org.craftercms.commons.validation.ValidationUtils
- DEFAULT_HTTP_PORT - Static variable in class org.craftercms.commons.http.HttpUtils
- DEFAULT_HTTPS_PORT - Static variable in class org.craftercms.commons.http.HttpUtils
- DEFAULT_ITERATIONS - Static variable in class org.craftercms.commons.crypto.SimpleDigest
- DEFAULT_LIST_DELIMITER - Static variable in class org.craftercms.commons.config.EncryptionAwareConfigurationReader
- DEFAULT_LOGGING_MESSAGE_BUNDLE_NAME - Static variable in class org.craftercms.commons.i10n.I10nUtils
- DEFAULT_MONGO_HOST - Static variable in class org.craftercms.commons.mongo.MongoClientFactory
- DEFAULT_MONGO_PORT - Static variable in class org.craftercms.commons.mongo.MongoClientFactory
- DEFAULT_PIPELINE_PREFIX - Static variable in class org.craftercms.commons.upgrade.impl.pipeline.DefaultUpgradePipelineFactoryImpl
- DEFAULT_SALT_SIZE - Static variable in class org.craftercms.commons.crypto.SimpleDigest
- DEFAULT_SHUTDOWN_CLIENT_AFTER_IDLE_SECS - Static variable in class org.craftercms.commons.aws.AbstractAwsClientCachingFactory
- DefaultDbIntegrityValidatorImpl - Class in org.craftercms.commons.entitlements.validator.impl
-
Default Implementation of
DbIntegrityValidator
. - DefaultDbIntegrityValidatorImpl() - Constructor for class org.craftercms.commons.entitlements.validator.impl.DefaultDbIntegrityValidatorImpl
- DefaultEntitlementValidatorImpl - Class in org.craftercms.commons.entitlements.validator.impl
-
Default Implementation of
EntitlementValidator
. - DefaultEntitlementValidatorImpl() - Constructor for class org.craftercms.commons.entitlements.validator.impl.DefaultEntitlementValidatorImpl
- defaultKeyAlgorithm - Variable in class org.craftercms.commons.crypto.impl.SecretKeyRepositoryImpl
- DefaultPermission - Class in org.craftercms.commons.security.permissions
-
Default
Permission
that uses a set of allowed actions to check if a subject is allowed to perform a specific action. - DefaultPermission() - Constructor for class org.craftercms.commons.security.permissions.DefaultPermission
- DefaultUpgradePipelineFactoryImpl<T> - Class in org.craftercms.commons.upgrade.impl.pipeline
-
Default implementation of
UpgradePipelineFactory
- DefaultUpgradePipelineFactoryImpl(String, UpgradeConfigurationProvider<HierarchicalConfiguration>, VersionProvider<T>) - Constructor for class org.craftercms.commons.upgrade.impl.pipeline.DefaultUpgradePipelineFactoryImpl
- DefaultUpgradePipelineImpl<T> - Class in org.craftercms.commons.upgrade.impl.pipeline
-
Default implementation for
UpgradePipeline
. - DefaultUpgradePipelineImpl(String, List<UpgradeOperation<T>>) - Constructor for class org.craftercms.commons.upgrade.impl.pipeline.DefaultUpgradePipelineImpl
- defaultValue - Variable in class org.craftercms.commons.plugin.model.Parameter
-
The default value of the parameter
- defaultValue - Variable in class org.craftercms.commons.upgrade.impl.providers.AbstractVersionProvider
-
The default value to use when no version is found, defaults to
VersionProvider.SKIP
- deleteAudits(List<String>) - Method in class org.craftercms.commons.audit.AuditService
-
Deletes all audits where its it is in the given List.
- deleteCookie(String, HttpServletResponse) - Method in class org.craftercms.commons.http.CookieManager
-
Add a "delete" cookie to the response to indicate the that the stored cookie should be deleted.
- deleteFile(String) - Method in class org.craftercms.commons.mongo.AbstractJongoRepository
- deleteFile(String) - Method in interface org.craftercms.commons.mongo.CrudRepository
-
Deletes the File with the given name.
- deleteFile(Path) - Static method in class org.craftercms.commons.git.utils.GitUtils
-
Force delete a file on disk
- deleteFile(ObjectId) - Method in class org.craftercms.commons.mongo.AbstractJongoRepository
- deleteFile(ObjectId) - Method in interface org.craftercms.commons.mongo.CrudRepository
-
Deletes the File with the given Id.
- deleteGitIndex(String) - Static method in class org.craftercms.commons.git.utils.GitUtils
-
Delete the git index for a given git repository (used to fix a broken repo)
- DELIMITER - Static variable in class org.craftercms.commons.aws.AwsUtils
- deliveryBaseUrl - Variable in class org.craftercms.commons.config.profiles.webdav.WebDavProfile
- delocalizePath(String) - Static method in class org.craftercms.commons.locale.LocaleUtils
- DESC - Enum constant in enum class org.craftercms.commons.rest.parameters.SortField.Order
- description - Variable in class org.craftercms.commons.plugin.model.Asset
-
The description of the asset
- description - Variable in class org.craftercms.commons.plugin.model.Parameter
-
The description of the parameter
- description - Variable in class org.craftercms.commons.plugin.model.Plugin
-
The description of the plugin
- descriptorVersion - Variable in class org.craftercms.commons.plugin.model.PluginDescriptor
-
The version of the descriptor
- deserialize(JsonParser, DeserializationContext) - Method in class org.craftercms.commons.jackson.ObjectIdDeserializer
- deserializers - Variable in class org.craftercms.commons.jackson.CustomSerializationObjectMapper
- destroy() - Method in class org.craftercms.commons.aws.AbstractAwsClientCachingFactory
- destroy() - Method in class org.craftercms.commons.http.RequestContextBindingFilter
- destroyInstance(Cache<K, V>) - Method in class org.craftercms.commons.cache.GuavaCacheFactoryBean
- destroyInstance(MongoClient) - Method in class org.craftercms.commons.mongo.MongoClientFromUriFactoryBean
- developer - Variable in class org.craftercms.commons.plugin.model.Plugin
-
The developer information of the plugin
- Developer - Class in org.craftercms.commons.plugin.model
-
Holds all metadata about the developers
- Developer() - Constructor for class org.craftercms.commons.plugin.model.BlueprintDescriptor.Developer
-
Deprecated.
- Developer() - Constructor for class org.craftercms.commons.plugin.model.Developer
- digest(byte[]) - Method in class org.craftercms.commons.crypto.SimpleDigest
- digestBase64(String) - Method in class org.craftercms.commons.crypto.SimpleDigest
- disableCaching(HttpServletResponse) - Static method in class org.craftercms.commons.http.HttpUtils
-
Disable caching in the client.
- DisableClassLoadingConstructor - Class in org.craftercms.commons.config
-
Extension of
Constructor
to disable any class from being loaded - DisableClassLoadingConstructor(Class<?>, LoaderOptions) - Constructor for class org.craftercms.commons.config.DisableClassLoadingConstructor
- DisableClassLoadingConstructor(String, LoaderOptions) - Constructor for class org.craftercms.commons.config.DisableClassLoadingConstructor
- DisableClassLoadingConstructor(LoaderOptions) - Constructor for class org.craftercms.commons.config.DisableClassLoadingConstructor
- DisableClassLoadingConstructor(TypeDescription, LoaderOptions) - Constructor for class org.craftercms.commons.config.DisableClassLoadingConstructor
- discardAllChanges(Git) - Static method in class org.craftercms.commons.git.utils.GitUtils
-
Executes a git reset to discard all uncommitted changes
- Document - Annotation Interface in org.craftercms.commons.mongo
- documentation - Variable in class org.craftercms.commons.plugin.model.Plugin
-
The URL for the documentation
- doDecrypt(String, Key) - Method in class org.craftercms.commons.crypto.impl.AesTextEncryptor
- doDiff(Git, ObjectReader, ObjectId, ObjectId) - Static method in class org.craftercms.commons.git.utils.GitUtils
- doEncrypt(String, Key) - Method in class org.craftercms.commons.crypto.impl.AesTextEncryptor
- doExecute(UpgradeContext<T>) - Method in class org.craftercms.commons.upgrade.impl.operations.AbstractUpgradeOperation
- doExecute(UpgradeContext<T>) - Method in class org.craftercms.commons.upgrade.impl.operations.UpdateVersionUpgradeOperation
- doFilter(ServletRequest, ServletResponse, FilterChain) - Method in class org.craftercms.commons.http.RequestContextBindingFilter
-
Binds a new
RequestContext
to the current thread, and after the the filter chain has finished executing, removes it from the current thread. - doFilterInternal(HttpServletRequest, HttpServletResponse, FilterChain) - Method in class org.craftercms.commons.web.AddResponseHeaderFilter
- doFilterInternal(HttpServletRequest, HttpServletResponse, FilterChain) - Method in class org.craftercms.commons.web.CloudfrontForwardedHeaderFilter
- doGetContent(AbstractBlobStore.Mapping, String) - Method in class org.craftercms.commons.file.blob.impl.AbstractBlobStore
- doGetContent(AbstractBlobStore.Mapping, String) - Method in class org.craftercms.commons.file.blob.impl.s3.AwsS3BlobStore
- doGetEntitlementUsage(EntitlementType) - Method in interface org.craftercms.commons.entitlements.usage.EntitlementUsageProvider
-
Performs the module specific operations to get the current value of the given entitlement
- doGetFile(ProfileAwareRemotePath, S3Profile) - Method in class org.craftercms.commons.file.stores.impl.s3.S3FileStore
- doGetFile(ProfileAwareRemotePath, WebDavProfile) - Method in class org.craftercms.commons.file.stores.impl.webdav.WebDavFileStore
- doGetFile(ProfileAwareRemotePath, T) - Method in class org.craftercms.commons.file.stores.impl.AbstractProfileAwareRemoteFileStore
- doGetTargets() - Method in class org.craftercms.commons.upgrade.impl.AbstractUpgradeManager
- doGetVersion(UpgradeContext<T>) - Method in class org.craftercms.commons.upgrade.impl.providers.AbstractFileVersionProvider
- doGetVersion(UpgradeContext<T>) - Method in class org.craftercms.commons.upgrade.impl.providers.AbstractVersionProvider
- doInit(HierarchicalConfiguration<?>) - Method in class org.craftercms.commons.upgrade.impl.operations.AbstractUpgradeOperation
- doInit(HierarchicalConfiguration<ImmutableNode>) - Method in class org.craftercms.commons.file.blob.impl.AbstractBlobStore
- doInit(HierarchicalConfiguration<ImmutableNode>) - Method in class org.craftercms.commons.file.blob.impl.s3.AwsS3BlobStore
- DONT_BREAK_LINES - Static variable in class org.craftercms.commons.crypto.Base64
-
Deprecated.Don't break lines when encoding (violates strict Base64 specification)
- doSetVersion(UpgradeContext<T>, String) - Method in class org.craftercms.commons.upgrade.impl.providers.AbstractFileVersionProvider
- doSetVersion(UpgradeContext<T>, String) - Method in class org.craftercms.commons.upgrade.impl.providers.AbstractVersionProvider
- doUpgrade(UpgradeContext<T>) - Method in class org.craftercms.commons.upgrade.impl.AbstractUpgradeManager
- DuplicateKeyException - Exception Class in org.craftercms.commons.mongo
-
Mongo exception thrown when a document can't be inserted because there's already a document with the same key.
- DuplicateKeyException() - Constructor for exception class org.craftercms.commons.mongo.DuplicateKeyException
- DuplicateKeyException(String) - Constructor for exception class org.craftercms.commons.mongo.DuplicateKeyException
- DuplicateKeyException(String, Throwable) - Constructor for exception class org.craftercms.commons.mongo.DuplicateKeyException
- DuplicateKeyException(String, Throwable, boolean, boolean) - Constructor for exception class org.craftercms.commons.mongo.DuplicateKeyException
- DuplicateKeyException(Throwable) - Constructor for exception class org.craftercms.commons.mongo.DuplicateKeyException
E
- ELASTICSEARCH - Static variable in interface org.craftercms.commons.plugin.model.SearchEngines
-
Elasticsearch, the default since 3.1
- element - Variable in class org.craftercms.commons.plugin.model.Installation
-
The new element to add in the configuration file
- Element() - Constructor for class org.craftercms.commons.plugin.model.Installation.Element
- elementXpath - Variable in class org.craftercms.commons.plugin.model.Installation
-
XPath selector to check if the wiring has already been done
- email - Variable in class org.craftercms.commons.plugin.model.Contact
-
The email of the contact
- Email - Interface in org.craftercms.commons.mail
-
Represents an email (possibly with from, to, body, etc., depending of the implementation).
- EMAIL - Enum constant in enum class org.craftercms.commons.validation.annotations.param.EsapiValidationType
- EMAIL_PATTERN - Static variable in class org.craftercms.commons.mail.EmailUtils
- EmailAddressException - Exception Class in org.craftercms.commons.mail
-
Thrown when an email address in wrong format is encountered.
- EmailAddressException(Throwable) - Constructor for exception class org.craftercms.commons.mail.EmailAddressException
- EmailException - Exception Class in org.craftercms.commons.mail
-
Thrown when an email can't be sent for some reason.
- EmailException(String, Object...) - Constructor for exception class org.craftercms.commons.mail.EmailException
- EmailException(String, Throwable, Object...) - Constructor for exception class org.craftercms.commons.mail.EmailException
- EmailFactory - Interface in org.craftercms.commons.mail
-
Factory for creating
Email
s. - EmailFactoryImpl - Class in org.craftercms.commons.mail.impl
-
Default implementation of
EmailFactory
. - EmailFactoryImpl(JavaMailSender) - Constructor for class org.craftercms.commons.mail.impl.EmailFactoryImpl
- EmailImpl - Class in org.craftercms.commons.mail.impl
-
Default implementation of
Email
, which uses Spring Mail to send a message. - EmailImpl(JavaMailSender, MimeMessage) - Constructor for class org.craftercms.commons.mail.impl.EmailImpl
- EmailPreparationException - Exception Class in org.craftercms.commons.mail
-
Thrown when an email message couldn't be prepared properly.
- EmailPreparationException(Throwable) - Constructor for exception class org.craftercms.commons.mail.EmailPreparationException
- EmailSendException - Exception Class in org.craftercms.commons.mail
-
Thrown when an email couldn't be sent for some reason.
- EmailSendException(Throwable) - Constructor for exception class org.craftercms.commons.mail.EmailSendException
- EmailUtils - Class in org.craftercms.commons.mail
-
Utility methods for email related stuff.
- enabled - Variable in class org.craftercms.commons.upgrade.impl.operations.AbstractUpgradeOperation
-
Indicates if the operation should be executed, true by default
- enabled - Variable in class org.craftercms.commons.web.AddResponseHeaderFilter
-
Indicates if the headers should be added
- enabled - Variable in class org.craftercms.commons.web.CloudfrontForwardedHeaderFilter
- enabled - Variable in class org.craftercms.commons.web.ForwardedHeaderFilter
- ENCODE - Static variable in class org.craftercms.commons.crypto.Base64
-
Deprecated.Specify encoding.
- encodeBytes(byte[]) - Static method in class org.craftercms.commons.crypto.Base64
-
Deprecated.Encodes a byte array into Base64 notation.
- encodeBytes(byte[], int) - Static method in class org.craftercms.commons.crypto.Base64
-
Deprecated.Encodes a byte array into Base64 notation.
- encodeBytes(byte[], int, int) - Static method in class org.craftercms.commons.crypto.Base64
-
Deprecated.Encodes a byte array into Base64 notation.
- encodeBytes(byte[], int, int, int) - Static method in class org.craftercms.commons.crypto.Base64
-
Deprecated.Encodes a byte array into Base64 notation.
- encodeFileToFile(String, String) - Static method in class org.craftercms.commons.crypto.Base64
-
Deprecated.Reads
infile
and encodes it tooutfile
. - encodeFromFile(String) - Static method in class org.craftercms.commons.crypto.Base64
-
Deprecated.Convenience method for reading a binary file and base64-encoding it.
- encodeObject(Serializable) - Static method in class org.craftercms.commons.crypto.Base64
-
Deprecated.Serializes an object and returns the Base64-encoded version of that serialized object.
- encodeObject(Serializable, int) - Static method in class org.craftercms.commons.crypto.Base64
-
Deprecated.Serializes an object and returns the Base64-encoded version of that serialized object.
- encodeToFile(byte[], String) - Static method in class org.craftercms.commons.crypto.Base64
-
Deprecated.Convenience method for encoding data to a file.
- encodeUrlMacro(String) - Static method in class org.craftercms.commons.http.HttpUtils
-
Encode an URL to valid the macro characters
- encrypt(byte[]) - Method in class org.craftercms.commons.crypto.SimpleAesCipher
-
Deprecated.
- encrypt(byte[]) - Method in class org.craftercms.commons.crypto.SimpleCipher
- encrypt(String) - Method in class org.craftercms.commons.crypto.impl.AesTextEncryptor
- encrypt(String) - Method in class org.craftercms.commons.crypto.impl.NoOpTextEncryptor
- encrypt(String) - Method in class org.craftercms.commons.crypto.impl.PbkAesTextEncryptor
- encrypt(String) - Method in interface org.craftercms.commons.crypto.TextEncryptor
-
Encrypts the specified clear text.
- encrypt(Path, InputStream, OutputStream) - Static method in class org.craftercms.commons.crypto.PGPUtils
-
Performs encryption on a single file using a PGP public key.
- encryptBase64(String) - Method in class org.craftercms.commons.crypto.SimpleCipher
- encryptedValuePrefix - Variable in class org.craftercms.commons.config.EncryptionAwareConfigurationReader
- EncryptionAwareConfigurationReader - Class in org.craftercms.commons.config
-
Base class that loads configuration files handling encrypted properties
- EncryptionAwareConfigurationReader(char, String, TextEncryptor) - Constructor for class org.craftercms.commons.config.EncryptionAwareConfigurationReader
- EncryptionAwareConfigurationReader(TextEncryptor) - Constructor for class org.craftercms.commons.config.EncryptionAwareConfigurationReader
- EncryptionAwareConfigurationReader(TextEncryptor, int) - Constructor for class org.craftercms.commons.config.EncryptionAwareConfigurationReader
- EncryptionTool - Class in org.craftercms.commons.crypto.impl
-
Main class that allows encryption/decryption of data using AES with PBK.
- EncryptionTool() - Constructor for class org.craftercms.commons.crypto.impl.EncryptionTool
- encryptor - Variable in class org.craftercms.commons.config.DecryptionLookup
- endpoint - Variable in class org.craftercms.commons.config.profiles.aws.AbstractAwsProfile
-
Endpoint to connect to compatible services (eg.
- ENGINE - Enum constant in enum class org.craftercms.commons.entitlements.model.Module
- ENTERPRISE - Static variable in interface org.craftercms.commons.plugin.model.CrafterCmsEditions
-
The enterprise edition
- Entitlement - Class in org.craftercms.commons.entitlements.model
-
Holds the value for a given entitlement type.
- Entitlement() - Constructor for class org.craftercms.commons.entitlements.model.Entitlement
- EntitlementExceededException - Exception Class in org.craftercms.commons.entitlements.exception
-
Exception thrown when the validation of an entitlement fails.
- EntitlementExceededException(Module, EntitlementType, Number, Number) - Constructor for exception class org.craftercms.commons.entitlements.exception.EntitlementExceededException
- EntitlementException - Exception Class in org.craftercms.commons.entitlements.exception
-
Base class for all entitlement related errors.
- EntitlementException() - Constructor for exception class org.craftercms.commons.entitlements.exception.EntitlementException
- EntitlementException(String) - Constructor for exception class org.craftercms.commons.entitlements.exception.EntitlementException
- EntitlementException(String, Throwable) - Constructor for exception class org.craftercms.commons.entitlements.exception.EntitlementException
- EntitlementException(Throwable) - Constructor for exception class org.craftercms.commons.entitlements.exception.EntitlementException
- entitlementType - Variable in exception class org.craftercms.commons.entitlements.exception.EntitlementExceededException
-
The entitlement that was being validated.
- entitlementType - Variable in exception class org.craftercms.commons.entitlements.exception.UnsupportedEntitlementException
-
The requested entitlement.
- EntitlementType - Enum Class in org.craftercms.commons.entitlements.model
-
Holds the available entitlements when requesting an entitlement validation.
- EntitlementUsageProvider - Interface in org.craftercms.commons.entitlements.usage
-
Defines the operations to support entitlement usage data in a module.
- EntitlementValidator - Interface in org.craftercms.commons.entitlements.validator
-
Defines the operations to perform entitlement validations.
- entitlementValue - Variable in exception class org.craftercms.commons.entitlements.exception.EntitlementExceededException
-
The entitlement value found in the license file.
- environment - Variable in class org.craftercms.commons.config.ConfigurationResolverImpl
-
The active environment
- envPath - Variable in class org.craftercms.commons.config.ConfigurationResolverImpl
-
The path pattern for a specific environment
- equals(Object) - Method in class org.craftercms.commons.config.profiles.aws.AbstractAwsProfile
- equals(Object) - Method in class org.craftercms.commons.config.profiles.aws.S3Profile
- equals(Object) - Method in class org.craftercms.commons.config.profiles.ConfigurationProfile
- equals(Object) - Method in class org.craftercms.commons.file.blob.impl.AbstractBlobStore.Mapping
- equals(Object) - Method in class org.craftercms.commons.mongo.FileInfo
- equals(Object) - Method in class org.craftercms.commons.plugin.model.Asset
- equals(Object) - Method in class org.craftercms.commons.plugin.model.Contact
- equals(Object) - Method in class org.craftercms.commons.plugin.model.Developer
- equals(Object) - Method in class org.craftercms.commons.plugin.model.Link
- equals(Object) - Method in class org.craftercms.commons.plugin.model.Media
- equals(Object) - Method in class org.craftercms.commons.plugin.model.Parameter
- equals(Object) - Method in class org.craftercms.commons.plugin.model.Plugin
- equals(Object) - Method in class org.craftercms.commons.plugin.model.PluginDescriptor
- equals(Object) - Method in class org.craftercms.commons.plugin.model.Version
- equals(Object) - Method in class org.craftercms.commons.security.permissions.DefaultPermission
- error(String, Object...) - Method in class org.craftercms.commons.i10n.I10nLogger
- error(String, Throwable, Object...) - Method in class org.craftercms.commons.i10n.I10nLogger
- ERROR_KEY_DEC_ERROR - Static variable in class org.craftercms.commons.crypto.SimpleCipher
- ERROR_KEY_ENC_ERROR - Static variable in class org.craftercms.commons.crypto.SimpleCipher
- ERROR_KEY_GET_KEY_ERROR - Static variable in class org.craftercms.commons.crypto.impl.SecretKeyRepositoryImpl
- ERROR_KEY_INVALID_ALG - Static variable in class org.craftercms.commons.crypto.SimpleDigest
- ERROR_KEY_IV_NOT_SET - Static variable in class org.craftercms.commons.crypto.SimpleCipher
- ERROR_KEY_KEY_NOT_SET - Static variable in class org.craftercms.commons.crypto.SimpleCipher
- ERROR_KEY_KEY_STORE_LOAD_ERROR - Static variable in class org.craftercms.commons.crypto.impl.SecretKeyRepositoryImpl
- ERROR_KEY_KEY_STORE_STORE_ERROR - Static variable in class org.craftercms.commons.crypto.impl.SecretKeyRepositoryImpl
- ERROR_KEY_LOAD_ERROR - Static variable in class org.craftercms.commons.config.YamlConfiguration
- ERROR_KEY_SAVE_KEY_ERROR - Static variable in class org.craftercms.commons.crypto.impl.SecretKeyRepositoryImpl
- ERROR_KEY_TEMPLATE_CONFIG_MISSING - Static variable in class org.craftercms.commons.mail.impl.EmailFactoryImpl
- ERROR_KEY_WRITE_NOT_SUPPORTED - Static variable in class org.craftercms.commons.config.YamlConfiguration
- ErrorCodes - Class in org.craftercms.commons.validation
- errorDetails - Variable in exception class org.craftercms.commons.rest.RestServiceException
- errorMessageBundle - Variable in class org.craftercms.commons.validation.rest.ValidationAwareRestExceptionHandlers
- errorMessageBundle - Variable in class org.craftercms.commons.validation.ValidationResult
- errorResponseType - Variable in class org.craftercms.commons.rest.RestTemplate
- errors - Variable in class org.craftercms.commons.validation.ValidationResult
- EsapiValidatedParam - Annotation Interface in org.craftercms.commons.validation.annotations.param
-
Parameters annotated with
EsapiValidatedParam
will be validated byEsapiValidator
using the specified type. - EsapiValidationType - Enum Class in org.craftercms.commons.validation.annotations.param
-
Supported ESAPI validator "types".
- EsapiValidator - Class in org.craftercms.commons.validation.validators.impl
-
StringValidator
extension that validates the parameter value againstESAPI
validator(), using the annotation 'type' property. - EsapiValidator() - Constructor for class org.craftercms.commons.validation.validators.impl.EsapiValidator
- EsapiValidator(EsapiValidationType) - Constructor for class org.craftercms.commons.validation.validators.impl.EsapiValidator
- Exclude - Annotation Interface in org.craftercms.commons.jackson.mvc.annotations
-
Exclude (Suppress) the Annotated field from been process it will be ignore.
- execute() - Method in interface org.craftercms.commons.lang.Callback
-
Executes the callback, returning the result or throwing a runtime exception if an error occurs.
- execute(UpgradeContext<T>) - Method in class org.craftercms.commons.upgrade.impl.operations.AbstractUpgradeOperation
- execute(UpgradeContext<T>) - Method in class org.craftercms.commons.upgrade.impl.pipeline.DefaultUpgradePipelineImpl
-
Executes each
UpgradeOperation
for the given target - execute(UpgradeContext<T>) - Method in interface org.craftercms.commons.upgrade.UpgradeOperation
-
Performs a single upgrade operation.
- execute(UpgradeContext<T>) - Method in interface org.craftercms.commons.upgrade.UpgradePipeline
-
Executes each
UpgradeOperation
for the given target - executePipeline(UpgradeContext<T>, UpgradePipelineFactory<T>) - Method in class org.craftercms.commons.upgrade.impl.AbstractUpgradeManager
- executeUpdate(String, CrudRepository<?>) - Method in class org.craftercms.commons.mongo.UpdateHelper
- exists() - Method in class org.craftercms.commons.spring.resources.S3Resource
- exists() - Method in class org.craftercms.commons.spring.resources.WebDavResource
- EXPIRES_HEADER_NAME - Static variable in class org.craftercms.commons.http.HttpUtils
- extension - Variable in class org.craftercms.commons.rest.AbstractRestClientBase
F
- FIELD_MISSING_ERROR_CODE - Static variable in class org.craftercms.commons.validation.ErrorCodes
- FIELD_UNRECOGNIZED_ERROR_CODE - Static variable in class org.craftercms.commons.validation.ErrorCodes
- FILE_MODE_CONFIG_PARAM - Static variable in class org.craftercms.commons.git.utils.GitUtils
- FILE_MODE_DEFAULT - Static variable in class org.craftercms.commons.git.utils.GitUtils
- fileExtension - Variable in class org.craftercms.commons.file.blob.impl.BlobUrlResolverImpl
-
Extension used for the blob files
- FileInfo - Class in org.craftercms.commons.mongo
-
Grid Fs File Information
- FileInfo() - Constructor for class org.craftercms.commons.mongo.FileInfo
- FileUtils - Class in org.craftercms.commons.file
-
General file manipulation utilities.
- filter - Variable in class org.craftercms.commons.jackson.mvc.CrafterJackson2MessageConverter
- find(String) - Method in class org.craftercms.commons.mongo.AbstractJongoRepository
- find(String) - Method in interface org.craftercms.commons.mongo.CrudRepository
-
Search all documents in the given collection that match the query.
- find(String, Object...) - Method in class org.craftercms.commons.mongo.AbstractJongoRepository
- find(String, Object...) - Method in interface org.craftercms.commons.mongo.CrudRepository
-
Finds all documents of the given collection that match the template query
§§ - findAll() - Method in class org.craftercms.commons.mongo.AbstractJongoRepository
- findAll() - Method in interface org.craftercms.commons.mongo.CrudRepository
-
Gets all documents of a the given collection.
- findById(String) - Method in class org.craftercms.commons.mongo.AbstractJongoRepository
- findById(String) - Method in interface org.craftercms.commons.mongo.CrudRepository
-
Finds by the Id.
- findByStringId(String) - Method in class org.craftercms.commons.mongo.AbstractJongoRepository
- findByStringId(String) - Method in interface org.craftercms.commons.mongo.CrudRepository
-
Finds by the Id.
- findFilterId(Annotated) - Method in class org.craftercms.commons.jackson.mvc.CrafterJacksonAnnotationIntrospector
- findOne(String) - Method in class org.craftercms.commons.mongo.AbstractJongoRepository
- findOne(String) - Method in interface org.craftercms.commons.mongo.CrudRepository
-
Search for documents of the given collection that match the query.
In only return the first Document - findOne(String, Object...) - Method in class org.craftercms.commons.mongo.AbstractJongoRepository
- findOne(String, Object...) - Method in interface org.craftercms.commons.mongo.CrudRepository
-
Search for documents of the given collection that match the query.
In only return the first Document - findPath(String, Locale, Locale, Predicate<String>) - Static method in class org.craftercms.commons.locale.LocaleUtils
- findSecretKey(InputStream, long, char[]) - Static method in class org.craftercms.commons.crypto.PGPUtils
-
Extracts the PGP private key from an encoded stream.
- findStore(HierarchicalConfiguration, Predicate<HierarchicalConfiguration>) - Method in class org.craftercms.commons.file.blob.impl.BlobStoreResolverImpl
- findStoreId(HierarchicalConfiguration, Predicate<HierarchicalConfiguration>) - Method in class org.craftercms.commons.file.blob.impl.BlobStoreResolverImpl
- FixedCorsConfigurationSource - Class in org.craftercms.commons.spring.cors
-
Implementation of
CorsConfigurationSource
that setup and returns a single instance - FixedCorsConfigurationSource(boolean, String, String, String, String, boolean) - Constructor for class org.craftercms.commons.spring.cors.FixedCorsConfigurationSource
- FixedPublishingTargetResolver - Class in org.craftercms.commons.config
-
Implementation of
PublishingTargetResolver
that always returns the configured target - FixedPublishingTargetResolver(String) - Constructor for class org.craftercms.commons.config.FixedPublishingTargetResolver
- FixedStoreTypeRemotePathParser - Class in org.craftercms.commons.file.stores.impl
-
RemotePathParser
that uses a fixed store type and the complete path string to build theRemotePath
. - FixedStoreTypeRemotePathParser(String) - Constructor for class org.craftercms.commons.file.stores.impl.FixedStoreTypeRemotePathParser
- flushBase64() - Method in class org.craftercms.commons.crypto.Base64.OutputStream
-
Deprecated.Method added by PHIL.
- FORMATTER - Static variable in class org.craftercms.commons.monitoring.StatusInfo
- forType(String) - Method in class org.craftercms.commons.git.utils.AuthConfiguratorFactory
-
Creates a new instance of
TypeBasedAuthConfiguratorBuilder
- forUrl(String) - Method in class org.craftercms.commons.git.utils.AuthConfiguratorFactory
-
Creates a new instance of
UrlBasedAuthConfiguratorBuilder
- ForwardedHeaderFilter - Class in org.craftercms.commons.web
-
Extension of
ForwardedHeaderFilter
that can be disabled via configuration - ForwardedHeaderFilter(boolean) - Constructor for class org.craftercms.commons.web.ForwardedHeaderFilter
- freeMarkerConfig - Variable in class org.craftercms.commons.mail.impl.EmailFactoryImpl
G
- GDataPropertyFilter - Class in org.craftercms.commons.jackson.mvc
-
A Gdata like property filter (aka selector) gets the information from .
- GDataPropertyFilter() - Constructor for class org.craftercms.commons.jackson.mvc.GDataPropertyFilter
- generateAesIv() - Static method in class org.craftercms.commons.crypto.CryptoUtils
-
Generates a random initialization vector for an AES cipher.
- generateAesKey() - Static method in class org.craftercms.commons.crypto.CryptoUtils
-
Generates a random AES encryption key.
- generateKey(String) - Static method in class org.craftercms.commons.crypto.CryptoUtils
-
Generates a random encryption key.
- generateRandomBytes(int) - Static method in class org.craftercms.commons.crypto.CryptoUtils
-
Generates a random array of bytes, using the singleton
SecureRandom
. - get(String) - Method in class org.craftercms.commons.properties.OverrideProperties
-
Gets the Query with the given name.
- get(String) - Method in class org.craftercms.commons.spring.context.ApplicationContextAccessor
- get(String, Class<T>) - Method in class org.craftercms.commons.spring.context.ApplicationContextAccessor
- getAbsoluteUrl(String) - Method in class org.craftercms.commons.rest.AbstractRestClientBase
- getAcceptableMediaTypes(HttpServletRequest) - Method in class org.craftercms.commons.rest.HttpMessageConvertingResponseWriter
-
Return the acceptable media types from the request.
- getAccessKey() - Method in class org.craftercms.commons.config.profiles.aws.AbstractAwsProfile
- getActualKey() - Method in class org.craftercms.commons.spring.resources.S3Resource
- getActualLogger() - Method in class org.craftercms.commons.i10n.I10nLogger
- getActualMethod(JoinPoint) - Static method in class org.craftercms.commons.aop.AopUtils
- getAllowedActions() - Method in class org.craftercms.commons.security.permissions.DefaultPermission
- getAllSupportedMediaTypes(List<HttpMessageConverter<?>>) - Method in class org.craftercms.commons.rest.HttpMessageConvertingResponseWriter
-
Return the media types supported by all provided message converters sorted by specificity via
MediaType.sortBySpecificity(List)
. - getAnnotatedProtectedResource(Method, Object[]) - Method in class org.craftercms.commons.security.permissions.annotations.AbstractPermissionAnnotationHandler
-
Gets the protected resource (parameter annotated with
ProtectedResource
) from the method parameters. - getAnnotatedProtectedResourceIds(Method, Object[]) - Method in class org.craftercms.commons.security.permissions.annotations.AbstractPermissionAnnotationHandler
-
Gets the protected resource ids (e.g.: siteId, path) from the method parameters.
- getApplicationContext() - Method in class org.craftercms.commons.spring.context.ApplicationContextAccessor
- getAsyncClient() - Method in class org.craftercms.commons.file.blob.impl.s3.AwsS3BlobStore
- getAttributes() - Method in class org.craftercms.commons.mongo.FileInfo
- getAttributes() - Method in class org.craftercms.commons.plugin.model.Installation.Element
- getAuditDate() - Method in class org.craftercms.commons.audit.AuditModel
-
Gets Audit entry Date.
- getAuditLog(String) - Method in class org.craftercms.commons.audit.AuditService
-
Gets the audit log for its Id.
- getAuditLogs(Date) - Method in class org.craftercms.commons.audit.AuditService
-
Returns all Audits starting the given date.
- getAuditLogs(Date, Date) - Method in class org.craftercms.commons.audit.AuditService
-
Returns all Audits where logged date is between the given dates.
- getBase64Salt() - Method in class org.craftercms.commons.crypto.SimpleDigest
- getBaseRequestUrl(HttpServletRequest, boolean) - Static method in class org.craftercms.commons.http.HttpUtils
-
Returns the portion from the URL that includes the scheme, server name and port number, without the server path.
- getBaseUrl() - Method in class org.craftercms.commons.config.profiles.webdav.WebDavProfile
-
Returns the base url of the webdav server.
- getBean(String) - Method in class org.craftercms.commons.spring.context.RestrictedApplicationContext
- getBean(String, Class<T>) - Method in class org.craftercms.commons.spring.context.RestrictedApplicationContext
- getBlobUrl(String) - Method in interface org.craftercms.commons.file.blob.BlobUrlResolver
-
Returns the blob file url for the given content
- getBlobUrl(String) - Method in class org.craftercms.commons.file.blob.impl.BlobUrlResolverImpl
- getBlueprint() - Method in class org.craftercms.commons.plugin.model.BlueprintDescriptor
-
Deprecated.
- getBlueprint() - Method in class org.craftercms.commons.plugin.model.PluginDescriptor
-
Deprecated.
- getBooleanProperty(Configuration, String) - Static method in class org.craftercms.commons.config.ConfigUtils
-
Returns the specified Boolean property from the configuration
- getBooleanProperty(Configuration, String, Boolean) - Static method in class org.craftercms.commons.config.ConfigUtils
-
Returns the specified Boolean property from the configuration
- getBucketName() - Method in class org.craftercms.commons.config.profiles.aws.S3Profile
- getBuild() - Method in class org.craftercms.commons.plugin.model.BlueprintDescriptor.Blueprint
-
Deprecated.
- getById(HierarchicalConfiguration, String) - Method in class org.craftercms.commons.file.blob.impl.BlobStoreResolverImpl
- getById(ConfigurationProvider, String) - Method in interface org.craftercms.commons.file.blob.BlobStoreResolver
-
Returns the
BlobStore
for the given id - getById(ConfigurationProvider, String) - Method in class org.craftercms.commons.file.blob.impl.BlobStoreResolverImpl
- getChildren() - Method in class org.craftercms.commons.plugin.model.Installation.Element
- getCipher() - Method in class org.craftercms.commons.crypto.SimpleCipher
- getClassForName(String) - Method in class org.craftercms.commons.config.DisableClassLoadingConstructor
- getClient() - Method in class org.craftercms.commons.file.blob.impl.s3.AwsS3BlobStore
- getClient(P) - Method in class org.craftercms.commons.aws.AbstractAwsClientCachingFactory
- getClientId() - Method in interface org.craftercms.commons.entitlements.validator.EntitlementValidator
-
Provides the client id of the current validator.
- getCollection() - Method in class org.craftercms.commons.mongo.AbstractJongoRepository
-
Gets the Jongo Document.
- getCompany() - Method in class org.craftercms.commons.plugin.model.BlueprintDescriptor.Developer
-
Deprecated.
- getCompany() - Method in class org.craftercms.commons.plugin.model.Developer
- getCompatibleLocales(Locale) - Static method in class org.craftercms.commons.locale.LocaleUtils
- getCompatibleLocales(Locale, Locale) - Static method in class org.craftercms.commons.locale.LocaleUtils
- getConfig(String) - Method in interface org.craftercms.commons.config.ConfigurationProvider
-
Get the content of the given configuration file
- getConfiguration() - Method in class org.craftercms.commons.upgrade.impl.configuration.YamlConfigurationProvider
- getConfiguration() - Method in interface org.craftercms.commons.upgrade.UpgradeConfigurationProvider
-
Gets the configuration for the upgrade process
- getConfiguration(ConfigurationProvider) - Method in class org.craftercms.commons.file.blob.impl.BlobStoreResolverImpl
- getConfigurationAt(HierarchicalConfiguration<ImmutableNode>, String) - Static method in class org.craftercms.commons.config.ConfigUtils
-
Returns the sub-configuration whose root is the specified key.
- getConfigurationsAt(HierarchicalConfiguration<ImmutableNode>, String) - Static method in class org.craftercms.commons.config.ConfigUtils
-
Returns the sub-configurations whose root is the specified key.
- getConnectorFactory() - Method in class org.craftercms.commons.git.jgit.SshSessionFactory
- getContentLength() - Method in class org.craftercms.commons.file.stores.impl.ResourceBasedRemoteFile
- getContentLength() - Method in interface org.craftercms.commons.file.stores.RemoteFile
-
Returns the content length of the file.
- getContentType() - Method in class org.craftercms.commons.mongo.FileInfo
- getContentUrl(String) - Method in interface org.craftercms.commons.file.blob.BlobUrlResolver
-
Returns the content url for the given blob file
- getContentUrl(String) - Method in class org.craftercms.commons.file.blob.impl.BlobUrlResolverImpl
- getCookie(String, HttpServletRequest) - Static method in class org.craftercms.commons.http.HttpUtils
-
Returns the cookie with the given name for the given request
- getCookieValue(String, HttpServletRequest) - Static method in class org.craftercms.commons.http.HttpUtils
-
Returns the cookie value with the given name for the given request
- getCorsConfiguration(HttpServletRequest) - Method in class org.craftercms.commons.spring.cors.FixedCorsConfigurationSource
- getCrafterCmsEditions() - Method in class org.craftercms.commons.plugin.model.Plugin
- getCrafterCmsVersions() - Method in class org.craftercms.commons.plugin.model.Plugin
- getCraftercmsVersionsSupported() - Method in class org.craftercms.commons.plugin.model.BlueprintDescriptor.Blueprint
-
Deprecated.
- getCredentialsProvider() - Method in class org.craftercms.commons.config.profiles.aws.AbstractAwsProfile
- getCurrent() - Static method in class org.craftercms.commons.http.RequestContext
-
Returns the context for the current thread.
- getCurrentMemory() - Static method in class org.craftercms.commons.monitoring.MemoryInfo
- getCurrentMemory(String) - Method in class org.craftercms.commons.monitoring.rest.MonitoringRestControllerBase
- getCurrentStatus() - Static method in class org.craftercms.commons.monitoring.StatusInfo
-
Create the StatusInfo with current information.
- getCurrentStatus(String, String) - Method in class org.craftercms.commons.monitoring.rest.MonitoringRestControllerBase
- getCurrentSubject() - Method in interface org.craftercms.commons.security.permissions.SubjectResolver
-
Returns the current subject.
- getCurrentUsage() - Method in interface org.craftercms.commons.entitlements.usage.EntitlementUsageProvider
-
Provides a list holding the current values for all entitlements supported by the current module.
- getCurrentValue() - Method in exception class org.craftercms.commons.entitlements.exception.EntitlementExceededException
- getCurrentVersion(String) - Method in class org.craftercms.commons.monitoring.rest.MonitoringRestControllerBase
- getDate() - Method in class org.craftercms.commons.plugin.model.BlueprintDescriptor.Build
-
Deprecated.
- getDefaultErrorMessageBundle() - Static method in class org.craftercms.commons.validation.ValidationUtils
- getDefaultIdentities(File) - Method in class org.craftercms.commons.git.jgit.SshPrivateKeySessionFactory
- getDefaultPreferredAuthentications() - Method in class org.craftercms.commons.git.jgit.SshPrivateKeySessionFactory
- getDefaultPreferredAuthentications() - Method in class org.craftercms.commons.git.jgit.SshSessionFactory
- getDefaultValue() - Method in class org.craftercms.commons.plugin.model.Parameter
- getDeliveryBaseUrl() - Method in class org.craftercms.commons.config.profiles.webdav.WebDavProfile
-
Deprecated.The new service will ignore this property and use a /remote-assets/... URL instead
- getDescription() - Method in interface org.craftercms.commons.entitlements.validator.EntitlementValidator
-
Provides a general description of the current validator.
- getDescription() - Method in class org.craftercms.commons.entitlements.validator.impl.DefaultEntitlementValidatorImpl
- getDescription() - Method in class org.craftercms.commons.plugin.model.Asset
- getDescription() - Method in class org.craftercms.commons.plugin.model.BlueprintDescriptor.Blueprint
-
Deprecated.
- getDescription() - Method in class org.craftercms.commons.plugin.model.BlueprintDescriptor.Screenshot
-
Deprecated.
- getDescription() - Method in class org.craftercms.commons.plugin.model.BlueprintDescriptor.Video
-
Deprecated.
- getDescription() - Method in class org.craftercms.commons.plugin.model.Parameter
- getDescription() - Method in class org.craftercms.commons.plugin.model.Plugin
- getDescription() - Method in class org.craftercms.commons.spring.resources.S3Resource
- getDescription() - Method in class org.craftercms.commons.spring.resources.WebDavResource
- getDescriptorVersion() - Method in class org.craftercms.commons.plugin.model.BlueprintDescriptor
-
Deprecated.
- getDescriptorVersion() - Method in class org.craftercms.commons.plugin.model.PluginDescriptor
- getDeveloper() - Method in class org.craftercms.commons.plugin.model.BlueprintDescriptor.Media
-
Deprecated.
- getDeveloper() - Method in class org.craftercms.commons.plugin.model.Plugin
- getDigest() - Method in class org.craftercms.commons.crypto.SimpleDigest
- getDocumentation() - Method in class org.craftercms.commons.plugin.model.Plugin
- getEdition(String) - Static method in class org.craftercms.commons.plugin.model.Version
- getElement() - Method in class org.craftercms.commons.plugin.model.Installation
- getElementXpath() - Method in class org.craftercms.commons.plugin.model.Installation
- getEmail() - Method in class org.craftercms.commons.plugin.model.BlueprintDescriptor.Company
-
Deprecated.
- getEmail() - Method in class org.craftercms.commons.plugin.model.BlueprintDescriptor.Person
-
Deprecated.
- getEmail() - Method in class org.craftercms.commons.plugin.model.Contact
- getEmail(String, String[], String[], String[], String, String, boolean, File...) - Method in interface org.craftercms.commons.mail.EmailFactory
-
Creates a new
Email
. - getEmail(String, String[], String[], String[], String, String, boolean, File...) - Method in class org.craftercms.commons.mail.impl.EmailFactoryImpl
- getEmail(String, String[], String[], String[], String, String, Object, boolean, File...) - Method in interface org.craftercms.commons.mail.EmailFactory
-
Creates a new
Email
. - getEmail(String, String[], String[], String[], String, String, Object, boolean, File...) - Method in class org.craftercms.commons.mail.impl.EmailFactoryImpl
- getEmail(String, String[], String[], String[], String, String, String, boolean, File...) - Method in interface org.craftercms.commons.mail.EmailFactory
-
Creates a new
Email
. - getEmail(String, String[], String[], String[], String, String, String, boolean, File...) - Method in class org.craftercms.commons.mail.impl.EmailFactoryImpl
- getEmail(String, String[], String[], String[], String, String, String, Object, boolean, File...) - Method in interface org.craftercms.commons.mail.EmailFactory
-
Creates a new
Email
. - getEmail(String, String[], String[], String[], String, String, String, Object, boolean, File...) - Method in class org.craftercms.commons.mail.impl.EmailFactoryImpl
- getEndpoint() - Method in class org.craftercms.commons.config.profiles.aws.AbstractAwsProfile
- getEntitlementType() - Method in exception class org.craftercms.commons.entitlements.exception.EntitlementExceededException
- getEntitlementType() - Method in exception class org.craftercms.commons.entitlements.exception.UnsupportedEntitlementException
- getEntitlementUsage(EntitlementType) - Method in interface org.craftercms.commons.entitlements.usage.EntitlementUsageProvider
-
Returns the current usage for a given entitlement type in the current module
- getEntitlementValue() - Method in exception class org.craftercms.commons.entitlements.exception.EntitlementExceededException
- getErrorDetails() - Method in exception class org.craftercms.commons.rest.RestServiceException
- getErrorMessage(ResourceBundle, String, Object...) - Static method in class org.craftercms.commons.validation.ValidationUtils
- getErrors() - Method in class org.craftercms.commons.validation.ValidationResult
- getEsapiErrorMessageKey(String) - Static method in class org.craftercms.commons.validation.ErrorCodes
- getField() - Method in class org.craftercms.commons.rest.parameters.SortField
- getFile() - Method in class org.craftercms.commons.spring.resources.S3Resource
- getFile() - Method in class org.craftercms.commons.spring.resources.WebDavResource
- getFile(RemotePath) - Method in class org.craftercms.commons.file.stores.impl.AbstractProfileAwareRemoteFileStore
- getFile(RemotePath) - Method in class org.craftercms.commons.file.stores.impl.UrlBasedFileStore
- getFile(RemotePath) - Method in interface org.craftercms.commons.file.stores.RemoteFileStore
-
Resolves the given
RemotePath
as aRemoteFile
. - getFile(UpgradeContext<T>) - Method in class org.craftercms.commons.upgrade.impl.providers.AbstractFileVersionProvider
- getFileId() - Method in class org.craftercms.commons.mongo.FileInfo
- getFileInfo(String) - Method in class org.craftercms.commons.mongo.AbstractJongoRepository
- getFileInfo(String) - Method in interface org.craftercms.commons.mongo.CrudRepository
-
Gets the file information based on its name..
- getFileInfo(ObjectId) - Method in class org.craftercms.commons.mongo.AbstractJongoRepository
- getFileInfo(ObjectId) - Method in interface org.craftercms.commons.mongo.CrudRepository
-
Gets the file information based on its id..
- getFilename() - Method in class org.craftercms.commons.spring.resources.S3Resource
- getFilename() - Method in class org.craftercms.commons.spring.resources.WebDavResource
- getFileName() - Method in class org.craftercms.commons.mongo.FileInfo
- getFileSize() - Method in class org.craftercms.commons.mongo.FileInfo
- getFileSizeBytes() - Method in class org.craftercms.commons.mongo.FileInfo
- getFilterName() - Method in class org.craftercms.commons.jackson.mvc.AbstractCrafterPropertyFilter
- getFilterName() - Method in class org.craftercms.commons.jackson.mvc.GDataPropertyFilter
- getFreeJvmMemory() - Method in class org.craftercms.commons.monitoring.MemoryInfo
- getFreeOsMemory() - Method in class org.craftercms.commons.monitoring.MemoryInfo
- getFreeSwapMemory() - Method in class org.craftercms.commons.monitoring.MemoryInfo
- getFullRequestUri(HttpServletRequest, boolean) - Static method in class org.craftercms.commons.http.HttpUtils
-
Returns the full request URI, including scheme, server name, port number and server path.
- getFullUrl(HttpServletRequest, String) - Static method in class org.craftercms.commons.http.HttpUtils
-
Returns the full URL for the relative URL based in the specified request.
- getGlobalPermission(S) - Method in interface org.craftercms.commons.security.permissions.PermissionResolver
-
Returns the global permission (that applies to any or all resources) associated to the given subject.
- getHash() - Method in class org.craftercms.commons.file.blob.Blob
- getHasPermissionAnnotation(Method, ProceedingJoinPoint, Class<T>) - Method in class org.craftercms.commons.security.permissions.annotations.AbstractPermissionAnnotationHandler
-
Get a permission annotation of the given type from the given method or its containing class if exists
- getHomeDirectory() - Method in class org.craftercms.commons.git.jgit.SshSessionFactory
- getId() - Method in class org.craftercms.commons.audit.AuditModel
-
Gets Id of the Audit Entry.
- getId() - Method in interface org.craftercms.commons.entitlements.validator.EntitlementValidator
-
Provides the id of the current validator.
- getId() - Method in interface org.craftercms.commons.file.blob.BlobStore
-
Returns the unique id of the store
- getId() - Method in class org.craftercms.commons.file.blob.impl.AbstractBlobStore
- getId() - Method in class org.craftercms.commons.plugin.model.BlueprintDescriptor.Blueprint
-
Deprecated.
- getId() - Method in class org.craftercms.commons.plugin.model.BlueprintDescriptor.Build
-
Deprecated.
- getId() - Method in class org.craftercms.commons.plugin.model.Plugin
- getInputStream() - Method in class org.craftercms.commons.file.stores.impl.ResourceBasedRemoteFile
- getInputStream() - Method in interface org.craftercms.commons.file.stores.RemoteFile
-
Returns an input stream to the content of the file.
- getInputStream() - Method in class org.craftercms.commons.mongo.FileInfo
- getInputStream() - Method in class org.craftercms.commons.spring.resources.S3Resource
- getInputStream() - Method in class org.craftercms.commons.spring.resources.WebDavResource
- getInputStream(long, long) - Method in interface org.craftercms.commons.spring.resources.RangeAwareResource
-
Returns a range of bytes from the resource's content.
- getInputStream(long, long) - Method in class org.craftercms.commons.spring.resources.RangeAwareUrlResource
- getInputStream(long, long) - Method in class org.craftercms.commons.spring.resources.S3Resource
- getInputStream(long, long) - Method in class org.craftercms.commons.spring.resources.WebDavResource
- getInstallation() - Method in class org.craftercms.commons.plugin.model.Plugin
- getIntegerProperty(Configuration, String) - Static method in class org.craftercms.commons.config.ConfigUtils
-
Returns the specified Integer property from the configuration
- getIntegerProperty(Configuration, String, Integer) - Static method in class org.craftercms.commons.config.ConfigUtils
-
Returns the specified Integer property from the configuration
- getIterations() - Method in class org.craftercms.commons.crypto.SimpleDigest
- getIv() - Method in class org.craftercms.commons.crypto.SimpleCipher
- getJavaVendor() - Method in class org.craftercms.commons.monitoring.VersionInfo
- getJavaVersion() - Method in class org.craftercms.commons.monitoring.VersionInfo
- getJavaVm() - Method in class org.craftercms.commons.monitoring.VersionInfo
- getJsonPrefix() - Method in class org.craftercms.commons.jackson.mvc.CrafterJackson2MessageConverter
- getKey() - Method in class org.craftercms.commons.crypto.SimpleCipher
- getKey(String, boolean) - Method in class org.craftercms.commons.crypto.impl.SecretKeyRepositoryImpl
- getKey(String, boolean) - Method in interface org.craftercms.commons.crypto.SecretKeyRepository
-
Returns the secret key for the specified key name
- getKey(AbstractBlobStore.Mapping, String) - Method in class org.craftercms.commons.file.blob.impl.s3.AwsS3BlobStore
- getLabel() - Method in class org.craftercms.commons.plugin.model.Parameter
- getLicense() - Method in class org.craftercms.commons.plugin.model.BlueprintDescriptor.Blueprint
-
Deprecated.
- getLicense() - Method in class org.craftercms.commons.plugin.model.Plugin
- getLoaderOptions() - Method in class org.craftercms.commons.config.YamlConfiguration
- getLocalizedMessage(String, Object...) - Method in class org.craftercms.commons.i10n.I10nLogger
- getLocalizedMessage(String, String, Object...) - Static method in class org.craftercms.commons.i10n.I10nUtils
-
Returns a formatted, localized message according to the specified resource bundle and key.
- getLocalizedMessage(ResourceBundle, String, Object...) - Static method in class org.craftercms.commons.i10n.I10nUtils
-
Returns a formatted, localized message according to the specified resource bundle and key.
- getLock(Object) - Method in class org.craftercms.commons.concurrent.locks.AbstractWeakKeyBasedLockFactory
- getLock(Object) - Method in interface org.craftercms.commons.concurrent.locks.KeyBasedLockFactory
-
Returns a lock for the specified key.
- getLongProperty(Configuration, String) - Static method in class org.craftercms.commons.config.ConfigUtils
-
Returns the specified Long property from the configuration
- getLongProperty(Configuration, String, Long) - Static method in class org.craftercms.commons.config.ConfigUtils
-
Returns the specified Long property from the configuration
- getLookupVariables() - Method in interface org.craftercms.commons.config.ConfigurationProvider
-
Get a Map of variables to be expanded during configuration files loading.
- getMajor() - Method in class org.craftercms.commons.plugin.model.BlueprintDescriptor.Version
-
Deprecated.
- getMajor() - Method in class org.craftercms.commons.plugin.model.Version
- getMapping(String) - Method in class org.craftercms.commons.file.blob.impl.AbstractBlobStore
- getMaxJvmMemory() - Method in class org.craftercms.commons.monitoring.MemoryInfo
- getMd5() - Method in class org.craftercms.commons.mongo.FileInfo
- getMedia() - Method in class org.craftercms.commons.plugin.model.BlueprintDescriptor.Blueprint
-
Deprecated.
- getMedia() - Method in class org.craftercms.commons.plugin.model.Plugin
- getMessage() - Method in exception class org.craftercms.commons.i10n.AbstractI10nException
- getMessage() - Method in exception class org.craftercms.commons.i10n.AbstractI10nRuntimeException
- getMessage() - Method in class org.craftercms.commons.rest.Result
- getMessage() - Method in class org.craftercms.commons.validation.ValidationError
- getMessage() - Method in exception class org.craftercms.commons.validation.ValidationException
- getMessage() - Method in class org.craftercms.commons.validation.ValidationResult
- getMessage() - Method in exception class org.craftercms.commons.validation.ValidationRuntimeException
- getMessageConverters() - Method in class org.craftercms.commons.rest.HttpMessageConvertingResponseErrorHandler
- getMinor() - Method in class org.craftercms.commons.plugin.model.BlueprintDescriptor.Version
-
Deprecated.
- getMinor() - Method in class org.craftercms.commons.plugin.model.Version
- getModule() - Method in exception class org.craftercms.commons.entitlements.exception.EntitlementExceededException
- getModule() - Method in exception class org.craftercms.commons.entitlements.exception.UnsupportedEntitlementException
- getModule() - Method in interface org.craftercms.commons.entitlements.usage.EntitlementUsageProvider
-
Identifies the current module running.
- getMostSpecificMediaType(MediaType, MediaType) - Method in class org.craftercms.commons.rest.HttpMessageConvertingResponseWriter
-
Return the more specific of the acceptable and the producible media types with the q-value of the former.
- getMostSuperClassName(Class<?>) - Method in class org.craftercms.commons.jackson.mvc.GDataPropertyFilter
- getName() - Method in class org.craftercms.commons.plugin.model.BlueprintDescriptor.Blueprint
-
Deprecated.
- getName() - Method in class org.craftercms.commons.plugin.model.BlueprintDescriptor.Company
-
Deprecated.
- getName() - Method in class org.craftercms.commons.plugin.model.BlueprintDescriptor.License
-
Deprecated.
- getName() - Method in class org.craftercms.commons.plugin.model.BlueprintDescriptor.Person
-
Deprecated.
- getName() - Method in class org.craftercms.commons.plugin.model.BlueprintDescriptor.Website
-
Deprecated.
- getName() - Method in class org.craftercms.commons.plugin.model.Contact
- getName() - Method in class org.craftercms.commons.plugin.model.Installation.Attribute
- getName() - Method in class org.craftercms.commons.plugin.model.Installation.Element
- getName() - Method in class org.craftercms.commons.plugin.model.Link
- getName() - Method in class org.craftercms.commons.plugin.model.Parameter
- getName() - Method in class org.craftercms.commons.plugin.model.Plugin
- getObject() - Method in class org.craftercms.commons.crypto.SecretKeyFactoryBean
- getObject() - Method in class org.craftercms.commons.spring.BeanListFactoryBean
- getObject() - Method in class org.craftercms.commons.spring.ConditionalFactoryBean
- getObjectFor(Class<T>, Object, String, Object) - Method in interface org.craftercms.commons.jackson.mvc.annotations.InjectValueFactory
- getObjectType() - Method in class org.craftercms.commons.cache.GuavaCacheFactoryBean
- getObjectType() - Method in class org.craftercms.commons.crypto.SecretKeyFactoryBean
- getObjectType() - Method in class org.craftercms.commons.jackson.mvc.SelectorFilterFactory
- getObjectType() - Method in class org.craftercms.commons.mongo.JongoFactoryBean
- getObjectType() - Method in class org.craftercms.commons.mongo.MongoClientFactory
- getObjectType() - Method in class org.craftercms.commons.mongo.MongoClientFromUriFactoryBean
- getObjectType() - Method in class org.craftercms.commons.mongo.MongoClientOptionsFactory
- getObjectType() - Method in class org.craftercms.commons.spring.BeanListFactoryBean
- getObjectType() - Method in class org.craftercms.commons.spring.ConditionalFactoryBean
- getObjectType() - Method in class org.craftercms.commons.spring.groovy.SandboxInterceptorFactory
- getOrder() - Method in class org.craftercms.commons.rest.parameters.SortField
- getOrder() - Method in class org.craftercms.commons.spring.ListMergingPostProcessor
- getOrigins(String) - Static method in class org.craftercms.commons.spring.cors.FixedCorsConfigurationSource
- getOsArch() - Method in class org.craftercms.commons.monitoring.VersionInfo
- getOsName() - Method in class org.craftercms.commons.monitoring.VersionInfo
- getOsVersion() - Method in class org.craftercms.commons.monitoring.VersionInfo
- getPackageBuild() - Method in interface org.craftercms.commons.entitlements.validator.EntitlementValidator
-
Provides the build of the containing JAR file.
- getPackageBuild() - Method in class org.craftercms.commons.monitoring.VersionInfo
- getPackageBuildDate() - Method in class org.craftercms.commons.monitoring.VersionInfo
- getPackageName() - Method in class org.craftercms.commons.monitoring.VersionInfo
- getPackageVersion() - Method in interface org.craftercms.commons.entitlements.validator.EntitlementValidator
-
Provides the version of the containing JAR file.
- getPackageVersion() - Method in class org.craftercms.commons.monitoring.VersionInfo
- getParameters() - Method in class org.craftercms.commons.plugin.model.Plugin
- getParamsFromQueryString(String) - Static method in class org.craftercms.commons.http.HttpUtils
-
Returns a map with the extracted parameters from the specified query string.
- getParentXpath() - Method in class org.craftercms.commons.plugin.model.Installation
- getPassword() - Method in class org.craftercms.commons.config.profiles.webdav.WebDavProfile
-
Returns the password used to connect to the server.
- getPatch() - Method in class org.craftercms.commons.plugin.model.BlueprintDescriptor.Version
-
Deprecated.
- getPatch() - Method in class org.craftercms.commons.plugin.model.Version
- getPath() - Method in class org.craftercms.commons.file.stores.impl.ResourceBasedRemoteFile
- getPath() - Method in interface org.craftercms.commons.file.stores.RemoteFile
-
Returns information about the path of the file in the remote store.
- getPath() - Method in class org.craftercms.commons.file.stores.RemotePath
-
Returns the path or ID of file in the remote store.
- getPayload() - Method in class org.craftercms.commons.audit.AuditModel
-
Gets Payload of the audit.
- getPeople() - Method in class org.craftercms.commons.plugin.model.BlueprintDescriptor.Developer
-
Deprecated.
- getPeople() - Method in class org.craftercms.commons.plugin.model.Developer
- getPermission(S, R) - Method in interface org.craftercms.commons.security.permissions.PermissionResolver
-
Returns the permission associated to the given subject and resource.
- getPermissions() - Method in class org.craftercms.commons.security.permissions.ProtectedResourceBase
- getPerson() - Method in class org.craftercms.commons.plugin.model.BlueprintDescriptor.PersonWrapper
-
Deprecated.
- getPipeline(UpgradeContext<T>) - Method in class org.craftercms.commons.upgrade.impl.pipeline.DefaultUpgradePipelineFactoryImpl
-
Retrieves the needed upgrade operations for the given target
- getPipeline(UpgradeContext<T>) - Method in interface org.craftercms.commons.upgrade.UpgradePipelineFactory
-
Retrieves the needed upgrade operations for the given target
- getPlugin() - Method in class org.craftercms.commons.plugin.model.PluginDescriptor
- getPrefix() - Method in class org.craftercms.commons.config.profiles.aws.S3Profile
- getProducibleMediaTypes(Class<?>) - Method in class org.craftercms.commons.rest.HttpMessageConvertingResponseWriter
-
Returns the media types that can be produced: Media types of configured converters that can write the specific return value, or
MediaType.ALL
- getProfile() - Method in class org.craftercms.commons.file.stores.impl.ProfileAwareRemotePath
- getProfileId() - Method in class org.craftercms.commons.config.profiles.ConfigurationProfile
- getProperty(String) - Method in class org.craftercms.commons.spring.ApacheCommonsConfiguration2PropertySource
- getPropertyNames() - Method in class org.craftercms.commons.spring.ApacheCommonsConfiguration2PropertySource
- getProxyCookieHeader(HttpServletRequest) - Static method in class org.craftercms.commons.proxy.ProxyUtils
-
Rebuild cookie header to filter out cookies should be ignored by the proxy
- getPublicKey(InputStream) - Static method in class org.craftercms.commons.crypto.PGPUtils
-
Extracts the PGP public key from an encoded stream.
- getPublishingTarget() - Method in class org.craftercms.commons.config.FixedPublishingTargetResolver
- getPublishingTarget() - Method in interface org.craftercms.commons.config.PublishingTargetResolver
-
Returns the current publishing target
- getQueryFor(String) - Method in class org.craftercms.commons.mongo.AbstractJongoRepository
-
Get the query string for a given key
- getQueryStringFromParams(MultiValueMap<String, String>) - Static method in class org.craftercms.commons.http.HttpUtils
-
Builds a query string from the specified params.
- getQueryStringFromParams(MultiValueMap<String, String>, boolean) - Static method in class org.craftercms.commons.http.HttpUtils
-
Builds a query string from the specified params.
- getQueryStringFromParams(MultiValueMap<String, String>, String, boolean) - Static method in class org.craftercms.commons.http.HttpUtils
-
Builds a query string from the specified params.
- getRegion() - Method in class org.craftercms.commons.config.profiles.aws.AbstractAwsProfile
- getRequest() - Method in class org.craftercms.commons.http.RequestContext
-
Returns the current request.
- getRequestUriWithoutContextPath(HttpServletRequest) - Static method in class org.craftercms.commons.http.HttpUtils
-
Returns the request URI without the context path.
- getRequiredBooleanProperty(Configuration, String) - Static method in class org.craftercms.commons.config.ConfigUtils
-
Returns the specified Boolean property from the configuration.
- getRequiredConfigurationAt(HierarchicalConfiguration<ImmutableNode>, String) - Static method in class org.craftercms.commons.config.ConfigUtils
-
Returns the sub-configuration whose root is the specified key.
- getRequiredConfigurationsAt(HierarchicalConfiguration<ImmutableNode>, String) - Static method in class org.craftercms.commons.config.ConfigUtils
-
Returns the sub-configurations whose root is the specified key.
- getRequiredIntegerProperty(Configuration, String) - Static method in class org.craftercms.commons.config.ConfigUtils
-
Returns the specified Integer property from the configuration.
- getRequiredLongProperty(Configuration, String) - Static method in class org.craftercms.commons.config.ConfigUtils
-
Returns the specified Long property from the configuration.
- getRequiredStringArrayProperty(Configuration, String) - Static method in class org.craftercms.commons.config.ConfigUtils
-
Returns the specified String array property from the configuration.
- getRequiredStringProperty(Configuration, String) - Static method in class org.craftercms.commons.config.ConfigUtils
-
Returns the specified String property from the configuration.
- getResource() - Method in class org.craftercms.commons.spring.resources.WebDavResource
- getResource(String, Blob) - Method in interface org.craftercms.commons.file.blob.BlobStore
-
Resolves the given blob to a readable resource
- getResource(String, Blob) - Method in class org.craftercms.commons.file.blob.impl.AbstractBlobStore
- getResourceBundle() - Method in exception class org.craftercms.commons.crypto.CryptoException
- getResourceBundle() - Method in exception class org.craftercms.commons.exceptions.DateParseException
- getResourceBundle() - Method in exception class org.craftercms.commons.i10n.AbstractI10nException
- getResourceBundle() - Method in exception class org.craftercms.commons.i10n.AbstractI10nRuntimeException
- getResourceBundle() - Method in exception class org.craftercms.commons.mail.EmailException
- getResourceBundle() - Method in exception class org.craftercms.commons.security.exception.SecurityException
- getResponse() - Method in class org.craftercms.commons.http.RequestContext
-
Returns the current response.
- getResponseBodyAsString(ClientHttpResponse) - Method in class org.craftercms.commons.rest.HttpMessageConvertingResponseErrorHandler
- getResponseStatus() - Method in exception class org.craftercms.commons.rest.RestServiceException
- getResponseType() - Method in class org.craftercms.commons.rest.HttpMessageConvertingResponseErrorHandler
- getResult() - Method in exception class org.craftercms.commons.validation.ValidationException
- getResult() - Method in interface org.craftercms.commons.validation.ValidationResultAware
- getResult() - Method in exception class org.craftercms.commons.validation.ValidationRuntimeException
- getSalt() - Method in class org.craftercms.commons.crypto.SimpleDigest
- getSavedDate() - Method in class org.craftercms.commons.mongo.FileInfo
- getScreenshot() - Method in class org.craftercms.commons.plugin.model.BlueprintDescriptor.ScreenshotWrapper
-
Deprecated.
- getScreenshots() - Method in class org.craftercms.commons.plugin.model.BlueprintDescriptor.Media
-
Deprecated.
- getScreenshots() - Method in class org.craftercms.commons.plugin.model.Media
- getSearchEngine() - Method in class org.craftercms.commons.plugin.model.BlueprintDescriptor.Blueprint
-
Deprecated.
- getSearchEngine() - Method in class org.craftercms.commons.plugin.model.Plugin
- getSecretKey() - Method in class org.craftercms.commons.config.profiles.aws.AbstractAwsProfile
- getServletContext() - Method in class org.craftercms.commons.http.RequestContext
-
Returns the current servlet context.
- getSourceClass() - Method in interface org.craftercms.commons.converters.Converter
-
Returns the class of the objects this converter converts from.
- getSourceClass() - Method in class org.craftercms.commons.converters.impl.StringToBooleanConverter
- getSourceClass() - Method in class org.craftercms.commons.converters.impl.StringToDateConverter
- getSourceClass() - Method in class org.craftercms.commons.converters.impl.StringToDoubleConverter
- getSourceClass() - Method in class org.craftercms.commons.converters.impl.StringToFloatConverter
- getSourceClass() - Method in class org.craftercms.commons.converters.impl.StringToIntegerConverter
- getSourceClass() - Method in class org.craftercms.commons.converters.impl.StringToLongConverter
- getSourceClass() - Method in class org.craftercms.commons.converters.impl.StringToShortConverter
- getSourceClass() - Method in class org.craftercms.commons.converters.impl.StringToStringConverter
- getSshDirectory() - Method in class org.craftercms.commons.git.jgit.SshSessionFactory
- getStartup() - Method in class org.craftercms.commons.monitoring.StatusInfo
- getStoreId() - Method in class org.craftercms.commons.file.blob.Blob
- getStoreName() - Method in class org.craftercms.commons.mongo.FileInfo
- getStoreType() - Method in class org.craftercms.commons.file.stores.RemotePath
-
Returns the remote store type (s3, etc).
- getStringArrayProperty(Configuration, String) - Static method in class org.craftercms.commons.config.ConfigUtils
-
Returns the specified String array property from the configuration.
- getStringProperty(Configuration, String) - Static method in class org.craftercms.commons.config.ConfigUtils
-
Returns the specified String property from the configuration
- getStringProperty(Configuration, String, String) - Static method in class org.craftercms.commons.config.ConfigUtils
-
Returns the specified String property from the configuration
- getSupportedEntitlements() - Method in interface org.craftercms.commons.entitlements.usage.EntitlementUsageProvider
- getTags() - Method in class org.craftercms.commons.plugin.model.BlueprintDescriptor.Blueprint
-
Deprecated.
- getTags() - Method in class org.craftercms.commons.plugin.model.Plugin
- getTarget() - Method in class org.craftercms.commons.upgrade.impl.UpgradeContext
- getTargetClass() - Method in interface org.craftercms.commons.converters.Converter
-
Returns the class of the objects this converter converts to.
- getTargetClass() - Method in class org.craftercms.commons.converters.impl.StringToBooleanConverter
- getTargetClass() - Method in class org.craftercms.commons.converters.impl.StringToDateConverter
- getTargetClass() - Method in class org.craftercms.commons.converters.impl.StringToDoubleConverter
- getTargetClass() - Method in class org.craftercms.commons.converters.impl.StringToFloatConverter
- getTargetClass() - Method in class org.craftercms.commons.converters.impl.StringToIntegerConverter
- getTargetClass() - Method in class org.craftercms.commons.converters.impl.StringToLongConverter
- getTargetClass() - Method in class org.craftercms.commons.converters.impl.StringToShortConverter
- getTargetClass() - Method in class org.craftercms.commons.converters.impl.StringToStringConverter
- getTargetId() - Method in class org.craftercms.commons.validation.ValidationError
- getTargets() - Method in class org.craftercms.commons.upgrade.impl.AbstractUpgradeManager
- getTargets() - Method in interface org.craftercms.commons.upgrade.UpgradeManager
-
Returns all targets to be upgraded
- getTitle() - Method in class org.craftercms.commons.plugin.model.Asset
- getTitle() - Method in class org.craftercms.commons.plugin.model.BlueprintDescriptor.Screenshot
-
Deprecated.
- getTitle() - Method in class org.craftercms.commons.plugin.model.BlueprintDescriptor.Video
-
Deprecated.
- getTotalJvmMemory() - Method in class org.craftercms.commons.monitoring.MemoryInfo
- getTotalOsMemory() - Method in class org.craftercms.commons.monitoring.MemoryInfo
- getTotalSwapMemory() - Method in class org.craftercms.commons.monitoring.MemoryInfo
- getTreeForCommit(Repository, ObjectId) - Static method in class org.craftercms.commons.git.utils.GitUtils
- getTreeIteratorForCommit(Git, ObjectReader, ObjectId) - Static method in class org.craftercms.commons.git.utils.GitUtils
- getType() - Method in class org.craftercms.commons.entitlements.model.Entitlement
- getType() - Method in class org.craftercms.commons.plugin.model.Installation
- getType() - Method in class org.craftercms.commons.plugin.model.Parameter
- getType() - Method in class org.craftercms.commons.plugin.model.Plugin
- getUptime() - Method in class org.craftercms.commons.monitoring.StatusInfo
- getURI() - Method in class org.craftercms.commons.spring.resources.S3Resource
- getURI() - Method in class org.craftercms.commons.spring.resources.WebDavResource
- getUrl() - Method in class org.craftercms.commons.plugin.model.Asset
- getUrl() - Method in class org.craftercms.commons.plugin.model.BlueprintDescriptor.Company
-
Deprecated.
- getUrl() - Method in class org.craftercms.commons.plugin.model.BlueprintDescriptor.License
-
Deprecated.
- getUrl() - Method in class org.craftercms.commons.plugin.model.BlueprintDescriptor.Person
-
Deprecated.
- getUrl() - Method in class org.craftercms.commons.plugin.model.BlueprintDescriptor.Screenshot
-
Deprecated.
- getUrl() - Method in class org.craftercms.commons.plugin.model.BlueprintDescriptor.Video
-
Deprecated.
- getUrl() - Method in class org.craftercms.commons.plugin.model.BlueprintDescriptor.Website
-
Deprecated.
- getUrl() - Method in class org.craftercms.commons.plugin.model.Contact
- getUrl() - Method in class org.craftercms.commons.plugin.model.Link
- getURL() - Method in class org.craftercms.commons.spring.resources.S3Resource
- getURL() - Method in class org.craftercms.commons.spring.resources.WebDavResource
- getUsername() - Method in class org.craftercms.commons.config.profiles.webdav.WebDavProfile
-
Returns the username used to connect to the server.
- getValue() - Method in class org.craftercms.commons.entitlements.model.Entitlement
- getValue() - Method in class org.craftercms.commons.plugin.model.Installation.Attribute
- getValue() - Method in class org.craftercms.commons.plugin.model.Installation.Element
- getVersion() - Method in interface org.craftercms.commons.entitlements.validator.EntitlementValidator
-
Provides the version of the current validator.
- getVersion() - Method in class org.craftercms.commons.plugin.model.BlueprintDescriptor.Blueprint
-
Deprecated.
- getVersion() - Method in class org.craftercms.commons.plugin.model.BlueprintDescriptor.CraftercmsVersionSupported
-
Deprecated.
- getVersion() - Method in class org.craftercms.commons.plugin.model.Plugin
- getVersion(Class) - Static method in class org.craftercms.commons.monitoring.VersionInfo
-
Gets the current VersionInfo base on a Class that will load it's manifest file.
- getVersion(String) - Static method in class org.craftercms.commons.plugin.model.Version
- getVersion(Manifest) - Static method in class org.craftercms.commons.monitoring.VersionInfo
-
Gets the current VersionInfo based on Manifest & current JVM information.
- getVersion(UpgradeContext<T>) - Method in class org.craftercms.commons.upgrade.impl.providers.AbstractVersionProvider
- getVersion(UpgradeContext<T>) - Method in interface org.craftercms.commons.upgrade.VersionProvider
-
Returns the current version
- getVideo() - Method in class org.craftercms.commons.plugin.model.BlueprintDescriptor.VideoWrapper
-
Deprecated.
- getVideos() - Method in class org.craftercms.commons.plugin.model.BlueprintDescriptor.Media
-
Deprecated.
- getVideos() - Method in class org.craftercms.commons.plugin.model.Media
- getWebsite() - Method in class org.craftercms.commons.plugin.model.BlueprintDescriptor.Blueprint
-
Deprecated.
- getWebsite() - Method in class org.craftercms.commons.plugin.model.Plugin
- getXmlConfiguration(String, String, ConfigurationProvider) - Method in interface org.craftercms.commons.config.ConfigurationResolver
-
Get the content of a given configuration file
- getXmlConfiguration(String, String, ConfigurationProvider) - Method in class org.craftercms.commons.config.ConfigurationResolverImpl
- GIT_FOLDER_NAME - Static variable in class org.craftercms.commons.git.utils.GitUtils
- GIT_INDEX_NAME - Static variable in class org.craftercms.commons.git.utils.GitUtils
- GIT_LOCK_NAME - Static variable in class org.craftercms.commons.git.utils.GitUtils
- GIT_SSH_URL_REGEX - Static variable in class org.craftercms.commons.git.utils.UrlBasedAuthConfiguratorBuilder
- GitAuthenticationConfigurator - Interface in org.craftercms.commons.git.auth
-
Utility class that configures a Git connection based on an authentication strategy.
- GitUtils - Class in org.craftercms.commons.git.utils
-
Common operations related to git
- GitUtils() - Constructor for class org.craftercms.commons.git.utils.GitUtils
- gridfs - Variable in class org.craftercms.commons.mongo.AbstractJongoRepository
- GROUP_NAME - Enum constant in enum class org.craftercms.commons.validation.annotations.param.EsapiValidationType
- groups() - Element in annotation interface org.craftercms.commons.validation.annotations.param.EsapiValidatedParam
- groups() - Element in annotation interface org.craftercms.commons.validation.annotations.param.SqlSort
- groups() - Element in annotation interface org.craftercms.commons.validation.annotations.param.ValidateNoTagsParam
- groups() - Element in annotation interface org.craftercms.commons.validation.annotations.param.ValidateSecurePathParam
- groups() - Element in annotation interface org.craftercms.commons.validation.annotations.param.ValidateStringParam
- groups() - Element in annotation interface org.craftercms.commons.validation.annotations.param.ValidConfigurationPath
- groups() - Element in annotation interface org.craftercms.commons.validation.annotations.param.ValidExistingContentPath
- groups() - Element in annotation interface org.craftercms.commons.validation.annotations.param.ValidNewContentPath
- groups() - Element in annotation interface org.craftercms.commons.validation.annotations.param.ValidSiteId
- groups() - Element in annotation interface org.craftercms.commons.validation.annotations.param.ValidUsername
- GuavaCacheFactoryBean<K,
V> - Class in org.craftercms.commons.cache -
Spring
FactoryBean
used to create Guava caches as beans. - GuavaCacheFactoryBean() - Constructor for class org.craftercms.commons.cache.GuavaCacheFactoryBean
- GZIP - Static variable in class org.craftercms.commons.crypto.Base64
-
Deprecated.Specify that data should be gzip-compressed.
H
- handledType() - Method in class org.craftercms.commons.jackson.ObjectIdSerializer
- handleError(ClientHttpResponse) - Method in class org.craftercms.commons.rest.HttpMessageConvertingResponseErrorHandler
- handleExceptionInternal(Exception, Object, HttpHeaders, HttpStatusCode, WebRequest) - Method in class org.craftercms.commons.rest.BaseRestExceptionHandlers
- handleExceptionInternal(Exception, String, HttpHeaders, HttpStatus, WebRequest) - Method in class org.craftercms.commons.rest.BaseRestExceptionHandlers
- handleGeneralException(Exception, WebRequest) - Method in class org.craftercms.commons.rest.BaseRestExceptionHandlers
- handleGeneralException(Exception, WebRequest) - Method in class org.craftercms.commons.validation.rest.ValidationAwareRestExceptionHandlers
- handleHttpMessageNotReadable(HttpMessageNotReadableException, HttpHeaders, HttpStatusCode, WebRequest) - Method in class org.craftercms.commons.validation.rest.ValidationAwareRestExceptionHandlers
- handleMethodArgumentNotValid(MethodArgumentNotValidException, HttpHeaders, HttpStatusCode, WebRequest) - Method in class org.craftercms.commons.validation.rest.ValidationAwareRestExceptionHandlers
- handleValidationException(ValidationException, WebRequest) - Method in class org.craftercms.commons.validation.rest.ValidationAwareRestExceptionHandlers
- hasError(ClientHttpResponse) - Method in class org.craftercms.commons.rest.HttpMessageConvertingResponseErrorHandler
- hasError(HttpStatusCode) - Method in class org.craftercms.commons.rest.HttpMessageConvertingResponseErrorHandler
- hasErrors() - Method in class org.craftercms.commons.validation.ValidationResult
- hash - Variable in class org.craftercms.commons.file.blob.Blob
-
A hash that can be used to detect the specific version of the blobs
- hashCode() - Method in class org.craftercms.commons.config.profiles.aws.AbstractAwsProfile
- hashCode() - Method in class org.craftercms.commons.config.profiles.aws.S3Profile
- hashCode() - Method in class org.craftercms.commons.config.profiles.ConfigurationProfile
- hashCode() - Method in class org.craftercms.commons.file.blob.impl.AbstractBlobStore.Mapping
- hashCode() - Method in class org.craftercms.commons.mongo.FileInfo
- hashCode() - Method in class org.craftercms.commons.plugin.model.Asset
- hashCode() - Method in class org.craftercms.commons.plugin.model.Contact
- hashCode() - Method in class org.craftercms.commons.plugin.model.Developer
- hashCode() - Method in class org.craftercms.commons.plugin.model.Link
- hashCode() - Method in class org.craftercms.commons.plugin.model.Media
- hashCode() - Method in class org.craftercms.commons.plugin.model.Parameter
- hashCode() - Method in class org.craftercms.commons.plugin.model.Plugin
- hashCode() - Method in class org.craftercms.commons.plugin.model.PluginDescriptor
- hashCode() - Method in class org.craftercms.commons.plugin.model.Version
- hashCode() - Method in class org.craftercms.commons.security.permissions.DefaultPermission
- hashPassword(String) - Static method in class org.craftercms.commons.crypto.CryptoUtils
-
Hashes a password using a
SimpleDigest
. - hasIgnoreMarker(AnnotatedMember) - Method in class org.craftercms.commons.jackson.mvc.CrafterJacksonAnnotationIntrospector
- HasPermission - Annotation Interface in org.craftercms.commons.security.permissions.annotations
-
Annotations that applications can use to indicate that a certain method or all methods of a class require permission checking.
- HasPermissionAnnotationHandler - Class in org.craftercms.commons.security.permissions.annotations
-
Aspect that handles
HasPermission
annotations, by doing appropriate permission checking. - HasPermissionAnnotationHandler(Map<Class<?>, PermissionEvaluator<?, ?>>, String) - Constructor for class org.craftercms.commons.security.permissions.annotations.HasPermissionAnnotationHandler
- headers - Variable in class org.craftercms.commons.web.AddResponseHeaderFilter
-
Map of headers to add
- HTTP_SCHEME - Static variable in class org.craftercms.commons.http.HttpUtils
- HttpMessageConvertingResponseErrorHandler - Class in org.craftercms.commons.rest
-
ResponseErrorHandler
that converts the body of a response with error status code usingHttpMessageConverter
s, and then throws aRestServiceException
with the deserialized response body as theerrorDetails
. - HttpMessageConvertingResponseErrorHandler(Class<?>) - Constructor for class org.craftercms.commons.rest.HttpMessageConvertingResponseErrorHandler
- HttpMessageConvertingResponseWriter - Class in org.craftercms.commons.rest
-
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'sAbstractMessageConverterMethodProcessor
). - HttpMessageConvertingResponseWriter(ContentNegotiationManager, List<HttpMessageConverter<?>>) - Constructor for class org.craftercms.commons.rest.HttpMessageConvertingResponseWriter
- HTTPParameterName - Enum constant in enum class org.craftercms.commons.validation.annotations.param.EsapiValidationType
- HTTPS_SCHEME - Static variable in class org.craftercms.commons.http.HttpUtils
- HttpUtils - Class in org.craftercms.commons.http
-
Utility methods for HTTP related stuff.
- HttpUtils() - Constructor for class org.craftercms.commons.http.HttpUtils
I
- I10nLogger - Class in org.craftercms.commons.i10n
-
Localized logger, which wraps an slf4j logger.
- I10nLogger(Class<?>) - Constructor for class org.craftercms.commons.i10n.I10nLogger
- I10nLogger(Class<?>, String) - Constructor for class org.craftercms.commons.i10n.I10nLogger
- I10nLogger(Logger, String) - Constructor for class org.craftercms.commons.i10n.I10nLogger
- I10nMethodLogger - Class in org.craftercms.commons.logging
-
MethodLogger
using I10n logging. - I10nMethodLogger() - Constructor for class org.craftercms.commons.logging.I10nMethodLogger
- I10nUtils - Class in org.craftercms.commons.i10n
-
Utility class for localization stuff.
- id - Variable in class org.craftercms.commons.audit.AuditModel
-
Id of the audit entry.
- id - Variable in class org.craftercms.commons.file.blob.impl.AbstractBlobStore
-
The id of the store
- id - Variable in class org.craftercms.commons.plugin.model.Plugin
-
The unique id of the plugin
- IGNORE_REQUEST_COOKIES - Static variable in class org.craftercms.commons.proxy.ProxyUtils
- IGNORE_REQUEST_HEADERS - Static variable in class org.craftercms.commons.proxy.ProxyUtils
- ignoreMissingObject() - Static method in class org.craftercms.commons.aws.AwsUtils
-
Convenience handler to ignore NoSuchKeyException.
- include(BeanPropertyWriter) - Method in class org.craftercms.commons.jackson.mvc.GDataPropertyFilter
- include(PropertyWriter) - Method in class org.craftercms.commons.jackson.mvc.GDataPropertyFilter
- info(String, Object...) - Method in class org.craftercms.commons.i10n.I10nLogger
- info(String, Throwable, Object...) - Method in class org.craftercms.commons.i10n.I10nLogger
- init() - Method in class org.craftercms.commons.mongo.AbstractJongoRepository
- init() - Method in class org.craftercms.commons.properties.OverrideProperties
-
Checks and starts the reading of the given Resources.
- init(FilterConfig) - Method in class org.craftercms.commons.http.RequestContextBindingFilter
- init(String, String, HierarchicalConfiguration<?>) - Method in class org.craftercms.commons.upgrade.impl.operations.AbstractUpgradeOperation
- init(String, String, HierarchicalConfiguration<?>) - Method in interface org.craftercms.commons.upgrade.UpgradeOperation
-
Initializes the instance with the given configuration
- init(HierarchicalConfiguration<ImmutableNode>) - Method in interface org.craftercms.commons.file.blob.BlobStore
-
Performs all setup needed with the given configuration
- init(HierarchicalConfiguration<ImmutableNode>) - Method in class org.craftercms.commons.file.blob.impl.AbstractBlobStore
- initialize(EsapiValidatedParam) - Method in class org.craftercms.commons.validation.validators.impl.EsapiValidator
- initialize(SqlSort) - Method in class org.craftercms.commons.validation.validators.impl.SortFieldValidator
- initialize(SqlSort) - Method in class org.craftercms.commons.validation.validators.impl.SqlSortValidator
- initialize(ValidateStringParam) - Method in class org.craftercms.commons.validation.validators.impl.StringValidator
- InjectValue - Annotation Interface in org.craftercms.commons.jackson.mvc.annotations
- injectValueFactory - Variable in class org.craftercms.commons.jackson.mvc.CrafterJackson2MessageConverter
- InjectValueFactory - Interface in org.craftercms.commons.jackson.mvc.annotations
- InputStream(InputStream) - Constructor for class org.craftercms.commons.crypto.Base64.InputStream
-
Deprecated.Constructs a
Base64.InputStream
in DECODE mode. - InputStream(InputStream, int) - Constructor for class org.craftercms.commons.crypto.Base64.InputStream
-
Deprecated.Constructs a
Base64.InputStream
in either ENCODE or DECODE mode. - insert(T) - Method in class org.craftercms.commons.mongo.AbstractJongoRepository
- insert(T) - Method in interface org.craftercms.commons.mongo.CrudRepository
-
Inserts the document into the collection.
- insert(T...) - Method in class org.craftercms.commons.mongo.AbstractJongoRepository
- insert(T...) - Method in interface org.craftercms.commons.mongo.CrudRepository
-
Inserts multiple documents into the collection.
- installation - Variable in class org.craftercms.commons.plugin.model.Plugin
-
List of installations to perform for the plugin
- Installation - Class in org.craftercms.commons.plugin.model
-
Holds the data required to install a plugin in a configuration file
- Installation() - Constructor for class org.craftercms.commons.plugin.model.Installation
- Installation.Attribute - Class in org.craftercms.commons.plugin.model
-
Represents an XML attribute
- Installation.Element - Class in org.craftercms.commons.plugin.model
-
Represents an XML element
- intercept(HttpRequest, byte[], ClientHttpRequestExecution) - Method in class org.craftercms.commons.rest.LoggingRequestInterceptor
- internalParser(String) - Method in class org.craftercms.commons.jackson.mvc.GDataPropertyFilter
- INVALID_METHOD_PARAMS_ERROR_CODE - Static variable in class org.craftercms.commons.validation.ErrorCodes
- INVALID_REQUEST_BODY_ERROR_CODE - Static variable in class org.craftercms.commons.validation.ErrorCodes
- InvalidManagementTokenException - Exception Class in org.craftercms.commons.exceptions
-
Exception thrown when monitoring API is called with invalid authorization token
- InvalidManagementTokenException(String) - Constructor for exception class org.craftercms.commons.exceptions.InvalidManagementTokenException
- isAllowed(String) - Method in class org.craftercms.commons.security.permissions.CompositePermission
- isAllowed(String) - Method in class org.craftercms.commons.security.permissions.DefaultPermission
- isAllowed(String) - Method in interface org.craftercms.commons.security.permissions.Permission
-
Returns true if action execution is allowed
- isAllowed(String) - Method in class org.craftercms.commons.spring.context.RestrictedApplicationContext
- isAllowed(R, String) - Method in class org.craftercms.commons.security.permissions.impl.PermissionEvaluatorImpl
- isAllowed(R, String) - Method in interface org.craftercms.commons.security.permissions.PermissionEvaluator
-
Checks if the current subject (according to
SubjectResolver
) is allowed to perform the specified action on the given resource. - isAllowed(S, R, String) - Method in class org.craftercms.commons.security.permissions.impl.PermissionEvaluatorImpl
- isAllowed(S, R, String) - Method in interface org.craftercms.commons.security.permissions.PermissionEvaluator
-
Checks if the given subject is allowed to perform the specified action on the given resource
- isCompatible(String) - Method in interface org.craftercms.commons.file.blob.BlobStore
-
Indicates if the given path is compatible with the store
- isCompatible(String) - Method in class org.craftercms.commons.file.blob.impl.AbstractBlobStore
- isDebugEnabled() - Method in class org.craftercms.commons.i10n.I10nLogger
- isEmpty() - Method in class org.craftercms.commons.upgrade.impl.pipeline.DefaultUpgradePipelineImpl
-
Indicates if the pipeline doesn't contain any operations
- isEmpty() - Method in interface org.craftercms.commons.upgrade.UpgradePipeline
-
Indicates if the pipeline doesn't contain any operations
- isErrorEnabled() - Method in class org.craftercms.commons.i10n.I10nLogger
- isInfoEnabled() - Method in class org.craftercms.commons.i10n.I10nLogger
- isInteractive() - Method in class org.craftercms.commons.git.jgit.SshUsernamePasswordCredentialsProvider
- isOpen() - Method in class org.craftercms.commons.spring.resources.S3Resource
- isOpen() - Method in class org.craftercms.commons.spring.resources.WebDavResource
- isPathStyleAccessEnabled() - Method in class org.craftercms.commons.config.profiles.aws.S3Profile
- isPreemptiveAuth() - Method in class org.craftercms.commons.config.profiles.webdav.WebDavProfile
- isPrimitive(Class<?>) - Method in class org.craftercms.commons.jackson.mvc.AbstractCrafterPropertyFilter
- isReadable() - Method in class org.craftercms.commons.spring.resources.S3Resource
- isReadable() - Method in class org.craftercms.commons.spring.resources.WebDavResource
- isRepositoryLocked(String) - Static method in class org.craftercms.commons.git.utils.GitUtils
-
Check if a git repository is locked
- isRequired() - Method in class org.craftercms.commons.plugin.model.Parameter
- isSingleton() - Method in class org.craftercms.commons.crypto.SecretKeyFactoryBean
- isSingleton() - Method in class org.craftercms.commons.spring.BeanListFactoryBean
- isSingleton() - Method in class org.craftercms.commons.spring.ConditionalFactoryBean
- isTraceEnabled() - Method in class org.craftercms.commons.i10n.I10nLogger
- isValid(String, ConstraintValidatorContext) - Method in class org.craftercms.commons.validation.validators.impl.AbstractStringValidator
- isValid(String, ConstraintValidatorContext) - Method in class org.craftercms.commons.validation.validators.impl.EsapiValidator
- isValid(String, ConstraintValidatorContext) - Method in class org.craftercms.commons.validation.validators.impl.SqlSortValidator
- isValid(SortField, ConstraintValidatorContext) - Method in class org.craftercms.commons.validation.validators.impl.SortFieldValidator
- isWarnEnabled() - Method in class org.craftercms.commons.i10n.I10nLogger
- ITEM - Enum constant in enum class org.craftercms.commons.entitlements.model.EntitlementType
- IterableUtils - Class in org.craftercms.commons.collections
-
Utility methods for
Iterable
.
J
- JacksonUtils - Class in org.craftercms.commons.jackson
-
Utility methods for Jackson.
- jongo - Variable in class org.craftercms.commons.mongo.AbstractJongoRepository
- JongoFactoryBean - Class in org.craftercms.commons.mongo
-
Creates a Jongo singleton for application wide use.
- JongoFactoryBean(String, MongoClient) - Constructor for class org.craftercms.commons.mongo.JongoFactoryBean
- JongoQueries - Class in org.craftercms.commons.mongo
-
Holds a Map of all the register MongoQueries.
- JongoQueries() - Constructor for class org.craftercms.commons.mongo.JongoQueries
- jsonPrefix - Variable in class org.craftercms.commons.jackson.mvc.CrafterJackson2MessageConverter
K
- key - Variable in exception class org.craftercms.commons.i10n.AbstractI10nException
- key - Variable in exception class org.craftercms.commons.i10n.AbstractI10nRuntimeException
- KEY - Static variable in exception class org.craftercms.commons.exceptions.DateParseException
- KEY - Static variable in exception class org.craftercms.commons.mail.EmailPreparationException
- KEY - Static variable in exception class org.craftercms.commons.mail.EmailSendException
- KEY - Static variable in exception class org.craftercms.commons.security.exception.SubjectNotFoundException
- KEY_BUILD_ON - Static variable in class org.craftercms.commons.monitoring.VersionInfo
-
Manifest key for the date in ms when the package was build.
- KEY_IMPLEMENTATION_BUILD - Static variable in class org.craftercms.commons.monitoring.VersionInfo
-
Manifest key for codebase packageVersion (usually git hash or svn id).
- KEY_IMPLEMENTATION_TITLE - Static variable in class org.craftercms.commons.monitoring.VersionInfo
-
Manifest key for name of the Lib/app in the jar (usually maven name tag value).
- KEY_IMPLEMENTATION_VERSION - Static variable in class org.craftercms.commons.monitoring.VersionInfo
-
Manifest key for VersionInfo of the code (usually matches Mvn packageVersion)
- KEY_REQUEST_PARAMS - Static variable in class org.craftercms.commons.freemarker.CrafterFreeMarkerView
- KEY_STORE_TYPE - Static variable in class org.craftercms.commons.crypto.impl.SecretKeyRepositoryImpl
- KeyBasedLockFactory<L> - Interface in org.craftercms.commons.concurrent.locks
-
Factory for getting locks that can be used for concurrent thread synchronization based on keys.
- keyStore - Variable in class org.craftercms.commons.crypto.impl.SecretKeyRepositoryImpl
- keyStoreFile - Variable in class org.craftercms.commons.crypto.impl.SecretKeyRepositoryImpl
- keyStorePassword - Variable in class org.craftercms.commons.crypto.impl.SecretKeyRepositoryImpl
L
- label - Variable in class org.craftercms.commons.plugin.model.Parameter
-
The label to display for the parameter
- lastModified() - Method in class org.craftercms.commons.spring.resources.S3Resource
- lastModified() - Method in class org.craftercms.commons.spring.resources.WebDavResource
- LEFT_CURLY_BRACE - Static variable in class org.craftercms.commons.http.HttpUtils
- license - Variable in class org.craftercms.commons.plugin.model.Plugin
-
The license of the plugin
- License() - Constructor for class org.craftercms.commons.plugin.model.BlueprintDescriptor.License
-
Deprecated.
- Link - Class in org.craftercms.commons.plugin.model
-
Holds the data about a single link
- Link() - Constructor for class org.craftercms.commons.plugin.model.Link
- LIST_NOT_EMPTY_ERROR_CODE - Static variable in class org.craftercms.commons.validation.ErrorCodes
- listFilesByName(String) - Method in class org.craftercms.commons.mongo.AbstractJongoRepository
- listFilesByName(String) - Method in interface org.craftercms.commons.mongo.CrudRepository
- ListMergingPostProcessor - Class in org.craftercms.commons.spring
-
BeanFactoryPostProcessor
that allows to add additional elements to a list property value of an already defined bean. - ListMergingPostProcessor() - Constructor for class org.craftercms.commons.spring.ListMergingPostProcessor
- LIVE - Static variable in interface org.craftercms.commons.config.PublishingTargetResolver
- load(Reader) - Method in class org.craftercms.commons.config.YamlConfiguration
- loaderOptions - Variable in class org.craftercms.commons.config.YamlConfiguration
- loadFile(Path) - Method in class org.craftercms.commons.upgrade.impl.providers.YamlFileVersionProvider
- loadKeyStore() - Method in class org.craftercms.commons.crypto.impl.SecretKeyRepositoryImpl
- loadProfile(String) - Method in interface org.craftercms.commons.config.profiles.ConfigurationProfileLoader
-
Loads the
ConfigurationProfile
that corresponds to the given ID. - loadProfile(String) - Method in class org.craftercms.commons.file.stores.impl.AbstractProfileAwareRemoteFileStore
- loadResource(String) - Method in class org.craftercms.commons.upgrade.impl.operations.AbstractUpgradeOperation
- LOCALE_PATTERN - Static variable in class org.craftercms.commons.locale.LocaleUtils
- LOCALE_SEPARATOR - Static variable in class org.craftercms.commons.locale.LocaleUtils
- LocaleUtils - Class in org.craftercms.commons.locale
-
Utility class for handling locale codes
- LocaleUtils() - Constructor for class org.craftercms.commons.locale.LocaleUtils
- localizePath(String, Locale) - Static method in class org.craftercms.commons.locale.LocaleUtils
- locks - Variable in class org.craftercms.commons.concurrent.locks.AbstractWeakKeyBasedLockFactory
- LOG_KEY_ADDED_COOKIE - Static variable in class org.craftercms.commons.http.CookieManager
- LOG_KEY_BINGING_CONTEXT - Static variable in class org.craftercms.commons.http.RequestContextBindingFilter
- LOG_KEY_DEC_SUCCESSFUL - Static variable in class org.craftercms.commons.crypto.SimpleCipher
- LOG_KEY_DECRYPTION_ERROR - Static variable in class org.craftercms.commons.config.DecryptionLookup
- LOG_KEY_DEF_CIPHER_CREATED - Static variable in class org.craftercms.commons.crypto.SimpleCipher
- LOG_KEY_DEF_DIGEST_CREATED - Static variable in class org.craftercms.commons.crypto.SimpleDigest
- LOG_KEY_DELETED_COOKIE - Static variable in class org.craftercms.commons.http.CookieManager
- LOG_KEY_DIGEST_GEN - Static variable in class org.craftercms.commons.crypto.SimpleDigest
- LOG_KEY_EMAIL_SENT - Static variable in class org.craftercms.commons.mail.impl.EmailImpl
- LOG_KEY_ENC_SUCCESSFUL - Static variable in class org.craftercms.commons.crypto.SimpleCipher
- LOG_KEY_ENTRY - Static variable in class org.craftercms.commons.logging.I10nMethodLogger
- LOG_KEY_EXCEPTION - Static variable in class org.craftercms.commons.logging.I10nMethodLogger
- LOG_KEY_EXIT - Static variable in class org.craftercms.commons.logging.I10nMethodLogger
- LOG_KEY_IV_GEN - Static variable in class org.craftercms.commons.crypto.SimpleCipher
- LOG_KEY_KEY_CREATED - Static variable in class org.craftercms.commons.crypto.impl.SecretKeyRepositoryImpl
- LOG_KEY_KEY_FOUND - Static variable in class org.craftercms.commons.crypto.impl.SecretKeyRepositoryImpl
- LOG_KEY_KEY_GEN - Static variable in class org.craftercms.commons.crypto.SimpleCipher
- LOG_KEY_KEY_NOT_FOUND - Static variable in class org.craftercms.commons.crypto.impl.SecretKeyRepositoryImpl
- LOG_KEY_KEY_SAVED - Static variable in class org.craftercms.commons.crypto.impl.SecretKeyRepositoryImpl
- LOG_KEY_KEY_STORE_LOADED - Static variable in class org.craftercms.commons.crypto.impl.SecretKeyRepositoryImpl
- LOG_KEY_KEY_STORE_STORED - Static variable in class org.craftercms.commons.crypto.impl.SecretKeyRepositoryImpl
- LOG_KEY_MIME_MSG_CREATED - Static variable in class org.craftercms.commons.mail.impl.EmailFactoryImpl
- LOG_KEY_NOOP_USED - Static variable in class org.craftercms.commons.crypto.impl.NoOpTextEncryptor
- LOG_KEY_PROCESSING_EMAIL_TEMPLATE - Static variable in class org.craftercms.commons.mail.impl.EmailFactoryImpl
- LOG_KEY_SALT_GEN - Static variable in class org.craftercms.commons.crypto.SimpleDigest
- LOG_KEY_UNBINDING_CONTEXT - Static variable in class org.craftercms.commons.http.RequestContextBindingFilter
- LOG_KEY_WRITTEN_WITH_MESSAGE_CONVERTER - Static variable in class org.craftercms.commons.rest.HttpMessageConvertingResponseWriter
- LOG_KEY_YAML_LOADED - Static variable in class org.craftercms.commons.config.YamlConfiguration
- logEntry(String, String, Object[]) - Method in class org.craftercms.commons.logging.I10nMethodLogger
- logEntry(String, String, Object[]) - Method in interface org.craftercms.commons.logging.MethodLogger
-
Logs a method entry.
- logException(String, String, Throwable) - Method in class org.craftercms.commons.logging.I10nMethodLogger
- logException(String, String, Throwable) - Method in interface org.craftercms.commons.logging.MethodLogger
-
Logs a method failure with a exception.
- logExit(String, String, Object) - Method in class org.craftercms.commons.logging.I10nMethodLogger
- logExit(String, String, Object) - Method in interface org.craftercms.commons.logging.MethodLogger
-
Logs a method exit.
- Logged - Annotation Interface in org.craftercms.commons.logging
-
Annotation used to indicate that a method (or all methods of a class, if used in a class) should be logged.
- LoggedAspect - Class in org.craftercms.commons.logging
-
Aspect that uses a
MethodLogger
to log methods withLogged
annotation (or all methods of a class, if used in a class). - LoggedAspect() - Constructor for class org.craftercms.commons.logging.LoggedAspect
- logger - Variable in class org.craftercms.commons.file.blob.impl.BlobStoreResolverImpl
- logger - Variable in class org.craftercms.commons.git.utils.AbstractAuthConfiguratorBuilder
- logger - Variable in class org.craftercms.commons.upgrade.impl.AbstractUpgradeManager
- logger - Variable in class org.craftercms.commons.upgrade.impl.operations.AbstractUpgradeOperation
- logger - Variable in class org.craftercms.commons.upgrade.impl.pipeline.DefaultUpgradePipelineFactoryImpl
- logger - Variable in class org.craftercms.commons.upgrade.impl.providers.AbstractVersionProvider
- LoggingRequestInterceptor - Class in org.craftercms.commons.rest
-
REST client request interceptor that logs the whole request and response.
- LoggingRequestInterceptor() - Constructor for class org.craftercms.commons.rest.LoggingRequestInterceptor
- logMethod(ProceedingJoinPoint) - Method in class org.craftercms.commons.logging.LoggedAspect
- lookup(String) - Method in class org.craftercms.commons.config.DecryptionLookup
M
- mailSender - Variable in class org.craftercms.commons.mail.impl.EmailFactoryImpl
- mailSender - Variable in class org.craftercms.commons.mail.impl.EmailImpl
- main(String[]) - Static method in class org.craftercms.commons.crypto.Base64
-
Deprecated.Encodes or decodes two files from the command line; feel free to delete this method (in fact you probably should) if you're embedding this code into a larger program.
- main(String...) - Static method in class org.craftercms.commons.crypto.impl.EncryptionTool
- major - Variable in class org.craftercms.commons.plugin.model.Version
-
The major version
- managementToken - Variable in class org.craftercms.commons.security.permissions.annotations.HasPermissionAnnotationHandler
-
Management token to be validated in case a
HasPermission
annotation has been configured to accept a management token. - MANIFEST_PATH - Static variable in class org.craftercms.commons.monitoring.VersionInfo
-
Manifest Default Path
- Mapping() - Constructor for class org.craftercms.commons.file.blob.impl.AbstractBlobStore.Mapping
- mappings - Variable in class org.craftercms.commons.file.blob.impl.AbstractBlobStore
-
The mappings for the different environments
- mapProfile(HierarchicalConfiguration<ImmutableNode>) - Method in class org.craftercms.commons.config.profiles.AbstractProfileConfigMapper
- mapProfile(HierarchicalConfiguration<ImmutableNode>) - Method in class org.craftercms.commons.config.profiles.aws.AbstractAwsProfileMapper
- mapProfile(HierarchicalConfiguration<ImmutableNode>) - Method in class org.craftercms.commons.config.profiles.aws.S3ProfileMapper
- mapProfile(HierarchicalConfiguration<ImmutableNode>) - Method in class org.craftercms.commons.config.profiles.webdav.WebDavProfileMapper
- MapUtils - Class in org.craftercms.commons.collections
-
Utility methods for maps.
- matchesAny(String, String...) - Static method in class org.craftercms.commons.lang.RegexUtils
-
Returns true if the string matches any of the specified regexes.
- matchesAny(String, List<String>) - Static method in class org.craftercms.commons.lang.RegexUtils
-
Returns true if the string matches (full match) any of the specified regexes.
- matchesAny(String, List<String>, boolean) - Static method in class org.craftercms.commons.lang.RegexUtils
-
Returns true if the string matches any of the specified regexes.
- matchFullInput - Variable in class org.craftercms.commons.validation.validators.impl.AbstractStringValidator
- matchFullInput() - Element in annotation interface org.craftercms.commons.validation.annotations.param.ValidateStringParam
- matchPassword(String, String) - Static method in class org.craftercms.commons.crypto.CryptoUtils
-
Returns true if it's a password match, that is, if the hashed clear password equals the given hash.
- MAX_SITE_ID_LENGTH - Static variable in annotation interface org.craftercms.commons.validation.annotations.param.ValidSiteId
- MAX_USERNAME_LENGTH - Static variable in annotation interface org.craftercms.commons.validation.annotations.param.ValidUsername
- maxAuditAllowedDays - Variable in class org.craftercms.commons.audit.AuditReaper
-
Maximum days to keep in the log.
- media - Variable in class org.craftercms.commons.plugin.model.Plugin
-
The media assets of the plugin
- Media - Class in org.craftercms.commons.plugin.model
-
Holds all data about assets for a plugin
- Media() - Constructor for class org.craftercms.commons.plugin.model.BlueprintDescriptor.Media
-
Deprecated.
- Media() - Constructor for class org.craftercms.commons.plugin.model.Media
- MEDIA_TYPE_APPLICATION - Static variable in class org.craftercms.commons.rest.HttpMessageConvertingResponseWriter
- MEMORY_URL - Static variable in class org.craftercms.commons.monitoring.rest.MonitoringRestControllerBase
- MemoryInfo - Class in org.craftercms.commons.monitoring
-
Holds basic JVM memory.
- message - Variable in class org.craftercms.commons.mail.impl.EmailImpl
- message - Variable in class org.craftercms.commons.validation.ValidationResult
- message() - Element in annotation interface org.craftercms.commons.validation.annotations.param.EsapiValidatedParam
- message() - Element in annotation interface org.craftercms.commons.validation.annotations.param.SqlSort
- message() - Element in annotation interface org.craftercms.commons.validation.annotations.param.ValidateNoTagsParam
- message() - Element in annotation interface org.craftercms.commons.validation.annotations.param.ValidateSecurePathParam
- message() - Element in annotation interface org.craftercms.commons.validation.annotations.param.ValidateStringParam
- message() - Element in annotation interface org.craftercms.commons.validation.annotations.param.ValidConfigurationPath
- message() - Element in annotation interface org.craftercms.commons.validation.annotations.param.ValidExistingContentPath
- message() - Element in annotation interface org.craftercms.commons.validation.annotations.param.ValidNewContentPath
- message() - Element in annotation interface org.craftercms.commons.validation.annotations.param.ValidSiteId
- message() - Element in annotation interface org.craftercms.commons.validation.annotations.param.ValidUsername
- messageConverters - Variable in class org.craftercms.commons.rest.HttpMessageConvertingResponseErrorHandler
- messageConverters - Variable in class org.craftercms.commons.rest.HttpMessageConvertingResponseWriter
- methodLogger - Variable in class org.craftercms.commons.logging.LoggedAspect
- MethodLogger - Interface in org.craftercms.commons.logging
-
Utility for logging a method entry/exit.
- minor - Variable in class org.craftercms.commons.plugin.model.Version
-
The minor version
- MissingConfigurationException - Exception Class in org.craftercms.commons.config
-
ConfigurationException
thrown when a specific configuration property or sub-configuration is missing. - MissingConfigurationException(String) - Constructor for exception class org.craftercms.commons.config.MissingConfigurationException
- MissingConfigurationException(String, Throwable) - Constructor for exception class org.craftercms.commons.config.MissingConfigurationException
- module - Variable in exception class org.craftercms.commons.entitlements.exception.EntitlementExceededException
-
The module that requested the validation.
- module - Variable in exception class org.craftercms.commons.entitlements.exception.UnsupportedEntitlementException
-
The requested module.
- Module - Enum Class in org.craftercms.commons.entitlements.model
-
Holds the available modules when requesting an entitlement validation.
- MongoClientFactory - Class in org.craftercms.commons.mongo
-
Creates a Mongo Client based on a connection String
- MongoClientFactory() - Constructor for class org.craftercms.commons.mongo.MongoClientFactory
- MongoClientFromUriFactoryBean - Class in org.craftercms.commons.mongo
-
FactoryBean
that besides creating aMongoClient
from a Mongo URI, closes the client when it's destroyed. - MongoClientFromUriFactoryBean(String) - Constructor for class org.craftercms.commons.mongo.MongoClientFromUriFactoryBean
- MongoClientOptionsFactory - Class in org.craftercms.commons.mongo
-
Spring helper for Create a MongoClient
- MongoClientOptionsFactory() - Constructor for class org.craftercms.commons.mongo.MongoClientOptionsFactory
- MongoDataException - Exception Class in org.craftercms.commons.mongo
-
Checked Exception to wrap around MongoException.
- MongoDataException() - Constructor for exception class org.craftercms.commons.mongo.MongoDataException
- MongoDataException(String) - Constructor for exception class org.craftercms.commons.mongo.MongoDataException
- MongoDataException(String, Throwable) - Constructor for exception class org.craftercms.commons.mongo.MongoDataException
- MongoDataException(String, Throwable, boolean, boolean) - Constructor for exception class org.craftercms.commons.mongo.MongoDataException
- MongoDataException(Throwable) - Constructor for exception class org.craftercms.commons.mongo.MongoDataException
- MongoScriptRunner - Class in org.craftercms.commons.mongo
-
Utility class for running Mongo scripts in JS.
- MongoScriptRunner(String, MongoClient, List<Resource>) - Constructor for class org.craftercms.commons.mongo.MongoScriptRunner
- MonitoringRestControllerBase - Class in org.craftercms.commons.monitoring.rest
-
Base controller for all monitoring related APIs
- MonitoringRestControllerBase(String) - Constructor for class org.craftercms.commons.monitoring.rest.MonitoringRestControllerBase
N
- name - Variable in class org.craftercms.commons.plugin.model.Contact
-
The name of the contact
- name - Variable in class org.craftercms.commons.plugin.model.Installation.Attribute
- name - Variable in class org.craftercms.commons.plugin.model.Installation.Element
- name - Variable in class org.craftercms.commons.plugin.model.Link
-
The name of the link
- name - Variable in class org.craftercms.commons.plugin.model.Parameter
-
The name of the parameter (must be camelCase)
- name - Variable in class org.craftercms.commons.plugin.model.Plugin
-
The name of the plugin
- name - Variable in class org.craftercms.commons.upgrade.impl.pipeline.DefaultUpgradePipelineImpl
-
Name of the pipeline.
- NAME_REGEX - Static variable in class org.craftercms.commons.plugin.model.Parameter
- newLock() - Method in class org.craftercms.commons.concurrent.locks.AbstractWeakKeyBasedLockFactory
- newLock() - Method in class org.craftercms.commons.concurrent.locks.WeakKeyBasedReentrantLockFactory
- nextVersion - Variable in class org.craftercms.commons.upgrade.impl.operations.AbstractUpgradeOperation
-
The next version.
- NO_OPTIONS - Static variable in class org.craftercms.commons.crypto.Base64
-
Deprecated.No options specified.
- NONE - Static variable in interface org.craftercms.commons.git.utils.AuthenticationType
- NoopAuthConfigurator - Class in org.craftercms.commons.git.auth
-
Implementation of
GitAuthenticationConfigurator
that doesn't perform any action - NoopAuthConfigurator() - Constructor for class org.craftercms.commons.git.auth.NoopAuthConfigurator
- NoOpTextEncryptor - Class in org.craftercms.commons.crypto.impl
-
TextEncryptor
that does not actually encrypt or decrypt the text at all. - NoOpTextEncryptor() - Constructor for class org.craftercms.commons.crypto.impl.NoOpTextEncryptor
- NOT_NULL_ERROR_CODE - Static variable in class org.craftercms.commons.validation.ErrorCodes
- NoTagsValidator - Class in org.craftercms.commons.validation.validators.impl
- NoTagsValidator() - Constructor for class org.craftercms.commons.validation.validators.impl.NoTagsValidator
- NUMBER_MAX_VALUE_ERROR - Static variable in class org.craftercms.commons.validation.ErrorCodes
- NUMBER_MIN_VALUE_ERROR - Static variable in class org.craftercms.commons.validation.ErrorCodes
O
- OBJECT_FIELD_READ_ERROR_CODE - Static variable in class org.craftercms.commons.validation.ErrorCodes
-
Object errors
- ObjectIdDeserializer - Class in org.craftercms.commons.jackson
-
Custom Jackson deserializer for
ObjectId
s, which deserializes a String as an ObjectId by creating the ObjectId throughObjectId(String)
. - ObjectIdDeserializer() - Constructor for class org.craftercms.commons.jackson.ObjectIdDeserializer
- ObjectIdSerializer - Class in org.craftercms.commons.jackson
-
Custom Jackson serializer for
ObjectId
s, which serializes an ObjectId as a String by callingObjectId.toString()
. - ObjectIdSerializer() - Constructor for class org.craftercms.commons.jackson.ObjectIdSerializer
- of(int, int, int) - Static method in class org.craftercms.commons.plugin.model.Version
- of(String) - Static method in class org.craftercms.commons.plugin.model.Version
- of(Plugin) - Static method in class org.craftercms.commons.plugin.model.PluginDescriptor
-
Wraps the plugin metadata in a descriptor object
- OK - Static variable in class org.craftercms.commons.rest.Result
- oldquery - Variable in class org.craftercms.commons.entitlements.validator.impl.DefaultDbIntegrityValidatorImpl
- onAudit(AuditModel) - Method in class org.craftercms.commons.audit.AuditListener
- onRemoval(RemovalNotification<P, C>) - Method in class org.craftercms.commons.aws.AbstractAwsClientCachingFactory
- openRepository(File) - Static method in class org.craftercms.commons.git.utils.GitUtils
-
Opens the Git repository at the specified location.
- operations - Variable in class org.craftercms.commons.upgrade.impl.pipeline.DefaultUpgradePipelineImpl
-
List of all upgrade operations to be executed.
- ORDERED - Static variable in class org.craftercms.commons.crypto.Base64
-
Deprecated.Encode using the special "ordered" dialect of Base64 described here: http://www.faqs.org/qa/rfcc-1940.html.
- org.craftercms.commons.aop - package org.craftercms.commons.aop
- org.craftercms.commons.audit - package org.craftercms.commons.audit
- org.craftercms.commons.aws - package org.craftercms.commons.aws
- org.craftercms.commons.cache - package org.craftercms.commons.cache
- org.craftercms.commons.collections - package org.craftercms.commons.collections
- org.craftercms.commons.concurrent.locks - package org.craftercms.commons.concurrent.locks
- org.craftercms.commons.config - package org.craftercms.commons.config
- org.craftercms.commons.config.profiles - package org.craftercms.commons.config.profiles
- org.craftercms.commons.config.profiles.aws - package org.craftercms.commons.config.profiles.aws
- org.craftercms.commons.config.profiles.webdav - package org.craftercms.commons.config.profiles.webdav
- org.craftercms.commons.converters - package org.craftercms.commons.converters
- org.craftercms.commons.converters.impl - package org.craftercms.commons.converters.impl
- org.craftercms.commons.crypto - package org.craftercms.commons.crypto
- org.craftercms.commons.crypto.impl - package org.craftercms.commons.crypto.impl
- org.craftercms.commons.entitlements.exception - package org.craftercms.commons.entitlements.exception
- org.craftercms.commons.entitlements.model - package org.craftercms.commons.entitlements.model
- org.craftercms.commons.entitlements.usage - package org.craftercms.commons.entitlements.usage
- org.craftercms.commons.entitlements.validator - package org.craftercms.commons.entitlements.validator
- org.craftercms.commons.entitlements.validator.impl - package org.craftercms.commons.entitlements.validator.impl
- org.craftercms.commons.exceptions - package org.craftercms.commons.exceptions
- org.craftercms.commons.file - package org.craftercms.commons.file
- org.craftercms.commons.file.blob - package org.craftercms.commons.file.blob
- org.craftercms.commons.file.blob.exception - package org.craftercms.commons.file.blob.exception
- org.craftercms.commons.file.blob.impl - package org.craftercms.commons.file.blob.impl
- org.craftercms.commons.file.blob.impl.s3 - package org.craftercms.commons.file.blob.impl.s3
- org.craftercms.commons.file.stores - package org.craftercms.commons.file.stores
- org.craftercms.commons.file.stores.impl - package org.craftercms.commons.file.stores.impl
- org.craftercms.commons.file.stores.impl.s3 - package org.craftercms.commons.file.stores.impl.s3
- org.craftercms.commons.file.stores.impl.webdav - package org.craftercms.commons.file.stores.impl.webdav
- org.craftercms.commons.freemarker - package org.craftercms.commons.freemarker
- org.craftercms.commons.git.auth - package org.craftercms.commons.git.auth
- org.craftercms.commons.git.jgit - package org.craftercms.commons.git.jgit
- org.craftercms.commons.git.utils - package org.craftercms.commons.git.utils
- org.craftercms.commons.http - package org.craftercms.commons.http
- org.craftercms.commons.i10n - package org.craftercms.commons.i10n
- org.craftercms.commons.jackson - package org.craftercms.commons.jackson
- org.craftercms.commons.jackson.mvc - package org.craftercms.commons.jackson.mvc
- org.craftercms.commons.jackson.mvc.annotations - package org.craftercms.commons.jackson.mvc.annotations
- org.craftercms.commons.lang - package org.craftercms.commons.lang
- org.craftercms.commons.locale - package org.craftercms.commons.locale
- org.craftercms.commons.logging - package org.craftercms.commons.logging
- org.craftercms.commons.mail - package org.craftercms.commons.mail
- org.craftercms.commons.mail.impl - package org.craftercms.commons.mail.impl
- org.craftercms.commons.mongo - package org.craftercms.commons.mongo
- org.craftercms.commons.monitoring - package org.craftercms.commons.monitoring
- org.craftercms.commons.monitoring.rest - package org.craftercms.commons.monitoring.rest
- org.craftercms.commons.plugin - package org.craftercms.commons.plugin
- org.craftercms.commons.plugin.exception - package org.craftercms.commons.plugin.exception
- org.craftercms.commons.plugin.impl - package org.craftercms.commons.plugin.impl
- org.craftercms.commons.plugin.model - package org.craftercms.commons.plugin.model
- org.craftercms.commons.properties - package org.craftercms.commons.properties
- org.craftercms.commons.proxy - package org.craftercms.commons.proxy
- org.craftercms.commons.rest - package org.craftercms.commons.rest
- org.craftercms.commons.rest.parameters - package org.craftercms.commons.rest.parameters
- org.craftercms.commons.security.exception - package org.craftercms.commons.security.exception
- org.craftercms.commons.security.permissions - package org.craftercms.commons.security.permissions
- org.craftercms.commons.security.permissions.annotations - package org.craftercms.commons.security.permissions.annotations
- org.craftercms.commons.security.permissions.impl - package org.craftercms.commons.security.permissions.impl
- org.craftercms.commons.spring - package org.craftercms.commons.spring
- org.craftercms.commons.spring.context - package org.craftercms.commons.spring.context
- org.craftercms.commons.spring.cors - package org.craftercms.commons.spring.cors
- org.craftercms.commons.spring.groovy - package org.craftercms.commons.spring.groovy
- org.craftercms.commons.spring.resources - package org.craftercms.commons.spring.resources
- org.craftercms.commons.upgrade - package org.craftercms.commons.upgrade
- org.craftercms.commons.upgrade.exception - package org.craftercms.commons.upgrade.exception
- org.craftercms.commons.upgrade.impl - package org.craftercms.commons.upgrade.impl
- org.craftercms.commons.upgrade.impl.configuration - package org.craftercms.commons.upgrade.impl.configuration
- org.craftercms.commons.upgrade.impl.operations - package org.craftercms.commons.upgrade.impl.operations
- org.craftercms.commons.upgrade.impl.pipeline - package org.craftercms.commons.upgrade.impl.pipeline
- org.craftercms.commons.upgrade.impl.providers - package org.craftercms.commons.upgrade.impl.providers
- org.craftercms.commons.validation - package org.craftercms.commons.validation
- org.craftercms.commons.validation.annotations.param - package org.craftercms.commons.validation.annotations.param
- org.craftercms.commons.validation.rest - package org.craftercms.commons.validation.rest
- org.craftercms.commons.validation.validators.impl - package org.craftercms.commons.validation.validators.impl
- org.craftercms.commons.web - package org.craftercms.commons.web
- org.craftercms.commons.zip - package org.craftercms.commons.zip
- OutputStream(OutputStream) - Constructor for class org.craftercms.commons.crypto.Base64.OutputStream
-
Deprecated.Constructs a
Base64.OutputStream
in ENCODE mode. - OutputStream(OutputStream, int) - Constructor for class org.craftercms.commons.crypto.Base64.OutputStream
-
Deprecated.Constructs a
Base64.OutputStream
in either ENCODE or DECODE mode. - OverrideProperties - Class in org.craftercms.commons.properties
- OverrideProperties() - Constructor for class org.craftercms.commons.properties.OverrideProperties
-
Create a JongoQueries instance.
P
- p - Variable in class org.craftercms.commons.jackson.mvc.GDataPropertyFilter
- Parameter - Class in org.craftercms.commons.plugin.model
-
Holds the information for a parameter
- Parameter() - Constructor for class org.craftercms.commons.plugin.model.Parameter
- Parameter.Type - Enum Class in org.craftercms.commons.plugin.model
-
Possible types for the parameters
- parameters - Variable in class org.craftercms.commons.plugin.model.Plugin
-
The parameters supported by the plugin
- parentXpath - Variable in class org.craftercms.commons.plugin.model.Installation
-
XPath selector for the parent node
- parse(String, Matcher) - Method in class org.craftercms.commons.file.stores.impl.FixedStoreTypeRemotePathParser
- parse(String, Matcher) - Method in class org.craftercms.commons.file.stores.impl.PathPartsBasedProfileAwareRemotePathParser
- parse(String, Matcher) - Method in interface org.craftercms.commons.file.stores.impl.RemotePathParser
-
Parses the remote path string.
- parseLocale(String) - Static method in class org.craftercms.commons.locale.LocaleUtils
- parseLocales(List<String>) - Static method in class org.craftercms.commons.locale.LocaleUtils
- parseRequestSelector(String) - Method in class org.craftercms.commons.jackson.mvc.GDataPropertyFilter
- passphrase - Variable in class org.craftercms.commons.git.auth.SshPrivateKeyAuthConfigurator
- password - Variable in class org.craftercms.commons.config.profiles.webdav.WebDavProfile
- password - Variable in class org.craftercms.commons.git.auth.SshPasswordAuthConfigurator
- password - Variable in class org.craftercms.commons.git.utils.AbstractAuthConfiguratorBuilder
- PASSWORD - Enum constant in enum class org.craftercms.commons.plugin.model.Parameter.Type
- PASSWORD_SEP - Static variable in class org.craftercms.commons.crypto.CryptoUtils
- patch - Variable in class org.craftercms.commons.plugin.model.Version
-
The patch version
- path - Variable in class org.craftercms.commons.spring.resources.WebDavResource
- pathParsers - Variable in class org.craftercms.commons.file.stores.impl.RemoteFileResolverImpl
- PathPartsBasedProfileAwareRemotePathParser - Class in org.craftercms.commons.file.stores.impl
-
RemotePathParser
that buildsProfileAwareRemotePath
s based on the parts of the given path, returned by the groups of the regex matcher. - PathPartsBasedProfileAwareRemotePathParser() - Constructor for class org.craftercms.commons.file.stores.impl.PathPartsBasedProfileAwareRemotePathParser
- pathStyleAccessEnabled - Variable in class org.craftercms.commons.config.profiles.aws.S3Profile
-
Indicates if path style access should be used for all request
- pattern - Variable in class org.craftercms.commons.file.blob.impl.AbstractBlobStore
-
The regex to check for compatible paths
- payload - Variable in class org.craftercms.commons.audit.AuditModel
-
Payload of the audit.
- payload() - Element in annotation interface org.craftercms.commons.validation.annotations.param.EsapiValidatedParam
- payload() - Element in annotation interface org.craftercms.commons.validation.annotations.param.SqlSort
- payload() - Element in annotation interface org.craftercms.commons.validation.annotations.param.ValidateNoTagsParam
- payload() - Element in annotation interface org.craftercms.commons.validation.annotations.param.ValidateSecurePathParam
- payload() - Element in annotation interface org.craftercms.commons.validation.annotations.param.ValidateStringParam
- payload() - Element in annotation interface org.craftercms.commons.validation.annotations.param.ValidConfigurationPath
- payload() - Element in annotation interface org.craftercms.commons.validation.annotations.param.ValidExistingContentPath
- payload() - Element in annotation interface org.craftercms.commons.validation.annotations.param.ValidNewContentPath
- payload() - Element in annotation interface org.craftercms.commons.validation.annotations.param.ValidSiteId
- payload() - Element in annotation interface org.craftercms.commons.validation.annotations.param.ValidUsername
- PbkAesTextEncryptor - Class in org.craftercms.commons.crypto.impl
-
Wrapper for
AesTextEncryptor
that generates the encryption key based on a password and salt. - PbkAesTextEncryptor(String, String) - Constructor for class org.craftercms.commons.crypto.impl.PbkAesTextEncryptor
- people - Variable in class org.craftercms.commons.plugin.model.Developer
-
The list of people that worked on the plugin
- Permission - Interface in org.craftercms.commons.security.permissions
-
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.
- PermissionEvaluator<S,
R> - Interface in org.craftercms.commons.security.permissions -
Evaluates or checks permissions.
- PermissionEvaluatorImpl<S,
R> - Class in org.craftercms.commons.security.permissions.impl -
Default implementation of
PermissionEvaluator
- PermissionEvaluatorImpl(SubjectResolver<S>, PermissionResolver<S, R>) - Constructor for class org.craftercms.commons.security.permissions.impl.PermissionEvaluatorImpl
- permissionEvaluators - Variable in class org.craftercms.commons.security.permissions.annotations.AbstractPermissionAnnotationHandler
- PermissionException - Exception Class in org.craftercms.commons.security.exception
-
RuntimeException
version ofPermissionException
. - PermissionException() - Constructor for exception class org.craftercms.commons.security.exception.PermissionException
- PermissionException(String, Object...) - Constructor for exception class org.craftercms.commons.security.exception.PermissionException
- PermissionException(String, Throwable, Object...) - Constructor for exception class org.craftercms.commons.security.exception.PermissionException
- PermissionException(Throwable) - Constructor for exception class org.craftercms.commons.security.exception.PermissionException
- permissionResolver - Variable in class org.craftercms.commons.security.permissions.impl.PermissionEvaluatorImpl
- PermissionResolver<S,
R> - Interface in org.craftercms.commons.security.permissions -
Resolves the permissions for a particular type of subjects and resources.
- permissions - Variable in class org.craftercms.commons.security.permissions.CompositePermission
- permissions - Variable in class org.craftercms.commons.security.permissions.ProtectedResourceBase
- persistAudit(T) - Method in class org.craftercms.commons.audit.AuditService
-
Defines the actual save of the audit to the given audit repository.
- Person() - Constructor for class org.craftercms.commons.plugin.model.BlueprintDescriptor.Person
-
Deprecated.
- PersonWrapper() - Constructor for class org.craftercms.commons.plugin.model.BlueprintDescriptor.PersonWrapper
-
Deprecated.
- PGPUtils - Class in org.craftercms.commons.crypto
-
Utility class to perform encryption and decryption using PGP keys.
- PGPUtils() - Constructor for class org.craftercms.commons.crypto.PGPUtils
- pipelineName - Variable in class org.craftercms.commons.upgrade.impl.pipeline.DefaultUpgradePipelineFactoryImpl
-
Name used in the configuration file
- pipelinePrefix - Variable in class org.craftercms.commons.upgrade.impl.pipeline.DefaultUpgradePipelineFactoryImpl
-
The prefix for the pipelines in the configuration file, defaults to
DEFAULT_PIPELINE_PREFIX
- PLACEHOLDER_ENVIRONMENT - Static variable in class org.craftercms.commons.config.ConfigurationResolverImpl
- PLACEHOLDER_MODULE - Static variable in class org.craftercms.commons.config.ConfigurationResolverImpl
- plugin - Variable in class org.craftercms.commons.plugin.model.PluginDescriptor
-
The actual metadata of the plugin
- Plugin - Class in org.craftercms.commons.plugin.model
-
Holds the metadata for a plugin
- Plugin() - Constructor for class org.craftercms.commons.plugin.model.Plugin
- PluginDescriptor - Class in org.craftercms.commons.plugin.model
-
Holds all the metadata for a plugin
- PluginDescriptor() - Constructor for class org.craftercms.commons.plugin.model.PluginDescriptor
- PluginDescriptorReader - Interface in org.craftercms.commons.plugin
-
Parses a
PluginDescriptor
from various sources - PluginDescriptorReaderImpl - Class in org.craftercms.commons.plugin.impl
-
Default implementation of
PluginDescriptorReader
that parses YAML files. - PluginDescriptorReaderImpl() - Constructor for class org.craftercms.commons.plugin.impl.PluginDescriptorReaderImpl
- PluginException - Exception Class in org.craftercms.commons.plugin.exception
-
Exception related to plugin descriptors
- PluginException(String) - Constructor for exception class org.craftercms.commons.plugin.exception.PluginException
- PluginException(String, Throwable) - Constructor for exception class org.craftercms.commons.plugin.exception.PluginException
- PluginTypes - Interface in org.craftercms.commons.plugin.model
-
All available plugin types for Crafter CNS
- postProcessBeanDefinitionRegistry(BeanDefinitionRegistry) - Method in class org.craftercms.commons.spring.ListMergingPostProcessor
- postProcessBeanFactory(ConfigurableListableBeanFactory) - Method in class org.craftercms.commons.spring.ListMergingPostProcessor
- PRAGMA_HEADER_NAME - Static variable in class org.craftercms.commons.http.HttpUtils
- preemptiveAuth - Variable in class org.craftercms.commons.config.profiles.webdav.WebDavProfile
- prefix - Variable in class org.craftercms.commons.config.profiles.aws.S3Profile
-
Optional prefix to prepend to all keys
- prefix - Variable in class org.craftercms.commons.file.blob.impl.AbstractBlobStore.Mapping
-
The prefix to use in the store
- prefixLookups - Variable in class org.craftercms.commons.config.EncryptionAwareConfigurationReader
- PREVIEW - Static variable in interface org.craftercms.commons.config.PublishingTargetResolver
- PRIVATE_KEY - Static variable in interface org.craftercms.commons.git.utils.AuthenticationType
- privateKey - Variable in class org.craftercms.commons.git.jgit.SshPrivateKeySessionFactory
- privateKeyPassphrase - Variable in class org.craftercms.commons.git.utils.AbstractAuthConfiguratorBuilder
- privateKeyPath - Variable in class org.craftercms.commons.git.auth.SshPrivateKeyAuthConfigurator
- privateKeyPath - Variable in class org.craftercms.commons.git.utils.AbstractAuthConfiguratorBuilder
- processConfig(HierarchicalConfiguration<ImmutableNode>) - Method in interface org.craftercms.commons.config.ConfigurationMapper
-
Reads a single profile from the given configuration
- processConfig(HierarchicalConfiguration<ImmutableNode>) - Method in class org.craftercms.commons.config.profiles.AbstractProfileConfigMapper
- processTemplate(String, Object) - Method in class org.craftercms.commons.mail.impl.EmailFactoryImpl
- profile - Variable in class org.craftercms.commons.file.blob.impl.AbstractBlobStore
-
The profile to connect to the remote store
- PROFILE - Enum constant in enum class org.craftercms.commons.entitlements.model.Module
- ProfileAwareRemotePath - Class in org.craftercms.commons.file.stores.impl
-
Extension of
RemotePath
that adds the concept of a remote configuration profile to the path. - ProfileAwareRemotePath(String, String, String) - Constructor for class org.craftercms.commons.file.stores.impl.ProfileAwareRemotePath
- profileId - Variable in class org.craftercms.commons.config.profiles.ConfigurationProfile
- profileLoader - Variable in class org.craftercms.commons.file.stores.impl.AbstractProfileAwareRemoteFileStore
- profileMapper - Variable in class org.craftercms.commons.file.blob.impl.AbstractBlobStore
-
The mapper to load the profile configuration
- properties - Variable in class org.craftercms.commons.properties.OverrideProperties
-
Backend properties file.
- ProtectedResource - Annotation Interface in org.craftercms.commons.security.permissions.annotations
-
Used in a method parameter to indicate the resource or main ID of the resource to be protected.
- ProtectedResourceBase<P> - Class in org.craftercms.commons.security.permissions
-
Base for protected resources that provide already attached permissions.
- ProtectedResourceBase() - Constructor for class org.craftercms.commons.security.permissions.ProtectedResourceBase
- ProtectedResourceId - Annotation Interface in org.craftercms.commons.security.permissions.annotations
-
Used in a method parameter to indicate an ID (of several) of the resource to be protected.
- PROVIDER - Static variable in class org.craftercms.commons.crypto.PGPUtils
- ProxyUtils - Class in org.craftercms.commons.proxy
- ProxyUtils() - Constructor for class org.craftercms.commons.proxy.ProxyUtils
- publishingTargetResolver - Variable in class org.craftercms.commons.file.blob.impl.AbstractBlobStore
-
The publishing target resolver
- PublishingTargetResolver - Interface in org.craftercms.commons.config
-
Provides access to the current publishing target
- pull(String, Object) - Method in class org.craftercms.commons.mongo.UpdateHelper
- pull(Git, String, String, String, MergeStrategy, ContentMergeStrategy, MergeCommand.FastForwardMode, GitAuthenticationConfigurator) - Static method in class org.craftercms.commons.git.utils.GitUtils
-
Execute a Git pull.
- pullAll(String, Collection<?>) - Method in class org.craftercms.commons.mongo.UpdateHelper
- pullAllDocuments(String, String, Collection<?>) - Method in class org.craftercms.commons.mongo.UpdateHelper
- pullValues - Variable in class org.craftercms.commons.mongo.UpdateHelper
- push(String, Object) - Method in class org.craftercms.commons.mongo.UpdateHelper
- push(Git, String, boolean, String, String, GitAuthenticationConfigurator, boolean) - Static method in class org.craftercms.commons.git.utils.GitUtils
-
Executes a git push.
- pushAll(String, Collection<?>) - Method in class org.craftercms.commons.mongo.UpdateHelper
- pushValues - Variable in class org.craftercms.commons.mongo.UpdateHelper
Q
- queries - Variable in class org.craftercms.commons.mongo.AbstractJongoRepository
- query - Variable in class org.craftercms.commons.entitlements.validator.impl.DefaultDbIntegrityValidatorImpl
-
SQL statement to generate the validation value.
R
- RANGE_HEADER_FORMAT - Static variable in class org.craftercms.commons.lang.UrlUtils
- RANGE_HEADER_NAME - Static variable in class org.craftercms.commons.lang.UrlUtils
- RANGE_NO_END_HEADER_FORMAT - Static variable in class org.craftercms.commons.lang.UrlUtils
- RangeAwareResource - Interface in org.craftercms.commons.spring.resources
-
Extension of Spring's
Resource
that provides random access to the content. - RangeAwareUrlResource - Class in org.craftercms.commons.spring.resources
-
UrlResource
extension that implementsRangeAwareResource
in order to provide random access to content (range content queries). - RangeAwareUrlResource(String) - Constructor for class org.craftercms.commons.spring.resources.RangeAwareUrlResource
- RangeAwareUrlResource(String, String) - Constructor for class org.craftercms.commons.spring.resources.RangeAwareUrlResource
- RangeAwareUrlResource(String, String, String) - Constructor for class org.craftercms.commons.spring.resources.RangeAwareUrlResource
- RangeAwareUrlResource(URI) - Constructor for class org.craftercms.commons.spring.resources.RangeAwareUrlResource
- RangeAwareUrlResource(URL) - Constructor for class org.craftercms.commons.spring.resources.RangeAwareUrlResource
- read() - Method in class org.craftercms.commons.crypto.Base64.InputStream
-
Deprecated.Reads enough of the input stream to convert to/from Base64 and returns the next byte.
- read(byte[], int, int) - Method in class org.craftercms.commons.crypto.Base64.InputStream
-
Deprecated.Calls
Base64.InputStream.read()
repeatedly until the end of stream is reached or len bytes are read. - read(InputStream) - Method in class org.craftercms.commons.config.YamlConfiguration
- read(InputStream) - Method in class org.craftercms.commons.plugin.impl.PluginDescriptorReaderImpl
-
Parses a
PluginDescriptor
from the given stream - read(InputStream) - Method in interface org.craftercms.commons.plugin.PluginDescriptorReader
-
Parses a
PluginDescriptor
from the given stream - read(Reader) - Method in class org.craftercms.commons.config.YamlConfiguration
- read(Reader) - Method in class org.craftercms.commons.plugin.impl.PluginDescriptorReaderImpl
-
Parses a
PluginDescriptor
from the given reader - read(Reader) - Method in interface org.craftercms.commons.plugin.PluginDescriptorReader
-
Parses a
PluginDescriptor
from the given reader - readableFileSize(long) - Static method in class org.craftercms.commons.file.FileUtils
-
Given the size of a file outputs as human readable size using SI prefix.
- readConfig(ConfigurationProvider, String, String, String, String) - Method in interface org.craftercms.commons.config.ConfigurationMapper
-
Reads the configuration from the specified input stream, extracts the specific sub-configuration identified by
configId
and maps the configuration to a Java bean. - readConfig(ConfigurationProvider, String, String, String, String) - Method in class org.craftercms.commons.config.profiles.AbstractProfileConfigMapper
- readFile(String) - Method in class org.craftercms.commons.mongo.AbstractJongoRepository
- readFile(String) - Method in interface org.craftercms.commons.mongo.CrudRepository
-
Returns the InputStream of the file with the given name.
- readFile(ObjectId) - Method in class org.craftercms.commons.mongo.AbstractJongoRepository
- readFile(ObjectId) - Method in interface org.craftercms.commons.mongo.CrudRepository
-
Returns the InputStream of the file with the given id.
- readPropertyFile(InputStream) - Method in class org.craftercms.commons.mongo.JongoQueries
- readPropertyFile(InputStream) - Method in class org.craftercms.commons.properties.OverrideProperties
-
Does the actual Reading of the properties file (of the given inputstream).
- readVersionFromFile(Path) - Method in class org.craftercms.commons.upgrade.impl.providers.AbstractFileVersionProvider
- readVersionFromFile(Path) - Method in class org.craftercms.commons.upgrade.impl.providers.YamlFileVersionProvider
- readXmlConfiguration(InputStream, char, Map<String, Lookup>, Map<String, String>) - Static method in class org.craftercms.commons.config.ConfigUtils
-
Reads the XML configuration from the specified input stream, using the
ConfigUtils.DEFAULT_ENCODING
. - readXmlConfiguration(InputStream, char, Map<String, Lookup>, Map<String, String>, String) - Static method in class org.craftercms.commons.config.ConfigUtils
-
Reads the XML configuration from the specified input stream, using the given file encoding.
- readXmlConfiguration(InputStream, Map<String, String>) - Method in class org.craftercms.commons.config.EncryptionAwareConfigurationReader
- readXmlConfiguration(Resource, char, Map<String, Lookup>, Map<String, String>) - Static method in class org.craftercms.commons.config.ConfigUtils
- readXmlConfiguration(Resource, Map<String, String>) - Method in class org.craftercms.commons.config.EncryptionAwareConfigurationReader
- readYamlConfiguration(File) - Method in class org.craftercms.commons.config.EncryptionAwareConfigurationReader
- readYamlConfiguration(Reader) - Method in class org.craftercms.commons.config.EncryptionAwareConfigurationReader
- readYamlConfiguration(Reader, Map<String, Lookup>) - Static method in class org.craftercms.commons.config.ConfigUtils
- readYamlConfiguration(Reader, Map<String, Lookup>, int) - Static method in class org.craftercms.commons.config.ConfigUtils
-
Read a YAML configuration from the given reader.
- readYamlConfiguration(Resource) - Method in class org.craftercms.commons.config.EncryptionAwareConfigurationReader
- RegexUtils - Class in org.craftercms.commons.lang
-
Utility methods for regex related operations.
- region - Variable in class org.craftercms.commons.config.profiles.aws.AbstractAwsProfile
-
Region to use in AWS services.
- registerSerializationModule() - Method in class org.craftercms.commons.jackson.CustomSerializationObjectMapper
- reload() - Method in class org.craftercms.commons.properties.OverrideProperties
-
Reload the Query map.
- RemoteFile - Interface in org.craftercms.commons.file.stores
-
Represents a file stored remotely.
- RemoteFileResolver - Interface in org.craftercms.commons.file.stores
-
Resolves special paths to files in remote stores.
- RemoteFileResolverImpl - Class in org.craftercms.commons.file.stores.impl
-
Default implementation of
RemoteFileResolver
. - RemoteFileResolverImpl(Map<String, RemotePathParser>, Map<String, RemoteFileStore>) - Constructor for class org.craftercms.commons.file.stores.impl.RemoteFileResolverImpl
- RemoteFileStore - Interface in org.craftercms.commons.file.stores
-
Interface for "proxies" to remote file stores.
- RemotePath - Class in org.craftercms.commons.file.stores
-
Represents the path of a remote file.
- RemotePath(String, String) - Constructor for class org.craftercms.commons.file.stores.RemotePath
- RemotePathParser - Interface in org.craftercms.commons.file.stores.impl
-
Internal helper interface that parses a matched remote path.
- remove(String) - Method in class org.craftercms.commons.mongo.AbstractJongoRepository
- remove(String) - Method in interface org.craftercms.commons.mongo.CrudRepository
-
Removes all Documents that are found using the given query.
- remove(String, Object...) - Method in class org.craftercms.commons.mongo.AbstractJongoRepository
- remove(String, Object...) - Method in interface org.craftercms.commons.mongo.CrudRepository
-
Removes all Documents that are found using the given query.
- removeById(String) - Method in class org.craftercms.commons.mongo.AbstractJongoRepository
- removeById(String) - Method in interface org.craftercms.commons.mongo.CrudRepository
-
Removes a Document with the given id
- removeByStringId(String) - Method in class org.craftercms.commons.mongo.AbstractJongoRepository
- removeByStringId(String) - Method in interface org.craftercms.commons.mongo.CrudRepository
-
Removes by the Id.
- removePermission(P) - Method in class org.craftercms.commons.security.permissions.ProtectedResourceBase
- RequestContext - Class in org.craftercms.commons.http
-
Holds the current HTTP servlet request and response.
- RequestContext(HttpServletRequest, HttpServletResponse, ServletContext) - Constructor for class org.craftercms.commons.http.RequestContext
- RequestContextBindingFilter - Class in org.craftercms.commons.http
-
Binds a new request context to the current thread before the chain is called, and then removes it after the chain is called.
- RequestContextBindingFilter() - Constructor for class org.craftercms.commons.http.RequestContextBindingFilter
- required - Variable in class org.craftercms.commons.plugin.model.Parameter
-
Indicates if the parameter is required
- requiredViewClass() - Method in class org.craftercms.commons.freemarker.CrafterFreeMarkerViewResolver
- resolve(String) - Method in class org.craftercms.commons.file.stores.impl.RemoteFileResolverImpl
- resolve(String) - Method in interface org.craftercms.commons.file.stores.RemoteFileResolver
-
Given the specified path, returns a
RemoteFile
associated to the path. - ResourceBasedRemoteFile - Class in org.craftercms.commons.file.stores.impl
-
Implementation of
RemoteFile
that basically is facade to a SpringResource
. - ResourceBasedRemoteFile(RemotePath, Resource) - Constructor for class org.craftercms.commons.file.stores.impl.ResourceBasedRemoteFile
- resourceBundle - Variable in class org.craftercms.commons.i10n.I10nLogger
- resources - Variable in class org.craftercms.commons.properties.OverrideProperties
-
List of all Query files to be load.
- responseStatus - Variable in exception class org.craftercms.commons.rest.RestServiceException
- responseType - Variable in class org.craftercms.commons.rest.HttpMessageConvertingResponseErrorHandler
- RestrictedApplicationContext - Class in org.craftercms.commons.spring.context
-
Extension of
GenericApplicationContext
that only allows access to beans in the site config whitelist - RestrictedApplicationContext(ApplicationContext, String[]) - Constructor for class org.craftercms.commons.spring.context.RestrictedApplicationContext
- RestServiceException - Exception Class in org.craftercms.commons.rest
-
Exception thrown when an error is received from a REST service.
- RestServiceException(HttpStatusCode, Object) - Constructor for exception class org.craftercms.commons.rest.RestServiceException
- RestServiceUtils - Class in org.craftercms.commons.rest
-
Utility methods for RESTful services.
- restTemplate - Variable in class org.craftercms.commons.rest.AbstractRestClientBase
- RestTemplate - Class in org.craftercms.commons.rest
-
Simple extension of
RestTemplate
that adds the following custom functionality: Forces the use ofHttpComponentsClientHttpRequestFactory
, to avoid issues with 40x responses.HttpMessageConvertingResponseErrorHandler
is used by default. - RestTemplate(Class<?>) - Constructor for class org.craftercms.commons.rest.RestTemplate
- RestTemplate(List<HttpMessageConverter<?>>) - Constructor for class org.craftercms.commons.rest.RestTemplate
- result - Variable in exception class org.craftercms.commons.validation.ValidationException
- result - Variable in exception class org.craftercms.commons.validation.ValidationRuntimeException
- Result - Class in org.craftercms.commons.rest
-
Very simple class that can be returned by REST API methods to indicate a result with a message, generally for success.
- Result() - Constructor for class org.craftercms.commons.rest.Result
- Result(String) - Constructor for class org.craftercms.commons.rest.Result
- resumeEncoding() - Method in class org.craftercms.commons.crypto.Base64.OutputStream
-
Deprecated.Resumes encoding of the stream.
- returnList(Find) - Method in class org.craftercms.commons.mongo.AbstractJongoRepository
-
Actually makes the transformation form Jongo to List of Objects.
- returnSimple(FindOne) - Method in class org.craftercms.commons.mongo.AbstractJongoRepository
-
Actually makes the transformation form Jongo to the Object.
- RIGHT_CURLY_BRACE - Static variable in class org.craftercms.commons.http.HttpUtils
- role() - Element in annotation interface org.craftercms.commons.jackson.mvc.annotations.SecureProperty
-
Role name to check if has access to the property.
- ROOT_URL - Static variable in class org.craftercms.commons.monitoring.rest.MonitoringRestControllerBase
S
- S3AsyncClientCachingFactory - Class in org.craftercms.commons.aws
-
AbstractAwsClientCachingFactory
for S3 async clients. - S3AsyncClientCachingFactory() - Constructor for class org.craftercms.commons.aws.S3AsyncClientCachingFactory
- S3ClientCachingFactory - Class in org.craftercms.commons.aws
-
AbstractAwsClientCachingFactory
for S3 clients. - S3ClientCachingFactory() - Constructor for class org.craftercms.commons.aws.S3ClientCachingFactory
- S3FileStore - Class in org.craftercms.commons.file.stores.impl.s3
-
A
RemoteFileStore
to S3. - S3FileStore(S3ClientCachingFactory, ConfigurationProfileLoader<S3Profile>) - Constructor for class org.craftercms.commons.file.stores.impl.s3.S3FileStore
- s3KeyFromPath(String, String) - Static method in class org.craftercms.commons.aws.AwsUtils
-
Form a S3 key from a base key and a path
- S3Profile - Class in org.craftercms.commons.config.profiles.aws
-
Holds the information to connect to AWS S3.
- S3Profile() - Constructor for class org.craftercms.commons.config.profiles.aws.S3Profile
- S3ProfileMapper - Class in org.craftercms.commons.config.profiles.aws
-
Configuration mapper for
S3Profile
s. - S3ProfileMapper(ConfigurationResolver) - Constructor for class org.craftercms.commons.config.profiles.aws.S3ProfileMapper
- S3Resource - Class in org.craftercms.commons.spring.resources
-
Implementation of
Resource
for S3 files. - S3Resource(S3ClientCachingFactory, S3Profile, String) - Constructor for class org.craftercms.commons.spring.resources.S3Resource
- S3Resource(S3ClientCachingFactory, S3Profile, String, String) - Constructor for class org.craftercms.commons.spring.resources.S3Resource
- S3Utils - Class in org.craftercms.commons.file.stores
-
Utility methods for S3.
- S3Utils() - Constructor for class org.craftercms.commons.file.stores.S3Utils
- sandboxEnabled - Variable in class org.craftercms.commons.spring.groovy.SandboxInterceptorFactory
-
Indicates if the sandbox should be enabled
- SandboxInterceptorFactory - Class in org.craftercms.commons.spring.groovy
-
Implementation of
FactoryBean
forSandboxInterceptor
- SandboxInterceptorFactory(boolean, boolean, Resource, String[]) - Constructor for class org.craftercms.commons.spring.groovy.SandboxInterceptorFactory
- save(String, Object...) - Method in class org.craftercms.commons.mongo.AbstractJongoRepository
- save(String, Object...) - Method in interface org.craftercms.commons.mongo.CrudRepository
-
Inserts in the given collection the json "As Is"
Json String can contain placeholders this will allow the user to have predefine json strings
that will be substitute with the given queryParams.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 queryParams should match the same in the json string.
Example
String Json ="{name:#,address: #,age:#}"
save("testCollection",Json,"Dr.John Z.", new Address(), 125); - save(T) - Method in class org.craftercms.commons.mongo.AbstractJongoRepository
- save(T) - Method in interface org.craftercms.commons.mongo.CrudRepository
-
Saves the document into the collection.
- saveFile(InputStream, String, String) - Method in class org.craftercms.commons.mongo.AbstractJongoRepository
- saveFile(InputStream, String, String) - Method in interface org.craftercms.commons.mongo.CrudRepository
-
Saves the given InputStream as with the given name.
- saveFile(InputStream, String, String, ObjectId) - Method in class org.craftercms.commons.mongo.AbstractJongoRepository
- saveFile(InputStream, String, String, ObjectId) - Method in interface org.craftercms.commons.mongo.CrudRepository
-
Saves the given InputStream as with the given name.
- saveKey(String, SecretKey) - Method in class org.craftercms.commons.crypto.impl.SecretKeyRepositoryImpl
- saveKey(String, SecretKey) - Method in interface org.craftercms.commons.crypto.SecretKeyRepository
-
Saves the secret key in the repository, with the specified name
- Screenshot() - Constructor for class org.craftercms.commons.plugin.model.BlueprintDescriptor.Screenshot
-
Deprecated.
- screenshots - Variable in class org.craftercms.commons.plugin.model.Media
- ScreenshotWrapper() - Constructor for class org.craftercms.commons.plugin.model.BlueprintDescriptor.ScreenshotWrapper
-
Deprecated.
- scythe() - Method in class org.craftercms.commons.audit.AuditReaper
-
Search all logs to be deleted and send there id's to the audit service to be deleted.
- SEARCH_KEYWORDS - Enum constant in enum class org.craftercms.commons.validation.annotations.param.EsapiValidationType
- searchEngine - Variable in class org.craftercms.commons.plugin.model.Plugin
-
The search engine required by the plugin
- SearchEngines - Interface in org.craftercms.commons.plugin.model
-
All available search engines for CrafterCMS
- secretKey - Variable in class org.craftercms.commons.config.profiles.aws.AbstractAwsProfile
-
The AWS secret key (if using static credentials)
- SecretKeyFactoryBean - Class in org.craftercms.commons.crypto
-
Spring factory bean used to easily inject a secret key from a
SecretKeyRepository
. - SecretKeyFactoryBean(String, boolean, SecretKeyRepository) - Constructor for class org.craftercms.commons.crypto.SecretKeyFactoryBean
- SecretKeyRepository - Interface in org.craftercms.commons.crypto
-
Repository for storing/retrieving encryption keys.
- SecretKeyRepositoryImpl - Class in org.craftercms.commons.crypto.impl
-
Default implementation of
SecretKeyRepository
, which uses JCE Key Store. - SecretKeyRepositoryImpl(File, String) - Constructor for class org.craftercms.commons.crypto.impl.SecretKeyRepositoryImpl
- SecurePathValidator - Class in org.craftercms.commons.validation.validators.impl
- SecurePathValidator() - Constructor for class org.craftercms.commons.validation.validators.impl.SecurePathValidator
- SecureProperty - Annotation Interface in org.craftercms.commons.jackson.mvc.annotations
-
Check if this property will be serialize depending of the result of
SecurePropertyHandler.suppressProperty(Object, String[])
- securePropertyHandler - Variable in class org.craftercms.commons.jackson.mvc.CrafterJackson2MessageConverter
- SecurePropertyHandler - Interface in org.craftercms.commons.jackson.mvc
-
Defines how the SecureProperty Should be handel.
- secureRandom - Static variable in class org.craftercms.commons.crypto.CryptoUtils
- SecurityException - Exception Class in org.craftercms.commons.security.exception
-
RuntimeException
version ofSecurityException
. - SecurityException() - Constructor for exception class org.craftercms.commons.security.exception.SecurityException
- SecurityException(String, Object...) - Constructor for exception class org.craftercms.commons.security.exception.SecurityException
- SecurityException(String, Throwable, Object...) - Constructor for exception class org.craftercms.commons.security.exception.SecurityException
- SecurityException(Throwable) - Constructor for exception class org.craftercms.commons.security.exception.SecurityException
- SELECTOR_ALIAS_PREFIX - Static variable in class org.craftercms.commons.jackson.mvc.GDataPropertyFilter
- SelectorFilterFactory - Class in org.craftercms.commons.jackson.mvc
- SelectorFilterFactory() - Constructor for class org.craftercms.commons.jackson.mvc.SelectorFilterFactory
- SelectorFilterFactory(List<AbstractCrafterPropertyFilter>) - Constructor for class org.craftercms.commons.jackson.mvc.SelectorFilterFactory
- selectorParameterName - Variable in class org.craftercms.commons.jackson.mvc.GDataPropertyFilter
- send() - Method in interface org.craftercms.commons.mail.Email
-
Sends the email.
- send() - Method in class org.craftercms.commons.mail.impl.EmailImpl
- serialize(ObjectId, JsonGenerator, SerializerProvider) - Method in class org.craftercms.commons.jackson.ObjectIdSerializer
- serializers - Variable in class org.craftercms.commons.jackson.CustomSerializationObjectMapper
- serviceName - Variable in class org.craftercms.commons.config.profiles.AbstractProfileConfigMapper
- set(String, Object) - Method in class org.craftercms.commons.mongo.UpdateHelper
- setAccessKey(String) - Method in class org.craftercms.commons.config.profiles.aws.AbstractAwsProfile
- setActualPathGroup(int) - Method in class org.craftercms.commons.file.stores.impl.PathPartsBasedProfileAwareRemotePathParser
- setAdditionalElements(List<String>) - Method in class org.craftercms.commons.spring.ListMergingPostProcessor
- setAlgorithm(String) - Method in class org.craftercms.commons.crypto.SimpleDigest
- setAlias(OverrideProperties) - Method in class org.craftercms.commons.jackson.mvc.GDataPropertyFilter
- setAllowedActions(Set<String>) - Method in class org.craftercms.commons.security.permissions.DefaultPermission
- setApplicationContext(ApplicationContext) - Method in class org.craftercms.commons.file.blob.impl.BlobStoreResolverImpl
- setApplicationContext(ApplicationContext) - Method in class org.craftercms.commons.spring.BeanListFactoryBean
- setApplicationContext(ApplicationContext) - Method in class org.craftercms.commons.spring.context.ApplicationContextAccessor
- setApplicationContext(ApplicationContext) - Method in class org.craftercms.commons.upgrade.impl.AbstractUpgradeManager
- setApplicationContext(ApplicationContext) - Method in class org.craftercms.commons.upgrade.impl.operations.AbstractUpgradeOperation
- setApplicationContext(ApplicationContext) - Method in class org.craftercms.commons.upgrade.impl.pipeline.DefaultUpgradePipelineFactoryImpl
- setAsyncClientFactory(S3AsyncClientCachingFactory) - Method in class org.craftercms.commons.file.blob.impl.s3.AwsS3BlobStore
- setAttribute(String, Object) - Method in class org.craftercms.commons.mongo.FileInfo
- setAttributes(List<Installation.Attribute>) - Method in class org.craftercms.commons.plugin.model.Installation.Element
- setAttributes(Map<String, Object>) - Method in class org.craftercms.commons.mongo.FileInfo
- setAuditDate(Date) - Method in class org.craftercms.commons.audit.AuditModel
-
Sets audit entry date.
- setAuditService(AuditService) - Method in class org.craftercms.commons.audit.AuditListener
- setAuditService(AuditService<?>) - Method in class org.craftercms.commons.audit.AuditReaper
- setBase64Salt(String) - Method in class org.craftercms.commons.crypto.SimpleDigest
- setBaseUrl(String) - Method in class org.craftercms.commons.config.profiles.webdav.WebDavProfile
-
Sets the base url of the webdav server.
- setBeanName(String) - Method in class org.craftercms.commons.cache.GuavaCacheFactoryBean
- setBeanName(String) - Method in class org.craftercms.commons.spring.ListMergingPostProcessor
- setBlueprint(BlueprintDescriptor.Blueprint) - Method in class org.craftercms.commons.plugin.model.BlueprintDescriptor
-
Deprecated.
- setBlueprint(BlueprintDescriptor.Blueprint) - Method in class org.craftercms.commons.plugin.model.PluginDescriptor
- setBucketName(String) - Method in class org.craftercms.commons.config.profiles.aws.S3Profile
- setBuild(BlueprintDescriptor.Build) - Method in class org.craftercms.commons.plugin.model.BlueprintDescriptor.Blueprint
-
Deprecated.
- setChildren(List<Installation.Element>) - Method in class org.craftercms.commons.plugin.model.Installation.Element
- setCipher(Cipher) - Method in class org.craftercms.commons.crypto.SimpleCipher
- setClientFactory(S3ClientCachingFactory) - Method in class org.craftercms.commons.file.blob.impl.s3.AwsS3BlobStore
- setCompany(BlueprintDescriptor.Company) - Method in class org.craftercms.commons.plugin.model.BlueprintDescriptor.Developer
-
Deprecated.
- setCompany(Contact) - Method in class org.craftercms.commons.plugin.model.Developer
- setConfigModule(String) - Method in class org.craftercms.commons.file.blob.impl.BlobStoreResolverImpl
- setConfigPath(String) - Method in class org.craftercms.commons.file.blob.impl.BlobStoreResolverImpl
- setConfigurationResolver(ConfigurationResolver) - Method in class org.craftercms.commons.file.blob.impl.BlobStoreResolverImpl
- setConnectionsPerHost(int) - Method in class org.craftercms.commons.mongo.MongoClientOptionsFactory
- setConnectionStr(String) - Method in class org.craftercms.commons.mongo.MongoScriptRunner
- setConnectionString(String) - Method in class org.craftercms.commons.mongo.MongoClientFactory
- setConnectTimeout(int) - Method in class org.craftercms.commons.mongo.MongoClientOptionsFactory
- setContentType(String) - Method in class org.craftercms.commons.mongo.FileInfo
- setContinueOnFailure(boolean) - Method in class org.craftercms.commons.upgrade.impl.AbstractUpgradeManager
- setContinueOnFailure(boolean) - Method in class org.craftercms.commons.upgrade.impl.pipeline.DefaultUpgradePipelineImpl
- setCrafterCmsEditions(List<String>) - Method in class org.craftercms.commons.plugin.model.Plugin
- setCrafterCmsVersions(List<Version>) - Method in class org.craftercms.commons.plugin.model.Plugin
- setCraftercmsVersionsSupported(List<BlueprintDescriptor.CraftercmsVersionSupported>) - Method in class org.craftercms.commons.plugin.model.BlueprintDescriptor.Blueprint
-
Deprecated.
- setCurrent(RequestContext) - Static method in class org.craftercms.commons.http.RequestContext
-
Sets the context for the current thread.
- setCursorFinalizerEnabled(boolean) - Method in class org.craftercms.commons.mongo.MongoClientOptionsFactory
- setDate(String) - Method in class org.craftercms.commons.plugin.model.BlueprintDescriptor.Build
-
Deprecated.
- setDefaultKeyAlgorithm(String) - Method in class org.craftercms.commons.crypto.impl.SecretKeyRepositoryImpl
- setDefaultValue(String) - Method in class org.craftercms.commons.plugin.model.Parameter
- setDefaultValue(String) - Method in class org.craftercms.commons.upgrade.impl.providers.AbstractVersionProvider
- setDeliveryBaseUrl(String) - Method in class org.craftercms.commons.config.profiles.webdav.WebDavProfile
-
Deprecated.The new service will ignore this property and use a /remote-assets/... URL instead
- setDescription(String) - Method in class org.craftercms.commons.plugin.model.Asset
- setDescription(String) - Method in class org.craftercms.commons.plugin.model.BlueprintDescriptor.Blueprint
-
Deprecated.
- setDescription(String) - Method in class org.craftercms.commons.plugin.model.BlueprintDescriptor.Screenshot
-
Deprecated.
- setDescription(String) - Method in class org.craftercms.commons.plugin.model.BlueprintDescriptor.Video
-
Deprecated.
- setDescription(String) - Method in class org.craftercms.commons.plugin.model.Parameter
- setDescription(String) - Method in class org.craftercms.commons.plugin.model.Plugin
- setDescriptorVersion(String) - Method in class org.craftercms.commons.plugin.model.BlueprintDescriptor
-
Deprecated.
- setDescriptorVersion(String) - Method in class org.craftercms.commons.plugin.model.PluginDescriptor
- setDeserializers(Map<Class<?>, JsonDeserializer<?>>) - Method in class org.craftercms.commons.jackson.CustomSerializationObjectMapper
- setDeserializers(Map<Class<?>, JsonDeserializer<?>>) - Method in class org.craftercms.commons.mongo.JongoFactoryBean
- setDeveloper(BlueprintDescriptor.Developer) - Method in class org.craftercms.commons.plugin.model.BlueprintDescriptor.Media
-
Deprecated.
- setDeveloper(Developer) - Method in class org.craftercms.commons.plugin.model.Plugin
- setDigest(MessageDigest) - Method in class org.craftercms.commons.crypto.SimpleDigest
- setDocumentation(String) - Method in class org.craftercms.commons.plugin.model.Plugin
- setDomain(String) - Method in class org.craftercms.commons.http.CookieManager
- setElement(Installation.Element) - Method in class org.craftercms.commons.plugin.model.Installation
- setElementXpath(String) - Method in class org.craftercms.commons.plugin.model.Installation
- setEmail(String) - Method in class org.craftercms.commons.plugin.model.BlueprintDescriptor.Company
-
Deprecated.
- setEmail(String) - Method in class org.craftercms.commons.plugin.model.BlueprintDescriptor.Person
-
Deprecated.
- setEmail(String) - Method in class org.craftercms.commons.plugin.model.Contact
- setEnabled(boolean) - Method in class org.craftercms.commons.upgrade.impl.operations.AbstractUpgradeOperation
- setEnabled(boolean) - Method in class org.craftercms.commons.web.AddResponseHeaderFilter
- setEndpoint(String) - Method in class org.craftercms.commons.config.profiles.aws.AbstractAwsProfile
- setEntitlementType(EntitlementType) - Method in exception class org.craftercms.commons.entitlements.exception.UnsupportedEntitlementException
- setErrorMessageBundle(ResourceBundle) - Method in class org.craftercms.commons.validation.rest.ValidationAwareRestExceptionHandlers
- setExtension(String) - Method in class org.craftercms.commons.rest.AbstractRestClientBase
- setFileId(ObjectId) - Method in class org.craftercms.commons.mongo.FileInfo
- setFileName(String) - Method in class org.craftercms.commons.mongo.FileInfo
- setFileSize(String) - Method in class org.craftercms.commons.mongo.FileInfo
- setFileSizeBytes(long) - Method in class org.craftercms.commons.mongo.FileInfo
- setFilters(List<AbstractCrafterPropertyFilter>) - Method in class org.craftercms.commons.jackson.mvc.SelectorFilterFactory
- setFreeMarkerConfig(Configuration) - Method in class org.craftercms.commons.mail.impl.EmailFactoryImpl
- setHash(String) - Method in class org.craftercms.commons.file.blob.Blob
- setHttpOnly(boolean) - Method in class org.craftercms.commons.http.CookieManager
- setId(String) - Method in class org.craftercms.commons.audit.AuditModel
-
Sets Id of the Audit Entry.
- setId(String) - Method in class org.craftercms.commons.file.blob.impl.AbstractBlobStore
- setId(String) - Method in class org.craftercms.commons.plugin.model.BlueprintDescriptor.Blueprint
-
Deprecated.
- setId(String) - Method in class org.craftercms.commons.plugin.model.BlueprintDescriptor.Build
-
Deprecated.
- setId(String) - Method in class org.craftercms.commons.plugin.model.Plugin
- setInjectValueFactory(InjectValueFactory) - Method in class org.craftercms.commons.jackson.mvc.CrafterJackson2MessageConverter
- setInstallation(List<Installation>) - Method in class org.craftercms.commons.plugin.model.Plugin
- setIterations(int) - Method in class org.craftercms.commons.crypto.SimpleDigest
- setIv(byte[]) - Method in class org.craftercms.commons.crypto.SimpleCipher
- setJongo(Jongo) - Method in class org.craftercms.commons.mongo.AbstractJongoRepository
- setJsonPrefix(String) - Method in class org.craftercms.commons.jackson.mvc.CrafterJackson2MessageConverter
- setKey(byte[]) - Method in class org.craftercms.commons.crypto.SimpleAesCipher
-
Deprecated.
- setKey(Key) - Method in class org.craftercms.commons.crypto.SimpleCipher
- setLabel(String) - Method in class org.craftercms.commons.plugin.model.Parameter
- setLicense(BlueprintDescriptor.License) - Method in class org.craftercms.commons.plugin.model.BlueprintDescriptor.Blueprint
-
Deprecated.
- setLicense(Link) - Method in class org.craftercms.commons.plugin.model.Plugin
- setLocationHeader(HttpHeaders, String, Object...) - Static method in class org.craftercms.commons.rest.RestServiceUtils
- setMajor(int) - Method in class org.craftercms.commons.plugin.model.BlueprintDescriptor.Version
-
Deprecated.
- setMajor(int) - Method in class org.craftercms.commons.plugin.model.Version
- setMaxAge(Integer) - Method in class org.craftercms.commons.http.CookieManager
- setMaxAuditAllowedDays(int) - Method in class org.craftercms.commons.audit.AuditReaper
- setMaxSize(long) - Method in class org.craftercms.commons.cache.GuavaCacheFactoryBean
- setMaxWaitTime(int) - Method in class org.craftercms.commons.mongo.MongoClientOptionsFactory
- setMd5(String) - Method in class org.craftercms.commons.mongo.FileInfo
- setMedia(BlueprintDescriptor.Media) - Method in class org.craftercms.commons.plugin.model.BlueprintDescriptor.Blueprint
-
Deprecated.
- setMedia(Media) - Method in class org.craftercms.commons.plugin.model.Plugin
- setMessage(String) - Method in class org.craftercms.commons.rest.Result
- setMessage(String) - Method in class org.craftercms.commons.validation.ValidationResult
- setMessageConverters(List<HttpMessageConverter<?>>) - Method in class org.craftercms.commons.rest.HttpMessageConvertingResponseErrorHandler
- setMethodLogger(MethodLogger) - Method in class org.craftercms.commons.logging.LoggedAspect
- setMinor(int) - Method in class org.craftercms.commons.plugin.model.BlueprintDescriptor.Version
-
Deprecated.
- setMinor(int) - Method in class org.craftercms.commons.plugin.model.Version
- setModule(Module) - Method in exception class org.craftercms.commons.entitlements.exception.UnsupportedEntitlementException
- setName(String) - Method in class org.craftercms.commons.plugin.model.BlueprintDescriptor.Blueprint
-
Deprecated.
- setName(String) - Method in class org.craftercms.commons.plugin.model.BlueprintDescriptor.Company
-
Deprecated.
- setName(String) - Method in class org.craftercms.commons.plugin.model.BlueprintDescriptor.License
-
Deprecated.
- setName(String) - Method in class org.craftercms.commons.plugin.model.BlueprintDescriptor.Person
-
Deprecated.
- setName(String) - Method in class org.craftercms.commons.plugin.model.BlueprintDescriptor.Website
-
Deprecated.
- setName(String) - Method in class org.craftercms.commons.plugin.model.Contact
- setName(String) - Method in class org.craftercms.commons.plugin.model.Installation.Attribute
- setName(String) - Method in class org.craftercms.commons.plugin.model.Installation.Element
- setName(String) - Method in class org.craftercms.commons.plugin.model.Link
- setName(String) - Method in class org.craftercms.commons.plugin.model.Parameter
- setName(String) - Method in class org.craftercms.commons.plugin.model.Plugin
- setOptions(MongoClientOptions) - Method in class org.craftercms.commons.mongo.MongoClientFactory
- setOrder(int) - Method in class org.craftercms.commons.spring.ListMergingPostProcessor
- setParameters(List<Parameter>) - Method in class org.craftercms.commons.plugin.model.Plugin
- setParentXpath(String) - Method in class org.craftercms.commons.plugin.model.Installation
- setPassword(String) - Method in class org.craftercms.commons.config.profiles.webdav.WebDavProfile
-
Sets the password used to connect to the server.
- setPassword(String) - Method in class org.craftercms.commons.mongo.JongoFactoryBean
- setPassword(String) - Method in class org.craftercms.commons.mongo.MongoClientFactory
- setPassword(String) - Method in class org.craftercms.commons.mongo.MongoScriptRunner
- setPatch(int) - Method in class org.craftercms.commons.plugin.model.BlueprintDescriptor.Version
-
Deprecated.
- setPatch(int) - Method in class org.craftercms.commons.plugin.model.Version
- setPath(String) - Method in class org.craftercms.commons.http.CookieManager
- setPathStyleAccessEnabled(boolean) - Method in class org.craftercms.commons.config.profiles.aws.S3Profile
- setPattern(String) - Method in class org.craftercms.commons.file.blob.impl.AbstractBlobStore
- setPayload(Object) - Method in class org.craftercms.commons.audit.AuditModel
-
Sets payload of the audit.
- setPeople(List<BlueprintDescriptor.PersonWrapper>) - Method in class org.craftercms.commons.plugin.model.BlueprintDescriptor.Developer
-
Deprecated.
- setPeople(List<Contact>) - Method in class org.craftercms.commons.plugin.model.Developer
- setPermissions(List<P>) - Method in class org.craftercms.commons.security.permissions.ProtectedResourceBase
- setPerson(BlueprintDescriptor.Person) - Method in class org.craftercms.commons.plugin.model.BlueprintDescriptor.PersonWrapper
-
Deprecated.
- setPipelinePrefix(String) - Method in class org.craftercms.commons.upgrade.impl.pipeline.DefaultUpgradePipelineFactoryImpl
- setPlugin(Plugin) - Method in class org.craftercms.commons.plugin.model.PluginDescriptor
- setPreemptiveAuth(boolean) - Method in class org.craftercms.commons.config.profiles.webdav.WebDavProfile
- setPrefix(String) - Method in class org.craftercms.commons.config.profiles.aws.S3Profile
- setProfileGroup(int) - Method in class org.craftercms.commons.file.stores.impl.PathPartsBasedProfileAwareRemotePathParser
- setProfileId(String) - Method in class org.craftercms.commons.config.profiles.ConfigurationProfile
- setProfileMapper(ConfigurationMapper<T>) - Method in class org.craftercms.commons.file.blob.impl.AbstractBlobStore
- setPropertyName(String) - Method in class org.craftercms.commons.spring.ListMergingPostProcessor
- setPublishingTargetResolver(PublishingTargetResolver) - Method in class org.craftercms.commons.file.blob.impl.AbstractBlobStore
- setQueries(JongoQueries) - Method in class org.craftercms.commons.mongo.AbstractJongoRepository
- setReadPreference(int) - Method in class org.craftercms.commons.mongo.MongoClientOptionsFactory
- setRecordStats(boolean) - Method in class org.craftercms.commons.cache.GuavaCacheFactoryBean
- setRegion(String) - Method in class org.craftercms.commons.config.profiles.aws.AbstractAwsProfile
- setRequest(HttpServletRequest) - Method in class org.craftercms.commons.http.RequestContext
-
Returns the current request.
- setRequired(boolean) - Method in class org.craftercms.commons.plugin.model.Parameter
- setResources(List<Resource>) - Method in class org.craftercms.commons.properties.OverrideProperties
- setResponse(HttpServletResponse) - Method in class org.craftercms.commons.http.RequestContext
-
Sets the current response.
- setResponseType(Class<?>) - Method in class org.craftercms.commons.rest.HttpMessageConvertingResponseErrorHandler
- setRunOnInit(boolean) - Method in class org.craftercms.commons.mongo.MongoScriptRunner
- setSalt(byte[]) - Method in class org.craftercms.commons.crypto.SimpleDigest
- setSavedDate(Date) - Method in class org.craftercms.commons.mongo.FileInfo
- setScreenshot(BlueprintDescriptor.Screenshot) - Method in class org.craftercms.commons.plugin.model.BlueprintDescriptor.ScreenshotWrapper
-
Deprecated.
- setScreenshots(List<Asset>) - Method in class org.craftercms.commons.plugin.model.Media
- setScreenshots(List<BlueprintDescriptor.ScreenshotWrapper>) - Method in class org.craftercms.commons.plugin.model.BlueprintDescriptor.Media
-
Deprecated.
- setSearchEngine(String) - Method in class org.craftercms.commons.plugin.model.BlueprintDescriptor.Blueprint
-
Deprecated.
- setSearchEngine(String) - Method in class org.craftercms.commons.plugin.model.Plugin
- setSecretKey(String) - Method in class org.craftercms.commons.config.profiles.aws.AbstractAwsProfile
- setSecure(boolean) - Method in class org.craftercms.commons.http.CookieManager
- setSecurePropertyHandler(SecurePropertyHandler) - Method in class org.craftercms.commons.jackson.mvc.CrafterJackson2MessageConverter
- setSecurityPropertyFilter(SecurePropertyHandler) - Method in class org.craftercms.commons.jackson.mvc.CrafterJacksonAnnotationIntrospector
- setSelectorParameterName(String) - Method in class org.craftercms.commons.jackson.mvc.GDataPropertyFilter
- setSerializers(List<JsonSerializer<?>>) - Method in class org.craftercms.commons.jackson.CustomSerializationObjectMapper
- setSerializers(List<JsonSerializer<?>>) - Method in class org.craftercms.commons.mongo.JongoFactoryBean
- setServletContext(ServletContext) - Method in class org.craftercms.commons.http.RequestContext
-
Sets the current servlet context.
- setShutdownClientAfterIdleSecs(int) - Method in class org.craftercms.commons.aws.AbstractAwsClientCachingFactory
- setStoreId(String) - Method in class org.craftercms.commons.file.blob.Blob
- setStoreName(String) - Method in class org.craftercms.commons.mongo.FileInfo
- setStoreTypeGroup(int) - Method in class org.craftercms.commons.file.stores.impl.PathPartsBasedProfileAwareRemotePathParser
- setTags(String) - Method in class org.craftercms.commons.plugin.model.BlueprintDescriptor.Blueprint
-
Deprecated.
- setTags(List<String>) - Method in class org.craftercms.commons.plugin.model.Plugin
- setTemplateEncoding(String) - Method in class org.craftercms.commons.mail.impl.EmailFactoryImpl
- setTemplatePrefix(String) - Method in class org.craftercms.commons.mail.impl.EmailFactoryImpl
- setTemplateSuffix(String) - Method in class org.craftercms.commons.mail.impl.EmailFactoryImpl
- setTimeToIdle(long) - Method in class org.craftercms.commons.cache.GuavaCacheFactoryBean
- setTimeToLive(long) - Method in class org.craftercms.commons.cache.GuavaCacheFactoryBean
- setTimeZone(String) - Method in class org.craftercms.commons.converters.impl.StringToDateConverter
- setTitle(String) - Method in class org.craftercms.commons.plugin.model.Asset
- setTitle(String) - Method in class org.craftercms.commons.plugin.model.BlueprintDescriptor.Screenshot
-
Deprecated.
- setTitle(String) - Method in class org.craftercms.commons.plugin.model.BlueprintDescriptor.Video
-
Deprecated.
- setType(String) - Method in class org.craftercms.commons.plugin.model.Installation
- setType(String) - Method in class org.craftercms.commons.plugin.model.Plugin
- setType(EntitlementType) - Method in class org.craftercms.commons.entitlements.model.Entitlement
- setType(Parameter.Type) - Method in class org.craftercms.commons.plugin.model.Parameter
- setUpdateVersion(boolean) - Method in class org.craftercms.commons.upgrade.impl.pipeline.DefaultUpgradePipelineFactoryImpl
- setUrl(String) - Method in class org.craftercms.commons.plugin.model.Asset
- setUrl(String) - Method in class org.craftercms.commons.plugin.model.BlueprintDescriptor.Company
-
Deprecated.
- setUrl(String) - Method in class org.craftercms.commons.plugin.model.BlueprintDescriptor.License
-
Deprecated.
- setUrl(String) - Method in class org.craftercms.commons.plugin.model.BlueprintDescriptor.Person
-
Deprecated.
- setUrl(String) - Method in class org.craftercms.commons.plugin.model.BlueprintDescriptor.Screenshot
-
Deprecated.
- setUrl(String) - Method in class org.craftercms.commons.plugin.model.BlueprintDescriptor.Video
-
Deprecated.
- setUrl(String) - Method in class org.craftercms.commons.plugin.model.BlueprintDescriptor.Website
-
Deprecated.
- setUrl(String) - Method in class org.craftercms.commons.plugin.model.Contact
- setUrl(String) - Method in class org.craftercms.commons.plugin.model.Link
- setUsername(String) - Method in class org.craftercms.commons.config.profiles.webdav.WebDavProfile
-
Sets the username used to connect to the server.
- setUsername(String) - Method in class org.craftercms.commons.mongo.JongoFactoryBean
- setUsername(String) - Method in class org.craftercms.commons.mongo.MongoClientFactory
- setUsername(String) - Method in class org.craftercms.commons.mongo.MongoScriptRunner
- SetUtils - Class in org.craftercms.commons.collections
-
Utilities for the
Set
collection. - setValue(int) - Method in class org.craftercms.commons.entitlements.model.Entitlement
- setValue(String) - Method in class org.craftercms.commons.plugin.model.Installation.Attribute
- setValue(String) - Method in class org.craftercms.commons.plugin.model.Installation.Element
- setValues - Variable in class org.craftercms.commons.mongo.UpdateHelper
- setVersion(String) - Method in class org.craftercms.commons.plugin.model.BlueprintDescriptor.CraftercmsVersionSupported
-
Deprecated.
- setVersion(BlueprintDescriptor.Version) - Method in class org.craftercms.commons.plugin.model.BlueprintDescriptor.Blueprint
-
Deprecated.
- setVersion(Version) - Method in class org.craftercms.commons.plugin.model.Plugin
- setVersion(UpgradeContext<T>, String) - Method in class org.craftercms.commons.upgrade.impl.providers.AbstractVersionProvider
- setVersion(UpgradeContext<T>, String) - Method in interface org.craftercms.commons.upgrade.VersionProvider
-
Updates the current version
- setVideo(BlueprintDescriptor.Video) - Method in class org.craftercms.commons.plugin.model.BlueprintDescriptor.VideoWrapper
-
Deprecated.
- setVideos(List<Asset>) - Method in class org.craftercms.commons.plugin.model.Media
- setVideos(List<BlueprintDescriptor.VideoWrapper>) - Method in class org.craftercms.commons.plugin.model.BlueprintDescriptor.Media
-
Deprecated.
- setWebsite(BlueprintDescriptor.Website) - Method in class org.craftercms.commons.plugin.model.BlueprintDescriptor.Blueprint
-
Deprecated.
- setWebsite(Link) - Method in class org.craftercms.commons.plugin.model.Plugin
- setWriteConcern(String) - Method in class org.craftercms.commons.mongo.MongoClientOptionsFactory
- shouldNotFilter(HttpServletRequest) - Method in class org.craftercms.commons.web.CloudfrontForwardedHeaderFilter
- shouldNotFilter(HttpServletRequest) - Method in class org.craftercms.commons.web.ForwardedHeaderFilter
- shutdownClient(RemovalNotification<P, C>) - Method in class org.craftercms.commons.aws.AbstractAwsClientCachingFactory
- SimpleAesCipher - Class in org.craftercms.commons.crypto
-
Deprecated.
- SimpleAesCipher(String) - Constructor for class org.craftercms.commons.crypto.SimpleAesCipher
-
Deprecated.
- SimpleCipher - Class in org.craftercms.commons.crypto
-
Utility class for simplifying encryption/decryption with the
Cipher
class. - SimpleCipher() - Constructor for class org.craftercms.commons.crypto.SimpleCipher
- SimpleDigest - Class in org.craftercms.commons.crypto
-
Utility class for simplifying message digest generation, using the
MessageDigest
. - SimpleDigest() - Constructor for class org.craftercms.commons.crypto.SimpleDigest
- SITE - Enum constant in enum class org.craftercms.commons.entitlements.model.EntitlementType
- SITE_ID - Enum constant in enum class org.craftercms.commons.validation.annotations.param.EsapiValidationType
- SKIP - Static variable in interface org.craftercms.commons.upgrade.VersionProvider
-
Value used when a file is missing from the repository
- SOCIAL - Enum constant in enum class org.craftercms.commons.entitlements.model.Module
- SortField - Class in org.craftercms.commons.rest.parameters
-
Represents a sort field-order pair.
- SortField(String) - Constructor for class org.craftercms.commons.rest.parameters.SortField
- SortField(String, SortField.Order) - Constructor for class org.craftercms.commons.rest.parameters.SortField
- SortField.Order - Enum Class in org.craftercms.commons.rest.parameters
- SortFieldValidator - Class in org.craftercms.commons.validation.validators.impl
-
Validates a
SortField
object. - SortFieldValidator() - Constructor for class org.craftercms.commons.validation.validators.impl.SortFieldValidator
- SPRING_PATH - Static variable in class org.craftercms.commons.monitoring.VersionInfo
-
The path for classes loaded from a Spring Boot JAR file
- SQL_ORDER_BY - Enum constant in enum class org.craftercms.commons.validation.annotations.param.EsapiValidationType
- SQL_SORT_VALIDATION_FAILED_ERROR_CODE - Static variable in class org.craftercms.commons.validation.ErrorCodes
- SqlSort - Annotation Interface in org.craftercms.commons.validation.annotations.param
-
Elements annotated with
SqlSort
will be validated bySqlSortValidator
. - SqlSortValidator - Class in org.craftercms.commons.validation.validators.impl
-
Validates that a String is a list of "column order(optional)" pairs, where column is one of the allowed values in columns parameter.
- SqlSortValidator() - Constructor for class org.craftercms.commons.validation.validators.impl.SqlSortValidator
- SqlSortValidator(List<String>) - Constructor for class org.craftercms.commons.validation.validators.impl.SqlSortValidator
- sshConfig - Variable in class org.craftercms.commons.git.auth.AbstractSshAuthConfigurator
- sshConfig - Variable in class org.craftercms.commons.git.jgit.SshSessionFactory
-
The folder for the SSH configuration
- sshConfig - Variable in class org.craftercms.commons.git.utils.AbstractAuthConfiguratorBuilder
- sshConfig - Variable in class org.craftercms.commons.git.utils.AuthConfiguratorFactory
- SshPasswordAuthConfigurator - Class in org.craftercms.commons.git.auth
-
GitAuthenticationConfigurator
that configures theTransportCommand
to use SSH with username/password authentication. - SshPasswordAuthConfigurator(File, String) - Constructor for class org.craftercms.commons.git.auth.SshPasswordAuthConfigurator
- SshPrivateKeyAuthConfigurator - Class in org.craftercms.commons.git.auth
-
GitAuthenticationConfigurator
that configures theTransportCommand
to use SSH with private key authentication. - SshPrivateKeyAuthConfigurator(File, String, String) - Constructor for class org.craftercms.commons.git.auth.SshPrivateKeyAuthConfigurator
- SshPrivateKeySessionFactory - Class in org.craftercms.commons.git.jgit
-
Extension of
SshSessionFactory
to use a given private key for SSH authentication - SshPrivateKeySessionFactory(File, Path) - Constructor for class org.craftercms.commons.git.jgit.SshPrivateKeySessionFactory
- SshSessionFactory - Class in org.craftercms.commons.git.jgit
-
Extension of
SshdSessionFactory
that overrides the default SSH configuration - SshSessionFactory(File) - Constructor for class org.craftercms.commons.git.jgit.SshSessionFactory
- SshUsernamePasswordCredentialsProvider - Class in org.craftercms.commons.git.jgit
-
Extension of
UsernamePasswordCredentialsProvider
to use in SSH authentication - SshUsernamePasswordCredentialsProvider(String, String) - Constructor for class org.craftercms.commons.git.jgit.SshUsernamePasswordCredentialsProvider
- STAGING - Static variable in interface org.craftercms.commons.config.PublishingTargetResolver
- STANDARD_PROTO_HEADER_NAME - Static variable in class org.craftercms.commons.web.CloudfrontForwardedHeaderFilter
- startup - Variable in class org.craftercms.commons.monitoring.StatusInfo
- STATUS_URL - Static variable in class org.craftercms.commons.monitoring.rest.MonitoringRestControllerBase
- StatusInfo - Class in org.craftercms.commons.monitoring
-
Gets current basic JVM status
- StatusInfo() - Constructor for class org.craftercms.commons.monitoring.StatusInfo
-
Create the StatusInfo with current information.
- store(Connection) - Method in interface org.craftercms.commons.entitlements.validator.DbIntegrityValidator
-
Generates the validator value for a new database.
- store(Connection) - Method in class org.craftercms.commons.entitlements.validator.impl.DefaultDbIntegrityValidatorImpl
-
Generates the validator value for a new database.
- storeId - Variable in class org.craftercms.commons.file.blob.Blob
-
The id of the blob store
- storeKeyStore() - Method in class org.craftercms.commons.crypto.impl.SecretKeyRepositoryImpl
- stores - Variable in class org.craftercms.commons.file.stores.impl.RemoteFileResolverImpl
- STRING - Enum constant in enum class org.craftercms.commons.plugin.model.Parameter.Type
- STRING_MAX_LENGTH_ERROR_CODE - Static variable in class org.craftercms.commons.validation.ErrorCodes
- STRING_MIN_LENGTH_ERROR_CODE - Static variable in class org.craftercms.commons.validation.ErrorCodes
- STRING_NOT_BLANK_ERROR_CODE - Static variable in class org.craftercms.commons.validation.ErrorCodes
- STRING_NOT_EMPTY_ERROR_CODE - Static variable in class org.craftercms.commons.validation.ErrorCodes
- STRING_REGEX_VALIDATION_FAILED_ERROR_CODE - Static variable in class org.craftercms.commons.validation.ErrorCodes
- StringToBooleanConverter - Class in org.craftercms.commons.converters.impl
-
Converts String to Boolean.
- StringToBooleanConverter() - Constructor for class org.craftercms.commons.converters.impl.StringToBooleanConverter
- StringToDateConverter - Class in org.craftercms.commons.converters.impl
-
Converts String to Date, with a custom pattern and time zone.
- StringToDateConverter(String) - Constructor for class org.craftercms.commons.converters.impl.StringToDateConverter
- StringToDoubleConverter - Class in org.craftercms.commons.converters.impl
-
Converts String to Double.
- StringToDoubleConverter() - Constructor for class org.craftercms.commons.converters.impl.StringToDoubleConverter
- StringToFloatConverter - Class in org.craftercms.commons.converters.impl
-
Converts String to Float.
- StringToFloatConverter() - Constructor for class org.craftercms.commons.converters.impl.StringToFloatConverter
- StringToIntegerConverter - Class in org.craftercms.commons.converters.impl
-
Converts String to Integer.
- StringToIntegerConverter() - Constructor for class org.craftercms.commons.converters.impl.StringToIntegerConverter
- StringToLongConverter - Class in org.craftercms.commons.converters.impl
-
Converts String to Long.
- StringToLongConverter() - Constructor for class org.craftercms.commons.converters.impl.StringToLongConverter
- StringToShortConverter - Class in org.craftercms.commons.converters.impl
-
Converts String to Short.
- StringToShortConverter() - Constructor for class org.craftercms.commons.converters.impl.StringToShortConverter
- StringToStringConverter - Class in org.craftercms.commons.converters.impl
-
Simple dummy converter that just returns a String value.
- StringToStringConverter() - Constructor for class org.craftercms.commons.converters.impl.StringToStringConverter
- StringValidator - Class in org.craftercms.commons.validation.validators.impl
- StringValidator() - Constructor for class org.craftercms.commons.validation.validators.impl.StringValidator
- StringValidator(List<String>, List<String>, boolean) - Constructor for class org.craftercms.commons.validation.validators.impl.StringValidator
- STUDIO - Enum constant in enum class org.craftercms.commons.entitlements.model.Module
- SubjectNotFoundException - Exception Class in org.craftercms.commons.security.exception
-
Thrown to indicate that the current subject couldn't be found.
- SubjectNotFoundException() - Constructor for exception class org.craftercms.commons.security.exception.SubjectNotFoundException
- subjectResolver - Variable in class org.craftercms.commons.security.permissions.impl.PermissionEvaluatorImpl
- SubjectResolver<S> - Interface in org.craftercms.commons.security.permissions
-
Resolves the current subject to be used for permission checking.
- superClassCache - Variable in class org.craftercms.commons.jackson.mvc.GDataPropertyFilter
- supports(Class<?>) - Method in class org.craftercms.commons.validation.validators.impl.AbstractStringValidator
- supports(Class<?>) - Method in class org.craftercms.commons.validation.validators.impl.EsapiValidator
- supports(Class<?>) - Method in class org.craftercms.commons.validation.validators.impl.SortFieldValidator
- supports(Class<?>) - Method in class org.craftercms.commons.validation.validators.impl.SqlSortValidator
- suppressProperty(Object, String[]) - Method in interface org.craftercms.commons.jackson.mvc.SecurePropertyHandler
-
Checks if the property is allowed for the given role.
- suspendEncoding() - Method in class org.craftercms.commons.crypto.Base64.OutputStream
-
Deprecated.Suspends encoding of the stream.
T
- tags - Variable in class org.craftercms.commons.plugin.model.Plugin
-
The tags of the plugin
- target - Variable in class org.craftercms.commons.config.FixedPublishingTargetResolver
-
The target to use
- target - Variable in class org.craftercms.commons.file.blob.impl.AbstractBlobStore.Mapping
-
The target in the store
- target - Variable in class org.craftercms.commons.upgrade.impl.UpgradeContext
-
The target of the upgrade.
- templateEncoding - Variable in class org.craftercms.commons.mail.impl.EmailFactoryImpl
- templatePrefix - Variable in class org.craftercms.commons.mail.impl.EmailFactoryImpl
- templateSuffix - Variable in class org.craftercms.commons.mail.impl.EmailFactoryImpl
- textEncryptor - Variable in class org.craftercms.commons.config.EncryptionAwareConfigurationReader
- TextEncryptor - Interface in org.craftercms.commons.crypto
-
Thread-safe service that facilitates easy encryption and decryption of text.
- timeZone - Variable in class org.craftercms.commons.converters.impl.StringToDateConverter
- title - Variable in class org.craftercms.commons.plugin.model.Asset
-
The title of the asset
- TOKEN - Static variable in interface org.craftercms.commons.git.utils.AuthenticationType
- toList(Iterable<T>) - Static method in class org.craftercms.commons.collections.IterableUtils
-
Creates a new list from the iterable elements.
- toResource() - Method in class org.craftercms.commons.file.stores.impl.ResourceBasedRemoteFile
- toResource() - Method in interface org.craftercms.commons.file.stores.RemoteFile
-
Returns the remote file as a Spring
Resource
. - toString() - Method in class org.craftercms.commons.config.profiles.aws.S3Profile
- toString() - Method in class org.craftercms.commons.entitlements.model.Entitlement
- toString() - Method in class org.craftercms.commons.mongo.FileInfo
- toString() - Method in class org.craftercms.commons.monitoring.MemoryInfo
- toString() - Method in class org.craftercms.commons.monitoring.StatusInfo
- toString() - Method in class org.craftercms.commons.monitoring.VersionInfo
- toString() - Method in class org.craftercms.commons.plugin.model.Asset
- toString() - Method in class org.craftercms.commons.plugin.model.Contact
- toString() - Method in class org.craftercms.commons.plugin.model.Developer
- toString() - Method in class org.craftercms.commons.plugin.model.Link
- toString() - Method in class org.craftercms.commons.plugin.model.Media
- toString() - Method in class org.craftercms.commons.plugin.model.Parameter
- toString() - Method in class org.craftercms.commons.plugin.model.Plugin
- toString() - Method in class org.craftercms.commons.plugin.model.PluginDescriptor
- toString() - Method in class org.craftercms.commons.plugin.model.Version
- toString() - Method in class org.craftercms.commons.rest.Result
- toString() - Method in class org.craftercms.commons.security.permissions.DefaultPermission
- toString() - Method in class org.craftercms.commons.spring.resources.S3Resource
- toString() - Method in class org.craftercms.commons.upgrade.impl.UpgradeContext
- toString(Locale) - Static method in class org.craftercms.commons.locale.LocaleUtils
- trace(String, Object...) - Method in class org.craftercms.commons.i10n.I10nLogger
- trace(String, Throwable, Object...) - Method in class org.craftercms.commons.i10n.I10nLogger
- type - Variable in class org.craftercms.commons.entitlements.model.Entitlement
- type - Variable in class org.craftercms.commons.plugin.model.Installation
-
The type of the widget to install
- type - Variable in class org.craftercms.commons.plugin.model.Parameter
-
The type of the parameter
- type - Variable in class org.craftercms.commons.plugin.model.Plugin
-
The type of plugin
- type() - Element in annotation interface org.craftercms.commons.security.permissions.annotations.HasPermission
-
The permission type, which indicates the
PermissionEvaluator
to use for permission evaluation. - type() - Element in annotation interface org.craftercms.commons.validation.annotations.param.EsapiValidatedParam
- TypeBasedAuthConfiguratorBuilder - Class in org.craftercms.commons.git.utils
-
Implementation of
AbstractAuthConfiguratorBuilder
that createsGitAuthenticationConfigurator
objects based on a given authentication type. - TypeBasedAuthConfiguratorBuilder(File, String) - Constructor for class org.craftercms.commons.git.utils.TypeBasedAuthConfiguratorBuilder
- typeKey - Variable in enum class org.craftercms.commons.validation.annotations.param.EsapiValidationType
U
- unlock(String) - Static method in class org.craftercms.commons.git.utils.GitUtils
-
Unlock a git repository by deleting the `.lock` file
- unset(String) - Method in class org.craftercms.commons.mongo.UpdateHelper
- unsetValues - Variable in class org.craftercms.commons.mongo.UpdateHelper
- UnsupportedEntitlementException - Exception Class in org.craftercms.commons.entitlements.exception
-
Exception thrown when an invalid module or entitlement is requested during a validation.
- UnsupportedEntitlementException(Module, EntitlementType) - Constructor for exception class org.craftercms.commons.entitlements.exception.UnsupportedEntitlementException
- unZipFiles(File, File) - Static method in class org.craftercms.commons.zip.ZipUtils
-
Unzips a zip file into an output folder.
- unZipFiles(InputStream, File) - Static method in class org.craftercms.commons.zip.ZipUtils
-
Unzips a zip from an input stream into an output folder.
- update(String, Object) - Method in class org.craftercms.commons.mongo.AbstractJongoRepository
- update(String, Object) - Method in interface org.craftercms.commons.mongo.CrudRepository
-
Updates the object with the given id with the given Object information.
- update(String, Object, boolean, boolean) - Method in class org.craftercms.commons.mongo.AbstractJongoRepository
- update(String, Object, boolean, boolean) - Method in interface org.craftercms.commons.mongo.CrudRepository
-
Updates the object with the given id with the given Object information.
- update(String, String, boolean, boolean) - Method in class org.craftercms.commons.mongo.AbstractJongoRepository
- update(String, String, boolean, boolean) - Method in interface org.craftercms.commons.mongo.CrudRepository
-
Updates the given
- update(String, String, boolean, boolean, Object...) - Method in class org.craftercms.commons.mongo.AbstractJongoRepository
- update(String, String, boolean, boolean, Object...) - Method in interface org.craftercms.commons.mongo.CrudRepository
-
Updates the given
- updateFile(InputStream, String, String) - Method in class org.craftercms.commons.mongo.AbstractJongoRepository
- updateFile(InputStream, String, String) - Method in interface org.craftercms.commons.mongo.CrudRepository
-
"Updates" the file with the new information (A name change is NOT valid )
- updateFile(ObjectId, InputStream, String, String) - Method in class org.craftercms.commons.mongo.AbstractJongoRepository
- updateFile(ObjectId, InputStream, String, String) - Method in interface org.craftercms.commons.mongo.CrudRepository
-
"Updates" the file with the new information (A name change is valid as long a file with new name does not exists)
- updateFile(ObjectId, InputStream, String, String, boolean) - Method in class org.craftercms.commons.mongo.AbstractJongoRepository
- updateFile(ObjectId, InputStream, String, String, boolean) - Method in interface org.craftercms.commons.mongo.CrudRepository
-
"Updates" the file with the new information (A name change is valid as long a file with new name does not exists)
- UpdateHelper - Class in org.craftercms.commons.mongo
-
Created by alfonsovasquez on 13/6/16.
- UpdateHelper() - Constructor for class org.craftercms.commons.mongo.UpdateHelper
- updateVersion - Variable in class org.craftercms.commons.upgrade.impl.pipeline.DefaultUpgradePipelineFactoryImpl
-
Indicates if the version of the target should be updated after the pipeline is executed, default to
true
- UpdateVersionUpgradeOperation<T> - Class in org.craftercms.commons.upgrade.impl.operations
-
Implementation of
UpgradeOperation
that updates the current version for the given target - UpdateVersionUpgradeOperation(VersionProvider<T>) - Constructor for class org.craftercms.commons.upgrade.impl.operations.UpdateVersionUpgradeOperation
- upgrade() - Method in class org.craftercms.commons.upgrade.impl.AbstractUpgradeManager
- upgrade() - Method in interface org.craftercms.commons.upgrade.UpgradeManager
-
Executes all required upgrades for the system
- upgrade(T) - Method in class org.craftercms.commons.upgrade.impl.AbstractUpgradeManager
- upgrade(T) - Method in interface org.craftercms.commons.upgrade.UpgradeManager
-
Executes all required upgrades for the given target
- UpgradeConfigurationProvider<T> - Interface in org.craftercms.commons.upgrade
-
Provides the configuration for an upgrade process
- UpgradeContext<T> - Class in org.craftercms.commons.upgrade.impl
-
Holds all data related to a given upgrade process.
- UpgradeContext(T) - Constructor for class org.craftercms.commons.upgrade.impl.UpgradeContext
- UpgradeException - Exception Class in org.craftercms.commons.upgrade.exception
-
Base class for all exceptions related to the upgrade process.
- UpgradeException(String) - Constructor for exception class org.craftercms.commons.upgrade.exception.UpgradeException
- UpgradeException(String, Throwable) - Constructor for exception class org.craftercms.commons.upgrade.exception.UpgradeException
- UpgradeException(Throwable) - Constructor for exception class org.craftercms.commons.upgrade.exception.UpgradeException
- UpgradeManager<T> - Interface in org.craftercms.commons.upgrade
-
Manages the current version and applies the required upgrades
- UpgradeNotSupportedException - Exception Class in org.craftercms.commons.upgrade.exception
-
Extension of
UpgradeException
thrown when the current version of a target can't be upgraded automatically. - UpgradeNotSupportedException(String) - Constructor for exception class org.craftercms.commons.upgrade.exception.UpgradeNotSupportedException
- UpgradeNotSupportedException(String, Exception) - Constructor for exception class org.craftercms.commons.upgrade.exception.UpgradeNotSupportedException
- UpgradeOperation<T> - Interface in org.craftercms.commons.upgrade
-
Defines the basic operations for a single upgrade
- UpgradePipeline<T> - Interface in org.craftercms.commons.upgrade
-
Groups any number of
UpgradeOperation
instances - UpgradePipelineFactory<T> - Interface in org.craftercms.commons.upgrade
-
Builds an
UpgradePipeline
with all the required operations - uptime - Variable in class org.craftercms.commons.monitoring.StatusInfo
- uri - Variable in class org.craftercms.commons.mongo.MongoClientFromUriFactoryBean
- url - Variable in class org.craftercms.commons.git.utils.UrlBasedAuthConfiguratorBuilder
-
The Git URL
- url - Variable in class org.craftercms.commons.plugin.model.Link
-
The URL of the link
- URL_SAFE - Static variable in class org.craftercms.commons.crypto.Base64
-
Deprecated.Encode using Base64-like encoding that is URL- and Filename-safe as described in Section 4 of RFC3548: http://www.faqs.org/rfcs/rfc3548.html.
- UrlBasedAuthConfiguratorBuilder - Class in org.craftercms.commons.git.utils
-
Implementation of
AbstractAuthConfiguratorBuilder
that createsGitAuthenticationConfigurator
objects based on the scheme of a given URL - UrlBasedAuthConfiguratorBuilder(File, String) - Constructor for class org.craftercms.commons.git.utils.UrlBasedAuthConfiguratorBuilder
- UrlBasedFileStore - Class in org.craftercms.commons.file.stores.impl
-
Simple
RemoteFileStore
where the paths are basically URLs from where the files can be accessed. - UrlBasedFileStore() - Constructor for class org.craftercms.commons.file.stores.impl.UrlBasedFileStore
- UrlUtils - Class in org.craftercms.commons.lang
-
Utility methods for paths and URLs.
- useProperty() - Element in annotation interface org.craftercms.commons.jackson.mvc.annotations.InjectValue
- USER - Enum constant in enum class org.craftercms.commons.entitlements.model.EntitlementType
- username - Variable in class org.craftercms.commons.config.profiles.webdav.WebDavProfile
- username - Variable in class org.craftercms.commons.git.utils.AbstractAuthConfiguratorBuilder
- USERNAME - Enum constant in enum class org.craftercms.commons.validation.annotations.param.EsapiValidationType
V
- validate(Object, Errors) - Method in class org.craftercms.commons.validation.validators.impl.AbstractStringValidator
- validate(Object, Errors) - Method in class org.craftercms.commons.validation.validators.impl.EsapiValidator
- validate(Object, Errors) - Method in class org.craftercms.commons.validation.validators.impl.SortFieldValidator
- validate(Object, Errors) - Method in class org.craftercms.commons.validation.validators.impl.SqlSortValidator
- validate(Connection) - Method in interface org.craftercms.commons.entitlements.validator.DbIntegrityValidator
-
Checks the validation value for an existing database.
- validate(Connection) - Method in class org.craftercms.commons.entitlements.validator.impl.DefaultDbIntegrityValidatorImpl
-
Checks the validation value for an existing database.
- validateEmail(String) - Static method in class org.craftercms.commons.mail.EmailUtils
- validateEntitlement(EntitlementType, int) - Method in interface org.craftercms.commons.entitlements.validator.EntitlementValidator
-
Checks that an entitlement is below the value indicated in the configuration file.
- ValidateNoTagsParam - Annotation Interface in org.craftercms.commons.validation.annotations.param
- validateObject(String) - Method in class org.craftercms.commons.mongo.AbstractJongoRepository
- validateObject(ObjectId) - Method in class org.craftercms.commons.mongo.AbstractJongoRepository
- ValidateSecurePathParam - Annotation Interface in org.craftercms.commons.validation.annotations.param
- validateString(String, List<String>, List<String>, boolean) - Static method in class org.craftercms.commons.validation.ValidationUtils
-
Convenience method to validate a String against a list of blacklist regexes and a list of whitelist regexes
- ValidateStringParam - Annotation Interface in org.craftercms.commons.validation.annotations.param
- validateToken(String) - Method in class org.craftercms.commons.monitoring.rest.MonitoringRestControllerBase
- validateValue(Validator, Object, String) - Static method in class org.craftercms.commons.validation.ValidationUtils
-
Invokes a
Validator
for a given value and return the list or errors - ValidationAwareRestExceptionHandlers - Class in org.craftercms.commons.validation.rest
- ValidationAwareRestExceptionHandlers() - Constructor for class org.craftercms.commons.validation.rest.ValidationAwareRestExceptionHandlers
- ValidationError - Class in org.craftercms.commons.validation
- ValidationError(String, String) - Constructor for class org.craftercms.commons.validation.ValidationError
- ValidationException - Exception Class in org.craftercms.commons.validation
-
Exception thrown when validation fails.
- ValidationException(String) - Constructor for exception class org.craftercms.commons.validation.ValidationException
- ValidationException(ValidationResult) - Constructor for exception class org.craftercms.commons.validation.ValidationException
- ValidationResult - Class in org.craftercms.commons.validation
- ValidationResult() - Constructor for class org.craftercms.commons.validation.ValidationResult
- ValidationResult(String) - Constructor for class org.craftercms.commons.validation.ValidationResult
- ValidationResult(String, ResourceBundle) - Constructor for class org.craftercms.commons.validation.ValidationResult
- ValidationResult(ResourceBundle) - Constructor for class org.craftercms.commons.validation.ValidationResult
- ValidationResultAware - Interface in org.craftercms.commons.validation
-
Basic interface for exceptions that contain a
ValidationResult
- ValidationRuntimeException - Exception Class in org.craftercms.commons.validation
-
Runtime exception thrown when validation fails.
- ValidationRuntimeException(String) - Constructor for exception class org.craftercms.commons.validation.ValidationRuntimeException
- ValidationRuntimeException(ValidationResult) - Constructor for exception class org.craftercms.commons.validation.ValidationRuntimeException
- ValidationUtils - Class in org.craftercms.commons.validation
- ValidConfigurationPath - Annotation Interface in org.craftercms.commons.validation.annotations.param
- ValidExistingContentPath - Annotation Interface in org.craftercms.commons.validation.annotations.param
- ValidNewContentPath - Annotation Interface in org.craftercms.commons.validation.annotations.param
- ValidSiteId - Annotation Interface in org.craftercms.commons.validation.annotations.param
- ValidUsername - Annotation Interface in org.craftercms.commons.validation.annotations.param
- value - Variable in class org.craftercms.commons.entitlements.model.Entitlement
- value - Variable in class org.craftercms.commons.plugin.model.Installation.Attribute
- value - Variable in class org.craftercms.commons.plugin.model.Installation.Element
- value() - Element in annotation interface org.craftercms.commons.security.permissions.annotations.ProtectedResourceId
-
The name of the ID, e.g. site, path, etc.
- valueOf(String) - Static method in enum class org.craftercms.commons.entitlements.model.EntitlementType
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class org.craftercms.commons.entitlements.model.Module
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class org.craftercms.commons.plugin.model.Parameter.Type
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class org.craftercms.commons.rest.parameters.SortField.Order
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class org.craftercms.commons.validation.annotations.param.EsapiValidationType
-
Returns the enum constant of this class with the specified name.
- values() - Static method in enum class org.craftercms.commons.entitlements.model.EntitlementType
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class org.craftercms.commons.entitlements.model.Module
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class org.craftercms.commons.plugin.model.Parameter.Type
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class org.craftercms.commons.rest.parameters.SortField.Order
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class org.craftercms.commons.validation.annotations.param.EsapiValidationType
-
Returns an array containing the constants of this enum class, in the order they are declared.
- version - Variable in class org.craftercms.commons.plugin.model.Plugin
-
The version of the plugin
- Version - Class in org.craftercms.commons.plugin.model
-
Holds the data about a version
- Version() - Constructor for class org.craftercms.commons.plugin.model.BlueprintDescriptor.Version
-
Deprecated.
- Version() - Constructor for class org.craftercms.commons.plugin.model.Version
- VERSION - Static variable in interface org.craftercms.commons.upgrade.VersionProvider
-
Keyword used to retrieve the version
- VERSION_URL - Static variable in class org.craftercms.commons.monitoring.rest.MonitoringRestControllerBase
- VersionInfo - Class in org.craftercms.commons.monitoring
-
Get's current version information about: 1.
- versionProvider - Variable in class org.craftercms.commons.upgrade.impl.operations.UpdateVersionUpgradeOperation
-
The version provider
- versionProvider - Variable in class org.craftercms.commons.upgrade.impl.pipeline.DefaultUpgradePipelineFactoryImpl
-
The version provider
- VersionProvider<T> - Interface in org.craftercms.commons.upgrade
-
Provides the current version of a specific target
- Video() - Constructor for class org.craftercms.commons.plugin.model.BlueprintDescriptor.Video
-
Deprecated.
- videos - Variable in class org.craftercms.commons.plugin.model.Media
- VideoWrapper() - Constructor for class org.craftercms.commons.plugin.model.BlueprintDescriptor.VideoWrapper
-
Deprecated.
W
- WAR_PATH - Static variable in class org.craftercms.commons.monitoring.VersionInfo
-
The path for classes loaded from a WAR file
- warn(String, Object...) - Method in class org.craftercms.commons.i10n.I10nLogger
- warn(String, Throwable, Object...) - Method in class org.craftercms.commons.i10n.I10nLogger
- WeakKeyBasedReentrantLockFactory - Class in org.craftercms.commons.concurrent.locks
-
Actual implementation of
AbstractWeakKeyBasedLockFactory
that usesReentrantLock
s. - WeakKeyBasedReentrantLockFactory() - Constructor for class org.craftercms.commons.concurrent.locks.WeakKeyBasedReentrantLockFactory
- WebDavFileStore - Class in org.craftercms.commons.file.stores.impl.webdav
-
Implementation of
RemoteFileStore
for WebDAV - WebDavFileStore(ConfigurationProfileLoader<WebDavProfile>) - Constructor for class org.craftercms.commons.file.stores.impl.webdav.WebDavFileStore
- WebDavProfile - Class in org.craftercms.commons.config.profiles.webdav
-
Holds the necessary information to connect to a WebDAV server.
- WebDavProfile() - Constructor for class org.craftercms.commons.config.profiles.webdav.WebDavProfile
- WebDavProfileMapper - Class in org.craftercms.commons.config.profiles.webdav
-
Configuration mapper for
WebDavProfile
s. - WebDavProfileMapper(ConfigurationResolver) - Constructor for class org.craftercms.commons.config.profiles.webdav.WebDavProfileMapper
- WebDavResource - Class in org.craftercms.commons.spring.resources
-
Implementation of
Resource
for WebDAV - WebDavResource(Sardine, String) - Constructor for class org.craftercms.commons.spring.resources.WebDavResource
- WebDavUtils - Class in org.craftercms.commons.file.stores
-
Utility methods for WebDAV
- WebDavUtils() - Constructor for class org.craftercms.commons.file.stores.WebDavUtils
- website - Variable in class org.craftercms.commons.plugin.model.Plugin
-
The website information of the plugin
- Website() - Constructor for class org.craftercms.commons.plugin.model.BlueprintDescriptor.Website
-
Deprecated.
- whitelistedPatterns() - Element in annotation interface org.craftercms.commons.validation.annotations.param.ValidateStringParam
- whitelistGetEnvRegex - Variable in class org.craftercms.commons.spring.groovy.SandboxInterceptorFactory
-
List of regex to allow System.getenv()
- whitelistRegexes - Variable in class org.craftercms.commons.validation.validators.impl.AbstractStringValidator
- withPassword(String) - Method in class org.craftercms.commons.git.utils.AbstractAuthConfiguratorBuilder
- withPrivateKeyPassphrase(String) - Method in class org.craftercms.commons.git.utils.AbstractAuthConfiguratorBuilder
- withPrivateKeyPath(String) - Method in class org.craftercms.commons.git.utils.AbstractAuthConfiguratorBuilder
- withUsername(String) - Method in class org.craftercms.commons.git.utils.AbstractAuthConfiguratorBuilder
- write(byte[], int, int) - Method in class org.craftercms.commons.crypto.Base64.OutputStream
-
Deprecated.Calls
Base64.OutputStream.write(int)
repeatedly until len bytes are written. - write(int) - Method in class org.craftercms.commons.crypto.Base64.OutputStream
-
Deprecated.Writes the byte to the output stream after converting to/from Base64 notation.
- write(Writer) - Method in class org.craftercms.commons.config.YamlConfiguration
- writeInternal(Object, Type, HttpOutputMessage) - Method in class org.craftercms.commons.jackson.mvc.CrafterJackson2MessageConverter
- writeVersionToFile(Path, String) - Method in class org.craftercms.commons.upgrade.impl.providers.AbstractFileVersionProvider
- writeVersionToFile(Path, String) - Method in class org.craftercms.commons.upgrade.impl.providers.YamlFileVersionProvider
- writeWithMessageConverters(T, HttpServletRequest, HttpServletResponse) - Method in class org.craftercms.commons.rest.HttpMessageConvertingResponseWriter
Y
- yaml - Variable in class org.craftercms.commons.upgrade.impl.providers.YamlFileVersionProvider
- YamlConfiguration - Class in org.craftercms.commons.config
-
Implementation of Apache Commons HierarchicalConfiguration that parses a YAML configuration file and loads the configuration in memory for easy access.
- YamlConfiguration() - Constructor for class org.craftercms.commons.config.YamlConfiguration
- YamlConfigurationProvider - Class in org.craftercms.commons.upgrade.impl.configuration
-
UpgradeConfigurationProvider
implementation that loads a YAML configuration file. - YamlConfigurationProvider(Resource) - Constructor for class org.craftercms.commons.upgrade.impl.configuration.YamlConfigurationProvider
- YamlFileVersionProvider<T> - Class in org.craftercms.commons.upgrade.impl.providers
-
Implementation of
VersionProvider
that handles YAML files - YamlFileVersionProvider() - Constructor for class org.craftercms.commons.upgrade.impl.providers.YamlFileVersionProvider
Z
- zipFiles(List<File>, File) - Static method in class org.craftercms.commons.zip.ZipUtils
-
Zips a collection of files to a destination zip file.
- zipFiles(List<File>, OutputStream) - Static method in class org.craftercms.commons.zip.ZipUtils
-
Zips a collection of files to a destination zip output stream.
- ZipUtils - Class in org.craftercms.commons.zip
-
Utility for zipping files.
- ZipUtils() - Constructor for class org.craftercms.commons.zip.ZipUtils
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form
PluginDescriptor