|
Oracle Fusion Middleware Java API Reference for Oracle Business Intelligence Enterprise Edition Systems Management 11g Release 1(11.1.1) E16455-05 |
|||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
@Description(resourceKey="oracle.bi.management.adminservices.mbeans.BIComponentMBean.description", resourceBundleBaseName="oracle.bi.management.adminservices.rsc.BIMBeanMsg") public interface BIComponentMBean
Defines an MBean interface for a component of a BI Domain. To ensure that exceptions are correctly reported in clients such as JConsole, which typically do not have BIEE jars, only standard exceptions are surfaced here.
Method Summary | |
---|---|
javax.management.ObjectName |
getBIInstanceDeployment()
Returns the object name of the mbean which represents the BI Instance deployment for this component. |
java.lang.String |
getClusterStyle()
Returns an indication as to whether the component's clustering is managed by OPMN. |
java.lang.String |
getComponentType()
Returns the public type of the component. |
java.lang.String |
getListenAddress()
Returns the host name or ip address that all listening ports are bound to for this component. |
java.lang.Integer |
getMonitorPort()
Returns the optional monitoring port in use for the component. |
java.lang.String |
getOpmnType()
Returns the OPMN type of the component. |
java.lang.Integer |
getPort()
Returns the main listening port in use for the component. |
java.lang.String |
getProcessId()
Returns the process id of the component. |
java.lang.Integer |
getScriptRPCPort()
Returns the optional scriptRPC Port in use for the BISCH component. |
java.lang.String |
getStatus()
Query the underlying process for it's current status. |
oracle.bi.management.bidomain.ComponentType |
getType()
Deprecated. Use getComponentType() or getOpmnType() . |
boolean |
isStarted()
Indicates whether the component is running. |
void |
setListenAddress(java.lang.String address)
Set the host name or ip address to bind listening ports to for this component. |
void |
setMonitorPort(java.lang.Integer port)
Sets the monitoring port to use for the component. |
void |
setPort(java.lang.Integer port)
Sets the main listening port to use for the component. |
void |
setScriptRPCPort(java.lang.Integer port)
Sets the scriptRPC port to use for the component. |
void |
start()
Starts the component and waits for component to start up before returning. |
void |
stop()
Stops the component so no further requests will be serviced. |
Method Detail |
---|
@Description(resourceKey="oracle.bi.management.adminservices.mbeans.BIComponentMBean.Type", resourceBundleBaseName="oracle.bi.management.adminservices.rsc.BIMBeanMsg") oracle.bi.management.bidomain.ComponentType getType()
getComponentType()
or getOpmnType()
.
@Description(resourceKey="oracle.bi.management.adminservices.mbeans.BIComponentMBean.ComponentType", resourceBundleBaseName="oracle.bi.management.adminservices.rsc.BIMBeanMsg") java.lang.String getComponentType()
@Description(resourceKey="oracle.bi.management.adminservices.mbeans.BIComponentMBean.OpmnType", resourceBundleBaseName="oracle.bi.management.adminservices.rsc.BIMBeanMsg") java.lang.String getOpmnType()
@Description(resourceKey="oracle.bi.management.adminservices.mbeans.BIComponentMBean.ProcessId", resourceBundleBaseName="oracle.bi.management.adminservices.rsc.BIMBeanMsg") java.lang.String getProcessId()
@Description(resourceKey="oracle.bi.management.adminservices.mbeans.BIComponentMBean.BIInstanceDeployment", resourceBundleBaseName="oracle.bi.management.adminservices.rsc.BIMBeanMsg") javax.management.ObjectName getBIInstanceDeployment()
BIInstanceDeploymentMBean
@Description(resourceKey="oracle.bi.management.adminservices.mbeans.BIComponentMBean.Port", resourceBundleBaseName="oracle.bi.management.adminservices.rsc.BIMBeanMsg") java.lang.Integer getPort()
void setPort(java.lang.Integer port) throws java.lang.IllegalArgumentException
port
- The listening port to use for the component. This may be a null value,
in which case a port will be automatically assigned on commit. If a non-null
value is specified then it must be a number within the port range of the
owning BIInstanceDeployment.
java.lang.IllegalArgumentException
- if the specified value is outside the
port range of the owning BIInstanceDeployment.@Description(resourceKey="oracle.bi.management.adminservices.mbeans.BIComponentMBean.MonitorPort", resourceBundleBaseName="oracle.bi.management.adminservices.rsc.BIMBeanMsg") java.lang.Integer getMonitorPort()
void setMonitorPort(java.lang.Integer port) throws java.lang.IllegalArgumentException
port
- The monitoring port to use for the component. This may be a
null value, in which case a port will be automatically assigned on commit
for those components which require a monitoring port. If a non-null
value is specified then it must be a number within the port range of the
owning BIInstanceDeployment.
java.lang.IllegalArgumentException
- if the specified value is outside the
port range of the owning BIInstanceDeployment.@Description(resourceKey="oracle.bi.management.adminservices.mbeans.BIComponentMBean.ScriptRPCPort", resourceBundleBaseName="oracle.bi.management.adminservices.rsc.BIMBeanMsg") java.lang.Integer getScriptRPCPort()
void setScriptRPCPort(java.lang.Integer port) throws java.lang.IllegalArgumentException
port
- The scriptRPC port to use for the component. This may be a
null value, in which case a port will be automatically assigned on commit
for those components which require a scriptRPC port. If a non-null
value is specified then it must be a number within the port range of the
owning BIInstanceDeployment.
java.lang.IllegalArgumentException
- if the specified value is outside the
port range of the owning BIInstanceDeployment.@Description(resourceKey="oracle.bi.management.adminservices.mbeans.BIComponentMBean.ListenAddress", resourceBundleBaseName="oracle.bi.management.adminservices.rsc.BIMBeanMsg") java.lang.String getListenAddress()
void setListenAddress(java.lang.String address) throws java.lang.IllegalArgumentException
address
-
java.lang.IllegalArgumentException
@Description(resourceKey="oracle.bi.management.adminservices.mbeans.BIComponentMBean.ClusterStyle", resourceBundleBaseName="oracle.bi.management.adminservices.rsc.BIMBeanMsg") java.lang.String getClusterStyle()
@Description(resourceKey="oracle.bi.management.adminservices.mbeans.BIComponentMBean.Started", resourceBundleBaseName="oracle.bi.management.adminservices.rsc.BIMBeanMsg") boolean isStarted()
@Description(resourceKey="oracle.bi.management.adminservices.mbeans.BIComponentMBean.stop", resourceBundleBaseName="oracle.bi.management.adminservices.rsc.BIMBeanMsg") void stop() throws javax.management.OperationsException
javax.management.OperationsException
- if the BI Instance was not successfully
stopped.@Description(resourceKey="oracle.bi.management.adminservices.mbeans.BIComponentMBean.start", resourceBundleBaseName="oracle.bi.management.adminservices.rsc.BIMBeanMsg") void start() throws javax.management.OperationsException
javax.management.OperationsException
- if the BI Instance was not successfully
started.@Description(resourceKey="oracle.bi.management.adminservices.mbeans.BIComponentMBean.getStatus", resourceBundleBaseName="oracle.bi.management.adminservices.rsc.BIMBeanMsg") java.lang.String getStatus() throws javax.management.OperationsException
javax.management.OperationsException
|
Oracle Fusion Middleware Java API Reference for Oracle Business Intelligence Enterprise Edition Systems Management 11g Release 1(11.1.1) E16455-05 |
|||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |