com.sap.cloud.server.odata.csdl

Class CsdlParser

java.lang.Object

com.sap.cloud.server.odata.csdl.CsdlParser

public class CsdlParser
extends java.lang.Object

Parser for Open Data Protocol (OData) service metadata documents (CSDL). A new parser should be created for each CsdlParser.parse call. A parser should not be shared by multiple threads.

Constructor Summary

Constructors

Constructor and Description
CsdlParser()

Method Summary

Modifier and Type	Method and Description
CsdlFetcher	getCsdlFetcher() Return (nullable) A callback which will be used to resolve any CSDL Reference that is encountered during parsing, in order to fetch the referenced metadata.
int	getCsdlOptions() Return a bitmask of CSDL parser options.
boolean	getExcludeServerOnly() Return skip server-only elements in the csdl xml to be parsed and added to CsdlDocument.
XmlElementList	getIncludeElements() Return extra CSDL child elements for main schema (e.g.
XmlElementList	getIncludeReferences() Return supplementary edmx:Reference elements.
DataSchemaList	getIncludeSchemas() Return pre-parsed schemas.
boolean	getLogErrors() Return should parser errors be logged before they are thrown?
boolean	getLogWarnings() Return should parser warnings be logged?
java.lang.String	getServiceName() Return (nullable) Data service name.
boolean	getTraceRequests() Return should parsing requests be traced?
void	includeNamespace(java.lang.String ns) See includeNamespace(String, String).
void	includeNamespace(java.lang.String ns, java.lang.String alias) Add to CsdlParser.includeReferences a supplementary CSDL edmx:Reference (with embedded edmx:Include).
void	includeReference(java.lang.String uri, java.lang.String ns) See includeReference(String, String, String).
void	includeReference(java.lang.String uri, java.lang.String ns, java.lang.String alias) Add to CsdlParser.includeReferences a supplementary CSDL edmx:Reference (with embedded edmx:Include).
void	includeSchema(DataSchema schema) Include the definitions of a pre-parsed schema into the document to be parsed.
CsdlDocument	parse(java.lang.String text, java.lang.String url) Parse the text of an Open Data Protocol (OData) service metadata (CSDL) document.
CsdlDocument	parseInProxy(java.lang.String text, java.lang.String url) For internal use only.
void	setCsdlFetcher(CsdlFetcher value) Set a callback which will be used to resolve any CSDL Reference that is encountered during parsing, in order to fetch the referenced metadata.
void	setCsdlOptions(int value) Set a bitmask of CSDL parser options.
void	setExcludeServerOnly(boolean value) Set skip server-only elements in the csdl xml to be parsed and added to CsdlDocument.
void	setIncludeElements(XmlElementList value) Set extra CSDL child elements for main schema (e.g.
void	setIncludeReferences(XmlElementList value) Set supplementary edmx:Reference elements.
void	setIncludeSchemas(DataSchemaList value) Set pre-parsed schemas.
void	setLogErrors(boolean value) Set should parser errors be logged before they are thrown?
void	setLogWarnings(boolean value) Set should parser warnings be logged?
void	setServiceName(java.lang.String value) Set data service name.
void	setTraceRequests(boolean value) Set should parsing requests be traced?

Methods inherited from class java.lang.Object

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

Constructor Detail

CsdlParser

public CsdlParser()

Method Detail

getCsdlFetcher

public CsdlFetcher getCsdlFetcher()

Return (nullable) A callback which will be used to resolve any CSDL Reference that is encountered during parsing, in order to fetch the referenced metadata. Must be set before CsdlParser.parse is called, or else any CSDL Reference that is encountered during parsing will result in a CsdlException being thrown.

Returns:

(nullable) A callback which will be used to resolve any CSDL Reference that is encountered during parsing, in order to fetch the referenced metadata.

getCsdlOptions

public int getCsdlOptions()

Return a bitmask of CSDL parser options.

See Also:

CsdlOption.

Returns:

A bitmask of CSDL parser options.

getExcludeServerOnly

public boolean getExcludeServerOnly()

Return skip server-only elements in the csdl xml to be parsed and added to CsdlDocument. An element is server-only if it contains the child element.

Returns:

Skip server-only elements in the csdl xml to be parsed and added to CsdlDocument.

getIncludeElements

public XmlElementList getIncludeElements()

Return extra CSDL child elements for main schema (e.g. external annotations).

Returns:

Extra CSDL child elements for main schema (e.g. external annotations).

getIncludeReferences

public XmlElementList getIncludeReferences()

Return supplementary edmx:Reference elements. Defaults to an empty list.

See Also:

CsdlParser.includeNamespace, CsdlParser.includeReference.

Returns:

Supplementary edmx:Reference elements. Defaults to an empty list.

getIncludeSchemas

public DataSchemaList getIncludeSchemas()

Return pre-parsed schemas. Defaults to an empty list.

See Also:

CsdlParser.includeSchema.

Returns:

Pre-parsed schemas. Defaults to an empty list.

getLogErrors

public boolean getLogErrors()

Return should parser errors be logged before they are thrown?

Returns:

Should parser errors be logged before they are thrown?

getLogWarnings

public boolean getLogWarnings()

Return should parser warnings be logged?

Returns:

Should parser warnings be logged?

getServiceName

public java.lang.String getServiceName()

Return (nullable) Data service name. If data metrics are required, this property should be set before CsdlParser.parse is called, so that all DataMethod and EntitySet in the parsed document will have appropriately named metrics.

Returns:

(nullable) Data service name. If data metrics are required, this property should be set before CsdlParser.parse is called,

getTraceRequests

public boolean getTraceRequests()

Return should parsing requests be traced?

Returns:

Should parsing requests be traced?

includeNamespace

public void includeNamespace(java.lang.String ns)

See includeNamespace(String, String).

Parameters:

ns - Ns parameter.

includeNamespace

public void includeNamespace(java.lang.String ns,
                             java.lang.String alias)

Add to CsdlParser.includeReferences a supplementary CSDL edmx:Reference (with embedded edmx:Include). Call this function before CsdlParser.parse if the document to be parsed is missing expected edmx:Reference elements for well-known schemas. This function generates an edmx:Reference with a fabricated "Uri" (with value "include/ns.xml"). It can be used together with a CsdlParser.csdlFetcher which resolves documents either by fabricated location (include/ns.xml) or by namespace (ns).

See Also:

CsdlParser.csdlOptions, CsdlParser.includeReference.

Parameters:

ns - For the "Namespace" attribute of "edmx:Include".

alias - (nullable) For the "Alias" attribute of "edmx:Include".

includeReference

public void includeReference(java.lang.String uri,
                             java.lang.String ns)

See includeReference(String, String, String).

Parameters:

uri - Uri parameter.

ns - Ns parameter.

includeReference

public void includeReference(java.lang.String uri,
                             java.lang.String ns,
                             java.lang.String alias)

Add to CsdlParser.includeReferences a supplementary CSDL edmx:Reference (with embedded edmx:Include). Call this function before CsdlParser.parse if the document to be parsed is missing expected edmx:Reference elements for well-known schemas. This function generates an edmx:Reference with a caller-specified "Uri". It can be used together with a CsdlParser.csdlFetcher which resolves documents either by caller-specified location (uri) or by namespace (ns).

See Also:

CsdlParser.csdlOptions, CsdlParser.includeNamespace.

Parameters:

uri - For the "Uri" attribute of "edmx:Reference".

ns - For the "Namespace" attribute of "edmx:Include".

alias - (nullable) For the "Alias" attribute of "edmx:Include".

includeSchema

public void includeSchema(DataSchema schema)

Include the definitions of a pre-parsed schema into the document to be parsed. Call this function before CsdlParser.parse if the document to be parsed has an edmx:Reference element for a well-known schema, and the pre-parsed schema should be used rather than loading the referenced schema over the network.

Parameters:

schema - Pre-parsed schema.

parse

public CsdlDocument parse(java.lang.String text,
                          java.lang.String url)

Parse the text of an Open Data Protocol (OData) service metadata (CSDL) document. Supports OData versions 1.0 to 4.0.

Parameters:

text - Text of the service metadata document.

url - URL of the service metadata document. Used for resolving relative URLs if any CSDL Reference is encountered during parsing. May also be included in exception messages.

Returns:

Parsed CSDL document.

parseInProxy

public CsdlDocument parseInProxy(java.lang.String text,
                                 java.lang.String url)

For internal use only.

Parameters:

text - (internal use only)

url - (internal use only)

Returns:

(internal use only)

setCsdlFetcher

public void setCsdlFetcher(CsdlFetcher value)

Set a callback which will be used to resolve any CSDL Reference that is encountered during parsing, in order to fetch the referenced metadata. Must be set before CsdlParser.parse is called, or else any CSDL Reference that is encountered during parsing will result in a CsdlException being thrown.

Parameters:

value - A callback which will be used to resolve any CSDL Reference that is encountered during parsing, in order to fetch the referenced metadata.

setCsdlOptions

public void setCsdlOptions(int value)

Set a bitmask of CSDL parser options.

See Also:

CsdlOption.

Parameters:

value - A bitmask of CSDL parser options.

setExcludeServerOnly

public void setExcludeServerOnly(boolean value)

Set skip server-only elements in the csdl xml to be parsed and added to CsdlDocument. An element is server-only if it contains the child element.

Parameters:

value - Skip server-only elements in the csdl xml to be parsed and added to CsdlDocument.

setIncludeElements

public void setIncludeElements(XmlElementList value)

Set extra CSDL child elements for main schema (e.g. external annotations).

Parameters:

value - Extra CSDL child elements for main schema (e.g. external annotations).

setIncludeReferences

public void setIncludeReferences(XmlElementList value)

Set supplementary edmx:Reference elements. Defaults to an empty list.

See Also:

CsdlParser.includeNamespace, CsdlParser.includeReference.

Parameters:

value - Supplementary edmx:Reference elements. Defaults to an empty list.

setIncludeSchemas

public void setIncludeSchemas(DataSchemaList value)

Set pre-parsed schemas. Defaults to an empty list.

See Also:

CsdlParser.includeSchema.

Parameters:

value - Pre-parsed schemas. Defaults to an empty list.

setLogErrors

public void setLogErrors(boolean value)

Set should parser errors be logged before they are thrown?

Parameters:

value - Should parser errors be logged before they are thrown?

setLogWarnings

public void setLogWarnings(boolean value)

Set should parser warnings be logged?

Parameters:

value - Should parser warnings be logged?

setServiceName

public void setServiceName(java.lang.String value)

Set data service name. If data metrics are required, this property should be set before CsdlParser.parse is called, so that all DataMethod and EntitySet in the parsed document will have appropriately named metrics.

Parameters:

value - Data service name. If data metrics are required, this property should be set before CsdlParser.parse is called,

setTraceRequests

public void setTraceRequests(boolean value)

Set should parsing requests be traced?

Parameters:

value - Should parsing requests be traced?