Java SE

Getting Started

The following steps describe the general process for setting up a rule set. To simplify the instructions, it is assumed that the AMC UI and AMC Collector are running locally in the same process. For more advanced configurations, see the Advanced Management Console User's Guide.

1. Set up Java Usage Tracker.

   Java Usage Tracker is a tool that is available with the Java Runtime Environment (JRE). This tool logs information about the applications that are run and the JREs that are used on the system where Usage Tracker is enabled. The following list shows some of the information that is logged:

   • URL from which the application is loaded

   • Start method, such as Java Plug-in, Java Web Start, or JVM

   • JRE version used

   • IP address from which the application was started

   To enable Usage Tracker, create a file named usagetracker.properties and include the following property in the file:

   com.oracle.usagetracker.logToUDP = localhost:19870
   

   Note:

   The port number is the default port number used by Advanced Management Console. If you use a different port number, or choose to run the AMC Collector on a remote server, you must change the settings in the console.

   On the machine where the AMC UI and AMC Collector are running, place the usagetracker.properties file in the following location, depending on the platform:

   • On Windows, place the file in the <JRE directory>/lib/management directory for each JRE on the system.

   • On OS X, place the file in the lib/management directory under the directory used by the Java Plug-in, for example, /Library/Internet Plug-Ins/JavaAppletPlugin.plugin/Contents/Home/lib/management.

2. Run an application.

   After Usage Tracker is enabled, make sure that the AMC Collector is running. For these instructions, run the AMC UI and AMC Collector locally. Run one or more applets or Java Web Start applications locally. The application is registered by the AMC Collector and stored in the database. Go to the Apps view to see the information that is collected. It might take a few minutes after the application is started for the information to be shown in the table.

3. (Optional) Import a rule set.

   If you have an existing rule set, you can import the file into the Advanced Management Console tool. Go to the Rules view and click the Import Rule Set icon. In the Import Rule Set window, enter the path or browse to the location of the rule set that you want to import. This file can be an XML file or the DeploymentRuleSet.jar file. Provide a name for the rule set, and click Import.

   The imported rule set can be viewed in the Rule Sets table, and the imported rules can be viewed in the Rules table. The names given to the imported rules are based on the name that you gave the rule set. For example, if you import a rule set with three rules and name the rule set Accounting Apps, then the rules are named Accounting Apps rule #0, Accounting Apps rule #1, and Accounting Apps rule #2.

   Note:

   Rule set names and rule names are used only within the Advanced Management Console tool. The names are not part of the exported rule set.

4. Create rules.

   You can use the information from Usage Tracker to create a rule, or you can create your own rule starting with an empty rule.

   To create a rule based on the information from Usage Tracker, go to the Apps view. Select the application for which you want to create a rule, and click New Rule. In the Create Rule window, provide a name for the rule, and select the rule action. To edit the fields that are filled in with the information collected by Usage Tracker, click Manual Rule. Click Create to save the rule.

   To create your own rule from scratch from the Apps view, click Empty Rule. In the Create Rule window, fill in the information for the rule. Click Create to save the rule. You can also create your own rule from the Rules view by clicking the New Rule icon.

   Note:

   The rule name is used only within the Advanced Management Console tool. The name is not part of the exported rule set.

5. Create a rule set.

   After you create one or more rules, you can create a rule set. In the Rules view, select the rules that you want to include in the rule set from the Rules table, then click the New Rule Set icon. In the New Rule Set window, provide a name for the rule set and select Add selected rules from the rules table. Click Create to save the rule set.

   Note:

   The rule set name is used only within the Advanced Management Console tool. The name is not part of the exported rule set.

   To add additional rules to the rule set after it is created, select one or more rules that you want to add from the Rules table and click the Add Selected Rules to Rule Set icon. In the Add Rules to Rule Set window, select one or more rule sets that you want to add the rule to, and click Create to save the rule set. You can also add a rule to a rule set by dragging the rule from the Rules table to the rule set in the Rule Sets table.

   The order of the rules in the rule set matters. The first rule matched for an application is the rule that is used. To rearrange the rules, drag the rule in the Rule Sets table to where you want it.

   To remove a rule from a rule set, select the rule under the rule set in the Rule Sets table, and click the Delete Selected Items icon. The rule is removed from the rule set, but remains in the Rules table. If you select the rule in the Rules table and click the Delete Rule icon, the rule is removed from the table and all rule sets that contained the rule.

6. View the relationship between rules and applications.

   To verify that the rule set you created has the desired effect, you can view the actions that will be taken for applications based on the rules in the rule set. In the Rules view, select a rule set in the Rule Sets table, and click the Rule Set Relationships icon.

   The Rule Set Relationships window shows the applications that match the rules in the rule set, and indicates the action that will be taken for each application. Green indicates that the application is allowed to run. Red indicates that the application is blocked. Yellow indicates that default processing is used for the application. To see what applications are matched by each rule, select the rule under the rule set.

   You can also use the Apps view to determine which rule sets contain rules that match an application and the action that will be taken. Select an application and click Relationships. The Application Relationships window shows the rule sets that match. Expand the rule set to see which rules match the application and the action that will be taken. If an application matches more than one rule, the first rule that is matched determines the action taken.

7. Export the rule set.

   When you are finished setting up the rule set that you want to use, export the rule set to create the DeploymentRuleSet.jar file, which is the file to be installed on your users' systems.

   To create and sign the DeploymentRuleSet.jar file as part of the export process, you must first configure the JAR signing information. Open the File menu, select Settings, then select JAR Signing Settings to open the JAR Signing Settings window. Enter the information for your keystore and certificate, and click Export.

   To export the rule set, go to the Rules view. Select a rule set from the Rule Sets table, and click the Export Rule Set icon. In the Export Rule Set window, enter or browse to the directory in which you want to place the exported file. If you configured the JAR signing information, you can select Sign Rule Set and enter the required passwords. Click OK to export the rule set. If you provided signing information, the signed DeploymentRuleSet.jar file is created in the location that you specified. If you did not provide signing information or signing failed, the ruleset.xml file is created, and you must use this file to manually create and sign the DeploymentRuleSet.jar file.

Additional Resources

For more information, see the following documents:

• Advanced Management Console User's Guide

• Deployment Rule Set chapter in the Java Platform, Standard Edition Deployment Guide

• Java Usage Tracker Overview

Documentation Accessibility

For information about Oracle's commitment to accessibility, visit the Oracle Accessibility Program website at http://www.oracle.com/pls/topic/lookup?ctx=acc&id=docacc.

Access to Oracle Support

Oracle customers have access to electronic support through My Oracle Support. For information, visit http://www.oracle.com/pls/topic/lookup?ctx=acc&id=info or visit http://www.oracle.com/pls/topic/lookup?ctx=acc&id=trs if you are hearing impaired.