|
Oracle Communications Service Broker Platform MBean Java API Reference 6.0 E26173-01 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface DomainServiceMBean
MBean to access the features of the Domain Service. Not all features are supported but more will be added as needed.
Method Summary | |
---|---|
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(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 |
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 |
---|
void setOffline(boolean offline)
offline
- true to offline mode or false for online modeboolean isOffline()
java.util.List<java.lang.String> listDomainTypes()
void createDomain(java.lang.String type, java.lang.String domainPath) throws java.io.IOException
type
- The type of domain. See getDomainTypes().domainPath
- The path where the domain will be createdjava.io.IOException
- Exception if the domain cannot be createdvoid createDomain(java.lang.String type, java.lang.String domainPath, java.lang.String bundleGroups) throws java.io.IOException
type
- The type of domain. See getDomainTypes().domainPath
- The path where the domain will be createdbundleGroups
- 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 serverjava.io.IOException
- Exception if the domain cannot be createdvoid createHostedDomain(java.lang.String type, java.lang.String domainPath, java.lang.String hostAddress) throws java.io.IOException
type
- The type of domain. Can be "all", "app" or "pa".domainPath
- The path where the domain will be createdhostAddress
- The address that will be used to host the domainjava.io.IOException
- Exception if the domain cannot be createdvoid createHostedDomain(java.lang.String type, java.lang.String domainPath, java.lang.String hostAddress, java.lang.String bundleList) throws java.io.IOException
type
- The type of domain. Can be "all", "app" or "pa".domainPath
- The path where the domain will be createdhostAddress
- The address that will be used to host the domainbundleList
- List of bundles to include (comma separated list).java.io.IOException
- Exception if the domain cannot be createdvoid openDomain(java.lang.String domainPath) throws java.io.IOException
domainPath
- The domain pathjava.io.IOException
- Exception if the domain cannot be open or if the domain is already opened by another processvoid closeDomain() throws java.io.IOException
java.io.IOException
- Exception if the domain cannot be closedjava.util.List<java.util.Map<java.lang.String,java.lang.String>> listServers()
void addManagedServer(java.lang.String name, java.lang.String host, int port, int adminPort, int jmxJrmpPort, int jmxRegistryPort) throws java.io.IOException
name
- Name of the managed serverhost
- Host of the managed serverport
- Port of the managed server, -1 means disabledadminPort
- Admin port of the managed serverjmxJrmpPort
- JMX port of the managed serverjmxRegistryPort
- JMX registry port of the managed serverjava.io.IOException
- Exception if the managed server cannot be added to the domainvoid editManagedServer(java.lang.String name, java.lang.String host, int port, int adminPort, int jmxJrmpPort, int jmxRegistryPort) throws java.io.IOException
name
- Name of the managed serverhost
- Host of the managed serverport
- Port of the managed server, -1 means disabledadminPort
- Admin port of the managed serverjmxJrmpPort
- JMX port of the managed serverjmxRegistryPort
- JMX registry port of the managed serverjava.io.IOException
- Exception if the managed server cannot be editedvoid removeManagedServer(java.lang.String name) throws java.io.IOException
name
- Name of the managed server to removejava.io.IOException
- Exception if the managed server cannot be removedvoid setDomainProperty(java.lang.String name, java.lang.String value) throws java.io.IOException
name
- Name of the propertyvalue
- Value of the property.java.io.IOException
- Exception if the property cannot be written to the domainvoid renameDomainProperty(java.lang.String oldName, java.lang.String newName, java.lang.String value) throws java.io.IOException
oldName
- Old property namenewName
- New property namevalue
- Property valuejava.io.IOException
- Exception if the property cannot be written to the domainjava.lang.String getDomainProperty(java.lang.String name)
name
- Name of the property
|
Oracle Communications Service Broker Platform MBean Java API Reference 6.0 E26173-01 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |