Commands for adapters

When we call the wladm Ant task, we can include various commands for adapters.

The list-adapters command

The list-adapters command returns a list of the adapters deployed for a given runtime. It has the following attributes:

Attribute	Description	Required	Default
runtime	Name of the runtime web application / MobileFirst project.	Yes	Not available
output	Name of output file.	No
outputproperty	Name of Ant property for the output.	No

Example:

<list-adapters runtime="worklight"/>

This command is based on the Adapters (GET) REST service.

The deploy-adapter command

The deploy-adapter command deploys an adapter in a runtime. It has the following attributes:

Attribute	Description	Required	Default
runtime	Name of the runtime web application / MobileFirst project.	Yes	Not available
file	Binary adapter file (.adapter).	Yes	Not available

Example:

<deploy-adapter runtime="worklight" file="MyAdapter.adapter"/>

This command is based on the Adapter (POST) REST service.

The show-adapter command

The show-adapter command shows details about an adapter. It has the following attributes:

Attribute	Description	Required	Default
runtime	Name of the runtime web application / MobileFirst project.	Yes	Not available
name	Name of an adapter.	Yes	Not available
output	Name of output file.	No
outputproperty	Name of Ant property for the output.	No

Example:

<show-adapter runtime="worklight" name="MyAdapter"/>

This command is based on the Adapter (GET) REST service.

The delete-adapter command

The delete-adapter command removes (undeploys) an adapter from a runtime. It has the following attributes:

Attribute	Description	Required	Default
runtime	Name of the runtime web application / MobileFirst project.	Yes	Not available
name	Name of an adapter.	Yes	Not available

Example:

<delete-adapter runtime="worklight" name="MyAdapter"/>

This command is based on the Adapter (DELETE) REST service.

The adapter command group

The adapter command group has the following attributes:

Attribute	Description	Required	Default
runtime	Name of the runtime web application / MobileFirst project.	Yes	Not available
name	Name of an adapter.	Yes	Not available

It supports the following elements:

Element	Description	Count
get-binary	Gets the binary data.	0..∞

The get-binary command

The get-binary command inside an <adapter> element returns the binary adapter file. It has the following attributes:

Attribute	Description	Required	Default
tofile	Name of the output file.	Yes	Not available

Example:

<adapter runtime="worklight" name="MyAdapter">
  <get-binary tofile="/tmp/MyAdapter.adapter"/>
</adapter>

This command is based on the Adapter Binary (GET, HEAD) REST service.

Parent topic: wladm Ant task