com.mulesoft.connector.netsuite.internal.citizen.metadata.util

Class CitizenMetadataUtils

java.lang.Object

com.mulesoft.connector.netsuite.internal.citizen.metadata.util.CitizenMetadataUtils

public final class CitizenMetadataUtils
extends Object

Field Summary

Fields

Modifier and Type	Field and Description
static String	WSDL_NETSUITE_WSDL

Method Summary

Modifier and Type	Method and Description
static org.mule.metadata.api.builder.ObjectFieldTypeBuilder	addField(org.mule.metadata.api.model.ObjectFieldType fieldType, org.mule.metadata.api.builder.ObjectTypeBuilder parentBuilder, List<String> attributes)
static void	addFormatToDateTimeField(org.mule.metadata.api.builder.ObjectFieldTypeBuilder fieldBuilder)
static void	copyKeyAttributes(org.mule.metadata.api.model.ObjectFieldType field, org.mule.metadata.api.builder.ObjectKeyBuilder key)
static org.mule.metadata.api.builder.ObjectTypeBuilder	copyValue(org.mule.metadata.api.model.ObjectFieldType field, org.mule.metadata.api.builder.ObjectFieldTypeBuilder newFieldBuilder)
static void	filterAndCopyKeyAttributes(org.mule.metadata.api.model.ObjectFieldType field, org.mule.metadata.api.builder.ObjectKeyBuilder key, List<String> attributes)
static void	filterMetadata(List<QName> path, org.mule.metadata.api.model.ObjectType originalType, Map<String,org.mule.metadata.api.builder.ObjectTypeBuilder> fieldTypeBuilderMap, Map<String,List<String>> attributeMap)
static String	getLabel(QName name)
static String	getMetadataFieldKey(String type, String separator, String scriptId, String internalId, String customListInternalId)
static Set<org.mule.runtime.api.metadata.MetadataKey>	getMetadataKeys()
static CitizenRecordEnum	getRecordEnum(String key) Gets a record enum from the string value
static org.mule.runtime.api.util.LazyValue<org.mule.metadata.xml.api.XmlTypeLoader>	getTypeLoader()
static String	getXmlAttribute(Node node, String key)
static org.mule.metadata.api.model.ObjectType	loadCitizenMetadata(org.mule.runtime.api.metadata.MetadataContext context, String key, Function<CitizenCustomFieldRefType,String> metadataKeyFunction, boolean fetchCustomFields, boolean fetchCustomLists, String qName)
static org.mule.metadata.api.model.MetadataType	loadMetaData(org.mule.runtime.api.metadata.MetadataContext context, String key, boolean fetchCustomLists) The method loads metadata model from service/operation metadata schema
static org.mule.metadata.api.model.MetadataType	loadMetaData(org.mule.runtime.api.metadata.MetadataContext context, String key, boolean fetchCustomFields, boolean fetchCustomLists)
static org.mule.metadata.api.model.MetadataType	loadMetaData(org.mule.runtime.api.metadata.MetadataContext context, String key, Function<CitizenCustomFieldRefType,String> metadataKeyFunction, boolean fetchCustomFields, boolean fetchCustomLists)
static org.mule.metadata.api.model.ObjectType	loadStaticMetadata(String qName) Loads static metadata from XSD files
static org.mule.metadata.api.model.ObjectFieldType	mapField(org.mule.metadata.api.model.ObjectFieldType field, org.mule.metadata.api.builder.ObjectTypeBuilder builder) Rebuilds metadata field to include a label defined by a local part of QName.
static void	mapKey(org.mule.metadata.api.builder.ObjectFieldTypeBuilder fieldTypeBuilder, org.mule.metadata.api.model.ObjectFieldType field, QName name) Performs a mapping for each metadata key.
static void	mapKey(org.mule.metadata.api.builder.ObjectFieldTypeBuilder fieldTypeBuilder, org.mule.metadata.api.model.ObjectFieldType field, QName name, boolean copyAttributes)
static void	mapKey(org.mule.metadata.api.builder.ObjectFieldTypeBuilder fieldTypeBuilder, org.mule.metadata.api.model.ObjectFieldType field, QName name, List<String> attributes)
static String[]	splitCustomRecordKey(String recordType, NetSuiteSoapConfig config)
static void	unwrapRootFieldAndMap(org.mule.runtime.api.metadata.MetadataContext context, org.mule.metadata.api.builder.ObjectTypeBuilder builder, org.mule.metadata.api.model.ObjectType objectType, String fieldName, String wsdlVersion, String recordData, Function<CitizenCustomFieldRefType,String> metadataKeyFunction, boolean fetchCustomFields, boolean fetchCustomLists) Retrieves the first field from the input objectType and replaces its name with the field name argument.

Methods inherited from class java.lang.Object

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

Field Detail

WSDL_NETSUITE_WSDL

public static final String WSDL_NETSUITE_WSDL

Method Detail

unwrapRootFieldAndMap

public static void unwrapRootFieldAndMap(org.mule.runtime.api.metadata.MetadataContext context,
                                         org.mule.metadata.api.builder.ObjectTypeBuilder builder,
                                         org.mule.metadata.api.model.ObjectType objectType,
                                         String fieldName,
                                         String wsdlVersion,
                                         String recordData,
                                         Function<CitizenCustomFieldRefType,String> metadataKeyFunction,
                                         boolean fetchCustomFields,
                                         boolean fetchCustomLists)
                                  throws org.mule.runtime.api.connection.ConnectionException,
                                         org.mule.runtime.api.metadata.MetadataResolvingException

Retrieves the first field from the input objectType and replaces its name with the field name argument. It is used to rename a root field, e.g. Customer, generated by WSDL parser to be inline with the actual data coming from Netsuite API, i.e. recordData. Furthermore, this method sets labels to local parts of the qualified names for all fields to improve readability.

Parameters:

context - metadata context

builder - metadata object builder

objectType - object to use as a transformation base

fieldName - a new field name

wsdlVersion - The wsdl version to use

recordData - the recordData for which we fetch the custom fields

metadataKeyFunction - the metadata key function to apply

fetchCustomFields - should fetch or not custom fields

fetchCustomLists - should fetch or not custom lists

Throws:

org.mule.runtime.api.connection.ConnectionException - if a connection exception occurs

org.mule.runtime.api.metadata.MetadataResolvingException - if something goes wrong while resolving the metadata

loadMetaData

public static org.mule.metadata.api.model.MetadataType loadMetaData(org.mule.runtime.api.metadata.MetadataContext context,
                                                                    String key,
                                                                    boolean fetchCustomLists)
                                                             throws org.mule.runtime.api.metadata.MetadataResolvingException

The method loads metadata model from service/operation metadata schema

Parameters:

context - a metadata context

key - field for which metadata model is required

fetchCustomLists - to fetch or not custom lists

Returns:

metadata for selected key

Throws:

org.mule.runtime.api.metadata.MetadataResolvingException - indicates problem either with xml loading or key value

loadMetaData

public static org.mule.metadata.api.model.MetadataType loadMetaData(org.mule.runtime.api.metadata.MetadataContext context,
                                                                    String key,
                                                                    boolean fetchCustomFields,
                                                                    boolean fetchCustomLists)
                                                             throws org.mule.runtime.api.metadata.MetadataResolvingException

Throws:

org.mule.runtime.api.metadata.MetadataResolvingException

loadMetaData

public static org.mule.metadata.api.model.MetadataType loadMetaData(org.mule.runtime.api.metadata.MetadataContext context,
                                                                    String key,
                                                                    Function<CitizenCustomFieldRefType,String> metadataKeyFunction,
                                                                    boolean fetchCustomFields,
                                                                    boolean fetchCustomLists)
                                                             throws org.mule.runtime.api.metadata.MetadataResolvingException

Throws:

org.mule.runtime.api.metadata.MetadataResolvingException

loadCitizenMetadata

public static org.mule.metadata.api.model.ObjectType loadCitizenMetadata(org.mule.runtime.api.metadata.MetadataContext context,
                                                                         String key,
                                                                         Function<CitizenCustomFieldRefType,String> metadataKeyFunction,
                                                                         boolean fetchCustomFields,
                                                                         boolean fetchCustomLists,
                                                                         String qName)
                                                                  throws org.mule.runtime.api.metadata.MetadataResolvingException,
                                                                         org.mule.runtime.api.connection.ConnectionException

Throws:

org.mule.runtime.api.metadata.MetadataResolvingException

org.mule.runtime.api.connection.ConnectionException

mapField

public static org.mule.metadata.api.model.ObjectFieldType mapField(org.mule.metadata.api.model.ObjectFieldType field,
                                                                   org.mule.metadata.api.builder.ObjectTypeBuilder builder)

Rebuilds metadata field to include a label defined by a local part of QName. If the field is of object type, it retrieves its child fields and call this method on each of them.

Parameters:

field - the object field type

builder - the object type builder

Returns:

the object field type

addFormatToDateTimeField

public static void addFormatToDateTimeField(org.mule.metadata.api.builder.ObjectFieldTypeBuilder fieldBuilder)

mapKey

public static void mapKey(org.mule.metadata.api.builder.ObjectFieldTypeBuilder fieldTypeBuilder,
                          org.mule.metadata.api.model.ObjectFieldType field,
                          QName name)

Performs a mapping for each metadata key. Adds a label based on the local part of QName.

Parameters:

fieldTypeBuilder - the fieldTypeBuilder to use

field - the field to use

name - the name to use

mapKey

public static void mapKey(org.mule.metadata.api.builder.ObjectFieldTypeBuilder fieldTypeBuilder,
                          org.mule.metadata.api.model.ObjectFieldType field,
                          QName name,
                          boolean copyAttributes)

mapKey

public static void mapKey(org.mule.metadata.api.builder.ObjectFieldTypeBuilder fieldTypeBuilder,
                          org.mule.metadata.api.model.ObjectFieldType field,
                          QName name,
                          List<String> attributes)
                   throws org.mule.runtime.api.metadata.MetadataResolvingException

Throws:

org.mule.runtime.api.metadata.MetadataResolvingException

getLabel

public static String getLabel(QName name)

copyKeyAttributes

public static void copyKeyAttributes(org.mule.metadata.api.model.ObjectFieldType field,
                                     org.mule.metadata.api.builder.ObjectKeyBuilder key)

filterAndCopyKeyAttributes

public static void filterAndCopyKeyAttributes(org.mule.metadata.api.model.ObjectFieldType field,
                                              org.mule.metadata.api.builder.ObjectKeyBuilder key,
                                              List<String> attributes)
                                       throws org.mule.runtime.api.metadata.MetadataResolvingException

Throws:

org.mule.runtime.api.metadata.MetadataResolvingException

getTypeLoader

public static org.mule.runtime.api.util.LazyValue<org.mule.metadata.xml.api.XmlTypeLoader> getTypeLoader()

addField

public static org.mule.metadata.api.builder.ObjectFieldTypeBuilder addField(org.mule.metadata.api.model.ObjectFieldType fieldType,
                                                                            org.mule.metadata.api.builder.ObjectTypeBuilder parentBuilder,
                                                                            List<String> attributes)
                                                                     throws org.mule.runtime.api.metadata.MetadataResolvingException

Throws:

org.mule.runtime.api.metadata.MetadataResolvingException

copyValue

public static org.mule.metadata.api.builder.ObjectTypeBuilder copyValue(org.mule.metadata.api.model.ObjectFieldType field,
                                                                        org.mule.metadata.api.builder.ObjectFieldTypeBuilder newFieldBuilder)

filterMetadata

public static void filterMetadata(List<QName> path,
                                  org.mule.metadata.api.model.ObjectType originalType,
                                  Map<String,org.mule.metadata.api.builder.ObjectTypeBuilder> fieldTypeBuilderMap,
                                  Map<String,List<String>> attributeMap)
                           throws org.mule.runtime.api.metadata.MetadataResolvingException

Throws:

org.mule.runtime.api.metadata.MetadataResolvingException

getMetadataFieldKey

public static String getMetadataFieldKey(String type,
                                         String separator,
                                         String scriptId,
                                         String internalId,
                                         String customListInternalId)

getXmlAttribute

public static String getXmlAttribute(Node node,
                                     String key)

splitCustomRecordKey

public static String[] splitCustomRecordKey(String recordType,
                                            NetSuiteSoapConfig config)

getMetadataKeys

public static Set<org.mule.runtime.api.metadata.MetadataKey> getMetadataKeys()

getRecordEnum

public static CitizenRecordEnum getRecordEnum(String key)

Gets a record enum from the string value

Parameters:

key - record enum string

Returns:

record enum

loadStaticMetadata

public static org.mule.metadata.api.model.ObjectType loadStaticMetadata(String qName)
                                                                 throws org.mule.runtime.api.metadata.MetadataResolvingException

Loads static metadata from XSD files

Parameters:

qName - qualified name of the XSD element

Returns:

metadata of the XSD element

Throws:

org.mule.runtime.api.metadata.MetadataResolvingException - in case no XSD element was found