Package org.craftercms.studio.api.v1.constant

Class StudioConstants

java.lang.Object

org.craftercms.studio.api.v1.constant.StudioConstants

public final class StudioConstants
extends Object

Studio Constants

Author:

Hyanghee Lim, Sumer Jabri

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ADMIN_ROLE
static final String	API_REQUEST_PARAM_ENTITIES
static final String	API_REQUEST_PARAM_ENVIRONMENT
static final String	API_REQUEST_PARAM_SITE	API Request Parameter Names
static final String	API_REQUEST_PARAM_SITE_ID
static final String	BOOTSTRAP_REPO_GLOBAL_PATH
static final String	BOOTSTRAP_REPO_PATH	Repository Constants
static final String	BROWSER_URI
static final String	CONFIG_PATH_ROOT
static final String	CONFIG_SITEENV_VARIABLE
static final String	CONFIG_SITENAME_VARIABLE
static final String	CONTENT_ENCODING	content encoding
static final String	CONTENT_TYPE
static final String	CONTENT_TYPE_ALL
static final String	CONTENT_TYPE_ASSET
static final String	CONTENT_TYPE_COMPONENT
static final String	CONTENT_TYPE_CONFIG_FOLDER
static final String	CONTENT_TYPE_CONFIG_REGEX
static final String	CONTENT_TYPE_CONFIGURATION
static final String	CONTENT_TYPE_CONTENT_TYPE
static final String	CONTENT_TYPE_DOCUMENT
static final String	CONTENT_TYPE_FILE
static final String	CONTENT_TYPE_FOLDER
static final String	CONTENT_TYPE_FORM_DEFINITION
static final String	CONTENT_TYPE_GROUP
static final String	CONTENT_TYPE_LEVEL_DESCRIPTOR
static final String	CONTENT_TYPE_PAGE	Content types constants
static final String	CONTENT_TYPE_REMOTE_REPOSITORY
static final String	CONTENT_TYPE_RENDERING_TEMPLATE
static final String	CONTENT_TYPE_SCRIPT
static final String	CONTENT_TYPE_SITE
static final String	CONTENT_TYPE_TAXONOMY
static final String	CONTENT_TYPE_TAXONOMY_REGEX
static final String	CONTENT_TYPE_UNKNOWN
static final String	CONTENT_TYPE_USER
static final String	DATE_FORMAT_DEPLOYED
static final String	DATE_FORMAT_SCHEDULED
static final String	DATE_PATTERN_MODEL
static final String	DATE_PATTERN_WORKFLOW
static final String	DATE_PATTERN_WORKFLOW_WITH_TZ
static final String	DEFAULT_CONFIG_URL
static final int	DEFAULT_ORGANIZATION_ID
static final String	DEFAULT_PUBLISHING_LOCK_OWNER_ID
static final String	DESCRIPTOR_ROOT_PATH	Studio Structure Constants
static final String	DM_GO_LIVE_CACHE_KEY
static final String	FILE_SEPARATOR	System constants
static final String	GLOBAL_REPOSITORY_GIT_LOCK
static final String	HTTP_SESSION_ATTRIBUTE_AUTHENTICATION	Session attributes
static final int	HTTP_STATUS_IMAGE_SIZE_ERROR	Error Codes
static final int	HTTP_STATUS_INTERNAL_SERVER_ERROR
static final String	IN_PROGRESS_BRANCH_NAME_SUFFIX
static final String	INDEX_FILE
static final String	INTERNAL_NAME
static final String	JSON_PROPERTY_DEPENDENCIES
static final String	JSON_PROPERTY_ITEM
static final String	KEY_CONTENT_TYPE
static final String	LOCKING_CACHE_CREATE_SCOPE
static final String	MODULE_ENGINE
static final String	MODULE_STUDIO
static final String	PATTERN_BASE_URL
static final String	PATTERN_CONTENT_TYPE	variable names in configuration properties
static final String	PATTERN_ENVIRONMENT
static final String	PATTERN_FROM_PATH
static final String	PATTERN_ID
static final String	PATTERN_KEY
static final String	PATTERN_MODULE
static final String	PATTERN_PATH
static final String	PATTERN_SANDBOX
static final String	PATTERN_SITE
static final String	PATTERN_TO_PATH
static final String	PATTERN_WEB_PROJECT
static final String	PERMISSION_VALUE_NOT_ALLOWED
static final String	PERMISSION_VALUE_PUBLISH
static final String	PERMISSION_VALUE_READ
static final String	PROPERTY_DOCUMENTS
static final String	PROPERTY_SORT_ASCENDING
static final String	PROPERTY_SORTED_BY
static final String	PROPERTY_TOTAL	document property names in return results
static final String	REMOTE_REPOSITORY_CREATE_OPTION_CLONE	Remote repository create option
static final String	REMOTE_REPOSITORY_CREATE_OPTION_PUSH
static final String	REMOVE_SYSTEM_ADMIN_MEMBER_LOCK
static final String	REPO_COMMIT_MESSAGE_PATH_VAR
static final String	REPO_COMMIT_MESSAGE_USERNAME_VAR	Repository commit messages variables
static final String	SITE_CONFIG_ELEMENT_ADMIN_EMAIL_ADDRESS
static final String	SITE_CONFIG_ELEMENT_AUTHORING_URL
static final String	SITE_CONFIG_ELEMENT_LIVE_URL
static final String	SITE_CONFIG_ELEMENT_PLUGIN_FOLDER_PATTERN
static final String	SITE_CONFIG_ELEMENT_SANDBOX_BRANCH
static final String	SITE_CONFIG_ELEMENT_SITE_URLS
static final String	SITE_CONFIG_ELEMENT_STAGING_URL
static final String	SITE_CONFIG_XML_ELEMENT_DATE_TIME_FORMAT_OPTIONS
static final String	SITE_CONFIG_XML_ELEMENT_ENABLE_STAGING_ENVIRONMENT
static final String	SITE_CONFIG_XML_ELEMENT_LIVE_ENVIRONMENT
static final String	SITE_CONFIG_XML_ELEMENT_LOCALE
static final String	SITE_CONFIG_XML_ELEMENT_PROTECTED_FOLDER_PATTERNS
static final String	SITE_CONFIG_XML_ELEMENT_PUBLISHED_REPOSITORY	Site config xml elements
static final String	SITE_CONFIG_XML_ELEMENT_PUBLISHER
static final String	SITE_CONFIG_XML_ELEMENT_REQUIRE_PEER_REVIEW
static final String	SITE_CONFIG_XML_ELEMENT_STAGING_ENVIRONMENT
static final String	SITE_CONFIG_XML_ELEMENT_TIME_ZONE
static final String	SITE_CONFIG_XML_ELEMENT_WORKFLOW
static final String	SITE_DEFAULT_GROUPS_DESCRIPTION	Site Constants
static final String	SITE_NAME
static final String	SITE_PUBLISHED_REPOSITORY_GIT_LOCK
static final String	SITE_SANDBOX_REPOSITORY_GIT_LOCK
static final String	SITE_UUID_FILE_COMMENT
static final String	SITE_UUID_FILENAME
static final String	SQL_SCRIPT_SUFFIX
static final String	STRING_SEPARATOR
static final String	STUDIO_CLOCK_EXECUTOR_SITE_LOCK
static final String	STUDIO_TEMPORARY_ROOT_DIR
static final List<String>	SUPPORT_RENAME_CONTENT_TYPES
static final String	SYSTEM_ADMIN_GROUP
static final String	SYSTEM_ADMIN_ROLE
static final String	TMP_FILE_SUFFIX
static final List<String>	TOP_LEVEL_FOLDERS
static final String	URL_ENCODING
static final String	USER

Method Summary

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

CONTENT_ENCODING

public static final String CONTENT_ENCODING

content encoding

See Also:

• Constant Field Values

URL_ENCODING

public static final String URL_ENCODING

See Also:

• Constant Field Values

PROPERTY_TOTAL

public static final String PROPERTY_TOTAL

document property names in return results

See Also:

• Constant Field Values

PROPERTY_SORTED_BY

public static final String PROPERTY_SORTED_BY

See Also:

• Constant Field Values

PROPERTY_SORT_ASCENDING

public static final String PROPERTY_SORT_ASCENDING

See Also:

• Constant Field Values

PROPERTY_DOCUMENTS

public static final String PROPERTY_DOCUMENTS

See Also:

• Constant Field Values

DM_GO_LIVE_CACHE_KEY

public static final String DM_GO_LIVE_CACHE_KEY

See Also:

• Constant Field Values

DATE_PATTERN_WORKFLOW

public static final String DATE_PATTERN_WORKFLOW

See Also:

• Constant Field Values

DATE_PATTERN_WORKFLOW_WITH_TZ

public static final String DATE_PATTERN_WORKFLOW_WITH_TZ

See Also:

• Constant Field Values

DATE_PATTERN_MODEL

public static final String DATE_PATTERN_MODEL

See Also:

• Constant Field Values

DATE_FORMAT_SCHEDULED

public static final String DATE_FORMAT_SCHEDULED

See Also:

• Constant Field Values

DATE_FORMAT_DEPLOYED

public static final String DATE_FORMAT_DEPLOYED

See Also:

• Constant Field Values

PATTERN_CONTENT_TYPE

public static final String PATTERN_CONTENT_TYPE

variable names in configuration properties

See Also:

• Constant Field Values

PATTERN_ENVIRONMENT

public static final String PATTERN_ENVIRONMENT

See Also:

• Constant Field Values

PATTERN_MODULE

public static final String PATTERN_MODULE

See Also:

• Constant Field Values

PATTERN_ID

public static final String PATTERN_ID

See Also:

• Constant Field Values

PATTERN_KEY

public static final String PATTERN_KEY

See Also:

• Constant Field Values

PATTERN_SANDBOX

public static final String PATTERN_SANDBOX

See Also:

• Constant Field Values

PATTERN_SITE

public static final String PATTERN_SITE

See Also:

• Constant Field Values

PATTERN_PATH

public static final String PATTERN_PATH

See Also:

• Constant Field Values

PATTERN_FROM_PATH

public static final String PATTERN_FROM_PATH

See Also:

• Constant Field Values

PATTERN_TO_PATH

public static final String PATTERN_TO_PATH

See Also:

• Constant Field Values

PATTERN_WEB_PROJECT

public static final String PATTERN_WEB_PROJECT

See Also:

• Constant Field Values

PATTERN_BASE_URL

public static final String PATTERN_BASE_URL

See Also:

• Constant Field Values

DESCRIPTOR_ROOT_PATH

public static final String DESCRIPTOR_ROOT_PATH

Studio Structure Constants

See Also:

• Constant Field Values

HTTP_STATUS_IMAGE_SIZE_ERROR

public static final int HTTP_STATUS_IMAGE_SIZE_ERROR

Error Codes

See Also:

• Constant Field Values

HTTP_STATUS_INTERNAL_SERVER_ERROR

public static final int HTTP_STATUS_INTERNAL_SERVER_ERROR

See Also:

• Constant Field Values

CONTENT_TYPE

public static final String CONTENT_TYPE

See Also:

• Constant Field Values

INTERNAL_NAME

public static final String INTERNAL_NAME

See Also:

• Constant Field Values

BROWSER_URI

public static final String BROWSER_URI

See Also:

• Constant Field Values

USER

public static final String USER

See Also:

• Constant Field Values

PERMISSION_VALUE_READ

public static final String PERMISSION_VALUE_READ

See Also:

• Constant Field Values

PERMISSION_VALUE_NOT_ALLOWED

public static final String PERMISSION_VALUE_NOT_ALLOWED

See Also:

• Constant Field Values

PERMISSION_VALUE_PUBLISH

public static final String PERMISSION_VALUE_PUBLISH

See Also:

• Constant Field Values

LOCKING_CACHE_CREATE_SCOPE

public static final String LOCKING_CACHE_CREATE_SCOPE

See Also:

• Constant Field Values

BOOTSTRAP_REPO_PATH

public static final String BOOTSTRAP_REPO_PATH

Repository Constants

See Also:

• Constant Field Values

BOOTSTRAP_REPO_GLOBAL_PATH

public static final String BOOTSTRAP_REPO_GLOBAL_PATH

See Also:

• Constant Field Values

CONFIG_SITENAME_VARIABLE

public static final String CONFIG_SITENAME_VARIABLE

See Also:

• Constant Field Values

CONFIG_SITEENV_VARIABLE

public static final String CONFIG_SITEENV_VARIABLE

See Also:

• Constant Field Values

IN_PROGRESS_BRANCH_NAME_SUFFIX

public static final String IN_PROGRESS_BRANCH_NAME_SUFFIX

See Also:

• Constant Field Values

SITE_DEFAULT_GROUPS_DESCRIPTION

public static final String SITE_DEFAULT_GROUPS_DESCRIPTION

Site Constants

See Also:

• Constant Field Values

SITE_NAME

public static final String SITE_NAME

See Also:

• Constant Field Values

SITE_UUID_FILENAME

public static final String SITE_UUID_FILENAME

See Also:

• Constant Field Values

SITE_UUID_FILE_COMMENT

public static final String SITE_UUID_FILE_COMMENT

See Also:

• Constant Field Values

CONTENT_TYPE_PAGE

public static final String CONTENT_TYPE_PAGE

Content types constants

See Also:

• Constant Field Values

CONTENT_TYPE_ASSET

public static final String CONTENT_TYPE_ASSET

See Also:

• Constant Field Values

CONTENT_TYPE_COMPONENT

public static final String CONTENT_TYPE_COMPONENT

See Also:

• Constant Field Values

CONTENT_TYPE_DOCUMENT

public static final String CONTENT_TYPE_DOCUMENT

See Also:

• Constant Field Values

CONTENT_TYPE_RENDERING_TEMPLATE

public static final String CONTENT_TYPE_RENDERING_TEMPLATE

See Also:

• Constant Field Values

CONTENT_TYPE_UNKNOWN

public static final String CONTENT_TYPE_UNKNOWN

See Also:

• Constant Field Values

CONTENT_TYPE_TAXONOMY

public static final String CONTENT_TYPE_TAXONOMY

See Also:

• Constant Field Values

CONTENT_TYPE_CONTENT_TYPE

public static final String CONTENT_TYPE_CONTENT_TYPE

See Also:

• Constant Field Values

CONTENT_TYPE_CONFIGURATION

public static final String CONTENT_TYPE_CONFIGURATION

See Also:

• Constant Field Values

CONTENT_TYPE_FOLDER

public static final String CONTENT_TYPE_FOLDER

See Also:

• Constant Field Values

CONTENT_TYPE_USER

public static final String CONTENT_TYPE_USER

See Also:

• Constant Field Values

CONTENT_TYPE_GROUP

public static final String CONTENT_TYPE_GROUP

See Also:

• Constant Field Values

CONTENT_TYPE_TAXONOMY_REGEX

public static final String CONTENT_TYPE_TAXONOMY_REGEX

See Also:

• Constant Field Values

CONTENT_TYPE_CONFIG_REGEX

public static final String CONTENT_TYPE_CONFIG_REGEX

See Also:

• Constant Field Values

CONFIG_PATH_ROOT

public static final String CONFIG_PATH_ROOT

See Also:

• Constant Field Values

CONTENT_TYPE_ALL

public static final String CONTENT_TYPE_ALL

See Also:

• Constant Field Values

CONTENT_TYPE_FORM_DEFINITION

public static final String CONTENT_TYPE_FORM_DEFINITION

See Also:

• Constant Field Values

CONTENT_TYPE_SITE

public static final String CONTENT_TYPE_SITE

See Also:

• Constant Field Values

CONTENT_TYPE_REMOTE_REPOSITORY

public static final String CONTENT_TYPE_REMOTE_REPOSITORY

See Also:

• Constant Field Values

CONTENT_TYPE_CONFIG_FOLDER

public static final String CONTENT_TYPE_CONFIG_FOLDER

See Also:

• Constant Field Values

CONTENT_TYPE_SCRIPT

public static final String CONTENT_TYPE_SCRIPT

See Also:

• Constant Field Values

CONTENT_TYPE_LEVEL_DESCRIPTOR

public static final String CONTENT_TYPE_LEVEL_DESCRIPTOR

See Also:

• Constant Field Values

CONTENT_TYPE_FILE

public static final String CONTENT_TYPE_FILE

See Also:

• Constant Field Values

SUPPORT_RENAME_CONTENT_TYPES

public static final List<String> SUPPORT_RENAME_CONTENT_TYPES

FILE_SEPARATOR

public static final String FILE_SEPARATOR

System constants

See Also:

• Constant Field Values

SYSTEM_ADMIN_GROUP

public static final String SYSTEM_ADMIN_GROUP

See Also:

• Constant Field Values

SYSTEM_ADMIN_ROLE

public static final String SYSTEM_ADMIN_ROLE

See Also:

• Constant Field Values

ADMIN_ROLE

public static final String ADMIN_ROLE

See Also:

• Constant Field Values

STRING_SEPARATOR

public static final String STRING_SEPARATOR

See Also:

• Constant Field Values

REMOTE_REPOSITORY_CREATE_OPTION_CLONE

public static final String REMOTE_REPOSITORY_CREATE_OPTION_CLONE

Remote repository create option

See Also:

• Constant Field Values

REMOTE_REPOSITORY_CREATE_OPTION_PUSH

public static final String REMOTE_REPOSITORY_CREATE_OPTION_PUSH

See Also:

• Constant Field Values

INDEX_FILE

public static final String INDEX_FILE

See Also:

• Constant Field Values

TOP_LEVEL_FOLDERS

public static final List<String> TOP_LEVEL_FOLDERS

JSON_PROPERTY_ITEM

public static final String JSON_PROPERTY_ITEM

See Also:

• Constant Field Values

JSON_PROPERTY_DEPENDENCIES

public static final String JSON_PROPERTY_DEPENDENCIES

See Also:

• Constant Field Values

API_REQUEST_PARAM_SITE

public static final String API_REQUEST_PARAM_SITE

API Request Parameter Names

See Also:

• Constant Field Values

API_REQUEST_PARAM_SITE_ID

public static final String API_REQUEST_PARAM_SITE_ID

See Also:

• Constant Field Values

API_REQUEST_PARAM_ENTITIES

public static final String API_REQUEST_PARAM_ENTITIES

See Also:

• Constant Field Values

API_REQUEST_PARAM_ENVIRONMENT

public static final String API_REQUEST_PARAM_ENVIRONMENT

See Also:

• Constant Field Values

SITE_CONFIG_XML_ELEMENT_PUBLISHED_REPOSITORY

public static final String SITE_CONFIG_XML_ELEMENT_PUBLISHED_REPOSITORY

Site config xml elements

See Also:

• Constant Field Values

SITE_CONFIG_XML_ELEMENT_ENABLE_STAGING_ENVIRONMENT

public static final String SITE_CONFIG_XML_ELEMENT_ENABLE_STAGING_ENVIRONMENT

See Also:

• Constant Field Values

SITE_CONFIG_XML_ELEMENT_STAGING_ENVIRONMENT

public static final String SITE_CONFIG_XML_ELEMENT_STAGING_ENVIRONMENT

See Also:

• Constant Field Values

SITE_CONFIG_XML_ELEMENT_LIVE_ENVIRONMENT

public static final String SITE_CONFIG_XML_ELEMENT_LIVE_ENVIRONMENT

See Also:

• Constant Field Values

SITE_CONFIG_ELEMENT_SANDBOX_BRANCH

public static final String SITE_CONFIG_ELEMENT_SANDBOX_BRANCH

See Also:

• Constant Field Values

SITE_CONFIG_ELEMENT_PLUGIN_FOLDER_PATTERN

public static final String SITE_CONFIG_ELEMENT_PLUGIN_FOLDER_PATTERN

See Also:

• Constant Field Values

SITE_CONFIG_ELEMENT_SITE_URLS

public static final String SITE_CONFIG_ELEMENT_SITE_URLS

See Also:

• Constant Field Values

SITE_CONFIG_ELEMENT_AUTHORING_URL

public static final String SITE_CONFIG_ELEMENT_AUTHORING_URL

See Also:

• Constant Field Values

SITE_CONFIG_ELEMENT_STAGING_URL

public static final String SITE_CONFIG_ELEMENT_STAGING_URL

See Also:

• Constant Field Values

SITE_CONFIG_ELEMENT_LIVE_URL

public static final String SITE_CONFIG_ELEMENT_LIVE_URL

See Also:

• Constant Field Values

SITE_CONFIG_ELEMENT_ADMIN_EMAIL_ADDRESS

public static final String SITE_CONFIG_ELEMENT_ADMIN_EMAIL_ADDRESS

See Also:

• Constant Field Values

SITE_CONFIG_XML_ELEMENT_WORKFLOW

public static final String SITE_CONFIG_XML_ELEMENT_WORKFLOW

See Also:

• Constant Field Values

SITE_CONFIG_XML_ELEMENT_PUBLISHER

public static final String SITE_CONFIG_XML_ELEMENT_PUBLISHER

See Also:

• Constant Field Values

SITE_CONFIG_XML_ELEMENT_REQUIRE_PEER_REVIEW

public static final String SITE_CONFIG_XML_ELEMENT_REQUIRE_PEER_REVIEW

See Also:

• Constant Field Values

SITE_CONFIG_XML_ELEMENT_PROTECTED_FOLDER_PATTERNS

public static final String SITE_CONFIG_XML_ELEMENT_PROTECTED_FOLDER_PATTERNS

See Also:

• Constant Field Values

SITE_CONFIG_XML_ELEMENT_LOCALE

public static final String SITE_CONFIG_XML_ELEMENT_LOCALE

See Also:

• Constant Field Values

SITE_CONFIG_XML_ELEMENT_DATE_TIME_FORMAT_OPTIONS

public static final String SITE_CONFIG_XML_ELEMENT_DATE_TIME_FORMAT_OPTIONS

See Also:

• Constant Field Values

SITE_CONFIG_XML_ELEMENT_TIME_ZONE

public static final String SITE_CONFIG_XML_ELEMENT_TIME_ZONE

See Also:

• Constant Field Values

REPO_COMMIT_MESSAGE_USERNAME_VAR

public static final String REPO_COMMIT_MESSAGE_USERNAME_VAR

Repository commit messages variables

See Also:

• Constant Field Values

REPO_COMMIT_MESSAGE_PATH_VAR

public static final String REPO_COMMIT_MESSAGE_PATH_VAR

See Also:

• Constant Field Values

HTTP_SESSION_ATTRIBUTE_AUTHENTICATION

public static final String HTTP_SESSION_ATTRIBUTE_AUTHENTICATION

Session attributes

See Also:

• Constant Field Values

DEFAULT_ORGANIZATION_ID

public static final int DEFAULT_ORGANIZATION_ID

See Also:

• Constant Field Values

REMOVE_SYSTEM_ADMIN_MEMBER_LOCK

public static final String REMOVE_SYSTEM_ADMIN_MEMBER_LOCK

See Also:

• Constant Field Values

KEY_CONTENT_TYPE

public static final String KEY_CONTENT_TYPE

See Also:

• Constant Field Values

MODULE_STUDIO

public static final String MODULE_STUDIO

See Also:

• Constant Field Values

MODULE_ENGINE

public static final String MODULE_ENGINE

See Also:

• Constant Field Values

DEFAULT_CONFIG_URL

public static final String DEFAULT_CONFIG_URL

See Also:

• Constant Field Values

DEFAULT_PUBLISHING_LOCK_OWNER_ID

public static final String DEFAULT_PUBLISHING_LOCK_OWNER_ID

See Also:

• Constant Field Values

GLOBAL_REPOSITORY_GIT_LOCK

public static final String GLOBAL_REPOSITORY_GIT_LOCK

See Also:

• Constant Field Values

SITE_SANDBOX_REPOSITORY_GIT_LOCK

public static final String SITE_SANDBOX_REPOSITORY_GIT_LOCK

See Also:

• Constant Field Values

SITE_PUBLISHED_REPOSITORY_GIT_LOCK

public static final String SITE_PUBLISHED_REPOSITORY_GIT_LOCK

See Also:

• Constant Field Values

STUDIO_CLOCK_EXECUTOR_SITE_LOCK

public static final String STUDIO_CLOCK_EXECUTOR_SITE_LOCK

See Also:

• Constant Field Values

STUDIO_TEMPORARY_ROOT_DIR

public static final String STUDIO_TEMPORARY_ROOT_DIR

See Also:

• Constant Field Values

SQL_SCRIPT_SUFFIX

public static final String SQL_SCRIPT_SUFFIX

See Also:

• Constant Field Values

TMP_FILE_SUFFIX

public static final String TMP_FILE_SUFFIX

See Also:

• Constant Field Values