cjgetappprop (get HITACHI Application Property)

Organization of this page

Format
Function
Arguments
Input examples
Return values
Notes

Format

For an application

cjgetappprop [server-name] [-nameserver provider-URL] 
       -name J2EE-application-name
       [-encoding code-set-name] -c Property-file-path

For an EJB-JAR, WAR, or RAR file

cjgetappprop [server-name] [-nameserver provider-URL] 
    -name J2EE-application-name -type {ejb|war|rar}
    -resname resource-display-name[/lower-resource-display-name]
    [-encoding code-set-name] -c Property-file-path

For obtaining all information

cjgetappprop [server-name] [-nameserver provider-URL] 
       -name J2EE-application-name -type all
       [-encoding code-set-name] -c Property-file-path

To Page Top

Function

This command obtains properties of an application or resources (for an EJB-JAR file, the resources are EJB-JAR files, Session Bean, Entity Bean, or Message-driven Beans. For a WAR file, the resources are WAR files, servlet/JSP, or filters.) included in that application, or property of RAR file, and then generates a property File.

For the property file used in setting up a J2EE application program and its resources, see the following locations:

3. Property Files Used for Setting J2EE Applications in the uCosminexus Application Server Application and Resource Definition Reference Guide.
4. Property Files Used for Setting Resources in the uCosminexus Application Server Application and Resource Definition Reference Guide.

For an application in exploded archive format, this command can be executed for a J2EE server that runs on the same host as the command execution host.

To Page Top

Arguments

server-name

Specifies the name of a connected J2EE server. If the server name is omitted, the host name is assumed.

-nameserver provider-URL

Specifies the access protocol for the CORBA Naming Service, the name of the host running the CORBA Naming Service, and the port number being used by the host. These items are specified in the following format:

protocol-name: : host-name: port-number

For details on the specification items, see 2.1.2 Provider URL.

-name J2EE-application-name

Specifies the name of the J2EE application that is to be retrieved.

-type {ejb|war|rar|all}

Specifies the type of resource to be retrieved:

ejb: EJB-JAR file or EJB file in an EJB-JAR file
war: WAR file, servlet/JSP in a WAR file, or filter
rar: RAR file
all: All information

-resname resource-display-name

Specifies the display name of the resource to be retrieved:

ejb-jar: EJB-JAR-file-display-name
ejb: EJB-JAR-file-display-name[/Enterprise-Bean-display-name]
war: WAR-file-display-name
rar: RAR-file-display-name
Servlet/JSP: WAR-file-display-name[/servlet/JSP-display-name]
filter: WAR-file-display-name[/filter-display-name]

If the display name of the lower resource is not specified, the specifications become specifications for an EJB-JAR file or a WAR file.

-encoding encoding-name

Specifies the name of the code set to be used when the property file is output. The following code set names can be specified:

UTF8
UTF-8
ASCII
US-ASCII
ISO-8859-1
EUC_JP
Shift_JIS
SJIS
windows-31j
MS932
Encoding name supported by JavaVM

If this argument is omitted, the name of JavaVM's default code set is used. To confirm the used encoding name, see the XML declaration in the first line of the property file that is acquired using the cjgetappprop command.

<?xml version="XML-standard-version-number" encoding="code-set-name"?>

-c Property-file-path

Specifies the output destination path of the property file.

To Page Top

Input examples

For an application

cjgetappprop MyServer -name App1 -encoding Shift_JIS -c App1Prop.xml

For an EJB-JAR file

cjgetappprop MyServer -name App1 -type ejb -resname accountJsp/MyAccount -encoding UTF-8 -c MyAccountProp.xml

For a WAR file

cjgetappprop MyServer -name App1 -type war -resname account-war/Account -c AccountProp.xml

For a RAR file

cjgetappprop MyServer -name App1 -type rar -resname account-rar -c AccountProp.xml

For obtaining all information

cjgetappprop MyServer -name App1 -type all -encoding Shift_JIS -c App1AllProp.xml

To Page Top

Return values

0:: The command terminated normally.
1:: The command terminated abnormally.
2:: The command could not be executed because of an exclusion error.
3:: A timeout occurred.
9:: The command could not be executed because there are no administrator privileges (in Windows).

To Page Top

Notes

When you specify a server name in the command arguments, you must specify it immediately after the command name. You can specify the other arguments in any order as long as they are subsequent to the server name (or subsequent to the command name if the server name is omitted). However, you cannot switch the sequence of an option name and its corresponding value (for example, you cannot specify J2EE-application-name -name); also, you cannot specify an option name in conjunction with a non-corresponding value (for example, you cannot specify -name ejb -type J2EE-application-name).
When you specify a server name in the command arguments, you must specify a case-sensitive character string that matches a server name specified in a cjsetup (set up or unsetup J2EE server).
If a property file already exists on the specified path, it is overwritten.

To Page Top