JGDMS Project 3.0-SNAPSHOT API Documentation

Skip navigation links
A C E F G H I J L M O P R S T U W 

A

AbstractPlugin - Class in org.apache.river.tool.envcheck
Base class for plugins providing rudimentary I18N support
AbstractPlugin() - Constructor for class org.apache.river.tool.envcheck.AbstractPlugin
Initialize the base class by obtaining the resource bundle associated with the instantiated class.
AllPermissionsTask() - Constructor for class org.apache.river.tool.envcheck.plugins.CheckPolicy.AllPermissionsTask
 

C

CheckActivationSystem - Class in org.apache.river.tool.envcheck.plugins
Plugin which checks the liveness of the activation system.
CheckActivationSystem() - Constructor for class org.apache.river.tool.envcheck.plugins.CheckActivationSystem
 
CheckActivationSystem.CheckActivationTask - Class in org.apache.river.tool.envcheck.plugins
subtask to perform the actual check
CheckActivationTask() - Constructor for class org.apache.river.tool.envcheck.plugins.CheckActivationSystem.CheckActivationTask
 
CheckCodebase - Class in org.apache.river.tool.envcheck.plugins
Plugin which performs a variety of checks on codebase components.
CheckCodebase() - Constructor for class org.apache.river.tool.envcheck.plugins.CheckCodebase
 
CheckCodebase.GetURLTask - Class in org.apache.river.tool.envcheck.plugins
 
CheckConfig - Class in org.apache.river.tool.envcheck.plugins
Check the configuration files for services identified by service descriptors in the service starter configuration.
CheckConfig() - Constructor for class org.apache.river.tool.envcheck.plugins.CheckConfig
 
CheckConfig.ConfigTask - Class in org.apache.river.tool.envcheck.plugins
Subtask to load the configuration
CheckConfig.GetGroupsTask - Class in org.apache.river.tool.envcheck.plugins
Subtask which obtains all initialLookupGroups entries and returns them in an array of GroupInfo objects.
CheckDirTask() - Constructor for class org.apache.river.tool.envcheck.plugins.CheckPersistence.CheckDirTask
 
checkFile(String, String) - Method in class org.apache.river.tool.envcheck.EnvCheck
Check for the existence of a file identified by a property supplied on the command line being analyzed.
checkFileName(String, String) - Static method in class org.apache.river.tool.envcheck.Util
Validate the accessibility of the non-directory file identified by name.
CheckJDK1_4 - Class in org.apache.river.tool.envcheck.plugins
Check that the Java platform is at least version 1.4.
CheckJDK1_4() - Constructor for class org.apache.river.tool.envcheck.plugins.CheckJDK1_4
 
CheckJDK1_4.JDK1_4Task - Class in org.apache.river.tool.envcheck.plugins
Subtask to check the VM version.
CheckJSKPlatform - Class in org.apache.river.tool.envcheck.plugins
Check whether jsk-platform.jar is in the classpath of the command-line being analyzed, and if the activation group if there is one.
CheckJSKPlatform() - Constructor for class org.apache.river.tool.envcheck.plugins.CheckJSKPlatform
 
CheckJSKPolicy - Class in org.apache.river.tool.envcheck.plugins
Check whether jsk-policy.jar is installed in the extensions directory.
CheckJSKPolicy() - Constructor for class org.apache.river.tool.envcheck.plugins.CheckJSKPolicy
 
CheckJSKPolicy.JSKPolicyTask - Class in org.apache.river.tool.envcheck.plugins
The task which checks the group VM.
CheckJsseProps - Class in org.apache.river.tool.envcheck.plugins
Checks whether various security oriented configuration files exist and are accessible.
CheckJsseProps() - Constructor for class org.apache.river.tool.envcheck.plugins.CheckJsseProps
 
CheckJsseProps.CheckLoginConfigInit - Class in org.apache.river.tool.envcheck.plugins
Checks the existence and accessibility of the login configuration.
CheckJsseProps.CheckProviderTask - Class in org.apache.river.tool.envcheck.plugins
Checks the policy provider of the group.
CheckJsseProps.GetGroupLoginConfigs - Class in org.apache.river.tool.envcheck.plugins
Gets login configuration urls of the group.
CheckLoggingConfig - Class in org.apache.river.tool.envcheck.plugins
Checks the existence and readability of the logging configuration file identified by the java.util.logging.config.file system property, if that property is defined.
CheckLoggingConfig() - Constructor for class org.apache.river.tool.envcheck.plugins.CheckLoggingConfig
 
CheckLoginConfigInit() - Constructor for class org.apache.river.tool.envcheck.plugins.CheckJsseProps.CheckLoginConfigInit
 
CheckNoLoopback - Class in org.apache.river.tool.envcheck.plugins
Checks that the return from InetAddress.getLocalHost() is not a loopback address.
CheckNoLoopback() - Constructor for class org.apache.river.tool.envcheck.plugins.CheckNoLoopback
 
CheckPersistence - Class in org.apache.river.tool.envcheck.plugins
Check that the persistence directory supplied by any SharedActivatableServiceDescriptors are either non-existant or empty.
CheckPersistence() - Constructor for class org.apache.river.tool.envcheck.plugins.CheckPersistence
 
CheckPersistence.CheckDirTask - Class in org.apache.river.tool.envcheck.plugins
Perform directory check with an active security policy in place.
CheckPersistence.GetEntriesTask - Class in org.apache.river.tool.envcheck.plugins
The subtask which obtains the list of persistence directory entries.
CheckPolicy - Class in org.apache.river.tool.envcheck.plugins
Check the security policy for existence, for valid syntax, and that it does not grant AllPermissions to all protection domains.
CheckPolicy() - Constructor for class org.apache.river.tool.envcheck.plugins.CheckPolicy
 
CheckPolicy.AllPermissionsTask - Class in org.apache.river.tool.envcheck.plugins
Task the check the policy in a child VM.
CheckProviderTask() - Constructor for class org.apache.river.tool.envcheck.plugins.CheckJsseProps.CheckProviderTask
 
checkSystemPropertyFile(String, String) - Static method in class org.apache.river.tool.envcheck.Util
Validate the accessibility of the non-directory file identified by the system property prop.
checkURL(URL, String) - Static method in class org.apache.river.tool.envcheck.Util
Check the accessibility of the given URL.
ConfigTask() - Constructor for class org.apache.river.tool.envcheck.plugins.CheckConfig.ConfigTask
 

E

EnvCheck - Class in org.apache.river.tool.envcheck
Tool used to perform validity checks on the run-time environment of a client or service.
EnvCheck() - Constructor for class org.apache.river.tool.envcheck.EnvCheck
 
ERROR - Static variable in class org.apache.river.tool.envcheck.Reporter
the level at which error messages are generated

F

FileAccessCheckTask - Class in org.apache.river.tool.envcheck.plugins
A subtask which checks for the accessibility of a file identified by a system property.
FileAccessCheckTask() - Constructor for class org.apache.river.tool.envcheck.plugins.FileAccessCheckTask
 
formatExplanation() - Method in class org.apache.river.tool.envcheck.Reporter.Message
Returns the flag indicating whether to format the explanation text.

G

getArgs() - Method in class org.apache.river.tool.envcheck.EnvCheck
Get the command line arguments of the command being analyzed.
getBundle() - Method in class org.apache.river.tool.envcheck.AbstractPlugin
Get the resource bundle for this class.
getClasspath() - Method in class org.apache.river.tool.envcheck.EnvCheck
Get the classpath provided by the command line being analyzed.
getDescriptors() - Method in class org.apache.river.tool.envcheck.EnvCheck
Return the ServiceDescriptors contained in the service starter configuration.
GetEntriesTask() - Constructor for class org.apache.river.tool.envcheck.plugins.CheckPersistence.GetEntriesTask
 
getErrorCount() - Static method in class org.apache.river.tool.envcheck.Reporter
Get the total number of error records that were generated.
getExplanation() - Method in class org.apache.river.tool.envcheck.Reporter.Message
Returns the explanation text.
getGroupDescriptor() - Method in class org.apache.river.tool.envcheck.EnvCheck
Return the SharedActivationGroupDescriptor contained in the service starter configuration.
GetGroupLoginConfigs() - Constructor for class org.apache.river.tool.envcheck.plugins.CheckJsseProps.GetGroupLoginConfigs
 
GetGroupsTask() - Constructor for class org.apache.river.tool.envcheck.plugins.CheckConfig.GetGroupsTask
 
getJarToRun() - Method in class org.apache.river.tool.envcheck.EnvCheck
Return the name of the executable JAR file supplied on the command line being analyzed.
getJavaCmd() - Method in class org.apache.river.tool.envcheck.EnvCheck
Return the java command for the command line being analyzed.
getLevel() - Method in class org.apache.river.tool.envcheck.Reporter.Message
Returns the message level.
getMessage() - Method in class org.apache.river.tool.envcheck.Reporter.Message
Returns the short message text.
getProperties() - Method in class org.apache.river.tool.envcheck.EnvCheck
Return a copy of the properties that were specified on the command line being analyzed.
getProperty(String) - Method in class org.apache.river.tool.envcheck.EnvCheck
Return a property value that was specified on the command line being analyzed.
getResourceBundle(Class) - Static method in class org.apache.river.tool.envcheck.Util
Get the resource bundle associated with class clazz.
getString(String) - Method in class org.apache.river.tool.envcheck.AbstractPlugin
Get the format string associated with key from the resource bundle for this class.
getString(String, Object) - Method in class org.apache.river.tool.envcheck.AbstractPlugin
Get the format string associated with key from the resource bundle for this class.
getString(String, Object, Object) - Method in class org.apache.river.tool.envcheck.AbstractPlugin
Get the format string associated with key from the resource bundle for this class.
getString(String, Object, Object, Object) - Method in class org.apache.river.tool.envcheck.AbstractPlugin
Get the format string associated with key from the resource bundle for this class.
getString(String, ResourceBundle) - Static method in class org.apache.river.tool.envcheck.Util
Print out string according to resourceBundle format.
getString(String, ResourceBundle, Object) - Static method in class org.apache.river.tool.envcheck.Util
Print out string according to resourceBundle format.
getString(String, ResourceBundle, Object, Object) - Static method in class org.apache.river.tool.envcheck.Util
Print out string according to resourceBundle format.
getString(String, ResourceBundle, Object, Object, Object) - Static method in class org.apache.river.tool.envcheck.Util
Print out string according to resourceBundle format.
GetURLTask() - Constructor for class org.apache.river.tool.envcheck.plugins.CheckCodebase.GetURLTask
 
getWarningCount() - Static method in class org.apache.river.tool.envcheck.Reporter
Get the total number of warning records that were generated.

H

handleUnexpectedSubtaskReturn(Object, String) - Method in class org.apache.river.tool.envcheck.AbstractPlugin
Utility method which can be called to process objects of unexpected type which are returned by a subtask.

I

INFO - Static variable in class org.apache.river.tool.envcheck.Reporter
the level at which information messages are generated
isPluginOption(String) - Method in class org.apache.river.tool.envcheck.AbstractPlugin
 
isPluginOption(String) - Method in interface org.apache.river.tool.envcheck.Plugin
Determine whether arg is a plugin-specific command-line option for this plugin and save any necessary state.
isPluginOption(String) - Method in class org.apache.river.tool.envcheck.plugins.CheckActivationSystem
Test whether to unconditionally test for the presence of the activation system.
isPluginOption(String) - Method in class org.apache.river.tool.envcheck.plugins.CheckJsseProps
 

J

JDK1_4Task() - Constructor for class org.apache.river.tool.envcheck.plugins.CheckJDK1_4.JDK1_4Task
 
JSKPolicyTask() - Constructor for class org.apache.river.tool.envcheck.plugins.CheckJSKPolicy.JSKPolicyTask
 

L

launch(String, String[]) - Method in class org.apache.river.tool.envcheck.EnvCheck
Launch a child VM using the java command, properties, and options supplied on the command line being analyzed.
launch(String) - Method in class org.apache.river.tool.envcheck.EnvCheck
Launch a child VM using the java command, properties, and options supplied on the command line.
launch(String, Properties, String[], String[]) - Method in class org.apache.river.tool.envcheck.EnvCheck
Launch a subtask VM using the java command given by javaCmd.
launch(NonActivatableServiceDescriptor, SharedActivationGroupDescriptor, String) - Method in class org.apache.river.tool.envcheck.EnvCheck
Launch a subtask using the environment defined by the given service descriptors.
launch(NonActivatableServiceDescriptor, SharedActivationGroupDescriptor, String, String[]) - Method in class org.apache.river.tool.envcheck.EnvCheck
Launch a subtask using the environment defined by the given service descriptors.

M

main(String[]) - Static method in class org.apache.river.tool.envcheck.EnvCheck
The entry point for the tool.
main(String[]) - Static method in class org.apache.river.tool.envcheck.SubVM
Entry point for the subtask.
Message(int, String, String) - Constructor for class org.apache.river.tool.envcheck.Reporter.Message
Construct a Message having the given level and text.
Message(int, String, Throwable, String) - Constructor for class org.apache.river.tool.envcheck.Reporter.Message
Construct a Message having the given level, text, and exception data.

O

org.apache.river.tool.envcheck - package org.apache.river.tool.envcheck
Tool for examining the run-time environment of a Jini component.
org.apache.river.tool.envcheck.plugins - package org.apache.river.tool.envcheck.plugins
 

P

Plugin - Interface in org.apache.river.tool.envcheck
A test plugin.
print(Reporter.Message) - Static method in class org.apache.river.tool.envcheck.Reporter
Generate the output for message .
print(Reporter.Message, String) - Static method in class org.apache.river.tool.envcheck.Reporter
Generate the output for message.
printStacks() - Method in class org.apache.river.tool.envcheck.EnvCheck
Return the flag indicating whether to output stack traces that result from a check.
printStackTrace() - Method in class org.apache.river.tool.envcheck.Reporter.Message
Prints a stack trace for the exception associated with this message.

R

Reporter - Class in org.apache.river.tool.envcheck
A class which provides a standard way to report the results of a test.
Reporter.Message - Class in org.apache.river.tool.envcheck
A container of message information to be processed by Reporter.
run(EnvCheck) - Method in interface org.apache.river.tool.envcheck.Plugin
Run the test implemented by the plugin.
run(String[]) - Method in class org.apache.river.tool.envcheck.plugins.CheckActivationSystem.CheckActivationTask
 
run(EnvCheck) - Method in class org.apache.river.tool.envcheck.plugins.CheckActivationSystem
Determine whether to perform this check, and perform the check if appropriate.
run(String[]) - Method in class org.apache.river.tool.envcheck.plugins.CheckCodebase.GetURLTask
 
run(EnvCheck) - Method in class org.apache.river.tool.envcheck.plugins.CheckCodebase
Depending on whether service start checks are configured, either check the codebase system property or all of the ServiceDescriptors that are instanceof NonActivatableServiceDescriptor.
run(String[]) - Method in class org.apache.river.tool.envcheck.plugins.CheckConfig.ConfigTask
Instantiate the configuration using the given args.
run(String[]) - Method in class org.apache.river.tool.envcheck.plugins.CheckConfig.GetGroupsTask
Instantiate the configuration.
run(EnvCheck) - Method in class org.apache.river.tool.envcheck.plugins.CheckConfig
If configured to perform JSK checks, perform checks for each descriptor.
run(String[]) - Method in class org.apache.river.tool.envcheck.plugins.CheckJDK1_4.JDK1_4Task
 
run(EnvCheck) - Method in class org.apache.river.tool.envcheck.plugins.CheckJDK1_4
Check the validity of the activation group VM (if there is one)
run(EnvCheck) - Method in class org.apache.river.tool.envcheck.plugins.CheckJSKPlatform
Check the command line vm and the group, if there is one, for a classpath containing jsk-platform.jar.
run(String[]) - Method in class org.apache.river.tool.envcheck.plugins.CheckJSKPolicy.JSKPolicyTask
 
run(EnvCheck) - Method in class org.apache.river.tool.envcheck.plugins.CheckJSKPolicy
Perform the check both for the current VM, and for the group VM if a SharedActivationGroupDescriptor is available from the plugin container.
run(String[]) - Method in class org.apache.river.tool.envcheck.plugins.CheckJsseProps.CheckLoginConfigInit
 
run(String[]) - Method in class org.apache.river.tool.envcheck.plugins.CheckJsseProps.CheckProviderTask
 
run(String[]) - Method in class org.apache.river.tool.envcheck.plugins.CheckJsseProps.GetGroupLoginConfigs
 
run(EnvCheck) - Method in class org.apache.river.tool.envcheck.plugins.CheckJsseProps
Check the security files for the current VM and for the group VM if there is a SharedActivationGroupDescriptor.
run(EnvCheck) - Method in class org.apache.river.tool.envcheck.plugins.CheckLoggingConfig
 
run(EnvCheck) - Method in class org.apache.river.tool.envcheck.plugins.CheckNoLoopback
Get the address of the local host and check for loopback.
run(String[]) - Method in class org.apache.river.tool.envcheck.plugins.CheckPersistence.CheckDirTask
 
run(String[]) - Method in class org.apache.river.tool.envcheck.plugins.CheckPersistence.GetEntriesTask
 
run(EnvCheck) - Method in class org.apache.river.tool.envcheck.plugins.CheckPersistence
Check the persistence directory for every SharedActivatableServiceDescriptor in the starter configuration.
run(String[]) - Method in class org.apache.river.tool.envcheck.plugins.CheckPolicy.AllPermissionsTask
Perform the syntax check and the AllPermission check
run(EnvCheck) - Method in class org.apache.river.tool.envcheck.plugins.CheckPolicy
Perform policy file checks for the current VM and all service descriptors.
run(String[]) - Method in class org.apache.river.tool.envcheck.plugins.FileAccessCheckTask
Check for the accessibility of a file identified by a system property.
run(String[]) - Method in interface org.apache.river.tool.envcheck.SubVMTask
Run the subtask.

S

setExplanation(boolean) - Static method in class org.apache.river.tool.envcheck.Reporter
Set the explanation generation flag;
setFormatExplanation(boolean) - Method in class org.apache.river.tool.envcheck.Reporter.Message
Set the flag indicating whether to format the explanation text.
setLevel(int) - Static method in class org.apache.river.tool.envcheck.Reporter
Set the reporting level.
setPrintTraces(boolean) - Static method in class org.apache.river.tool.envcheck.Reporter
Set the flag controlling printing of stack traces.
SubVM - Class in org.apache.river.tool.envcheck
A container for a subtask which runs in a separate and returns a single object by writing that object to System.out.
SubVM() - Constructor for class org.apache.river.tool.envcheck.SubVM
 
SubVMTask - Interface in org.apache.river.tool.envcheck
A subtask to be run in a separate VM.

T

taskName(String) - Method in class org.apache.river.tool.envcheck.AbstractPlugin
Return a fully qualified external class name for the given static inner class name.

U

Util - Class in org.apache.river.tool.envcheck
Miscellaneous utility methods for use by the checking framework and plugins.
Util() - Constructor for class org.apache.river.tool.envcheck.Util
 

W

WARNING - Static variable in class org.apache.river.tool.envcheck.Reporter
the level at which warning messages are generated
A C E F G H I J L M O P R S T U W 
Copyright ©, multiple authors.

Copyright © 2016–2018. All rights reserved.