oracle.axia.api.management.ds

Interface DomainServiceMBean

public interface DomainServiceMBean

MBean to access the features of the Domain Service. Not all features are supported but more will be added as needed.

Author:

Copyright (c) 2009 by Oracle Corp. All Rights Reserved.

Method Summary

Modifier and Type	Method and Description
void	addManagedServer(java.lang.String name, java.lang.String host, int port, int adminPort, int jmxJrmpPort, int jmxRegistryPort) Adds a managed server to the domain.
void	closeDomain() Closes a previously opened domain.
void	createDomain() Creates a new domain on the disk, interactively.
void	createDomain(java.lang.String type, java.lang.String domainPath) Creates a new domain on the disk.
void	createDomain(java.lang.String type, java.lang.String domainPath, java.lang.String bundleGroups) Creates a new domain on the disk with the list of bundle groups explicitly specified as an argument.
void	createDomain(java.lang.String domainTypes, java.lang.String domainPath, java.lang.String mAddress, int mPort, int mTtl, java.lang.String properties) Creates a new domain on the disk, silently.
void	createHostedDomain(java.lang.String type, java.lang.String domainPath, java.lang.String hostAddress) Creates a new domain on the disk that is going to be hosted.
void	createHostedDomain(java.lang.String type, java.lang.String domainPath, java.lang.String hostAddress, java.lang.String bundleList) Creates a new domain on the disk that is going to be hosted.
void	editManagedServer(java.lang.String name, java.lang.String host, int port, int adminPort, int jmxJrmpPort, int jmxRegistryPort) Edits an existing managed server.
java.lang.String	getDomainProperty(java.lang.String name) Returns the value of a property from the domain.
boolean	isOffline() Returns true if the domain is in offline mode.
java.util.List<java.lang.String>	listDomainTypes() Returns the domain types available.
java.util.List<java.util.Map<java.lang.String,java.lang.String>>	listServers() Returns the list of servers available in the domain.
void	openDomain(java.lang.String domainPath) Opens a domain for editing.
void	removeManagedServer(java.lang.String name) Removes a managed server from the domain.
void	renameDomainProperty(java.lang.String oldName, java.lang.String newName, java.lang.String value) Renames a domain property.
void	setDomainProperty(java.lang.String name, java.lang.String value) Sets a domain property.
void	setOffline(boolean offline) Sets the domain to offline or online mode.

Method Detail

setOffline

void setOffline(boolean offline)

Sets the domain to offline or online mode.

Parameters:

offline - true to offline mode or false for online mode

isOffline

boolean isOffline()

Returns true if the domain is in offline mode.

Returns:

true if the domain is in offline mode

listDomainTypes

java.util.List<java.lang.String> listDomainTypes()

Returns the domain types available. Each domain type is described by a string that can be re-used to create a domain.

Returns:

a list of string naming each domain type available

createDomain

void createDomain()
           throws java.io.IOException

Creates a new domain on the disk, interactively.

Throws:

java.io.IOException - Exception if the domain cannot be created

createDomain

void createDomain(java.lang.String domainTypes,
                  java.lang.String domainPath,
                  java.lang.String mAddress,
                  int mPort,
                  int mTtl,
                  java.lang.String properties)
           throws java.io.IOException

Creates a new domain on the disk, silently.

Parameters:

domainTypes - The domain types to include. See getDomainTypes().

domainPath - The path where the domain will be created

mAddress - The multicast address for the cluster.

mPort - The multicast port for the cluster.

mTtl - The TTL for the cluster.

properties - Additional domain properties.

Throws:

java.io.IOException - Exception if the domain cannot be created

createDomain

void createDomain(java.lang.String type,
                  java.lang.String domainPath)
           throws java.io.IOException

Creates a new domain on the disk.

Parameters:

type - The type of domain. See getDomainTypes().

domainPath - The path where the domain will be created

Throws:

java.io.IOException - Exception if the domain cannot be created

createDomain

void createDomain(java.lang.String type,
                  java.lang.String domainPath,
                  java.lang.String bundleGroups)
           throws java.io.IOException

Creates a new domain on the disk with the list of bundle groups explicitly specified as an argument.

Parameters:

type - The type of domain. See getDomainTypes().

domainPath - The path where the domain will be created

bundleGroups - List of bundle group to include (comma separated list). For example, to include only SIP bundles, specify: "base,base-sip,app,app-sip". Note that "base" and "app" must generally be included as they contain the base bundles for the server

Throws:

java.io.IOException - Exception if the domain cannot be created

createHostedDomain

void createHostedDomain(java.lang.String type,
                        java.lang.String domainPath,
                        java.lang.String hostAddress)
                 throws java.io.IOException

Creates a new domain on the disk that is going to be hosted. Refers to createDomain() for a description of the type of domain available.

Parameters:

type - The type of domain. Can be "all", "app" or "pa".

domainPath - The path where the domain will be created

hostAddress - The address that will be used to host the domain

Throws:

java.io.IOException - Exception if the domain cannot be created

createHostedDomain

void createHostedDomain(java.lang.String type,
                        java.lang.String domainPath,
                        java.lang.String hostAddress,
                        java.lang.String bundleList)
                 throws java.io.IOException

Creates a new domain on the disk that is going to be hosted. Refers to createDomain() for a description of the type of domain available.

Parameters:

type - The type of domain. Can be "all", "app" or "pa".

domainPath - The path where the domain will be created

hostAddress - The address that will be used to host the domain

bundleList - List of bundles to include (comma separated list).

Throws:

java.io.IOException - Exception if the domain cannot be created

openDomain

void openDomain(java.lang.String domainPath)
         throws java.io.IOException

Opens a domain for editing.

Parameters:

domainPath - The domain path

Throws:

java.io.IOException - Exception if the domain cannot be open or if the domain is already opened by another process

closeDomain

void closeDomain()
          throws java.io.IOException

Closes a previously opened domain.

Throws:

java.io.IOException - Exception if the domain cannot be closed

listServers

java.util.List<java.util.Map<java.lang.String,java.lang.String>> listServers()

Returns the list of servers available in the domain. Each entry in the list is a map containing all the server information (e.g. name, host).

Returns:

The list of servers available in the domain

addManagedServer

void addManagedServer(java.lang.String name,
                      java.lang.String host,
                      int port,
                      int adminPort,
                      int jmxJrmpPort,
                      int jmxRegistryPort)
               throws java.io.IOException

Adds a managed server to the domain. A domain must be opened before using this operation. Each managed server must have a unique name.

Parameters:

name - Name of the managed server

host - Host of the managed server

port - Port of the managed server (deprecated/unused)

adminPort - Admin port of the managed server

jmxJrmpPort - JMX port of the managed server

jmxRegistryPort - JMX registry port of the managed server

Throws:

java.io.IOException - Exception if the managed server cannot be added to the domain

editManagedServer

void editManagedServer(java.lang.String name,
                       java.lang.String host,
                       int port,
                       int adminPort,
                       int jmxJrmpPort,
                       int jmxRegistryPort)
                throws java.io.IOException

Edits an existing managed server. Note that if a managed server needs to be renamed it must be deleted and created again. A domain must be opened before using this operation.

Parameters:

name - Name of the managed server

host - Host of the managed server

port - Port of the managed server (deprecated/unused)

adminPort - Admin port of the managed server

jmxJrmpPort - JMX port of the managed server

jmxRegistryPort - JMX registry port of the managed server

Throws:

java.io.IOException - Exception if the managed server cannot be edited

removeManagedServer

void removeManagedServer(java.lang.String name)
                  throws java.io.IOException

Removes a managed server from the domain. A domain must be opened before using this operation.

Parameters:

name - Name of the managed server to remove

Throws:

java.io.IOException - Exception if the managed server cannot be removed

setDomainProperty

void setDomainProperty(java.lang.String name,
                       java.lang.String value)
                throws java.io.IOException

Sets a domain property. A domain must be opened before using this operation.

Parameters:

name - Name of the property

value - Value of the property.

Throws:

java.io.IOException - Exception if the property cannot be written to the domain

renameDomainProperty

void renameDomainProperty(java.lang.String oldName,
                          java.lang.String newName,
                          java.lang.String value)
                   throws java.io.IOException

Renames a domain property. A domain must be opened before using this operation.

Parameters:

oldName - Old property name

newName - New property name

value - Property value

Throws:

java.io.IOException - Exception if the property cannot be written to the domain

getDomainProperty

java.lang.String getDomainProperty(java.lang.String name)

Returns the value of a property from the domain.

Parameters:

name - Name of the property

Returns:

Value of the property