Uses of Annotation Interface
com.erudika.para.core.annotations.Documented
Packages that use Documented
-
Uses of Documented in com.erudika.para.core.utils
Methods in com.erudika.para.core.utils with annotations of type DocumentedModifier and TypeMethodDescriptionParaConfig.accessDeniedPath()The path to redirect to when 403 code is returned.booleanParaConfig.accessLogEnabled()Enable/disable the Para access log.ParaConfig.adminIdentifier()The identifier of the first administrator (can be email or social login ID).booleanParaConfig.allowUnverifiedEmails()Enable/disable email verification after the initial user registration.ParaConfig.amazonAppId()Amazon OAuth2 app ID.ParaConfig.amazonSecret()Amazon app secret key.booleanParaConfig.apiEnabled()Enable/disable the Para RESTful API.booleanParaConfig.appIdSpacePrefixEnabled()**For internal use only!ParaConfig.appName()Returns the name of the default application.ParaConfig.appSecretKey()Deprecated.ParaConfig.authCookieName()The name of the authorization cookie.booleanParaConfig.awsDynamoBackupsEnabled()Enable/disable point-in-time backups in DynamoDB.booleanParaConfig.awsDynamoEncryptionEnabled()Enable/disable SSE (encryption-at-rest) using own KMS, instead of AWS-owned CMK for all newly created DynamoDB tables.intParaConfig.awsDynamoMaxInitialReadCapacity()The maximum read capacity when creating a table with provisioned mode enabled.intParaConfig.awsDynamoMaxInitialWriteCapacity()The maximum write capacity when creating a table with provisioned mode enabled.booleanParaConfig.awsDynamoProvisionedBillingEnabled()Enable/disable provisioned billing as an alternative to on-demand billing in DynamoDB.ParaConfig.awsDynamoReplicaRegions()Toggles global table settings for the specified regions.ParaConfig.awsS3Bucket(String region) The S3 bucket where files will be stored by `FileStore` implementations.intParaConfig.awsS3MaxFileSizeMb()Maximum file size for files uploaded to S3, in megabytes.ParaConfig.awsSesRegion()AWS region to use in the `AWSEmailer` implementation.ParaConfig.cachePlugin()Selects the `Cache` implementation at runtime.longParaConfig.caffeineCacheSize()Maximum size for the Caffeine cache map.intParaConfig.caffeineEvictAfterMin()Cache eviction policy - objects are evicted from Caffeine cache after this time.ParaConfig.cassandraHosts()Comma-separated Cassandra server hosts (contact points).ParaConfig.cassandraKeyspace()The name of the Cassandra keyspace to use.ParaConfig.cassandraPassword()The password for the Cassandra user.intParaConfig.cassandraPort()The Cassandra server port to connect to.intParaConfig.cassandraReplicationFactor()Replication factor for the Cassandra keyspace.booleanParaConfig.cassandraSslEnabled()Enable/disable the SSL/TLS transport in Cassandra client.ParaConfig.cassandraSslKeystore()Cassandra client key store, containing the certificates to use.ParaConfig.cassandraSslKeystorePassword()Password for the Cassandra client key store.ParaConfig.cassandraSslProtocols()The protocols allowed for successful connection to Cassandra cluster.ParaConfig.cassandraTruststore()Cassandra client trust store, containing trusted certificates and CAs.ParaConfig.cassandraTruststorePassword()Password for the Cassandra trust store.ParaConfig.cassandraUser()The Cassandra username with access to the database.ParaConfig.clientSslKeystore()The SSL key store location.ParaConfig.clientSslKeystorePassword()The SSL key store password.ParaConfig.clientSslProtocols()SSL protocols allowed for a successul connection.ParaConfig.clientSslTruststore()The SSL trust store location.ParaConfig.clientSslTruststorePassword()The SSL trust store password.booleanParaConfig.clientUserAgentEnabled()Enable/disable `User-Agent` header in Para client.ParaConfig.clusterName()The name of the Para cluster.ParaConfig.corePackageName()Deprecated.booleanParaConfig.corsEnabled()Enable/disable the CORS filter.booleanParaConfig.csrfProtectionEnabled()Enable/disable CSRF protection which checks for valid CSRF tokens in write requests.booleanParaConfig.csrfProtectionWithSpaEnabled()Enable/disable CSRF protection with single-page application mode enabled.ParaConfig.daoPlugin()Selects the `DAO` implementation at runtime.booleanParaConfig.debugRequestSignaturesEnabled()Enable/disable debuging info for each AWS V4 request signature.ParaConfig.defaultEncoding()Default character encoding - `UTF-8`.ParaConfig.defaultQueueName()Returns the default queue name which will be polled for incoming JSON messages.booleanParaConfig.elasticsearchAsyncModeEnabled()Enable/disable asynchronous operations when indexing/unindexing.ParaConfig.elasticsearchAuthPassword()The password to use for authentication with ES.ParaConfig.elasticsearchAuthUser()The username to use for authentication with ES.ParaConfig.elasticsearchAutoExpandReplicas()Automatically make a replica copy of the index to the number of nodes specified.ParaConfig.elasticsearchAwsRegion()The AWS region where ES is deployed.intParaConfig.elasticsearchBulkActionLimit()`BulkProcessor` flush threshold in terms of batch size.intParaConfig.elasticsearchBulkBackoffDelayMs()`BulkProcessor` inital backoff delay, in milliseconds.intParaConfig.elasticsearchBulkBackoffRetries()`BulkProcessor` number of retries.intParaConfig.elasticsearchBulkConcurrentRequests()`BulkProcessor` number of concurrent requests (0 means synchronous execution).booleanParaConfig.elasticsearchBulkFlushEnabled()Eanble/disable immediately flushing the requests in `BulkProcessor`, concurrently (in another thread).intParaConfig.elasticsearchBulkFlushIntervalSec()`BulkProcessor` flush interval, in milliseconds.intParaConfig.elasticsearchBulkSizeLimitMb()`BulkProcessor` flush threshold, in megabytes.intParaConfig.elasticsearchChildIndexReplicas()The number of copies to store of each child app index.intParaConfig.elasticsearchChildIndexShards()The number of shards per index for a child apps.ParaConfig.elasticsearchFlavor()Eleasticsearch flavor - either `elasticsearch` or `opensearch`.booleanParaConfig.elasticsearchNestedModeEnabled()Switches between normal indexing and indexing with nested key/value objects for custom properties.booleanParaConfig.elasticsearchProxyEnabled()Enable/disable the Elasticsearch proxy endpoint.ParaConfig.elasticsearchProxyPath()The path to the ES proxy endpoint.booleanParaConfig.elasticsearchProxyReindexingEnabled()Enable/disable rebuilding indices through the Elasticsearch proxy endpoint.ParaConfig.elasticsearchRestClientContextPath()The context path where ES is deployed, if any.ParaConfig.elasticsearchRestClientHost()The ES server hostname.intParaConfig.elasticsearchRestClientPort()The ES server port number.ParaConfig.elasticsearchRestClientScheme()The scheme to use when connecting to the Elasticsearch server - `http` or `https`.intParaConfig.elasticsearchRootIndexReplicas()The number of copies to store of the root index.intParaConfig.elasticsearchRootIndexShards()The number of shards per index.booleanParaConfig.elasticsearchRootIndexSharingEnabled()Enable/disable root index sharing by child apps configured with `isSharingIndex = true`.booleanParaConfig.elasticsearchSignRequestsForAwsEnabled()Enable/disable request signing using the AWS V4 algorithm.ParaConfig.elasticsearchTrackTotalHits()Makes ES track the actual number of hits, even if they are more than the 10000.ParaConfig.emailerPlugin()Selects the `Emailer` implementation at runtime.ParaConfig.environment()Enables/disables certain features, depending on the environment.booleanParaConfig.exceptionOnWriteErrorsEnabled()Enable/disable throwing an exception when a write operation fails with errors.booleanParaConfig.executorServiceEnabled()The number of threads to use for the `ExecutorService` thread pool.intParaConfig.executorThreads()The number of threads to use for the `ExecutorService` thread pool.ParaConfig.facebookAppId()Facebook OAuth2 app ID.ParaConfig.facebookSecret()Facebook app secret key.ParaConfig.fileStoragePlugin()Selects the `FileStore` implementation at runtime.ParaConfig.githubAppId()GitHub OAuth2 app ID.ParaConfig.githubSecret()GitHub app secret key.intParaConfig.globalSyncIntervalSec()The time interval between the sending of each batch of index synchronization messages to the queue, in seconds.ParaConfig.googleAppId()Google OAuth2 app ID.ParaConfig.googleSecret()Google app secret key.booleanParaConfig.gzipEnabled()Enable/disable the GZIP filter for compressing API response entities.ParaConfig.h2DataFolder()The data directory for storing H2 databases.ParaConfig.h2Host()The hostname of the H2 server.ParaConfig.h2Password()The password of the H2 user.ParaConfig.h2ServerParameters()Parameters for the H2 TCP server.ParaConfig.h2User()The username with access to the H2 database.booleanParaConfig.hazelcastAsyncEnabled()Enable/disable asynchronous operations in the Hazelcast client.ParaConfig.hazelcastAwsAccessKey()The AWS access key to use if EC2 auto-discovery is enabled in Hazelcast.ParaConfig.hazelcastAwsRegion()The AWS region to use if EC2 auto-discovery is enabled in Hazelcast.ParaConfig.hazelcastAwsSecretKey()The AWS secret key to use if EC2 auto-discovery is enabled in Hazelcast.booleanParaConfig.hazelcastEc2DiscoveryEnabled()Enable/disable EC2 auto-discovery feature when deploying to AWS.ParaConfig.hazelcastEc2DiscoveryGroup()EC2 security group for cloud discovery of Hazelcast nodes.ParaConfig.hazelcastEvictionPolicy()Hazelcast cache eviction policy - `LRU` or `LFU`.intParaConfig.hazelcastMaxCacheSize()Maximum number of objects to keep in Hazelcast cache.intParaConfig.hazelcastTtlSec()Time-to-live value (how long the objects stay cached) for cached objects, in seconds.booleanParaConfig.healthCheckEnabled()Enable/disable the health check functionality in Para.intParaConfig.healthCheckInvervalSec()The health check interval, in seconds.intParaConfig.idTokenExpiresAfterSec()Expiration period for short-lived ID tokens, in seconds.com.typesafe.config.ConfigListParaConfig.ignoredPaths()A list of ignored paths which will not require authentication before accessing.intParaConfig.importBatchSize()The maximum number of objects to import, in each batch, when restoring data from backup.booleanParaConfig.isCacheEnabled()Enable/disable object caching.booleanParaConfig.isSearchEnabled()Enable/disable full-text search functionality.intParaConfig.jwtExpiresAfterSec()Expiration period for JWTs (access token), in seconds.intParaConfig.jwtRefreshIntervalSec()JWT refresh interval, after which a new token is issued, in seconds.booleanParaConfig.landingPageEnabled()Enable/disable the landing page when opening the server address in the browser.ParaConfig.ldapPasswordParameter()LDAP password parameter name.ParaConfig.ldapUsernameParameter()LDAP username parameter name.ParaConfig.linkedinAppId()LinkedIn OAuth2 app ID.ParaConfig.linkedinSecret()LinkedIn app secret key.ParaConfig.localFileStoreFolder()The local folder for file storage, when `LocalFileStore` is used.intParaConfig.localFileStoreMaxFileSizeMb()Maximum file size for files stored locally, in megabytes.booleanParaConfig.logoBannerEnabled()Enable/disable printing the Para ASCII logo on startup.ParaConfig.luceneDataFolder()The data folder where Lucene stores its indexes.String[]ParaConfig.markdownAllowFollowDomains()A whitelist of domains, links to which will be allowed to be followed by web crawlers (comma-separated list).ParaConfig.markdownSoftBreak()Sets the Markdown soft break character.ParaConfig.mattermostAppId()Mattermost OAuth2 app ID.ParaConfig.mattermostSecret()Mattermost app secret key.intParaConfig.maxDatatypesPerApp()Maximum number of data types which can be defined in each Para app.intParaConfig.maxEntitySizeBytes()Maximum size (in bytes) of incoming JSON payload entities in requests to the API.intParaConfig.maxFailedWebhookAttempts()The number of maximum failed webhook delivery attemts.intParaConfig.maxItemsPerPage()Maximum results per page - limits the number of items to show in search results.intParaConfig.maxPageLimit()Pagination limit - sets the maximum value for the `limit` request parameter, when it is used.intParaConfig.maxPages()Pagination limit - sets the highest page number possible.intParaConfig.maxPasswordMatchingAttempts()The maximum number of passord matching attempts for user accounts per time unit.ParaConfig.mcpServerMode()Enable/disable the MCP server.booleanParaConfig.metricsEnabled()Enable/disable the built-in metrics around CRUD methods.ParaConfig.metricsGraphiteHost()The URL of the Graphite host to push metrics to.intParaConfig.metricsGraphitePeriodSec()The period for how often to push system metrics in seconds.intParaConfig.metricsGraphitePort()The port number of the Graphite server.ParaConfig.metricsGraphitePrefixApps()The prefix to apply to metric names, e.g.ParaConfig.metricsGraphitePrefixSystem()The prefix to apply to system metric names.booleanParaConfig.metricsJmxEnabled()Enable/disable JMX reporting for all metrics.intParaConfig.metricsLoggingIntervalSec()The rate at which the metrics logger will write to file, in seconds.ParaConfig.microsoftAppId()Microsoft OAuth2 app ID.ParaConfig.microsoftSecret()Microsoft app secret key.ParaConfig.microsoftTenantId()Microsoft OAuth2 tenant ID.intParaConfig.minPasswordLength()The minimum length of user passwords.ParaConfig.mongoAuthPassword()The MongoDB user's password.ParaConfig.mongoAuthUser()The username with access to the MongoDB database.ParaConfig.mongoConnectionUri()The MongoDB URI string - verrides host, port, user and password if set.ParaConfig.mongoDatabase()The database name that Para will use.ParaConfig.mongoHost()The hostname of the MongoDB server.intParaConfig.mongoPort()The MongoDB server port.booleanParaConfig.mongoSslAllowAll()Allows a connection to any host over SSL by ignoring the certificate validation.booleanParaConfig.mongoSslEnabled()Enable/disable the SSL/TLS transport layer.intParaConfig.passwordMatchingLockPeriodHours()The time to force a user to wait until they can try to log back in, in hours.intParaConfig.passwordResetTimeoutSec()The time window in which passwords can be reset, in seconds.booleanParaConfig.pidFileEnabled()Enable/disable PID file generation on startup.ParaConfig.pluginFolder()The folder from which Para will load its JAR plugin files.ParaConfig.queuePlugin()Selects the `Queue` implementation at runtime.booleanParaConfig.queuePollingEnabled()Enable/disable polling the queue for message.intParaConfig.queuePollingIntervalSec()The polling interval of the Para river, in seconds.intParaConfig.queuePollingWaitSec()The polling sleep time, in seconds.booleanParaConfig.readFromIndexEnabled()Enable/disable reading data from search index instead of database.intParaConfig.reindexBatchSize(int max) Controls the number of documents to reindex in a single batch.booleanParaConfig.rememberMeEnabled()Deprecated.intParaConfig.requestExpiresAfterSec()Expiration period for signed API request, in seconds.ParaConfig.returnToCookieName()The name of the cookie used to remember which URL the user requested and will be redirected to after login.ParaConfig.returnToPath()The path to return to when an authentication request succeeds.intParaConfig.riverMaxIndexingRetries()The maximum number of attempts at reading an object from database and indexing it, when the operation was received from the queue.ParaConfig.rootSecretOverride()Overrides the secret key for the root Para app `app:para` once, upon first initialization.ParaConfig.searchPlugin()Selects the `Search` implementation at runtime.ParaConfig.separator()String separator - default is colon `:`.ParaConfig.serverContextPath()The context path (subpath) of the web application, defaults to the root path `/`.intParaConfig.serverPort()The network port of this Para server.intParaConfig.sessionTimeoutSec()Expiration period for the login session, in seconds.ParaConfig.sharedTableName()The name of the shared database table, used by shared apps.ParaConfig.signinFailurePath()The default page to send users to when login fails.ParaConfig.signinPath()The path to the login page.ParaConfig.signinSuccessPath()The default page to send users to when they login.ParaConfig.signoutPath()The path to the logout page.ParaConfig.signoutSuccessPath()The default page to send users to when they logout.ParaConfig.slackAppId()Slack OAuth2 app ID.ParaConfig.slackSecret()Slack app secret key.ParaConfig.sqlDriver()The fully-qualified class name for your SQL driver.ParaConfig.sqlHostUrl()The server URL to connect to, *without* the `jdbc:` prefix.ParaConfig.sqlPassword()The database user's password.ParaConfig.sqlUser()The username with access to the database.ParaConfig.supportEmail()The email of the webmaster/support team.booleanParaConfig.syncIndexWithDatabaseEnabled()Enable/disable the data synchronization between database and search index.ParaConfig.twitterAppId()Twitter OAuth app ID.ParaConfig.twitterSecret()Twitter app secret key.booleanParaConfig.versionBannerEnabled()Enable/disable version number printing in Para logs.intParaConfig.voteExpiresAfterSec()Vote expiration timeout, in seconds.intParaConfig.voteLockedAfterSec()Vote locking period, in seconds.booleanParaConfig.webhooksEnabled()Enable/disable webhooks functionality using `Webhook` objects.ParaConfig.workerId()Node number, 1 to 128.