Oracle® Communications Service Broker System Administrator's Guide Release 5.0 Part Number E15183-01 |
|
|
View PDF |
This chapter contains reference information on directory structures and directory contents, along with details about the start-scripts, JDKs and installer files.
This appendix specifies the directory structure, directory contents and start-scripts for an administration clients.
All administration clients are installed under the directory:
Linux and Solaris: Oracle_home/axia/admin_console
Oracle_home is the Oracle Home directory you defined when you installed the product.
Table A-1 describes the directory structure and the contents of the directory structure.
Table A-1 Directory Contents and Structure for Administration Clients Relative to Oracle_home/axia
Directory | Description |
---|---|
admin_console |
Top-level directory for all administration clients. It contains start-scripts for:
It also contains files related to Log4J:
|
admin_console/applications |
Created during start-up. Empty directory. |
admin_console/config |
Contains configuration data. |
admin_console/modules |
Contains all OSGi bundles for the administration clients, the Processing Server, and the Signaling Server. |
admin_console/osgi |
Contains platform-specific binaries and configuration files. |
admin_console/properties |
It contains property files used by the start-scripts for:
|
admin_console/workspace |
Contains meta-data for the administration clients. |
Table A-2 give information about start-scripts for Service Broker.
Table A-2 Start-scripts for the Administration Clients
Script | Description |
---|---|
script.sh |
Starts the Scripting Engine. It defines the environment variables:
script.sh calls common.sh. For more information, see Chapter 11, "Using Scripts for Configuration and Management". |
start.sh |
Starts the Stand-alone Administration Console. It defines the environment variables:
start.sh calls common.sh. |
web.sh |
Starts the Web Administration Console server. It defines the environment variables:
web.sh calls common.sh. For information on how to use the script, see Chapter 4, "Starting and Stopping Web Administration Console Servers". |
host.sh |
Starts the Domain Web server. It defines the environment variables:
host.sh calls common.sh. For information on how to use the script, see Chapter 5, "Starting and Stopping Domain Web Servers". |
common.sh |
Starts the Stand-alone Administration Console, Web Administration Console server, Scripting Engine, and the Domain Web server based on the environment variables set by the script that calls it. It defines the environment variables:
Defines the system property boot.properties. |
Table A-3 gives information property files in:
Oracle_home/admin_console/properties
Table A-3 Property files used by the Administration Clients
Property File | Description |
---|---|
common.properties |
Defines properties common for the:
The properties specified are:
See Table A-8. |
hosting.properties |
Defines properties for the Domain Web server. The properties specified are:
See Table A-8. |
script.properties |
Defines properties for the Domain Web server. The properties specified are:
See Table A-8. |
standalone.properties |
Defines properties for the Stand-alone Administration Console. The properties specified are:
See Table A-8. |
web.properties |
Defines properties for the Web Administration Console server. The properties specified are:
See Table A-8. |
This section specifies the directory structure, directory contents and start-scripts for Processing Servers and Signaling Servers.
Processing Servers and a Signaling Servers are installed under the directory:
Oracle_home/axia/managed_server
Where Oracle_home is the Oracle Home directory you defined when you installed the product.
Table A-4 describes the directory structure and the contents of the directory structure.
Table A-4 Directory Contents and Structure for Processing Servers and Signaling Servers relative to Oracle_home/axia
Directory | Description |
---|---|
managed_server |
Top-level directory for a Processing Server and a Signaling Server. It contains start-scripts for the Processing Server and the Signaling Server. I contains the property file server.properties. It also contains files related to Log4J:
These files are relevant up the point in the platform life cycle when the bundle for the Log4JService is started. After this point, this configuration is overridden by the configuration in the Log4J service itself. |
managed_server/config |
Contains configuration data. |
managed_server/modules |
Contains all necessary bundles to start the OSGi framework and bundles for:
The bundles in this directory is the minimal set necessary to initiate the server and load the contents of the domain configuration directory. |
managed_server/osgi |
This directory, sub-directories, and contents are created as a part of the server start life cycle and mirrors the content of the domain configuration file. Synchronized with the domain configuration. |
managed_server/osgi |
Contains binaries for the SS7 stacks for TDM and Sigtran. |
Table A-5 give information about start-scripts for Processing Servers and Signaling Servers.
Table A-5 Start-scripts for Processing Servers and Signaling Servers
Script | Description |
---|---|
start.sh |
Starts the Stand-alone Administration Console. Defines the environment variables:
Defines properties for the servers. The properties specified are:
See Table A-6. For a syntax description, see Chapter 2, "Starting and Stopping Processing Servers and Signaling Servers". |
Table A-6 gives information property files in:
Oracle_home/managed_server/properties
Table A-6 Property Files Used by Processing Servers and Signaling Servers
Property File | Description |
---|---|
server.properties |
Defines properties common for Processing Servers and Signaling Servers. The properties specified are:
See Table A-8. |
Table A-7 give information about the environment variables used.
Table A-7 Environment variables
Variable | Description |
---|---|
OSGI_CONFIG |
Defines the OSGi configuration and bundles. Must be set to:
|
BOOT_CONFIG |
Defines which property file to use. See Table A-3. |
BOOT_OPTS |
Defines system properties used at boot time. See Table A-8. |
JAVA_CMD |
Defines the JRE to use. |
AXIA_OPTS |
Defines any additional Java options to use. |
AXIA_MEM_OPTS |
Defines the Java heap size. Sets the flag -Xmx when starting the JRE. |
JAVA_OPTS |
Defines the system property boot.properties and aggregates the following environment variables:
|
Table A-8 describes the system properties defined for Oracle Communications Service Broker.
Table A-8 Description of System Properties
System Property | Description |
---|---|
axia.console.log4j.server.port |
The port to use for the logging service. Set in common.properties |
log4j.configuration |
The name of the static Log4J XML configuration file. Set in common.properties for the administration tools. Set in server.properties for the Processing Server and the Signaling Server. |
provisioning.spid |
Defines the name of the Processing Server or Signaling Server. Provided as an argument to the command. Set in start.sh (Processing Server and Signaling Server). |
org.osgi.ip.URL |
Defines the URL of the domain configuration file. HTTP and FILE can be used as the protocol part. Set in start.sh (Processing Server and Signaling Server). |
org.eclipse.equinox.http.jetty.http.port |
Defines the port the Web server listens to. Set in:
The setting in web.properties defines the port for the Web Administration Console server. The setting in hosting.properties defines the port for the Domain Web server. This setting must correspond to the port defined when the domain configuration was created. |
axia.domain.path |
Defines the URL to the domain configuration. Provided as an argument to the command. Set in web.sh. |
axia.hosting.domain.path |
Defines the URL to the domain configuration. Provided as an argument to the command. Set in host.sh. |
axia.console.script |
Defines the script to execute. Provided as an argument to the command. Set in script.sh. |
axia.ssl |
Specifies if SSL is enabled or disabled. Set this property to:
Set in common.properties. |
javax.net.ssl.keyStore |
The filename of the keystore to use for processing servers, signaling servers and the administration tools. The keystore is a file that contains public and private keys used to establish SSL connections. Set in common.properties for the administration tools. Set in server.properties for the Processing Server and the Signaling Server. |
javax.net.ssl.trustStore |
The filename of the truststore to use for processing servers, signaling servers and the administration tools. The truststore is a file that contains public certificates used to establish SSL connections. Set in common.properties for the administration tools. Set in server.properties for the Processing Server and the Signaling Server. |
axia.platform |
It defines the start mode. This must not be changed. Must be set to:
Set in:
|
org.eclipse.equinox.http.jetty.http.enabled |
Specifies if HTTP is used or not. Set this property to:
Set in:
Must always the Boolean NOT of the property org.eclipse.equinox.http.jetty.https.enabled in web.properties. Must always be set to false in script.properties and standalone.properties. |
org.eclipse.equinox.http.jetty.https.enabled |
Specifies if HTTPS is used or not. Set this property to:
Set in:
Must always the Boolean NOT of the property org.eclipse.equinox.http.jetty.http.enabled in web.properties. Must always be set to false in script.properties and standalone.properties. |
axia.basic.auth |
Specifies if HTTP basic authentication is used or not when the Web Administration Console connects to the Web Administration Console server. Set this property to:
Set in web.properties. |
org.eclipse.equinox.http.jetty.https.port |
Specifies which port to use for HTTPS connections. Set in web.properties. |
org.eclipse.equinox.http.jetty.ssl.keystore |
Specifies the keystore to use for the HTTPS connection between the Web Administration Console and the Web Administration Console server. This property i not set by default. If not set, the same keystore as defined in the property javax.net.ssl.keyStore is used. Set in web.properties. |
org.eclipse.equinox.http.jetty.other.info |
Specifies which help-system to use for the Administration Console. Ignored, for future use. Set in web.properties. |
boot.properties |
Specifies which property file to use. Do not change this setting. Set in:
|
Table A-9 give information about the directory structure and contents of a domain configuration.
Table A-9 Directory Structure for a Domain Configuration
Directory | Description |
---|---|
Domain_home |
Top-level directory for a domain configuration. This directory contains:
|
Domain_home/modules |
Contains binaries and configuration data for Processing Servers and Signaling Servers in the domain. |
A bundled JDK can be installed when an administration client, a Processing Server, and a Signaling Server is installed.
These files are located in under the directory:
Linux and Solaris: Oracle_home/axia
Where Oracle_home is the Oracle Home directory you defined when you installed the product.
Table A-10 describes the directory structure and the contents of the directory structure.
Table A-10 Directory Structure for JDKs Relative to Oracle_home/axia
Directory | Description |
---|---|
jdkversion |
Contains Sun HotSpot JDK. version correlates to the version of the JDK, for example 1.6.0_14 This directory is created only if you specified to install Sun HotSpot JDK during the installation. |
jrrt-version |
Contains Oracle JRockit JDK. version correlates to the version of the JDK, for example 3.1.0-1.6.0 This directory is created only if you specified to install Oracle JRockit JDK during the installation. |
A set of files and directories are created by Oracle Universal Installer.
These files are located under the directory:
Oracle_home/axia
Where Oracle_home is the Oracle Home directory you defined when you installed the product.
Table A-11 describes the directory structure and the contents of the directory structure.
Safe services is a set of services that are installed and running when the platform is in state SAFE MODE. They are the bare minimum of services that needs to be running in order to fetch server services, applications, and protocol adapters for the domain configuration and start them. Table A-12 lists these services.
Service | OSGi Bundles |
---|---|
Provisioning service |
oracle.axia.platform.provisioningservice |
Logging-related |
com.bea.core.apache.log4j oracle.axia.platform.loggingservice |
Services related to Equinox OSGi Framework |
org.eclipse.osgi.services org.eclipse.osgi.services org.eclipse.equinox.ds org.eclipse.equinox.util |