uCosminexus Service Platform, Reference Guide

[Contents][Glossary][Index][Back][Next]

cscsvcls (Displaying the service information)

Format

 
cscsvcls [-h]
 -user login-user-ID
 -pass login-password
 [-detail]

Function

Outputs the service information to the standard output. This command outputs the names and the status of the definition files set up in the development or operating environments for the following receptions and service adapters. This command also checks the value specified in arguments of the cscsvcctl command.

Classification Applicable reception or service adapter
Receptions
  • SOAP reception
  • TP1/RPC reception
  • FTP reception
  • HTTP reception
  • Message Queue reception
  • Custom reception
Service adapters
  • DB adapter
  • TP1 adapter
  • File adapter
  • Object Access adapter
  • Message Queue adapter
  • FTP adapter
  • File operations adapter
  • Mail adapter
  • HTTP adapter
  • Custom adapter

By setting up default values for mandatory options, such as the login user ID, in the HCSC-Manager command definition file, you can omit the specification of these values in this command.

For details on how to use this command, see the following locations in the uCosminexus Service Platform System Setup and Operation Guide according to the purpose of use:

Arguments

-h

Displays the usage of commands. When you specify this option, all other options are ignored even if specified.

-user login-user-ID ~ <one-byte alphanumeric characters and underscores (_)> ((1 to 16 characters))

Specifies the user ID that is used to log in to HCSC-Manager.

-pass login-password ~ <one-byte alphanumeric characters and underscores (_)> ((1 to 16 characters))

Specifies the password that is used to log in to HCSC-Manager.

-detail

Specify this option to display the values set during development.

Output format

When -detail is not specified:

 
Command Edit Time: command-issuing-time
Cluster(name: cluster-name)
- ServiceAdapter(ServiceID: service-ID-of-service-adapter, ServiceType: service-adapter-type)
 Attribute name: value
- ServiceAdapter(ServiceID: service-ID-of-service-adapter, ServiceType: service-adapter-type)
 Attribute name: value
- ServiceAdapter(ServiceID: service-ID-of-service-adapter, ServiceType: Custom)
 Definition file name: status
-UserDefinedReception(ReceptionID: reception-ID, ReceptionType: reception-type)
 Definition file name: status

When -detail is specified:

 
Command Edit Time: command-issuing-time
Cluster(name: cluster-name)
- ServiceAdapter(ServiceID: service-ID-of-service-adapter, ServiceType: service-adapter-type)
 Attribute name (def): value-specified-during-development
 Attribute name (set): value
- ServiceAdapter(ServiceID: service-ID-of-service-adapter, ServiceType: service-adapter-type)
 Attribute name (def): value-specified-during-development
 Attribute name (set): value
- ServiceAdapter(ServiceID: service-ID-of-service-adapter, ServiceType: Custom)
 Definition file name: status
 Property key name: property-value
-UserDefinedReception(ReceptionID: reception-ID, ReceptionType: reception-type)
 Definition file name: status
 Property key name=: property-value

Description

Display item Description
Command Edit Time Indicates the time when the command was issued.
The time is output in the format YYYY/MM/DD hh:mm:ss.SSS defined with java.text.SimpleDateFormat.
  • YYYY: Year
  • MM: Month
  • DD: Date
  • hh: Hour
  • mm: Minutes
  • ss: Seconds
  • SSS: Milliseconds
Cluster (name) Indicates the cluster name.
ServiceAdapter (ServiceID) Indicates the service ID of a service adapter.
ServiceType Indicates the service adapter type. One of the following is output:
  • SessionBean: Synchronous (SessionBean)
  • WebService: Synchronous (Web service)
  • MDB_WSR: Asynchronous (MDB (WS-R))
  • MDB_DBQ: Asynchronous (MDB (DB queue))
Attribute name Outputs the service information that is currently valid.
Attribute name (def) Outputs the service information set up during development.
Attribute name (set) Outputs the service information specified in the service-information change definition.
Reception ID Indicates the reception ID.
Reception type Outputs Custom.
Definition file name#1 Indicates the definition file name.
Status Indicates the definition file status. One of the following is output:
  • noChange: Status in which the self-defined file is not set in the operating environment
  • add: Status in which the self-defined file is added to the operating environment
  • changed: Status in which the definitions added to the operating environment are changed
Property key name#2 If the extension of the definition file is *.properties, the property key name is output.
Property value#2 If the extension of the definition file is *.properties, the property value is output.

#1
The name of HITACHI Application Integrated Property File might be displayed for a service adapter.

#2
This item is only displayed when the extension is *.properties.

The following table describes the output format for the service information. Note that the SOAP mode in the table represents the SOAP 1.1 mode and SOAP 1.1/ 1.2 combined mode.

Table 5-5 Output format of the service information

Service adapter type SOAP mode Output format (order of output) Corresponding attributes in the service-information change definition file
1.1 1.1/ 1.2 combined
WebService Y Y BasicAuthenticationId basic_authentication_id#1#2
Y Y BasicAuthenticationPass basic_authentication_pass#1#2
Y Y BasicAuthenticationUse basic_authentication_use#1
Y
SessionMaintain c4web.application.app_maintainsession#1
Y
NonProxyHosts c4web.application.non_proxy_hosts#1
Y
ProxyHost c4web.application.proxy_host#1
Y
ProxyPassword c4web.application.proxy_password#1#2
Y
ProxyPort c4web.application.proxy_port#1
Y
ProxyUser c4web.application.proxy_user#1#2
Y
ConnectTimeout c4web.application.socket_connect_timeout#1
Y com.cosminexus.csc.connect.timeout#1
Y
ReadTimeout c4web.application.socket_read_timeout#1
Y com.cosminexus.csc.request.timeout#1
Y
WriteTimeout c4web.application.socket_write_timeout#1
Y
PrfTraceLevel c4web.common.prf_trace_level#1
Y
ReceiveMaxSoapEnvelopeSize c4web.common.receive_max_soap_envelope_size#1
Y
SendMaxSoapEnvelopeSize c4web.common.send_max_soap_envelope_size#1
Y SessionMaintain com.cosminexus.csc.session.maintain#1
Y Y Url url
SessionBean Y
Timeout c4web.application.ejb_timeout#1
Y
PrfTraceLevel c4web.common.prf_trace_level#1
Y
LookupName lookupName
Y
Url url
MDB_WSR Y
LocalCall local_call
Y
QueueName queue_name
Y
Url url
Y
MaxMessageNum max_message_num
Y
QosInOrder qos_in_order
Y
RdAreaName rdarea_name
MDB_DBQ Y Y QueueName queue_name

Legend:
Y: Indicates that the mode supports the output of the service information.
Blank column: Indicates that the mode does not support the output of the service information.

#1
If not specified, a space is displayed.

#2
If specified, the The value has already been set. text is displayed.

Return values

Return value Meaning
0 The command terminated normally.
1 The command terminated abnormally.
3 An exclusion error occurred.
9 An error occurred when checking the execution permission.

[Contents][Back][Next]

[Trademarks]

All Rights Reserved. Copyright (C) 2015, Hitachi, Ltd.