Foglight 5.9.8 - Creating Actions Field Guide

Tchater maintenant avec le support

Configuring Environment Variables

There are two environment variables that you need to ensure are configured as follows:

•

ANT_HOME. Set it to point to the ANT installation on your computer.

•

FOGLIGHT_HOME. Set it to point to the Foglight® Management Server installation on your computer.

Creating the Directory Structure

Creating a directory structure involves extracting the contents of the ZIP file, Foglight_5.9.x_CreatingActionsFieldGuide.zip into a local directory. The following listing illustrates the directory structure that appears after extracting the contents of the ZIP file.

Table 1. Directory structure
File/Directory					Description
build.xml					ANT build file. For a sample file listing, see Appendix: Code Samples, build.xml .
build.properties					Configurable properties file that contains build-related information about the action name, package name, and the version number of the target cartridge. For a sample file listing, see Appendix: Code Samples, build.properties .
/src					Source directory containing a sample JavaTM code (see ExampleAction.java and ExampleActionMBean.java below).
	/com
		/sample
			/action
				ExampleAction.java	Implementation of the MBean interface. For a sample file listing, see Appendix: Code Samples, MBean Interface Implementation .
				ExampleActionMBean.java	MBean interface of the custom action. For a sample file listing, see Appendix: Code Samples, MBean Interface .

Configuring Build Properties

Configuring build properties ensures that the correct parameters are passed to the build process and that the resulting cartridge name and its version are properly set.

The build.properties file contains the following properties:

•

name. Specifies the action name. It is set to ExampleAction by default.


	IMPORTANT: If you choose to modify this property to a different value, at a later step you will need to edit the names of the MBean interface and its implementation class (ExampleActionMBean.java and ExampleAction.java, respectively). This includes editing the file names as well as the interface/class names in ExampleActionMBean.java and ExampleAction.java, respectively. For additional information, see Defining Custom Actions .The file names use the following syntax in order to follow ANT conventions for using variables:${implementation_class}.java${interface}Bean.java

•

package. Specifies the package name. It is set to com.sample.action in the example shown in the Foglight_5.9.x_CreatingActionsFieldGuide.zip file. If you intend to use a different package name and hierarchy, modify this property as required. Changing the package name requires additional modifications to the directory structure. For example, if you change the default package name to com.mycompany.myaction, rename the sample directory to mycompany and the action directory to myaction.


	IMPORTANT: At a later step, you will need to ensure that the correct package name is used in the package declaration at the beginning of the MBean interface and its implementation (ExampleActionMBean.java and ExampleAction.java by default). For more information about changing the package name in those files, see Defining Custom Actions .

•

version. Specifies the version of the target cartridge.

To configure build properties:


	NOTE: This procedure continues from Creating the Directory Structure .

Open the build.properties file for editing.

The file includes the following lines of code:

name=ExampleAction

package=com.sample.action

version=1.0

Edit the name, package, and version properties as required.

For example:

name=MyCustomAction

package=com.mycompany.myaction

version=2.0


	IMPORTANT: If you made changes to the package property, ensure that those changes are reflected in the directory structure. In the above example, modifying the entry com.sample.action to com.mycompany.myaction requires that you change the name of the sample directory to mycompany and the action directory to myaction.


	IMPORTANT: It is recommended that you increase the version number each time you package a new version of the action. Doing so ensures that the previous version is updated when you create and install the later version of the cartridge containing the custom action.


	TIP: Later on, you will need to ensure that the package name is also updated in the package declaration in the MBean interface and its implementation class. For more information, see Defining Custom Actions .

Save your changes and close the properties file.

Defining Custom Actions

A Foglight® action is comprised of two major components:

•

MBean interface (see Writing the MBean Interface )

•

MBean interface implementation (see Implementing the MBean Interface )

These action-specific components need to be saved in the src directory, where package_name follows the package hierarchy that is reflected in the directory structure. For example:

com/mycompany/someaction/SomeActionMBean.java (MBean interface)

com/mycompany/someaction/SomeAction.java (MBean interface implementation)

To find out more about the contents and structure of your working directory, see Creating the Directory Structure .