|
| Sun ONE Connector Builder 2.0 Developer's Guide |
Command Line Interface ReferenceThis module describes the command line utilities provided by the Sun ONE Connector Builder. The utilities are listed by functional area below. The subcommands and options for the command line utilities may change in subsequent releases of Connector Builder. These commands are available under the bin directory of <connector_builder_install_root> directory. The bin directory also includes a script named icenv.bat/icenv.sh. This script is for internal use only and you are advised not to use or modify it.
icsvrreg
icsvrreg is a command line utility used to register and unregister a deployment platform instance for resource adapter deployment in non-managed environment.
Description
icsvrreg is used for deployment platform instance registration in the non-managed environment. This command allows you to add, update, delete and list deployment platform instances. The registered instance is used later with other commands to deploy and configure resource adapters in non-managed environment.
Usage
The syntax for icsvrreg command is as follows:
icsvrreg <subcommand> [<options>]
icsvrreg add -n <name> -t <type> -d <serverdir>
icsvrreg add -n <name> -t <type> -d <serverdir> -u <soapurl>
icsvrreg update -n <name> -d <serverdir> -u <soapurl>
icsvrreg delete -n <name>
icsvrreg list
icsvrreg -h
icsvrreg -v
Subcommands
The table below lists the supported subcommands for icsvrreg. The left column lists the subcommand, the right column provides a description.
Options
The following table lists the options that are supported. The left column lists the long name, the middle column lists the short name and the right column lists the meaning of the option.
Examples
Example 1: Registering deployment platform instance of type iPlanet Application Server 6.5.
icsvrreg add -t ias65 -n myias -d /export/home/sun/ias6
Example 2: Registering deployment platform instance of type iPlanet Web Server 6.0.
icsvrreg add --type iws --name myiws --dir d:\sun\server\https-myhost.acme.com
Example 3: Updating Apache SOAP URL for registered server `myiws'
icsvrreg update -n myiws -u http://localhost:8000/soap/servlet/rpcrouter
Example 4: Unregistering the deployment platform instance.
icsvrreg delete -n myiws
Example 5: Listing registered deployment platform instances.
icsvrreg list
Environment Variables
The environment variable JAVA_HOME must be set prior to usage of this command.
Exit Status
The following exit values are returned:
0 Successful completion.
1 An error occurred.
See Also
icradeploy, icconfig, icwsdeploy
Diagnostics
All messages are generally self-explanatory.
- Please set JAVA_HOME environment variable.
The environment variable JAVA_HOME must be set prior to usage of this command.
- icsvrreg: Illegal option <xxxx>
You must have entered an invalid subcommand/option for icsvrreg command. Use -h option to know the usage of icsvrreg command.
- icsvrreg: `xxxx' option is missing
The option `xxxx' is mandatory. You need to specify all mandatory options.
- icsvrreg: Missing arguments for option `xxxx'
- icsvrreg: Server is already registered with name `xxxx'
You cannot register more than one server with the same name.
- icsvrreg: No server found with name <xxx> for delete/update operation
The specified registered server is not found for delete/update operation.
Notes
- If the directory name contains embedded spaces, the directory name must be specified in quotes, for example, "d:\Program Files\Sun\iAS6".
- Unregistering a deployment platform instance does not have any impact on already deployed resource adapters and SOAP Services. You can re-register the same deployment platform instance to administrate the deployed components.
- A default value for the SOAP URL is assigned based on the registered server type. If the actual URL differs from this, use the `update' subcommand to modify. The SOAP URL is used only for the resource adapter SOAP services deployment.
icradeploy
icradeploy is the command line utility to deploy and undeploy a resource adapter in non-managed environment.
Description
This command allows you to deploy, undeploy and list the deployed resource adapters.
Usage
The syntax for icradeploy command is as follows:
icradeploy <subcommand> [<options>]
icradeploy deploy -s <server_name> -a <adapter_name> -r <rar_file>
icradeploy undeploy -s <server_name> -a <adapter_name>
icradeploy list -s <server_name>
icradeploy -h
icradeploy -v
Subcommands
The following subcommands are supported:icradeploy subcommands
icradeploy subcommands
Subcommand
Description
deploy
Deploy a resource adapter
undeploy
Undeploy a resource adapter
list
List all deployed resource adapters
Options
The following options are supported:
Examples
Example 1: Deploying a resource adapter with name COTS into deployment platform registered with name myias.
icradeploy deploy -s myias -a COTS -r /export/home/COTS.rar
Example 2: Listing deployed resource adapters into deployment platform registered with name myias.
icradeploy list -s myias
Example 3: Undeploying an already deployed resource adapter.
icradeploy undeploy -s myias -a COTS
Example 4: Printing help information.
icradeploy -h
Example 5: Displaying version information.
icradeploy -v
Environment Variables
The environment variable JAVA_HOME must be set prior to usage of this command.
Exit Status
The following exit values are returned:
0 Successful completion.
1 An error occurred.
See Also
icsvrreg, icconfig, icwsdeploy
Diagnostics
All messages are generally self-explanatory.
- Please set JAVA_HOME environment variable.
The environment variable JAVA_HOME must be set prior to usage of this command.
- icradeploy: Illegal option <xxxx>
You must have entered an invalid subcommand/option for icradeploy command. Use -h option to know the usage of icradeploy command.
- icradeploy: <xxxx> option is missing
The option `xxxx' is mandatory. You need to specify all mandatory options.
- icradeploy: Missing arguments for option <xxxx>
- icradeploy: Invalid server <xxxx>
You must specify a valid registered server. The registered server name is case-sensitive.
- icradeploy: Error in deploying the resource adapter <xxx>. RAR file <xxx> is not found.
The specified rar file is not found. Specify the fully qualified file.
- icradeploy: Error in deploying the resource adapter <xxx>. Invalid rar file. ra.xml deployment descriptor is missing.
Ensure that a valid rar file is specified.
- icradeploy: Error in deploying the resource adapter <xxx>. Resource adapter with name <xxx> is already deployed.
You cannot deploy more than one resource adapter with the same name into a specific deployment platform.
- icradeploy: Error in undeploying the resource adapter <xxx>. NameNotFoundException.
Notes
- Adapter Name is not case-sensitive. The adapter name is always stored and displayed in lower case.
- The registered server name is case-sensitive.
- You cannot redeploy a resource adapter. You must first undeploy the existing resource adapter and deploy it again.
- When you undeploy a resource adapter, all the configured connection factories for that specific resource adapter are also removed.
- If the directory name contains embedded spaces, the directory name must be specified in quotes, for example, "d:\Program Files\Sun\iAS6".
icconfig
icconfig is the command line utility to configure connection factories for a deployed resource adapter in non-managed environment.
Description
Used for configuring the connection factories for a deployed resource adapter in non-managed environment. Using this utility, you can perform operations like add, update, delete, query, and list connection factory.
Usage
The syntax for icconfig command is as follows:
icconfig <subcommand> [<options>]
icconfig add -s <server_name> -n <jndi_name> -a <adapter_name> -p <name=value>+ -i <prop_file>
icconfig update -s <server_name> -n <jndi_name> -p <name=value>+ -i <prop_file>
icconfig delete -s <server_name> -n <jndi_name>
icconfig query -s <server_name> -n <jndi_name>
icconfig list -s <server_name>
icconfig -h
icconfig -v
Subcommands
The following subcommands are supported:
Options
The following options are supported:
Examples
Example 1: Adding a connection factory with default config parameter values specified in deployment descriptor.
icconfig add -s myias -n COTS -a COTS
Example 2: Updating an existing connection factory with new PortNumber config property value.
icconfig update -s myias -n COTS -p PortNumber=8081
Example 3: Updating an existing connection factory by passing new config property values through file.
icconfig update -s myias -n COTS -i /export/prop/test.properties
Example 4: Deleting an existing connection factory.
icconfig delete -s myias -n COTS
Example 5: Listing all configured connection factory in a specific deployment platform instance.
icconfig list -s myias
Environment Variables
The environment variable JAVA_HOME must be set prior to usage of this command.
Exit Status
The following exit values are returned:
0 Successful completion.
1 An error occurred.
See Also
icsvrreg, icradeploy, icwsdeploy
Diagnostics
All messages are generally self-explanatory.
- Please set JAVA_HOME environment variable.
The environment variable JAVA_HOME must be set prior to usage of this command.
- icconfig: Illegal option <xxxx>
You must have entered an invalid subcommand/option for icconfig command. Use -h option to know the usage of icconfig command.
- icconfig: <xxxx> option is missing
The option `xxxx' is mandatory. You need to specify all mandatory options.
- icconfig: Missing arguments for option <xxxx>
- icconfig: Invalid server <xxxx>
You must specify a valid registered server. The registered server name is case-sensitive.
- icconfig: Error in configuring connection factory with lookup name <xxx>. Adapter <xxx> must be deployed before registering connection factories.
- icconfig: Error in configuring connection factory with lookup name <xxx>. Connection factory with lookup name <xxx> is already present.
You cannot register more than one connection factory with the same name. The lookup name is case-sensitive and must be unique across all deployed resource adapters in the same deployment platform.
- icconfig: Error in updating connection factory with lookup name <xxx>. No properties are specified to update the connection factory.
Did not find any valid config property to update the connection factory. You must specify config properties that are defined only in deployment descriptor.
Notes
- Adapter Name is not case-sensitive. The adapter name is always stored and displayed in lower case.
- The registered server name is case-sensitive.
- The lookup name is case-sensitive and must be unique among all deployed resource adapters in the same deployment platform instance.
icwsdeploy
icwsdeploy is the command line utility to deploy and undeploy SOAP Services.
Description
Used for deploying SOAP Services.
Usage
The syntax for icwsdeploy command is as follows:
icwsdeploy <subcommand> [<options>]
icwsdeploy deploy -s <server_name> -d <deployment_descriptor_file>
icwsdeploy deployall -s <server_name> -j <jar file with dds>
icwsdeploy undploy -s <server_name> -n <service_name>
icwsdeploy list -s <server_name>
icwsdeploy -h
icwsdeploy -v
Subcommands
The following subcommands are supported:
Options
The following options are supported:
Examples
Example 1: Deploying a single Apache SOAP Service.
icwsdeploy deploy -s myias -d /export/home/mydescriptor.xml
Example 2: Deploying a set of Apache SOAP Services packaged in a Jar file.
icwsdeploy deployall -s myias -j /export/home/COTS-soapdd.jar
Example 3: List all deployed SOAP Services.
icwsdeploy list -s myias1
Example 4: Undeploying a deployed SOAP Service. You must first list the deployed service to know the service name.
icwsdeploy undeploy -s myias -n urn:COTS:COTSPIGetCustomer
Environment Variables
The environment variable JAVA_HOME must be set prior to usage of this command.
Exit Status
The following exit values are returned:
0 Successful completion.
1 An error occurred.
See Also
icsvrreg, icradeploy, icconfig
Diagnostics
All messages are generally self-explanatory.
- Please set JAVA_HOME environment variable.
The environment variable JAVA_HOME must be set prior to usage of this command.
- icwsdeploy: Illegal option <xxxx>
You must have entered an invalid subcommand/option for icwsdeploy command. Use -h option to know the usage of icwsdeploy command.
- icwsdeploy: <xxxx> option is missing
The option `xxxx' is mandatory. You need to specify all mandatory options.
- icwsdeploy: Missing arguments for option <xxxx>
- icwsdeploy: Invalid server <xxxx>
You must specify a valid registered server. The registered server name is case-sensitive.
- java.lang.NoClassDefFoundError: org/apache/soap/server/ServiceManagerClient Exception ....
Apache SOAP related libraries are not in CLASSPATH. This command uses by default the SOAP libraries that are packaged with the IDE. If this command is installed as a standalone, you must manually update ICB_SOAP_CLASSPATH variable in icenv.sh/bat script present under <connector_builder_install_root>/bin directory.
Notes
- The registered server name is case-sensitive.
- The list operation also includes services deployed into Apache SOAP Server by external means.
- The undeploy operation also allows you to undeploy a SOAP service deployed by external means.
- If the directory name contains embedded spaces, the directory name must be specified in quotes, for example, "d:\Program Files\Sun\iAS6".
ictstclnt
ictstclnt is the command line utility to start the TestClient.
Description
Executes the TestClient tool in command line mode by reading testrun parameters from an input file.
Usage
The syntax for ictstclnt command is as follows:
ictstclnt -i <testrun_parameters_file>
ictstclnt -h
ictstclnt -v
Options
The following options are supported:
Examples
Example 1: Executes the TestClient tool in command line mode by reading testrun parameters specified in /export/home/test/testrun.properties file.
ictstclnt -i /export/home/test/testrun.properties
Example 2: Displays the help information.
ictstclnt -h
Example 3: Displays the version information.
ictstclnt -v
Environment Variables
The environment variable JAVA_HOME must be set prior to usage of this command.
Exit Status
The following exit values are returned:
0 Successful completion.
1 An error occurred.
Diagnostics
All messages are generally self-explanatory.
- Please set JAVA_HOME environment variable.
The environment variable JAVA_HOME must be set prior to usage of this command.
- ictstclnt : Unrecognized option <xxxx> specified
You must have entered an invalid subcommand/option for ictstclnt command. Use -h option to know the usage of ictstclnt command.
- ictstclnt : Missing arguments for option <xxxx>
- ictstclnt : Error in reading testrun parameters input file <xxxx>
Could not read the input file specified. Check the input file and re-run the command.
- ictstclnt : No tests are specified.
No tests are specified in testlist file.
Notes
- If the directory name contains embedded spaces, the directory name must be specified in quotes, for example, "d:\Program Files\Sun\iAS6".
icversion
The icversion command is used for version verification of the the Connector Builder.
Description
The Connector Builder provides the icversion tool. Using this tool you can check the version of the Connector Builder.
Usage
The syntax of the of command is as follows:
icversion[-h] [-v] [-r <rarFile>]
The list of icversion options table lists the icversion options. The left column lists the subcommand long name. The middle column lists the subcommand short name and the right column lists the meaning.
Examples
The following are examples for usage of icversion:
icversion
icversion -v
icversion --version
icversion - h
icversion --help
icversion -r COTS.rar
icversion -rarfile COTS.rar
Environment Variables
The environment variable JAVA_HOME must be set prior to usage of this command.
Exit Status
The following exit values are returned:
0 Successful completion.
1 An error occurred
Diagnostics
All messages are generally self-explanatory.
- Please set JAVA_HOME environment variable.
The environment variable JAVA_HOME must be set prior to usage of this command.
- icversion : Illegal option <xxxx>
You must have entered an invalid subcommand/option for icversion command.
Use -h option to see the usage of icversion command.
- icversion : Missing arguments for option <xxxx>
You did not specify a value for the option <xxxx>.