Modifying the web services configuration
You can modify some configuration properties for web service implementations without stopping services and the Tomcat server.
The Service Configuration web service is deployed with CMDB Web Services archive and offers the following operations:
| Operation | Description |
|---|---|
GetProperties | For each specified property, this operation returns the matching data type, password status, and value. To retrieve all available properties, do not specify any property names. If a property is enabled as a password, GetProperties returns the value in encrypted format. |
SetProperties | For a specific property, set its data type, value, and password status. You can also use SetProperties to create custom properties. If the data type of a property is String and the password setting is True, the value of the property is passed encrypted. Only string properties can be passwords, so the password enablement is ignored for properties with other data types. If you specify a property that does not exist, SetProperties creates the property and applies settings that you declare for that property. |
| DeleteProperties | For each specified property, this operation performs one of the following actions:
|
Although these operations must meet the same security requirements as the rest of the web services, the UsernameToken does not contain a Remedy AR System username but an administrative username specific to the web service. The default for both the username and password for this administrative service is admin and admin respectively.
Runtime web services properties
Property | Settings | Description |
|---|---|---|
bmc.atrium.arserver.hostname | Type: string Default: localhost Password: false | The hostname of the Remedy Action Request System and BMC CMDB server that web services accesses. |
bmc.atrium.arserver.port | Type: integer Default: 0 Password: false | The port number of the Remedy Action Request System and BMC CMDB server that web services accesses. |
bmc.atrium.arserver.rpcqueue | Type: integer Default: 0 Password: false | The default RPC queue number used to access the BMC CMDB. Clients can specify a value for the RPC queue. But if not, the value defined for this property is used. |
bmc.atrium.arserver.defaultlocale | Type: string Default: en Password: false | The default locale to be used by the Web services and the Remedy AR System server/CMDB for its human readable status or fault messages. Clients can specify a value for the default locale. But if not, the value defined for this property is used. |
bmc.atrium.arserver.defaulttimezone | Type: string Default: NIL Password: false | The default timezone to be used in accessing the Remedy AR System server/CMDB. Clients can specify a value for the default time zone. But if not, the value defined for this property is used. |
bmc.atrium.arserver.defaulttimeout.normal | Type: integer Default: 0 Password: false | The normal timeout value to be used in accessing the Remedy AR System server/CMDB. Clients can specify a value for the default timeout. But if not, the value defined for this property is used. |
bmc.atrium.arserver.defaulttimeout.long | Type: integer Default: 0 Password: false | The long timeout value to be used in accessing the Remedy AR System server/CMDB. Clients can specify a value for the default long timeout. But if not, the value defined for this property is used. |
bmc.atrium.arserver.defaulttimeout.xlong | Type: integer Default: 0 Password: false | The extra long timeout value to be used in accessing the Remedy AR System server/CMDB. Clients can specify a value for the default extra long timeout. But if not, the value defined for this property is used. |
bmc.atrium.log.level | Type: string Default: WARN Password: false | The level at which the CMDB Web Services should log themselves. Log messages are written out to standard out, meaning that those messages should be included in the console window of Tomcat or one of its standard out logs. Possible values are INFO, ERROR, WARN, DEBUG, and TRACE. |
bmc.atrium.graphwalk.defaultexpiration | Type: duration Default: PT1H Password: false | The default expiration duration for any new graph walk query that began through the Graph walk service. Clients can specify this value, but if it is not specified, this value is taken as the default. The value is stored in xs:duration format. |
bmc.atrium.graphwalk.minimumexpiration | Type: duration Default: PT5M Password: false | The minimum expiration duration for any new graph walk query that began through the graph walk service. If a client submits a value that is below this minimum value, this value will become the expiration value instead. The value is stored in xs:duration format. |
bmc.atrium.graphwalk.maximumexpiration | Type: duration Default: PT5M Password: false | The maximum expiration duration for any new graph walk query that began through the graph Walk Service. If a client submits a value that is above this maximum value, this value will become the expiration value instead. It is in xs:duration format. |
bmc.atrium.graphwalk.cleanupinterval | Type: long Default: 300000 Password: false | The duration in milliseconds after which a new query or operation runs a cleanup thread before continuing the operation. This cleanup thread removes any graph walk contexts from the Graph Walk Service's memory before allowing the operation to continue. It will then reset the timer to wait for the completion of another interval. |
bmc.atrium.graphwalk.maximumretrieval | Type: integer Default: 250 Password: false | The maximum number of instances that can be returned in a single pull operation against a given graph walk context in the GraphWalk Service. If the number specified by the user exceeds this amount, this amount will be what is returned at most. |
bmc.atrium.serviceconfig.admin.username | Type: string Default: admin Password: false | The administrator username that allows access to the Service Configuration Service to retrieve or modify these runtime properties. |
bmc.atrium.serviceconfig.admin.password | Type: string Default: admin Password: true | The administrator password that allows access to the Service Configuration Service to retrieve or modify these runtime properties. |
The settings for these properties are stored in <ATRIUMCORE_HOME>/wsc/atriumws<currentAtriumVersion>/conf/AtriumProperties.xml.
The AriumProperties.xml file is loaded one time: the first call that a client makes to any web service that relies on those properties. When you use the Service Configuration web service, property modifications are saved immediately to AriumProperties.xml, preserving the properties' states on the next major restart or packaging and deployment of a new archive. Any required pre-determined properties that are missing from this file on startup are populated with default values.
You can modify the properties in AtriumProperties.xml instead of using the Service Configuration Web Service, but you must stop the services while modifying the properties and restart the Tomcat server. This risks disrupting other applications that the Tomcat server hosts.
Modifying archive properties in main.xml
To configure or view all security settings, you must use the atriumwsutil utility because all property values are encrypted in the conf/crypto.xml file, which is local to the utility.
However, some foundational properties are not related specifically to security and are not obscured through encryption. These properties are stored in the main.xml file which is a basic Java properties file in XML format. The installer populates the file with the correct properties. Normally, you do not need to modify the main.xml file.
If you modify the main.xml file, you must package and deploy the service.
Properties in main.xml
Property | Description |
|---|---|
| The absolute canonical path to the directory that contains the atriumwsutil utility, which will be used by the Web services to determine where to access resources relative to this directory, such as the runtime configuration properties file (contained in the c*onf/AtriumProperties.xml* file) and the default keystores (contained in the keystores directory). |
| The intended file name for the CMDB Web Services archive, so that the utility can repackage the assembly using the correct name. For this version of Atrium, that file name is atriumws91.aar. |
| The hostname of the computer system on which the utility and Web services are executing. In this version of Atrium, this value will be used by the utility to create the endpoint in the WSDL files to be accessed at runtime. |
| The port established in the Tomcat instance that will host the CMDB Web Application and the CMDB Web Services archive for the HTTP connector. It will be used by the utility in the formation of the endpoint in the WSDL files to be accessed at runtime when HTTP is specified as the published connection. |
| The port established in the Tomcat instance that will host the Atrium Web Application and the CMDB Web Services archive for the HTTPS connector. It will be used by the utility in the formation of the endpoint in the WSDL files to be accessed at runtime when HTTPS is specified as the published connection. |
| The first half of the local path that the utility will use in the formation of the endpoint in the WSDL files to be accessed at runtime. The value for this version of Atrium is atriumws81/services. The latter half of the endpoint is the name of the service, such as atrium_classes for the classes service. |
| The absolute canonical path to the Atrium Web Application currently running in Tomcat. The value for this version would usually be <CATALINA_HOME>/webapps/atriumws81, where <CATALINA_HOME> is the root of the Tomcat 6 installation that is hosting the Atrium Web Application. |
| The local directory name for the WEB-INF directory of the CMDB Web Application. It is almost always set to WEB-INF. |
| The local directory name for the directory that contains the Web service archives to be hosted by the CMDB Web Application. This is almost always set to services. The combination of this and the previous two properties determines which directory the utility will copy the latest Web Service archive for hot deploy. |
| The local file name for the directory that contains the file names of the Web service archives to be hosted by the Atrium Web Application. This is almost always set to services.list. When deploying, the utility updates this file to contain the Atrium Web service archive if it does not already contain it. |
| The major version. For example, for the release BMC CMDB 19.02.00, it is 19. |
| The minor version. For example, for the release BMC CMDB 19.02.00, it is 02. |
| The revision version. For example, for the release BMC CMDB 19.02.00, it is 00. |
| The patch level. For example, for the release BMC CMDB 20.02.01, it is 01. |
| The abbreviated version for the release of BMC CMDB, which is unique to a release of CMDB for all but patch level. |
Updating the WSDL and EPR links in the UDDI Registry to display the HTTPS port
Although you configured the web services port to HTTP by using the atriumws utility, the WSDL and EPR links in the UDDI Registry display the HTTPS port. To work around this issue, you must manually replace the HTTPS port with the HTTP port in the UDDI Registry.
To update the WSDL and EPR links in the UDDI Registry on Windows
- On the system where Web Services Registry is installed, open a command prompt window.
- Type the following command:
cd %ATRIUMCORE_HOME%\wsc\wsregistryapi - Type the following command to set the
CLASSPATHvariable:SET CLASSPATH=WSRegistryAPI81.jar;lib/axis2-1.5.1-merge-client-set.jar;lib/activation-1.1.jar - To delete the incorrect WSDL and EPR links from the UDDI Registry, enter a command similar to the following:
java -cp %CLASSPATH% com.bmc.webservices.uddiapi.test.UDDIRegistryInstallUtil deleteaccesspts localhost <UDDI_PORT> <UDDI_USER> <UDDI_PASSWD> .\webservices_list_template.xml - Open the webservices_list_template.xmlfile and apply the following changes:
- Replace all instances of
httpswithhttp. - For each service, replace the HTTPS port number with the HTTP port number in the EPR and WSDL URL links.
- Replace all instances of
- To add the correct WSDL and EPR links in the UDDI Registry, enter a command similar to the following:
java -cp %CLASSPATH% com.bmc.webservices.uddiapi.test.UDDIRegistryInstallUtil publish localhost <UDDI_PORT> <UDDI_USER> <UDDI_PASSWD> .\webservices_list_template.xml
To update the WSDL and EPR links in the UDDI Registry on UNIX or Linux
- On the system where Web Services Registry is installed, open a shell window.
- Type the following command:
cd $ATRIUMCORE_HOME/wsc/wsregistryapi - Type the following command to set the
CLASSPATHvariable:export CLASSPATH=WSRegistryAPI81.jar:lib/axis2-1.5.1-merge-client-set.jar;lib/activation-1.1.jar - To delete the incorrect WSDL and EPR links from the UDDI Registry , enter a command similar to the following:
java -cp $CLASSPATH com.bmc.webservices.uddiapi.test.UDDIRegistryInstallUtil deleteaccesspts localhost <UDDI_PORT> <UDDI_USER> <UDDI_PASSWD> ./webservices_list_template.xml - Open the webservices_list_template.xmlfile and apply the following changes:
- Replace all instances of "https" with "http".
- For each service, replace the HTTPS port number with the HTTP port number in the EPR and WSDL URL links.
- To add the correct WSDL and EPR links in the UDDI Registry, enter a command similar to the following:
java -cp $CLASSPATH com.bmc.webservices.uddiapi.test.UDDIRegistryInstallUtil publish localhost <UDDI_PORT> <UDDI_USER> <UDDI_PASSWD> ./ webservices_list_template.xml
Comments
Log in or register to comment.