com.adobe.xfa.agent

Class Agent

java.lang.Object

com.adobe.xfa.agent.Agent

All Implemented Interfaces:

PacketHandler

Direct Known Subclasses:

FormProcessor

public abstract class Agent
extends Object
implements PacketHandler

A base class to represent XFA agents. Derived classes would embody significant XFA form processor capabilities.

Field Summary

Fields

Modifier and Type	Field and Description
static int	FAIL Completion code for failure.
static int	SUCCESS Completion code for success.
static int	SUCCESS_WITH_INFORMATION Completion code for success with information.
static int	SUCCESS_WITH_WARNINGS Completion code for success with warning.

Constructor Summary

Constructors

Constructor and Description
Agent() Instantiates an agent.

Method Summary

Modifier and Type	Method and Description
void	filterPackets(Node oPacket, Object data) An XFA PacketHandler to filter out empty nodes and/or user-specified nodes in an XDP file.
abstract String	getConfigSchemaName() Retrieve the configuration schema tag name where the config options are stored for this agent.
String	getPacketList() Get the list of XFA packets for the XDP.

Methods inherited from class java.lang.Object

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

Field Detail

SUCCESS

public static final int SUCCESS

Completion code for success.

See Also:

Constant Field Values

FAIL

public static final int FAIL

Completion code for failure.

See Also:

Constant Field Values

SUCCESS_WITH_WARNINGS

public static final int SUCCESS_WITH_WARNINGS

Completion code for success with warning.

See Also:

Constant Field Values

SUCCESS_WITH_INFORMATION

public static final int SUCCESS_WITH_INFORMATION

Completion code for success with information.

See Also:

Constant Field Values

Constructor Detail

Agent

public Agent()

Instantiates an agent.

Method Detail

filterPackets

public void filterPackets(Node oPacket,
                          Object data)

An XFA PacketHandler to filter out empty nodes and/or user-specified nodes in an XDP file. This method gets called for each packet in an XDP that is being loaded.

Specified by:

filterPackets in interface PacketHandler

getConfigSchemaName

public abstract String getConfigSchemaName()

Retrieve the configuration schema tag name where the config options are stored for this agent.

getPacketList

public String getPacketList()

Get the list of XFA packets for the XDP.