com.hybris.ymkt.common.odata

Class ODataService

java.lang.Object

com.hybris.ymkt.common.odata.ODataService

public class ODataService
extends java.lang.Object

This bean shall be instantiated for each OData service as separate $metadata are used by OData services.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	ODataService.TokenCache

Field Summary

Fields

Modifier and Type	Field and Description
protected EdmxProvider	edmxProvider
protected HttpURLConnectionService	httpURLConnectionService
protected ODataConvertEdmService	oDataConvertEdmService
protected java.lang.String	password
protected java.net.Proxy	proxy
protected java.lang.String	rootUrl
protected java.lang.String	sapClient
protected ODataService.TokenCache	token
protected java.lang.String	user
protected static java.lang.String	X_CSRF_TOKEN

Constructor Summary

Constructors

Constructor and Description
ODataService()

Method Summary

Modifier and Type	Method and Description
byte[]	bufferStream(java.io.InputStream stream) Read InputStream and return a byte array.
protected void	checkStatus(HttpURLConnectionResponse response)
protected JsonObject	convertMapToJSON(EdmEntityType entityType, java.util.Map<?,?> data)
byte[]	convertMapToJSONPayload(java.lang.String entitySetName, java.util.Map<java.lang.String,java.lang.Object> data) Convert an entity map into a JSON payload reading to be transfered.
java.lang.String	convertMapToJSONString(EdmEntityType entityType, java.util.Map<java.lang.String,java.lang.Object> data) Convert an entity map into a JSON String.
java.util.Map<java.lang.String,java.lang.String>	convertMapToURIParameters(java.lang.String functionImportName, java.util.Map<java.lang.String,java.lang.Object> data) Build properly formated String value arguments for OData Function Import.
protected JsonElement	convertObjectToJsonElement(java.lang.Object value, EdmElement element)
protected JsonElement	convertObjectToJsonElement(java.lang.Object value, EdmNavigationProperty navigation)
protected java.lang.String	convertObjectToString(java.lang.Object value, EdmLiteralKind literalKind, EdmElement element)
java.lang.String	createResourcePath(java.lang.String entitySetName, java.util.Map<java.lang.String,java.lang.Object> data) Create $batch part URL accessing entity by keys for Addressing Entries.
java.net.URL	createURL(java.lang.String resourcePath) Create an absolute URL accessing the OData service at the resource path provided.
java.net.URL	createURL(java.lang.String resourcePath, java.util.Map<java.lang.String,java.lang.String> queryOptions) Create an absolute URL accessing the OData service at the resourcePath provided using OData query options.
java.net.URL	createURL(java.lang.String resourcePath, java.lang.String... queryOptions) Create an absolute URL accessing the OData service at the resourcePath provided using OData query options.
protected byte[]	decompressIfGZIP(byte[] payload)
protected HttpURLConnectionResponse	executeWithBasicAuth(HttpURLConnectionRequest request) Execute the request with Authorization : "Basic BASE64user:pass". Using this method will create a new http session (unnecessary cost) on the yMKT side. It is preferable to use executeWithRetry(HttpURLConnectionRequest) for most execution scenarios.
HttpURLConnectionResponse	executeWithRetry(HttpURLConnectionRequest request) Execute the request with "cookie" & "x-csrf-token". If the existing session and/or token expired, those are refreshed and the request is re-tried.
ODataFilterBuilder	filter(java.lang.String entitySetName) Create an ODataFilterBuilder starting on the entitySetName provided.
protected java.lang.StringBuilder	getCustomQueryOptions()
Edm	getEdm() Provide buffered olingo's Edm of the OData service.
EdmEntitySet	getEntitySet(java.lang.String entitySetName) Simple wrapping with improved error handling of : this.getEdm().getDefaultEntityContainer().getEntitySet(entitySetName);
protected ODataService.TokenCache	getTokenCache()
protected ODataService.TokenCache	refreshToken(ODataService.TokenCache token)
void	setHttpURLConnectionService(HttpURLConnectionService httpURLConnectionService)
void	setODataConvertEdmService(ODataConvertEdmService oDataConvertEdmService)
void	setPassword(java.lang.String password)
void	setProxy(java.lang.String proxy)
void	setRootUrl(java.lang.String rootUrl)
void	setSapClient(java.lang.String sapClient)
void	setUser(java.lang.String user)

Methods inherited from class java.lang.Object

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

Field Detail

X_CSRF_TOKEN

protected static final java.lang.String X_CSRF_TOKEN

See Also:

Constant Field Values

edmxProvider

protected volatile EdmxProvider edmxProvider

httpURLConnectionService

protected HttpURLConnectionService httpURLConnectionService

oDataConvertEdmService

protected ODataConvertEdmService oDataConvertEdmService

password

protected java.lang.String password

proxy

protected java.net.Proxy proxy

rootUrl

protected java.lang.String rootUrl

sapClient

protected java.lang.String sapClient

token

protected volatile ODataService.TokenCache token

user

protected java.lang.String user

Constructor Detail

ODataService

public ODataService()

Method Detail

bufferStream

public byte[] bufferStream(java.io.InputStream stream)
                    throws java.io.IOException

Read InputStream and return a byte array.

Parameters:

stream - InputStream to read.

Returns:

All bytes that could be read from the InputStream

Throws:

java.io.IOException - from InputStream.read(byte[])

See Also:

HttpURLConnectionService.bufferStream(InputStream)

checkStatus

protected void checkStatus(HttpURLConnectionResponse response)
                    throws java.io.IOException

Throws:

java.io.IOException

convertMapToJSON

protected JsonObject convertMapToJSON(EdmEntityType entityType,
                                      java.util.Map<?,?> data)
                               throws java.io.IOException,
                                      EdmException

Throws:

java.io.IOException

EdmException

convertMapToJSONPayload

public byte[] convertMapToJSONPayload(java.lang.String entitySetName,
                                      java.util.Map<java.lang.String,java.lang.Object> data)
                               throws java.io.IOException

Convert an entity map into a JSON payload reading to be transfered.

Parameters:

entitySetName - <EntitySet Name> value found in the DefaultEntityContainer of the OData service.

data - Map containing the <Property/NavigationProperty Name> and value to be converted.

Returns:

byte array of the JSON payload.

Throws:

java.io.IOException - if an I/O error occurs.

See Also:

EdmLiteralKind#JSON

convertMapToJSONString

public java.lang.String convertMapToJSONString(EdmEntityType entityType,
                                               java.util.Map<java.lang.String,java.lang.Object> data)
                                        throws java.io.IOException

Convert an entity map into a JSON String.

Parameters:

entityType - EdmEntityType of the OData entity to be converted.

data - Map containing the <Parameter> Name and value to be converted.

Returns:

String of the JSON payload.

Throws:

java.io.IOException - if an I/O error occurs.

See Also:

EdmLiteralKind#JSON

convertMapToURIParameters

public java.util.Map<java.lang.String,java.lang.String> convertMapToURIParameters(java.lang.String functionImportName,
                                                                                  java.util.Map<java.lang.String,java.lang.Object> data)
                                                                           throws java.io.IOException

Build properly formated String value arguments for OData Function Import.

Parameters:

functionImportName - Attribute Name value found in the <FunctionImport> of the OData service.

data - Map containing the <Parameter> Name and value to be converted.

Returns:

Map containing the <Parameter> Name and converted value.

Throws:

java.io.IOException - if an I/O error occurs.

See Also:

EdmLiteralKind#URI

convertObjectToJsonElement

protected JsonElement convertObjectToJsonElement(java.lang.Object value,
                                                 EdmElement element)
                                          throws EdmException

Throws:

EdmException

convertObjectToJsonElement

protected JsonElement convertObjectToJsonElement(java.lang.Object value,
                                                 EdmNavigationProperty navigation)
                                          throws EdmException,
                                                 java.io.IOException

Throws:

EdmException

java.io.IOException

convertObjectToString

protected java.lang.String convertObjectToString(java.lang.Object value,
                                                 EdmLiteralKind literalKind,
                                                 EdmElement element)
                                          throws EdmException

Throws:

EdmException

createResourcePath

public java.lang.String createResourcePath(java.lang.String entitySetName,
                                           java.util.Map<java.lang.String,java.lang.Object> data)
                                    throws java.io.IOException

Create $batch part URL accessing entity by keys for Addressing Entries.

Parameters:

entitySetName - <EntitySet Name> value found in the DefaultEntityContainer of the OData service.

data - Map containing the <Property/NavigationProperty Name> and value to be converted.

Returns:

resource path

Throws:

java.io.IOException - if an I/O error occurs.

createURL

public java.net.URL createURL(java.lang.String resourcePath)

Create an absolute URL accessing the OData service at the resource path provided.

Parameters:

resourcePath - Resource path of the OData service.

Returns:

URL

createURL

public java.net.URL createURL(java.lang.String resourcePath,
                              java.util.Map<java.lang.String,java.lang.String> queryOptions)

Create an absolute URL accessing the OData service at the resourcePath provided using OData query options.

Parameters:

resourcePath - Resource path of the OData service.

queryOptions - OData Query String Options.

Returns:

URL

createURL

public java.net.URL createURL(java.lang.String resourcePath,
                              java.lang.String... queryOptions)

Create an absolute URL accessing the OData service at the resourcePath provided using OData query options.

Parameters:

resourcePath - Resource path of the OData service.

queryOptions - OData Query String Options.

Returns:

URL

decompressIfGZIP

protected byte[] decompressIfGZIP(byte[] payload)
                           throws java.io.IOException

Throws:

java.io.IOException

executeWithBasicAuth

protected HttpURLConnectionResponse executeWithBasicAuth(HttpURLConnectionRequest request)
                                                  throws java.io.IOException

Execute the request with Authorization : "Basic BASE64user:pass".
Using this method will create a new http session (unnecessary cost) on the yMKT side.
It is preferable to use executeWithRetry(HttpURLConnectionRequest) for most execution scenarios.

Parameters:

request - HttpURLConnectionRequest to execute.

Returns:

HttpURLConnectionResponse executed.

Throws:

java.io.IOException - If the HTTP request was not successful.

See Also:

URLConnection.setRequestProperty(java.lang.String, java.lang.String)

executeWithRetry

public HttpURLConnectionResponse executeWithRetry(HttpURLConnectionRequest request)
                                           throws java.io.IOException

Execute the request with "cookie" & "x-csrf-token".
If the existing session and/or token expired, those are refreshed and the request is re-tried.

Parameters:

request - HttpURLConnectionRequest to execute.

Returns:

HttpURLConnectionResponse executed.

Throws:

java.io.IOException - If the HTTP request was not successful.

filter

public ODataFilterBuilder filter(java.lang.String entitySetName)
                          throws java.io.IOException

Create an ODataFilterBuilder starting on the entitySetName provided.

Parameters:

entitySetName - <EntitySet Name> value found in the DefaultEntityContainer of the OData service.

Returns:

ODataFilterBuilder

Throws:

java.io.IOException - if an I/O error occurs.

getCustomQueryOptions

protected java.lang.StringBuilder getCustomQueryOptions()

getEdm

public Edm getEdm()
           throws java.io.IOException

Provide buffered olingo's Edm of the OData service.

Returns:

And instance of Edm $metadata for the service end point set by setRootUrl(String).
This resource is requested once for the entire lifecycle of the bean. This resource is also synchronized.
Each Thread has its own instance of Edm.

Throws:

java.io.IOException - If Edm could not be returned.

getEntitySet

public EdmEntitySet getEntitySet(java.lang.String entitySetName)
                          throws java.io.IOException

Simple wrapping with improved error handling of :
this.getEdm().getDefaultEntityContainer().getEntitySet(entitySetName);

Parameters:

entitySetName - <EntitySet Name> value found in the DefaultEntityContainer of the OData service.

Returns:

EdmEntitySet

Throws:

java.io.IOException - In case of communication errors.

getTokenCache

protected ODataService.TokenCache getTokenCache()
                                         throws java.io.IOException

Throws:

java.io.IOException

refreshToken

protected ODataService.TokenCache refreshToken(ODataService.TokenCache token)
                                        throws java.io.IOException

Throws:

java.io.IOException

setHttpURLConnectionService

public void setHttpURLConnectionService(HttpURLConnectionService httpURLConnectionService)

setODataConvertEdmService

public void setODataConvertEdmService(ODataConvertEdmService oDataConvertEdmService)

setPassword

public void setPassword(java.lang.String password)

Parameters:

password - Password used to login with setUser(String) at the setRootUrl(String) address.

setProxy

public void setProxy(java.lang.String proxy)
              throws java.net.MalformedURLException

Throws:

java.net.MalformedURLException

setRootUrl

public void setRootUrl(java.lang.String rootUrl)

Parameters:

rootUrl - OData service root URL.
Sample : https://localhost:50100/sap/opu/odata/sap/PROD_RECO_RUNTIME_SRV/
localhost should be replaced with the proper SAP Marketing server host name.

setSapClient

public void setSapClient(java.lang.String sapClient)

Parameters:

sapClient - the sapClient to set

setUser

public void setUser(java.lang.String user)

Parameters:

user - Username used to login at the setRootUrl(String) address.