org.mule.extension.internal.utils

Class OlingoUtils

java.lang.Object

org.mule.extension.internal.utils.OlingoUtils

public class OlingoUtils
extends Object

Olingo related utility methods.

Constructor Summary

Constructors

Constructor and Description
OlingoUtils()

Method Summary

Modifier and Type	Method and Description
static Optional<org.apache.olingo.commons.api.edm.EdmEntitySet>	findEntitySetForEntity(org.apache.olingo.commons.api.edm.EdmEntityType entity, org.apache.olingo.commons.api.edm.Edm edm)
static String	formatODataValue(org.apache.olingo.commons.api.edm.EdmType type, Object o, boolean isCollection) Format the property value as a primitiveLiteral or an arrayOrObject literal.
static APIKitODataResponse	getAPIKitResponse(org.apache.olingo.server.api.ODataResponse response) Casts Olingo's ODataResponse to routing APIKitODataResponse.
static org.mule.runtime.api.util.MultiMap<String,String>	getCustomQueryOptions(List<org.apache.olingo.server.api.uri.queryoption.CustomQueryOption> customQueryOptions) Gets a map of custom query options name and values from Olingo's CustomQueryOption.
static Optional<org.apache.olingo.commons.api.edm.EdmEntitySet>	getEntitySet(org.apache.olingo.server.api.uri.UriInfo uriInfo) Given the URI details, it looks for the requested entity set.
static Optional<String>	getEntitySetName(org.apache.olingo.server.api.uri.UriInfo uriInfo) Given the URI details, it looks for the requested entity set name.
static List<String>	getEntityTypeFields(org.apache.olingo.commons.api.edm.EdmEntityType entityType) Given an entity type, gets the list of all its properties names.
static Map<String,String>	getEntityTypeKeysFromUriParameters(List<org.apache.olingo.server.api.uri.UriResource> uriResources) Given the URI resource segments, it returns a map of all the entity type keys and values provided.
static Optional<String>	getEntityTypeName(org.apache.olingo.commons.api.edm.EdmEntityType entityType) Gets the entity type's name if defined or an empty string otherwise.
static Optional<org.apache.olingo.commons.api.edm.EdmEntitySet>	getReturnEntitySet(org.apache.olingo.server.api.uri.UriInfo uriInfo, org.apache.olingo.commons.api.edm.Edm edm) Given the URI Info for a request tries to map the result to an EdmEntitySet.
static Optional<org.apache.olingo.commons.api.edm.EdmEntityType>	getReturnEntityType(ConfigurationRoutingKey routingKey, org.apache.olingo.commons.api.edm.Edm edm)
static Optional<org.apache.olingo.commons.api.edm.EdmEntityType>	getReturnEntityType(org.apache.olingo.server.api.uri.UriInfo uriInfo) Given the URI details, it looks for the requested entity type.
static RoutingKey<InputStream,ListenerRequestAttributes,SourceConfiguration>	getRoutingKey(org.apache.olingo.server.api.ODataRequest request, org.apache.olingo.server.api.uri.UriInfo uriInfo, SourceKind kind) Builds a ConfigurationRoutingKey based on the request method and the URI segment details.
static Map<String,String>	getSystemQueryOptions(List<org.apache.olingo.server.api.uri.queryoption.SystemQueryOption> systemQueryOptionOptions) Gets a map of system query options name and values from Olingo's SystemQueryOption.
static org.apache.olingo.server.api.uri.UriResource	getUriLastResourcePart(org.apache.olingo.server.api.uri.UriInfo uriInfo) Given the URI details, it returns the last URI resource.
static String	getUriPath(List<org.apache.olingo.server.api.uri.UriResource> parts) Builds a URI path out of the URI segments that are entity set or navigation types.
static org.mule.runtime.extension.api.runtime.operation.Result<InputStream,RouteOutputAttributes>	toResult(org.apache.olingo.server.api.ODataResponse response) Converts routing response to a runtime operation result.

Methods inherited from class java.lang.Object

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

Constructor Detail

OlingoUtils

public OlingoUtils()

Method Detail

getAPIKitResponse

public static APIKitODataResponse getAPIKitResponse(org.apache.olingo.server.api.ODataResponse response)

Casts Olingo's ODataResponse to routing APIKitODataResponse.

Parameters:

response -

Returns:

toResult

public static org.mule.runtime.extension.api.runtime.operation.Result<InputStream,RouteOutputAttributes> toResult(org.apache.olingo.server.api.ODataResponse response)

Converts routing response to a runtime operation result.

Parameters:

response -

Returns:

getReturnEntityType

public static Optional<org.apache.olingo.commons.api.edm.EdmEntityType> getReturnEntityType(org.apache.olingo.server.api.uri.UriInfo uriInfo)

Given the URI details, it looks for the requested entity type.

Parameters:

uriInfo -

Returns:

getReturnEntitySet

public static Optional<org.apache.olingo.commons.api.edm.EdmEntitySet> getReturnEntitySet(org.apache.olingo.server.api.uri.UriInfo uriInfo,
                                                                                          org.apache.olingo.commons.api.edm.Edm edm)

Given the URI Info for a request tries to map the result to an EdmEntitySet.

Parameters:

uriInfo - The URI information for the request.

edm - The EDM of the service.

Returns:

The EdmEntitySet of the requested entity wrapped on an Optional (if found). An empty Optional otherwise.

findEntitySetForEntity

public static Optional<org.apache.olingo.commons.api.edm.EdmEntitySet> findEntitySetForEntity(org.apache.olingo.commons.api.edm.EdmEntityType entity,
                                                                                              org.apache.olingo.commons.api.edm.Edm edm)

getUriLastResourcePart

public static org.apache.olingo.server.api.uri.UriResource getUriLastResourcePart(org.apache.olingo.server.api.uri.UriInfo uriInfo)

Given the URI details, it returns the last URI resource.

Parameters:

uriInfo -

Returns:

getEntitySetName

public static Optional<String> getEntitySetName(org.apache.olingo.server.api.uri.UriInfo uriInfo)

Given the URI details, it looks for the requested entity set name.

Parameters:

uriInfo -

Returns:

getEntitySet

public static Optional<org.apache.olingo.commons.api.edm.EdmEntitySet> getEntitySet(org.apache.olingo.server.api.uri.UriInfo uriInfo)

Given the URI details, it looks for the requested entity set.

Parameters:

uriInfo -

Returns:

getEntityTypeKeysFromUriParameters

public static Map<String,String> getEntityTypeKeysFromUriParameters(List<org.apache.olingo.server.api.uri.UriResource> uriResources)

Given the URI resource segments, it returns a map of all the entity type keys and values provided.

Parameters:

uriResources -

Returns:

getEntityTypeFields

public static List<String> getEntityTypeFields(org.apache.olingo.commons.api.edm.EdmEntityType entityType)

Given an entity type, gets the list of all its properties names.

Parameters:

entityType -

Returns:

getUriPath

public static String getUriPath(List<org.apache.olingo.server.api.uri.UriResource> parts)

Builds a URI path out of the URI segments that are entity set or navigation types.

Parameters:

parts -

Returns:

getRoutingKey

public static RoutingKey<InputStream,ListenerRequestAttributes,SourceConfiguration> getRoutingKey(org.apache.olingo.server.api.ODataRequest request,
                                                                                                  org.apache.olingo.server.api.uri.UriInfo uriInfo,
                                                                                                  SourceKind kind)

Builds a ConfigurationRoutingKey based on the request method and the URI segment details.

Parameters:

request - Request to be routed

uriInfo - UriInfo for that request

kind - Kind of request endpoint (single entity, entity collection, etc)

Returns:

Routing key for the given request

getSystemQueryOptions

public static Map<String,String> getSystemQueryOptions(List<org.apache.olingo.server.api.uri.queryoption.SystemQueryOption> systemQueryOptionOptions)

Gets a map of system query options name and values from Olingo's SystemQueryOption.

The initial dollar sign in option names is removed.

Parameters:

systemQueryOptionOptions - list of Olingo's SystemQueryOption

Returns:

Map of system query option names without the initial dollar sign and values, or empty map

getCustomQueryOptions

public static org.mule.runtime.api.util.MultiMap<String,String> getCustomQueryOptions(List<org.apache.olingo.server.api.uri.queryoption.CustomQueryOption> customQueryOptions)

Gets a map of custom query options name and values from Olingo's CustomQueryOption.

Parameters:

customQueryOptions - list of CustomQueryOption

Returns:

Map of custom query option names and values, or empty map

getEntityTypeName

public static Optional<String> getEntityTypeName(org.apache.olingo.commons.api.edm.EdmEntityType entityType)

Gets the entity type's name if defined or an empty string otherwise.

Parameters:

entityType - EDM entity type

Returns:

entity type's name

getReturnEntityType

public static Optional<org.apache.olingo.commons.api.edm.EdmEntityType> getReturnEntityType(ConfigurationRoutingKey routingKey,
                                                                                            org.apache.olingo.commons.api.edm.Edm edm)

formatODataValue

public static String formatODataValue(org.apache.olingo.commons.api.edm.EdmType type,
                                      Object o,
                                      boolean isCollection)

Format the property value as a primitiveLiteral or an arrayOrObject literal. The value to format is expected to come from a JSON deserialization. This code will assume a limited amount of representations for the values of each type.

Parameters:

type - The desired type to format the value to

o - The value to format.

Returns:

A formatted string that encodes the given value

Throws:

IllegalArgumentException - if the (type, value) combination passed as argument is unsupported.