cjsetappprop (set HITACHI Application Property)
- Organization of this page
Format
- For an application
cjsetappprop [server-name] [-nameserver provider-URL] -name J2EE-application-name -c Property-file-path
- For an EJB-JAR, WAR, or RAR file
cjsetappprop [server-name] [-nameserver provider-URL] -name J2EE-application-name -type {ejb|war|rar} -resname resource-display-name[/lower-resource-display-name] -c Property-file-path
- For setting all information
cjsetappprop [server-name] [-nameserver provider-URL] -name J2EE-application-name -type all -c Property-file-path
Function
This command changes the property of an application, property of the resource included in the EJB-JAR file (EJB-JAR file, Session Bean, Entity Bean, or Message-driven Bean), property of the resource included in the WAR file (WAR file, servlet/JSP, or filter), or the property of RAR file to the values in the specified application property file.
If the display name of a lower resource is not specified, the specification is for the EJB-JAR or WAR file.
For the property files used in setting up J2EE applications and 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.
If the application is in exploded archive format, this command can be executed only for a J2EE server operating in the same host as the command execution host.
If the cjsetappprop command is used for changing, adding, or deleting the Application Server-specific definition information of the application containing cosminexus.xml, cosminexus.xml is updated. If the changed, added, or deleted application has exploded archive format, cosminexus.xml in the application directory is updated. For the Application Server-specific definition information, see 2. Cosminexus Application Property File (cosminexus.xml) in the uCosminexus Application Server Application and Resource Definition Reference Guide.
If you change the following tag values for the applications that do not contain application.xml, application.xml is created:
- Application property file
-
<hitachi-application-property> - <description>
<hitachi-application-property> - <icon> - <small-icon>
<hitachi-application-property> - <icon> - <large-icon>
- WAR property file
-
<hitachi-war-property> - <war-runtime> - <context-root>
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 set up.
- -type {ejb|war|rar|all}
-
Specifies the type of resource that is to be set up:
-
ejb: EJB-JAR file or an EJB file in a EJB-JAR file
-
war: WAR file or a servlet/JSP in a WAR file
-
rar: RAR file
-
all: All information
-
- -resname resource-display-name
-
Specifies the display name of the resource that is to be set up:
-
For an EJB-JAR file: EJB-JAR-file-display-name
-
For an EJB file: EJB-JAR-file-display-name[/Enterprise-Bean-display-name]
-
For a WAR file: WAR-file-display-name
-
For a servlet/JSP: WAR-file-display-name[/servlet/JSP-display-name]
-
For a filter: WAR-file-display-name[/filter-display-name]
-
For a RAR file: RAR-file-display-name
-
- -c Property-file-path
-
Specifies the path of the input source property file.
Input examples
- For an application
cjsetappprop MyServer -name App1 -c App1Prop.xml
- For an EJB-JAR file
cjsetappprop MyServer -name App1 -type ejb -resname accountJsp/MyAccount -c MyAccountProp.xml
- For a WAR file
cjsetappprop MyServer -name App1 -type war -resname account-war/Account -c AccountProp.xml
- For a RAR file
cjsetappprop MyServer -name App1 -type rar -resname account-rar -c AccountProp.xml
- For setting all information
cjsetappprop MyServer -name App1 -type all -c App1AllProp.xml
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).
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).
-
The specified J2EE application or resource must exist.
-
When all is specified for the -type option, the resources to be modified are determined by the resource display name in the specified HITACHI Application Property File. For this reason, the display name of the resources cannot be changed.
-
If you set up the EJB-JAR property file when the <security-role-ref>-<role-link> tag is set up in the DD file (ejb-jar.xml), the value of the <security-role-ref>-<role-link> tag might be cleared in the DD file (ejb-jar.xml).