| /** |
| * Licensed to the Apache Software Foundation (ASF) under one |
| * or more contributor license agreements. See the NOTICE file |
| * distributed with this work for additional information |
| * regarding copyright ownership. The ASF licenses this file |
| * to you under the Apache License, Version 2.0 (the |
| * "License"); you may not use this file except in compliance |
| * with the License. You may obtain a copy of the License at |
| * <p> |
| * http://www.apache.org/licenses/LICENSE-2.0 |
| * <p> |
| * Unless required by applicable law or agreed to in writing, software |
| * distributed under the License is distributed on an "AS IS" BASIS, |
| * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| * See the License for the specific language governing permissions and |
| * limitations under the License. |
| */ |
| |
| package org.apache.atlas.repository; |
| |
| import org.apache.atlas.ApplicationProperties; |
| import org.apache.atlas.AtlasException; |
| import org.apache.commons.configuration.Configuration; |
| |
| import static org.apache.atlas.type.AtlasStructType.AtlasAttribute.encodePropertyKey; |
| |
| /** |
| * Repository Constants. |
| * |
| */ |
| public final class Constants { |
| |
| /** |
| * Globally Unique identifier property key. |
| */ |
| |
| public static final String INTERNAL_PROPERTY_KEY_PREFIX = "__"; |
| public static final String RELATIONSHIP_PROPERTY_KEY_PREFIX = "_r"; |
| public static final String GUID_PROPERTY_KEY = encodePropertyKey(INTERNAL_PROPERTY_KEY_PREFIX + "guid"); |
| public static final String RELATIONSHIP_GUID_PROPERTY_KEY = encodePropertyKey(RELATIONSHIP_PROPERTY_KEY_PREFIX + GUID_PROPERTY_KEY); |
| public static final String HISTORICAL_GUID_PROPERTY_KEY = encodePropertyKey(INTERNAL_PROPERTY_KEY_PREFIX + "historicalGuids"); |
| public static final String FREETEXT_REQUEST_HANDLER = "/freetext"; |
| public static final String TERMS_REQUEST_HANDLER = "/terms"; |
| |
| /** |
| * Entity type name property key. |
| */ |
| public static final String ENTITY_TYPE_PROPERTY_KEY = encodePropertyKey(INTERNAL_PROPERTY_KEY_PREFIX + "typeName"); |
| public static final String RELATIONSHIP_TYPE_PROPERTY_KEY = encodePropertyKey(RELATIONSHIP_PROPERTY_KEY_PREFIX + ENTITY_TYPE_PROPERTY_KEY); |
| |
| public static final String TYPE_NAME_INTERNAL = INTERNAL_PROPERTY_KEY_PREFIX + "internal"; |
| public static final String ASSET_ENTITY_TYPE = "Asset"; |
| public static final String OWNER_ATTRIBUTE = "owner"; |
| |
| /** |
| * Entity type's super types property key. |
| */ |
| public static final String SUPER_TYPES_PROPERTY_KEY = encodePropertyKey(INTERNAL_PROPERTY_KEY_PREFIX + "superTypeNames"); |
| |
| /** |
| * Full-text for the entity for enabling full-text search. |
| */ |
| public static final String ENTITY_TEXT_PROPERTY_KEY = encodePropertyKey("entityText"); |
| |
| /** |
| * Properties for type store graph. |
| */ |
| public static final String TYPE_CATEGORY_PROPERTY_KEY = getEncodedTypePropertyKey(INTERNAL_PROPERTY_KEY_PREFIX + "type.category"); |
| public static final String VERTEX_TYPE_PROPERTY_KEY = getEncodedTypePropertyKey(INTERNAL_PROPERTY_KEY_PREFIX + "type"); |
| public static final String TYPENAME_PROPERTY_KEY = getEncodedTypePropertyKey(INTERNAL_PROPERTY_KEY_PREFIX + "type.name"); |
| public static final String TYPEDESCRIPTION_PROPERTY_KEY = getEncodedTypePropertyKey(INTERNAL_PROPERTY_KEY_PREFIX + "type.description"); |
| public static final String TYPEVERSION_PROPERTY_KEY = getEncodedTypePropertyKey(INTERNAL_PROPERTY_KEY_PREFIX + "type.version"); |
| public static final String TYPEOPTIONS_PROPERTY_KEY = getEncodedTypePropertyKey(INTERNAL_PROPERTY_KEY_PREFIX + "type.options"); |
| public static final String TYPESERVICETYPE_PROPERTY_KEY = getEncodedTypePropertyKey(INTERNAL_PROPERTY_KEY_PREFIX + "type.servicetype"); |
| |
| // relationship def constants |
| public static final String RELATIONSHIPTYPE_END1_KEY = "endDef1"; |
| public static final String RELATIONSHIPTYPE_END2_KEY = "endDef2"; |
| public static final String RELATIONSHIPTYPE_CATEGORY_KEY = "relationshipCategory"; |
| public static final String RELATIONSHIPTYPE_LABEL_KEY = "relationshipLabel"; |
| public static final String RELATIONSHIPTYPE_TAG_PROPAGATION_KEY = encodePropertyKey("tagPropagation"); |
| public static final String RELATIONSHIPTYPE_BLOCKED_PROPAGATED_CLASSIFICATIONS_KEY = encodePropertyKey("blockedPropagatedClassifications"); |
| |
| /** |
| * Trait names property key and index name. |
| */ |
| public static final String TRAIT_NAMES_PROPERTY_KEY = encodePropertyKey(INTERNAL_PROPERTY_KEY_PREFIX + "traitNames"); |
| public static final String PROPAGATED_TRAIT_NAMES_PROPERTY_KEY = encodePropertyKey(INTERNAL_PROPERTY_KEY_PREFIX + "propagatedTraitNames"); |
| |
| public static final String VERSION_PROPERTY_KEY = encodePropertyKey(INTERNAL_PROPERTY_KEY_PREFIX + "version"); |
| public static final String STATE_PROPERTY_KEY = encodePropertyKey(INTERNAL_PROPERTY_KEY_PREFIX + "state"); |
| public static final String CREATED_BY_KEY = encodePropertyKey(INTERNAL_PROPERTY_KEY_PREFIX + "createdBy"); |
| public static final String MODIFIED_BY_KEY = encodePropertyKey(INTERNAL_PROPERTY_KEY_PREFIX + "modifiedBy"); |
| public static final String CLASSIFICATION_TEXT_KEY = encodePropertyKey(INTERNAL_PROPERTY_KEY_PREFIX + "classificationsText"); |
| public static final String CLASSIFICATION_NAMES_KEY = encodePropertyKey(INTERNAL_PROPERTY_KEY_PREFIX + "classificationNames"); |
| public static final String PROPAGATED_CLASSIFICATION_NAMES_KEY = encodePropertyKey(INTERNAL_PROPERTY_KEY_PREFIX + "propagatedClassificationNames"); |
| public static final String CUSTOM_ATTRIBUTES_PROPERTY_KEY = encodePropertyKey(INTERNAL_PROPERTY_KEY_PREFIX + "customAttributes"); |
| public static final String LABELS_PROPERTY_KEY = encodePropertyKey(INTERNAL_PROPERTY_KEY_PREFIX + "labels"); |
| public static final String EDGE_PENDING_TASKS_PROPERTY_KEY = encodePropertyKey(RELATIONSHIP_PROPERTY_KEY_PREFIX + "__pendingTasks"); |
| |
| /** |
| * Patch vertices property keys. |
| */ |
| public static final String PATCH_ID_PROPERTY_KEY = encodePropertyKey(INTERNAL_PROPERTY_KEY_PREFIX + "patch.id"); |
| public static final String PATCH_DESCRIPTION_PROPERTY_KEY = encodePropertyKey(INTERNAL_PROPERTY_KEY_PREFIX + "patch.description"); |
| public static final String PATCH_TYPE_PROPERTY_KEY = encodePropertyKey(INTERNAL_PROPERTY_KEY_PREFIX + "patch.type"); |
| public static final String PATCH_ACTION_PROPERTY_KEY = encodePropertyKey(INTERNAL_PROPERTY_KEY_PREFIX + "patch.action"); |
| public static final String PATCH_STATE_PROPERTY_KEY = encodePropertyKey(INTERNAL_PROPERTY_KEY_PREFIX + "patch.state"); |
| |
| /** |
| * The homeId field is used when saving into Atlas a copy of an object that is being imported from another |
| * repository. The homeId will be set to a String that identifies the other repository. The specific format |
| * of repository identifiers is domain dependent. Where it is set by Open Metadata Repository Services it will |
| * be a MetadataCollectionId. |
| * An object that is mastered by the Atlas repository, will have a null homeId field. This represents a locally |
| * mastered object that can be manipulated by Atlas and its applications as normal. |
| * An object with a non-null homeId is a copy of an object mastered by a different repository and the object |
| * should only be updated via the notifications and calls from Open Metadata Repository Services. |
| */ |
| public static final String HOME_ID_KEY = encodePropertyKey(INTERNAL_PROPERTY_KEY_PREFIX + "homeId"); |
| |
| /** |
| * The isProxy field is used when saving into Atlas a proxy of an entity - i.e. it is not a whole entity, but |
| * a partial representation of an entity that is referred to by a relationship end. |
| * The isProxy field will be set to true if the entity is a proxy. The field is used during retrieval of an |
| * entity (proxy) from Atlas to indicate that the entity does not contain full entity detail. |
| */ |
| public static final String IS_PROXY_KEY = encodePropertyKey(INTERNAL_PROPERTY_KEY_PREFIX + "isProxy"); |
| |
| /** |
| * The provenanceType field is used to record the provenance of an instance of an entity or relationship - this |
| * indicates how the instance was created. This corresponds to the InstanceProvenanceType enum defined in ODPi. |
| * To avoid creating a hard dependency on the ODPi class, the value is stored as an int corresponding to the |
| * ordinal in the ODPi enum. |
| */ |
| public static final String PROVENANCE_TYPE_KEY = encodePropertyKey(INTERNAL_PROPERTY_KEY_PREFIX + "provenanceType"); |
| |
| public static final String TIMESTAMP_PROPERTY_KEY = encodePropertyKey(INTERNAL_PROPERTY_KEY_PREFIX + "timestamp"); |
| |
| public static final String ENTITY_DELETED_TIMESTAMP_PROPERTY_KEY = encodePropertyKey(INTERNAL_PROPERTY_KEY_PREFIX + "entityDeletedTimestamp"); |
| |
| public static final String MODIFICATION_TIMESTAMP_PROPERTY_KEY = encodePropertyKey(INTERNAL_PROPERTY_KEY_PREFIX + "modificationTimestamp"); |
| |
| public static final String IS_INCOMPLETE_PROPERTY_KEY = encodePropertyKey(INTERNAL_PROPERTY_KEY_PREFIX + "isIncomplete"); |
| |
| /** |
| * search backing index name. |
| */ |
| public static final String BACKING_INDEX = "search"; |
| |
| /** |
| * search backing index name for vertex keys. |
| */ |
| public static final String VERTEX_INDEX = "vertex_index"; |
| |
| /** |
| * search backing index name for edge labels. |
| */ |
| public static final String EDGE_INDEX = "edge_index"; |
| |
| public static final String FULLTEXT_INDEX = "fulltext_index"; |
| |
| public static final String QUALIFIED_NAME = "Referenceable.qualifiedName"; |
| public static final String TYPE_NAME_PROPERTY_KEY = INTERNAL_PROPERTY_KEY_PREFIX + "typeName"; |
| public static final String INDEX_SEARCH_MAX_RESULT_SET_SIZE = "atlas.graph.index.search.max-result-set-size"; |
| public static final String INDEX_SEARCH_TYPES_MAX_QUERY_STR_LENGTH = "atlas.graph.index.search.types.max-query-str-length"; |
| public static final String INDEX_SEARCH_TAGS_MAX_QUERY_STR_LENGTH = "atlas.graph.index.search.tags.max-query-str-length"; |
| public static final String INDEX_SEARCH_VERTEX_PREFIX_PROPERTY = "atlas.graph.index.search.vertex.prefix"; |
| public static final String INDEX_SEARCH_VERTEX_PREFIX_DEFAULT = "$v$"; |
| |
| public static final String MAX_FULLTEXT_QUERY_STR_LENGTH = "atlas.graph.fulltext-max-query-str-length"; |
| public static final String MAX_DSL_QUERY_STR_LENGTH = "atlas.graph.dsl-max-query-str-length"; |
| |
| public static final String ATTRIBUTE_NAME_GUID = "guid"; |
| public static final String ATTRIBUTE_NAME_TYPENAME = "typeName"; |
| public static final String ATTRIBUTE_NAME_SUPERTYPENAMES = "superTypeNames"; |
| public static final String ATTRIBUTE_NAME_STATE = "state"; |
| public static final String ATTRIBUTE_NAME_VERSION = "version"; |
| public static final String TEMP_STRUCT_NAME_PREFIX = "__tempQueryResultStruct"; |
| |
| public static final String CLASSIFICATION_ENTITY_GUID = encodePropertyKey(INTERNAL_PROPERTY_KEY_PREFIX + "entityGuid"); |
| public static final String CLASSIFICATION_ENTITY_STATUS = encodePropertyKey(INTERNAL_PROPERTY_KEY_PREFIX + "entityStatus"); |
| public static final String CLASSIFICATION_VALIDITY_PERIODS_KEY = encodePropertyKey(INTERNAL_PROPERTY_KEY_PREFIX + "validityPeriods"); |
| public static final String CLASSIFICATION_VERTEX_PROPAGATE_KEY = encodePropertyKey(INTERNAL_PROPERTY_KEY_PREFIX + "propagate"); |
| public static final String CLASSIFICATION_VERTEX_REMOVE_PROPAGATIONS_KEY = encodePropertyKey(INTERNAL_PROPERTY_KEY_PREFIX + "removePropagations"); |
| public static final String CLASSIFICATION_VERTEX_NAME_KEY = encodePropertyKey(TYPE_NAME_PROPERTY_KEY); |
| public static final String CLASSIFICATION_EDGE_NAME_PROPERTY_KEY = encodePropertyKey(INTERNAL_PROPERTY_KEY_PREFIX + "name"); |
| public static final String CLASSIFICATION_EDGE_IS_PROPAGATED_PROPERTY_KEY = encodePropertyKey(INTERNAL_PROPERTY_KEY_PREFIX + "isPropagated"); |
| public static final String CLASSIFICATION_EDGE_STATE_PROPERTY_KEY = STATE_PROPERTY_KEY; |
| public static final String CLASSIFICATION_LABEL = "classifiedAs"; |
| public static final String CLASSIFICATION_NAME_DELIMITER = "|"; |
| public static final String LABEL_NAME_DELIMITER = CLASSIFICATION_NAME_DELIMITER; |
| public static final String TERM_ASSIGNMENT_LABEL = "r:AtlasGlossarySemanticAssignment"; |
| public static final String ATTRIBUTE_INDEX_PROPERTY_KEY = encodePropertyKey(INTERNAL_PROPERTY_KEY_PREFIX + "index"); |
| public static final String ATTRIBUTE_KEY_PROPERTY_KEY = encodePropertyKey(INTERNAL_PROPERTY_KEY_PREFIX + "key"); |
| public static final String ATTRIBUTE_VALUE_DELIMITER = ","; |
| |
| public static final String VERTEX_ID_IN_IMPORT_KEY = "__vIdInImport"; |
| public static final String EDGE_ID_IN_IMPORT_KEY = "__eIdInImport"; |
| |
| /* |
| * replication attributes |
| */ |
| |
| public static final String ATTR_NAME_REFERENCEABLE = "Referenceable."; |
| public static final String ATTR_NAME_REPLICATED_TO = "replicatedTo"; |
| public static final String ATTR_NAME_REPLICATED_FROM = "replicatedFrom"; |
| public static final Integer INCOMPLETE_ENTITY_VALUE = Integer.valueOf(1); |
| |
| /* |
| * typedef patch constants |
| */ |
| public static final String TYPEDEF_PATCH_ADD_MANDATORY_ATTRIBUTE = "ADD_MANDATORY_ATTRIBUTE"; |
| |
| /* |
| * Task related constants |
| */ |
| public static final String TASK_PREFIX = INTERNAL_PROPERTY_KEY_PREFIX + "task_"; |
| public static final String TASK_TYPE_PROPERTY_KEY = encodePropertyKey(TASK_PREFIX + "v_type"); |
| public static final String TASK_TYPE_NAME = INTERNAL_PROPERTY_KEY_PREFIX + "AtlasTaskDef"; |
| public static final String TASK_GUID = encodePropertyKey(TASK_PREFIX + "guid"); |
| public static final String TASK_TYPE = encodePropertyKey(TASK_PREFIX + "type"); |
| public static final String TASK_CREATED_TIME = encodePropertyKey(TASK_PREFIX + "timestamp"); |
| public static final String TASK_UPDATED_TIME = encodePropertyKey(TASK_PREFIX + "modificationTimestamp"); |
| public static final String TASK_CREATED_BY = encodePropertyKey(TASK_PREFIX + "createdBy"); |
| public static final String TASK_STATUS = encodePropertyKey(TASK_PREFIX + "status"); |
| public static final String TASK_ATTEMPT_COUNT = encodePropertyKey(TASK_PREFIX + "attemptCount"); |
| public static final String TASK_PARAMETERS = encodePropertyKey(TASK_PREFIX + "parameters"); |
| public static final String TASK_ERROR_MESSAGE = encodePropertyKey(TASK_PREFIX + "errorMessage"); |
| public static final String TASK_START_TIME = encodePropertyKey(TASK_PREFIX + "startTime"); |
| public static final String TASK_END_TIME = encodePropertyKey(TASK_PREFIX + "endTime"); |
| |
| /** |
| * Index Recovery vertex property keys. |
| */ |
| public static final String INDEX_RECOVERY_PREFIX = INTERNAL_PROPERTY_KEY_PREFIX + "idxRecovery_"; |
| public static final String PROPERTY_KEY_INDEX_RECOVERY_NAME = encodePropertyKey(INDEX_RECOVERY_PREFIX + "name"); |
| public static final String PROPERTY_KEY_INDEX_RECOVERY_START_TIME = encodePropertyKey(INDEX_RECOVERY_PREFIX + "startTime"); |
| public static final String PROPERTY_KEY_INDEX_RECOVERY_PREV_TIME = encodePropertyKey(INDEX_RECOVERY_PREFIX + "prevTime"); |
| public static final String PROPERTY_KEY_INDEX_RECOVERY_CUSTOM_TIME = encodePropertyKey(INDEX_RECOVERY_PREFIX + "customTime"); |
| |
| /** |
| * Audit Reduction vertex property keys. |
| */ |
| public static final String AUDIT_REDUCTION_PREFIX = INTERNAL_PROPERTY_KEY_PREFIX + "auditReduction_"; |
| public static final String PROPERTY_KEY_AUDIT_REDUCTION_NAME = encodePropertyKey(AUDIT_REDUCTION_PREFIX + "name"); |
| public static final String PROPERTY_KEY_GUIDS_TO_AGEOUT_BY_DEFAULT = encodePropertyKey(AUDIT_REDUCTION_PREFIX + "default"); |
| public static final String PROPERTY_KEY_GUIDS_TO_AGEOUT_BY_CUSTOM = encodePropertyKey(AUDIT_REDUCTION_PREFIX + "custom"); |
| public static final String PROPERTY_KEY_GUIDS_TO_SWEEPOUT = encodePropertyKey(AUDIT_REDUCTION_PREFIX + "sweepout"); |
| |
| public static final String SQOOP_SOURCE = "sqoop"; |
| public static final String FALCON_SOURCE = "falcon"; |
| public static final String HBASE_SOURCE = "hbase"; |
| public static final String HS2_SOURCE = "hive_server2"; |
| public static final String HMS_SOURCE = "hive_metastore"; |
| public static final String IMPALA_SOURCE = "impala"; |
| public static final String STORM_SOURCE = "storm"; |
| public static final String FILE_SPOOL_SOURCE = "file_spool"; |
| |
| /** |
| * Audit Reduction related constants |
| */ |
| public enum AtlasAuditAgingType { DEFAULT, CUSTOM, SWEEP } |
| public static final String AUDIT_REDUCTION_TYPE_NAME = "__auditReductionInfo"; |
| public static final String AUDIT_AGING_TYPE_KEY = "auditAgingType"; |
| public static final String AUDIT_AGING_TTL_KEY = "ttl"; |
| public static final String AUDIT_AGING_COUNT_KEY = "auditCount"; |
| public static final String AUDIT_AGING_ENTITY_TYPES_KEY = "entityTypes"; |
| public static final String AUDIT_AGING_ACTION_TYPES_KEY = "actionTypes"; |
| public static final String AUDIT_AGING_EXCLUDE_ENTITY_TYPES_KEY = "excludeEntityTypes"; |
| public static final String CREATE_EVENTS_AGEOUT_ALLOWED_KEY = "createEventsAgeoutAllowed"; |
| public static final String AUDIT_AGING_SUBTYPES_INCLUDED_KEY = "subTypesIncluded"; |
| |
| /* |
| * All supported file-format extensions for Bulk Imports through file upload |
| */ |
| public enum SupportedFileExtensions { XLSX, XLS, CSV } |
| |
| private Constants() { |
| } |
| |
| private static String getEncodedTypePropertyKey(String defaultKey) { |
| try { |
| Configuration configuration = ApplicationProperties.get(); |
| |
| if (configuration.containsKey("atlas.graph.index.search.backend") && |
| configuration.getString("atlas.graph.index.search.backend").equals("elasticsearch")) { |
| |
| return defaultKey.replaceAll("\\.", "_"); |
| } |
| |
| return encodePropertyKey(defaultKey); |
| } catch (AtlasException e) { |
| return encodePropertyKey(defaultKey); |
| } |
| } |
| } |
