10139N/A DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER. 12198N/A Copyright (c) 2008 Sun Microsystems Inc. All Rights Reserved 10139N/A The contents of this file are subject to the terms 10139N/A of the Common Development and Distribution License 10139N/A (the License). You may not use this file except in 10139N/A You can obtain a copy of the License at 12198N/A See the License for the specific language governing 10139N/A permission and limitations under the License. 10139N/A When distributing Covered Code, include this CDDL 10139N/A Header Notice in each file and include the License file 11419N/A If applicable, add the following below the CDDL Header, 10139N/A with the fields enclosed by brackets [] replaced by 11419N/A your own identifying information: 10139N/A "Portions Copyrighted [year] [name of copyright owner]" 10139N/A Portions Copyrighted 2012 ForgeRock Inc 10139N/AThis file contains information about the OpenAM diagnostic tool.
10139N/AIt is assumed that OpenAM Server is available.
10803N/A2. Supported versions of Java Runtime
10139N/AOpenAM Diagnostic Tool provides a means to validate the sanity of configured
10139N/Ainstance and environment. The tool can be used to verify the configuration
10139N/Asettings and identify any possible issues. The issues that can occur after the
11070N/Aissues pertain to misconfigurations, while the dynamic issues occur during
11070N/Arun-time. The tool does not address the dynamic issues.
10139N/A2. Supported versions of Java Runtime
10139N/A-------------------------------------
10139N/ANote: Embedded quotes in JAVA_HOME environment variable are not supported.
10139N/AThis tool can be extended since the implementation is based on a plug-in model.
10139N/A(plug-ins) for new services that can be seamlessly integrated with the existing
10139N/AEach feature that is part of the tool and provides certain functionality in a
10139N/Adomain, is viewed as a service. For example, a tool that provides OpenAM
10139N/AServer configuration related feature is viewed as "Server configuration service"
10139N/Aor in the server domain. A given service can provide one or more related
10139N/Aoperations in a particular functional area. For example, "Server configuration
10139N/Aservice" may provide features to view server configuration parameters, validate
10139N/Asession-failover configuration etc.
10139N/AThe directory in which the tool is unzipped is referred as ZIP_ROOT.
10139N/AThe directory layout would look something as :
10139N/A |----README (file containing the information about the Tool)
10139N/A |----config (Any configuration related files required by the Tool)
10139N/A |----lib (jar files that are required by the tool to operate)
10139N/A |----services (All the services implemented should be under this
10139N/A | | directory, including service descriptor files
10139N/A | |----resources (Properties file, images etc required by the
10139N/A | |----lib (Jar files required by the services)
10139N/A | | (This is a sample service used to illustrate the
10139N/A | | structure of service descriptor file. Any new service
10139N/A | | can use this file as a reference for integration into
10244N/A | | the tool. Once a new service is implemented, create a
10244N/A | | separate directory if the need be and place all the
10139N/A | | related files under this new directory. The tool when
11855N/A | | started will pick this new service and shall display
10139N/A | |----config (Any configuration related files required by the
10139N/A | | server. This is handled by the implementation of
10923N/A | |----config (Any configuration related files required by the
10923N/A | | agent service. This is handled by the
10923N/A | | implementation of the service)
10139N/A | | of servers. It includes directory server,
10139N/A | |----config (Any configuration related files required by the
10142N/A | | connectivity service. This is handled by the
10139N/A | | implementation of the service)
10139N/A | | changes to files of the configured server
10139N/A | |----config (Any configuration related files required by the
10139N/A | | tamperdetection service. This is handled by the
10139N/A | | implementation of the service)
10139N/A | |----config (Any configuration related files required by the
10139N/A | | reporting service. This is handled by the
10139N/A | | implementation of the service)
10139N/A | |----config (Any configuration related files required by the
10139N/A | | web container service. This is handled by the
10139N/A | | implementation of the service)
10139N/ANew services can be seamlessly added to the Diagnostic Tool. Refer to the sample
10139N/Ajava code provided under the sample service. The new service can provide
10139N/Aadditional functionality as a service or as a feature to an existing service
10139N/Adomain. Adding a new service domain or functionality needs to add a new
10139N/Adirectory with the domain specific name under the services directory.
10139N/AAdditionally, the service should provide a service descriptor file providing the
10139N/AIn order to add a new feature to an existing service domain, the service
10139N/Adescriptor file of that service needs to be updated with the corresponding
10139N/A--------------------------------
10139N/ADiagnostic Tool can be invoked in two modes
i.e. CLI or GUI. The default
10139N/Abehavior is GUI mode and can be overridden as shown in step 7b and 7c.
10139N/Aa. Invoking the diagnostic tool in GUI mode.
10139N/Ab. Invoking the diagnostic tool in CLI mode using the "--console" option.
10139N/Ac. Invoking the diagnostic tool in CLI mode using the configuration
10139N/A The default behavior can be changed to CLI mode by editing the
10139N/A Set the property as follows to override the default GUI mode:
10139N/A Invoke the tool in CLI mode for Unix platforms:
10139N/A Invoke the tool in CLI mode for Windows platforms: