com.sap.cloud.sdk.service.prov.api.internal

Class CSNUtil

java.lang.Object

com.sap.cloud.sdk.service.prov.api.internal.CSNUtil

public class CSNUtil
extends Object

Utility class for obtaining information from the CSN(Internal).

Field Summary

Fields

Modifier and Type	Field and Description
static String	auditLogOperation
static String	dataChangeLogOperation
static String	entitySemantics
static String	Semantics

Constructor Summary

Constructors

Constructor and Description
CSNUtil()

Method Summary

Modifier and Type	Method and Description
static boolean	checkVirtualElement(String propName, Set<String> virtualElements)
static Map<String,AdminDataAnnotation>	getAdminDataMapForCreate(String serviceName, String entityName, boolean userContextPresent)
static Map<String,AdminDataAnnotation>	getAdminDataMapForDeepCreate(String serviceName, String parentEntityName, String assoEntityName, String entityName, boolean userContextPresent)
static Map<String,AdminDataAnnotation>	getAdminDataMapForUpdate(String serviceName, String entityName, boolean userContextPresent)
static List<String>	getAggregationColumns(String serviceName, String entityName)
static String	getAggregationRefElement(String serviceName, String element, String entity)
static List<String>	getAllColumns(String serviceName, String entityName)
static AuthorizationDetails	getAuthorizationDetails(String serviceOrEntityName) Reads authorization (@requires/@restrict) details of the given service/entity name from CSN.json.
static String	getCDSDataType(String entityName, String serviceName, String propName)
static String	getCDSParamDataType(String entityName, String serviceName, String paramName)
static String	getcompositionPath(String serviceName, String root, String element)
static Map<String,List<String>>	getCompositionTree(String serviceName, String entityName)
static com.fasterxml.jackson.databind.JsonNode	getCsn() Returns the csn for the current call.
static InputStream	getCsnAsInputStream()
static InputStream	getCsnAsInputStream(com.fasterxml.jackson.databind.JsonNode csn)
static Map<String,AdminDataAnnotation>	getDataMapForCoreComputed(String serviceName, String entityName)
static Map<String,AdminDataAnnotation>	getDataMapForCoreImmutable(String serviceName, String entityName)
static Map<String,List<String>>	getDraftTree(String serviceName)
static String	getEntityName(String serviceName, String parentEntityName, String associationName)
static String	getEtagProperty(String fullyQualifiedEntityName)
static HashedData	getHashedCsn()
static List<String>	getKeys(String serviceName, String element)
static String	getNavName(String serviceName, String entityName, String targetNav)
static List<Map<String,String>>	getOrderByProperties(String serviceName, String entityName)
static String	getPersistenceName(String fqEntityName, String elementName) Returns the value @cds.persistence.name annotation if present in the csn for the passed element.
static Set<String>	getProperties(String serviceName, String entityName)
static Long	getQueryLimit(String serviceName)
static Map<String,List<String>>	getReferences(String serviceName, String entityName)
static Map<String,List<String>>	getReferences(String serviceName, String entityName, boolean readCompositionsOnly)
static Map<String,String>	getReferentialConstarint(String serviceName, String entityName, String navigation)
static List<String>	getRootEntitiesWithDeltaEnabled(String serviceName, String entityName)
static List<String>	getSearchableProperties(String serviceName, String entityName)
static Map<String,Double>	getSearchablePropertiesWithFuzzy(String serviceName, String entityName)
static Integer	getSnapshotStorageDays()
static String	getTemporalDataType(String serviceName)
static List<String>	getTemporalEntities(String serviceName)
static Set<String>	getVirtualElement(String serviceName, String entityName)
static boolean	isAggregatedEntity(String serviceName, String entityName)
static boolean	isAnyTemporal(String serviceName, String entitySetName)
static boolean	isAuditLogEnabled(String serviceName, String entityName, String operation)
static boolean	isAutoExposed(String entityName, String serviceName)
static boolean	isAutoExposedAndAutoExpose(String entityName, String serviceName)
static boolean	isConsistentPagingEnabled(String serviceName, String entityName)
static boolean	isConsistentPagingOrDeltaEnabled()
static boolean	isCreatable(String serviceName, String entityName)
static boolean	isDefaultOrderEnabled(String entityName, String serviceName)
static boolean	isDeletable(String serviceName, String entityName)
static boolean	isDeltaEnabled(String serviceName, String entityName)
static boolean	isDraftEnabledEntity(String entityName, String serviceName)
static boolean	isDraftNodeEntity(String entityName, String serviceName)
static boolean	isEntityTemporal(String serviceName, String entitySetName)
static boolean	isHdbcdsMapping()
static Boolean	isLocalized(String serviceName, String entityName)
static Boolean	isLocalizedForDraft(String serviceName, String entityName)
static boolean	isPlainSqlMapping()
static boolean	isTemporal(String serviceName, String requestURL)
static boolean	isUpdatable(String serviceName, String entityName)

Methods inherited from class java.lang.Object

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

Field Detail

entitySemantics

public static final String entitySemantics

See Also:

Constant Field Values

auditLogOperation

public static final String auditLogOperation

See Also:

Constant Field Values

Semantics

public static final String Semantics

See Also:

Constant Field Values

dataChangeLogOperation

public static final String dataChangeLogOperation

See Also:

Constant Field Values

Constructor Detail

CSNUtil

public CSNUtil()

Method Detail

isCreatable

public static boolean isCreatable(String serviceName,
                                  String entityName)
                           throws CSNNotSetException

Throws:

CSNNotSetException

getCsnAsInputStream

public static InputStream getCsnAsInputStream()
                                       throws com.fasterxml.jackson.core.JsonProcessingException

Throws:

com.fasterxml.jackson.core.JsonProcessingException

getCsnAsInputStream

public static InputStream getCsnAsInputStream(com.fasterxml.jackson.databind.JsonNode csn)
                                       throws com.fasterxml.jackson.core.JsonProcessingException

Throws:

com.fasterxml.jackson.core.JsonProcessingException

isUpdatable

public static boolean isUpdatable(String serviceName,
                                  String entityName)
                           throws CSNNotSetException

Throws:

CSNNotSetException

isDeletable

public static boolean isDeletable(String serviceName,
                                  String entityName)
                           throws CSNNotSetException

Throws:

CSNNotSetException

getAdminDataMapForCreate

public static Map<String,AdminDataAnnotation> getAdminDataMapForCreate(String serviceName,
                                                                       String entityName,
                                                                       boolean userContextPresent)

getAdminDataMapForDeepCreate

public static Map<String,AdminDataAnnotation> getAdminDataMapForDeepCreate(String serviceName,
                                                                           String parentEntityName,
                                                                           String assoEntityName,
                                                                           String entityName,
                                                                           boolean userContextPresent)

getAdminDataMapForUpdate

public static Map<String,AdminDataAnnotation> getAdminDataMapForUpdate(String serviceName,
                                                                       String entityName,
                                                                       boolean userContextPresent)

getSearchableProperties

public static List<String> getSearchableProperties(String serviceName,
                                                   String entityName)

getSearchablePropertiesWithFuzzy

public static Map<String,Double> getSearchablePropertiesWithFuzzy(String serviceName,
                                                                  String entityName)

getProperties

public static Set<String> getProperties(String serviceName,
                                        String entityName)

isPlainSqlMapping

public static boolean isPlainSqlMapping()

isHdbcdsMapping

public static boolean isHdbcdsMapping()

getEntityName

public static String getEntityName(String serviceName,
                                   String parentEntityName,
                                   String associationName)

getAuthorizationDetails

public static AuthorizationDetails getAuthorizationDetails(String serviceOrEntityName)

Reads authorization (@requires/@restrict) details of the given service/entity name from CSN.json.

Parameters:

serviceOrEntityName -

Returns:

AuthorizationDetails if found. Else returns null.

Throws:

IllegalArgumentException - - If conversion fails due to incompatible type; check CSN.json and AuthorizationDetails- class.

getPersistenceName

public static String getPersistenceName(String fqEntityName,
                                        String elementName)

Returns the value @cds.persistence.name annotation if present in the csn for the passed element. If not present this method returns null.

Parameters:

fqEntityName -

elementName -

Returns:

isDraftEnabledEntity

public static boolean isDraftEnabledEntity(String entityName,
                                           String serviceName)

isDefaultOrderEnabled

public static boolean isDefaultOrderEnabled(String entityName,
                                            String serviceName)

getCDSDataType

public static String getCDSDataType(String entityName,
                                    String serviceName,
                                    String propName)

getCsn

public static com.fasterxml.jackson.databind.JsonNode getCsn()

Returns the csn for the current call. This method logs if the csn is null. Actual handling for the null csn scenario is to be done in the calling method.

getHashedCsn

public static HashedData getHashedCsn()

isDraftNodeEntity

public static boolean isDraftNodeEntity(String entityName,
                                        String serviceName)

getCompositionTree

public static Map<String,List<String>> getCompositionTree(String serviceName,
                                                          String entityName)

getDraftTree

public static Map<String,List<String>> getDraftTree(String serviceName)

getQueryLimit

public static Long getQueryLimit(String serviceName)

isConsistentPagingEnabled

public static boolean isConsistentPagingEnabled(String serviceName,
                                                String entityName)

getTemporalEntities

public static List<String> getTemporalEntities(String serviceName)

isLocalized

public static Boolean isLocalized(String serviceName,
                                  String entityName)

isLocalizedForDraft

public static Boolean isLocalizedForDraft(String serviceName,
                                          String entityName)

isAnyTemporal

public static boolean isAnyTemporal(String serviceName,
                                    String entitySetName)

isTemporal

public static boolean isTemporal(String serviceName,
                                 String requestURL)

isEntityTemporal

public static boolean isEntityTemporal(String serviceName,
                                       String entitySetName)

getRootEntitiesWithDeltaEnabled

public static List<String> getRootEntitiesWithDeltaEnabled(String serviceName,
                                                           String entityName)

getcompositionPath

public static String getcompositionPath(String serviceName,
                                        String root,
                                        String element)

getKeys

public static List<String> getKeys(String serviceName,
                                   String element)

getOrderByProperties

public static List<Map<String,String>> getOrderByProperties(String serviceName,
                                                            String entityName)

isDeltaEnabled

public static boolean isDeltaEnabled(String serviceName,
                                     String entityName)

getAggregationColumns

public static List<String> getAggregationColumns(String serviceName,
                                                 String entityName)

getAllColumns

public static List<String> getAllColumns(String serviceName,
                                         String entityName)

getTemporalDataType

public static String getTemporalDataType(String serviceName)

isAutoExposedAndAutoExpose

public static boolean isAutoExposedAndAutoExpose(String entityName,
                                                 String serviceName)

isAutoExposed

public static boolean isAutoExposed(String entityName,
                                    String serviceName)

isAggregatedEntity

public static boolean isAggregatedEntity(String serviceName,
                                         String entityName)

getEtagProperty

public static String getEtagProperty(String fullyQualifiedEntityName)

getReferences

public static Map<String,List<String>> getReferences(String serviceName,
                                                     String entityName,
                                                     boolean readCompositionsOnly)

getReferences

public static Map<String,List<String>> getReferences(String serviceName,
                                                     String entityName)

getSnapshotStorageDays

public static Integer getSnapshotStorageDays()

isConsistentPagingOrDeltaEnabled

public static boolean isConsistentPagingOrDeltaEnabled()

getNavName

public static String getNavName(String serviceName,
                                String entityName,
                                String targetNav)

isAuditLogEnabled

public static boolean isAuditLogEnabled(String serviceName,
                                        String entityName,
                                        String operation)

getDataMapForCoreComputed

public static Map<String,AdminDataAnnotation> getDataMapForCoreComputed(String serviceName,
                                                                        String entityName)

getDataMapForCoreImmutable

public static Map<String,AdminDataAnnotation> getDataMapForCoreImmutable(String serviceName,
                                                                         String entityName)

getVirtualElement

public static Set<String> getVirtualElement(String serviceName,
                                            String entityName)

checkVirtualElement

public static boolean checkVirtualElement(String propName,
                                          Set<String> virtualElements)

getAggregationRefElement

public static String getAggregationRefElement(String serviceName,
                                              String element,
                                              String entity)

getCDSParamDataType

public static String getCDSParamDataType(String entityName,
                                         String serviceName,
                                         String paramName)

getReferentialConstarint

public static Map<String,String> getReferentialConstarint(String serviceName,
                                                          String entityName,
                                                          String navigation)