Adapter Development Kit 9.12 | webMethods Adapter Development Kit Documentation | webMethods Adapter Development Kit Installation and User’s Documentation | Using the Services for Managing Namespace Nodes | Connection Services | wm.art.dev.connection:fetchConnectionMetadata
 
wm.art.dev.connection:fetchConnectionMetadata
This service fetches the adapter-specific properties.
This service receives an adapter type name and a fully qualified connection factory class path, queries the connection factory and returns the metadata for all properties supported by the connections of that type.
Input Parameters
Name
Description
adapterTypeName
String. Required. Name of adapter. Same as the value returned by WmAdapter.getAdapterName method.
connectionFactoryType
String. Required. Fully qualified path of the connection factory implementation class.
Output Parameters
The service returns a connectionProperties array containing all metadata associated with each of the connection properties. You can use the following attributes to configure a connection node: systemName, parameterType, defaultValue, and isRequired.
Name
Description
displayName
String. Required. Adapter specific property name. Same as the value returned by WmDescriptor.getDisplayName method.
description
String. Required. Adapter specific property description. Same as the value returned by WmDescriptor.getDescription method.
templateURL
String. Required. URL of online help page for the connection.
connectionProperties[n]
IData[]. Required. An n-dimensioned array of properties.
systemName
String. Required. Adapter specific internal property name.
displayName
String. Required. External property name displayed.
description
String. Required. Description of the property.
parameterType
String. Required. Data type of the property.
*The following Java data types are supported for connections: char, short, int, long, float, double, boolean, java.lang.String, java.lang.Character, java.lang.Short, java.lang.Integer, java.lang.Long, java.lang.Float, java.lang.Double, java.lang.Boolean.
*Arrays are not supported.
groupURL
String. URL of the group's help page.
groupName
String. Name of the group to which the property belongs.
tupleName
String. Name of the tuple to which the property belongs.
treeName
String. Name of the tree to which the property belongs.
treeDelimiter
String. Delimiter character used in the tree.
resourceDomain
String. Resource domain name to which the property belongs.
defaultValue
String. Default property value.
isRequired
Boolean. Specifies whether the property is required.
isHidden
Boolean. Specifies whether the property is displayable.
isReadOnly
Boolean. Specifies whether the property can be modified.
isFill
Boolean. Specifies whether the editors must pre-fill the property.
isPassword
Boolean. Specifies whether the property is a password.
isMultiline
Boolean. Specifies whether the property traverses multiple lines.
isKey
Boolean. Specifies whether the property is a key field.
minSeqLength
String. Lower bound of the sequence.
minStringLength
String. Minimum string length.
maxStringLength
String. Maximum string length.
useParam
String. Specifies whether the property is available for use.
Example
For example, a Java client might invoke this service as follows:
IData pipeline = IDataFactory.create();
IDataCursor pipeCursor = pipeline.getCursor();
pipeCursor.insertAfter("adapterTypeName",
"FooAdapter");
pipeCursor.insertAfter("connectionFactoryType",
"com.wm.adapters.FooConnFactory");
ExtendedConnectionUtils.fetchConnectionMetadata(pipeline);
.
.
.