3 Using Java MBeans to Configure a Domain

This chapter describes how to configure a Service Broker domain using Java MBeans.

Opening a Domain for Configuration

To make changes in the domain configuration, you need to open this domain for configuration. After you opened the domain for configuration, no one else can do any changes in the domain.

To open a domain for configuration:

Invoke the following operation of DomainServiceMBean:
```
void openDomain(String domainPath)
```

See "DomainServiceMBean" for more information on this MBean.

Making Configuration Changes in a Domain

After you opened a domain for configuration, you can make configuration changes in the following modes:

Autocommit mode

When you update configurations in this mode, changes are committed and written to the configuration directory immediately. This is the default configuration mode.
Transaction mode

When you update configuration in this mode, multiple changes accumulate into one transaction. Setting the domain configuration to transaction mode makes it possible to perform a set of configuration updates and have them applied all at once.

You can perform the following actions in the transaction mode:
- Setting the transaction mode (see "Setting the Transaction Mode" for more information)
- Discarding changes (see "Discarding Changes" for more information)
- Committing accumulated changes (see "Committing Changes" for more information)

Setting the Transaction Mode

To make changes in the transaction mode:

Invoke the following operation of ConfigurationAdminMBean:
```
void begin()
```

See "ConfigurationAdminMBean" for more information on this MBean.

Discarding Changes

To discard the accumulated changes:

Invoke the following operation of ConfigurationAdminMBean:
```
void rollback()
```

See "ConfigurationAdminMBean" for more information on this MBean.

Committing Changes

To commit the accumulated changes:

Invoke the following operation of ConfigurationAdminMBean:
```
void commit()
```

See "ConfigurationAdminMBean" for more information on this MBean.

Releasing the Lock

To release the lock:

Invoke the following operation of DomainServiceMBean:
```
void closeDomain()
```

See "DomainServiceMBean" for more information on this MBean.

Specifying the Domain Configuration Mode

The domain configuration mode specifies how configuration updates are propagated to servers in the domain. You can use one of the following modes:

Online mode, when configuration updates are propagated to all servers in the domain as the changes are carried out.
Offline mode, when updates are carried out only to the domain configuration and applied to each server when it is re-started.

Setting the domain configuration offline makes it possible to perform a set of configuration updates and apply them the next time a server is restarted. This is used, for example, when doing a rolling upgrade of an installation.

To specify the domain configuration mode:

Set the OnLine attribute of DomainServiceMBean to one of the following values:
- Online
- Offline

Managing Domain Properties

Each domain configuration has a set of properties. The properties are name-value pairs. See Table 3-1.

The domain properties are set during domain creation. After the domain is created, you can change domain properties at any time using DomainServiceMBean.

You specify the domain properties during the domain creation properties.

Table 3-1 Domain Properties

Name	Value
axia.domain.host	Specifies the URI to the domain configuration. Format: [file\| http]://Context_path If your domain configuration is accessed using the Domain Web server, use the scheme http://. Example: http://myhost:9000/ If your domain configuration is accessed using a shared file system, use the scheme file://.
axia.ssl	Specifies if SSL is enabled or disabled for management operations. Set this property to: true to enable SLL false to disable SSL See "Configuring Security Between Service Broker Components".
axia.domain.id	Specifies the domain name in a multi-processing domain. To maintain domain exclusivity, each domain is assigned a unique name. All domains with the same ID are assumed to be in the same domain. Format: Can only contain letters, digits or underscores (a-z, A-Z, 0-9_). Case sensitive. Length: Between 1 and 8 characters. Examples: 23DoMain domain_1 If no name is specifically assigned, the value is default.

Name

Value

axia.domain.host

Specifies the URI to the domain configuration.

Format: [file| http]://Context_path

If your domain configuration is accessed using the Domain Web server, use the scheme http://.

Example:

http://myhost:9000/

If your domain configuration is accessed using a shared file system, use the scheme file://.

axia.ssl

Specifies if SSL is enabled or disabled for management operations.

Set this property to:

true to enable SLL
false to disable SSL

See "Configuring Security Between Service Broker Components".

axia.domain.id

Specifies the domain name in a multi-processing domain.

To maintain domain exclusivity, each domain is assigned a unique name. All domains with the same ID are assumed to be in the same domain.

Format: Can only contain letters, digits or underscores (a-z, A-Z, 0-9_). Case sensitive.

Length: Between 1 and 8 characters.

Examples:

23DoMain
domain_1

If no name is specifically assigned, the value is default.

To change or set a domain property, invoke the operation setDomainProperty on the MBean DomainServiceMBean.

DomainServiceMBean

JAR File

oracle.axia.platform.domainservice-version.jar

version is the version number of the JAR file: for example, 1.0.0.0.

Package

oracle.axia.api.management.ds

Object Name

oracle:type=oracle.axia.api.management.ds.DomainServiceMBean

Factory Method

Created automatically.

Attributes

None.

Operations

void addManagedServer(String name, String host, int port, int adminPort, int jmxJrmpPort, int jmxRegistryPort)

Adds a new server to a domain configuration.

Parameters:

name Name of the server.
host Host of the server.
port General purpose port of the server.
adminPort Administration port of the server.
jmxJrmpPort JMX port of the server.
jmxRegistryPort JMX registry port of the server.

void closeDomain()

Closes a domain that has been opened for updates.

void createDomain(String type, String domainPath)

Creates a domain that is accessed by the servers using a shared file system.

Parameters:

type Type of domain to create. See the discussion on creating the domain in Service Broker Installation Guide for available options.
domainPath Path to the directory where the domain configuration is created.

void createHostedDomain(String type, String domainPath, String hostAddress)

Creates a domain that is accessed by the Service Broker servers using HTTP or HTTPS.

Parameters:

type See createDomain.
domainPath See createDomain.
hostAddress Host and port for the Domain Web Server.

void editManagedServer(String name, String host, int port, int adminPort, int jmxJrmpPort, int jmxRegistryPort)

Edits the settings for a server.

Parameters:

name Name of the server.
host Host of the server.
port Port of the server.
adminPort Administration port of the server.
jmxJrmpPort JMX port of the server.
jmxRegistryPort JMX registry port of the server.

String getDomainProperty(String name)

Gets the value of a domain property. See Table 3-1.

Parameter:

name Name of the property.

isOffline()

Returns true if the domain is in offline configuration mode.

java.util.List<String>listDomainTypes()

Lists available domain types.

java.util.List<String>listServers()

Lists the name of the servers in the domain.

void openDomain(String domainPath)

Opens a domain for editing.

Parameter:

domainPath Path to the directory where the domain configuration is located.

void removeManagedServer(String name)

Removes a server from a domain.

Parameter:

name Name of the server to remove.

void renameDomainProperty(String oldName, String newName, String value)

Renames a domain property. See Table 3-1.

Parameters:

oldName Old name of the property.
newName new name of the property.
value Value of the property.

void setDomainProperty(String name, String value)

Sets a property for a domain. See Table 3-1.

Parameters:

name Name of the property.
value Value of the property.

void setOffline(boolean offline)

Sets the domain to Offline or Online mode.

Parameter:

offline True to set the domain configuration mode to offline, and false to set it to online.

ConfigurationAdminMBean

JAR File

oracle.axia.cm.api-version.jar

version is the version number of the JAR file: for example, 1.0.0.0.

Package

oracle.axia.api.management.cm

Object Name

oracle:type=oracle.axia.api.management.cm.ConfigurationAdminMBean

Factory Method

Created automatically.

Attributes

None.

Operations

void begin(): Sets the configuration changes mode to the Transaction mode.
void commit(): Commits configuration changes accumulated since the configuration changes mode changed to the Transaction mode using the begin operation.
boolean isTransactionActive(): Indicates if the configuration changes mode is set to the Transaction mode.
java.util.List<String>listPendingConfiguration(): Lists pending configuration entries accumulated since the configuration changes mode changed to the Transaction mode using the begin operation.
void rollback(): Discards any pending configuration entries accumulated since the configuration changes mode changed to the Transaction mode using the begin operation.