com.sap.cloud.mkt.servicerequest.utils

Class ServiceMetadataProvider

java.lang.Object

com.sap.cloud.mkt.servicerequest.utils.ServiceMetadataProvider

public class ServiceMetadataProvider
extends Object

Generic Metadata Parser for all Odata Services, to create instance of ServiceMetadataProvider, the calling class needs to provide an endpointURL and an optional value of destination Name which is the target destination configured for forwarding request to the corresponding S/4HANA or SAP Marketing Cloud System.

Author:

Anish Joshi

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ServiceMetadataProvider.EntityMetadata Object Representation of an Odata EntityType, Immutable class

Method Summary

Modifier and Type	Method and Description
Set<String>	getAllEntitySetNamesInDefaultSchema() Get Names of all entity sets present in the default schema of the service
static CompletableFuture<ServiceMetadataProvider>	getAsyncInstance(String serviceURI) Get Asynchronous instance of ServiceMetadataProvider, use functional callbacks on the future object to get peocessed data.
static CompletableFuture<ServiceMetadataProvider>	getAsyncInstance(String serviceURI, String destinationName) Get Asynchronous instance of ServiceMetadataProvider, use functional callbacks on the future object to get peocessed data.
ServiceMetadataProvider.EntityMetadata	getEntityMetaDataForEntityType(String entitySetName) Get metadata for an entityset.
Map<org.apache.olingo.odata2.api.edm.provider.EntityType,List<org.apache.olingo.odata2.api.edm.provider.Property>>	getEntityToPropertiesDictionary() Get a Dictionary of EntityType to All its constituent property, to get list of all the properties in a EntityType just perform Map#get(EntityType) operation on the Dictionary obtained via this method giving key reference of an olingo styled EntityType
Map<String,org.apache.olingo.odata2.api.edm.provider.EntityType>	getEntityTypeDictionary() Get EntitySet String to olingo Styled EntityType Dictionary
static ServiceMetadataProvider	getInstance(String serviceURI) Get Factory Instance of ServiceMetadataProvider
static ServiceMetadataProvider	getInstance(String serviceURI, String destinationName) Get Factory Instance of ServiceMetadataProvider
Map<String,List<org.apache.olingo.odata2.api.edm.provider.AnnotationAttribute>>	getPropertyAnnotationsforEntityProperties(List<org.apache.olingo.odata2.api.edm.provider.Property> propertyList) A Map of PropertyNames to corresponding Annotation Attributes, to read V2 Annotations of a particular property
org.apache.olingo.odata2.api.edm.provider.EdmProvider	getServiceMetadata() Get olingo styled instance of metadata object parsed
String	getServiceNameSpace() Get Service qualifier name i.e.

Methods inherited from class java.lang.Object

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

Method Detail

getServiceMetadata

public org.apache.olingo.odata2.api.edm.provider.EdmProvider getServiceMetadata()

Get olingo styled instance of metadata object parsed

Returns:

EdmProvider

getServiceNameSpace

public String getServiceNameSpace()

Get Service qualifier name i.e. Schema napespace

Returns:

Schema Namespace of the underlying service

Throws:

Exception

getEntityMetaDataForEntityType

public ServiceMetadataProvider.EntityMetadata getEntityMetaDataForEntityType(String entitySetName)

Get metadata for an entityset.

Parameters:

entitySetName - Name od the

Returns:

getAllEntitySetNamesInDefaultSchema

public Set<String> getAllEntitySetNamesInDefaultSchema()

Get Names of all entity sets present in the default schema of the service

Returns:

Throws:

Exception

getEntityTypeDictionary

public Map<String,org.apache.olingo.odata2.api.edm.provider.EntityType> getEntityTypeDictionary()

Get EntitySet String to olingo Styled EntityType Dictionary

Returns:

Throws:

Exception

getEntityToPropertiesDictionary

public Map<org.apache.olingo.odata2.api.edm.provider.EntityType,List<org.apache.olingo.odata2.api.edm.provider.Property>> getEntityToPropertiesDictionary()

Get a Dictionary of EntityType to All its constituent property, to get list of all the properties in a EntityType just perform Map#get(EntityType) operation on the Dictionary obtained via this method giving key reference of an olingo styled EntityType

Returns:

A Map of EntityType to list of all its constituent properties

Throws:

Exception

getPropertyAnnotationsforEntityProperties

public Map<String,List<org.apache.olingo.odata2.api.edm.provider.AnnotationAttribute>> getPropertyAnnotationsforEntityProperties(List<org.apache.olingo.odata2.api.edm.provider.Property> propertyList)

A Map of PropertyNames to corresponding Annotation Attributes, to read V2 Annotations of a particular property

Parameters:

propertyList - List of properties that can be obtained via getEntityToPropertiesDictionary()

Returns:

getInstance

public static ServiceMetadataProvider getInstance(String serviceURI,
                                                  String destinationName)

Get Factory Instance of ServiceMetadataProvider

Parameters:

serviceURI - service endpoint URL

destinationName - optional destinationName for forwarding request to source System

Returns:

instance of ServiceMetadataProvider

getInstance

public static ServiceMetadataProvider getInstance(String serviceURI)

Get Factory Instance of ServiceMetadataProvider

Parameters:

serviceURI - service endpoint URL

Returns:

instance of ServiceMetadataProvider

getAsyncInstance

public static CompletableFuture<ServiceMetadataProvider> getAsyncInstance(String serviceURI,
                                                                          String destinationName)

Get Asynchronous instance of ServiceMetadataProvider, use functional callbacks on the future object to get peocessed data.

Parameters:

serviceURI -

destinationName -

Returns:

getAsyncInstance

public static CompletableFuture<ServiceMetadataProvider> getAsyncInstance(String serviceURI)

Get Asynchronous instance of ServiceMetadataProvider, use functional callbacks on the future object to get peocessed data.

Parameters:

serviceURI -

Returns: