existingCode

Map

all

The existingCode context contains the protected code snippets collected from the input file, if an input directory had been specified. Otherwise, the Hashtable is empty. The key for the Hashtable entries is built using the form:  <class>[::<method>].

agenUtils

AgenUtils

all

The agenUtils context provides various utility functions supporting the analysis of MIB content. For example, retrieving MIB objects by name and getting the effective syntax of an OBJECT TYPE.
In addition, it provides access to the properties defined for a code generation project.

agenStringUtils

AgenStringUtils

all

The agenStringUtils context provides string utility functions to search and replace strings using regular expressions.

stringUtils

StringUtils

all

Additional string utilities provided by Velocity, for example reading a file into a String object.

agentCapabilities

IAgentCapabilities

all

This context is only available if a AGENT-CAPABILITIES statement has been selected for this project in the corresponding project wizard. It provides access to the selected statement's SMI definition.

module

IModule

2,3^* 

The module context provides access to the target MIB module of this code generation job.

moduleName

String

2,3* 

The name of the target MIB module (e.g. SNMPv2-MIB).

moduleNameNoHyphen

String

2,3* 

The name of the target MIB with hyphen "-" replaced by underscores "_" (e.g. SNMPv2_MIB).

context

String

2,3

The context name string generated by the selection template. This can be any string that must not contain ";", ",", and "=" characters. In case of jobs of type 2, the context name string equals the moduleName.

contextNoHyphen

String

2,3

The context name string generated by the selection template where hyphen characters ("-") are replaced by underscores ("_").

contextModules

List

2,3

The contextModules Velocity context provides access to all IModule instances selected for the current file context. In case of a job of type "once per module", the contents of this Velocity context is the same as modules.

contextModuleNames

List

2,3

The contextModules Velocity context provides access to all MIB module names selected for the current file context. In case of a job of type "once per module", the contents of this Velocity context is the same as moduleNames.

contextObjects

List

3

The contextObjects Velocity context provides access to all IObject instances selected for the current file context.

scalars

List

2,3

The scalars context provides access to all scalar OBJECT-TYPE definitions of module.

tables

List

2,3

The tables context provides access to all table objects defined in module. Table objects are those OBJECT-TYPE definitions that have an INDEX clause. The objects are ordered by their object identifier (OID)

tablesByDependencies

List

2,3

The tablesByDependencies context provides access to the same table objects as the context tables, but in different order. Tables with an INDEX clause „AUGMENTS“ will succeed tables which those tables depend on. Thr remaining tables are sorted by their object identifier (OID).

columns

Map

2,3

The columns context provides access to all columnar OBJECT-TYPE definitions. The keys of the Map are the table objects in the table context Vector. By calling the get method of the columns Map all columnar objects of the corresponding table are returned as a List of IObjectType instances.

indexes

Map

2,3

The indexes context provides access to the index objects of table objects. The keys of the Map are the table objects in the table context List. By calling the get method of the columns Map all index objects of the corresponding table are returned as a List of IObjectType instances.

notifications 

List

2,3

The notifications context provides access to all trap and notification objects defined in module. Notifications are TRAP-TYPE (SMIv1) or NOTIFICATION-TYPE (SMIv2) definitions.

identities

List

2,3

The identities context provides access to all OBJECT-IDENTITY definitions defined in module. This list is empty for SMIv1 MIB modules.

fileName

String

all^†

The output (file name) generated by the file name generation template. Consequently, this context is not available in the file name generation template itself.

fileNameNoDot

String

all†

Same as above but dots "." in the filename are replaced by underscores "_".

contexts

List

3

All contexts generated by the selection template. For each of the context string in this vector there will be an output file generated. To get the index of the current context within a code generation template, the $contexts.indexOf($context) method can be used.

modules

List

1,3

The modules context provides access to all MIB modules (IModule instances) for that program code should be generated.

moduleNames

List

1,3

The moduleNames context provides access to all MIB module names (String instances) of the target modules.

//

|:AgenPro|=
|AgenPro:|

//|:AgenPro|=_helloWorld

String msg = "Hello World";
System.out.println(msg);

//|AgenPro:|

//

--AgentGen BEGIN=
--AgentGen END

//--AgentGen BEGIN=_helloWorld

String msg = "Hello World";
System.out.println(msg);

//--AgentGen END

/*

*/

|:AgenPro|=
|AgenPro:|

/*|:AgenPro|=_helloWorld*/

String msg = "Hello World";
System.out.println(msg);

/*|AgenPro:|*/

<!--

-->

|:AgenPro|=
|AgenPro:|

<!--|:AgenPro|=pom.xml-->#if ($existingCode.get("pom.xml"))

$existingCode.get("pom.xml")

#else

<project></project>

#end

<!--|AgenPro:|-->

#--

--#

|:AgenPro|=
|AgenPro:|

#--|:AgenPro|=agen.properties--#

#if ($existingCode.
get("agen.properties"))

$existingCode.get("agen.properties")

#else

snmp4j.agent.cfg.contexts=

#end

#--|AgenPro:|--#