oracle.bi.management.adminservices.mbeans
Interface BIComponentMBean

@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

getType

@Description(resourceKey="oracle.bi.management.adminservices.mbeans.BIComponentMBean.Type",
             resourceBundleBaseName="oracle.bi.management.adminservices.rsc.BIMBeanMsg")
oracle.bi.management.bidomain.ComponentType getType()

Deprecated. Use getComponentType() or getOpmnType().

Returns the type of component.

getComponentType

@Description(resourceKey="oracle.bi.management.adminservices.mbeans.BIComponentMBean.ComponentType",
             resourceBundleBaseName="oracle.bi.management.adminservices.rsc.BIMBeanMsg")
java.lang.String getComponentType()

Returns the public type of the component.

Since:

11.1.1.5.51

getOpmnType

@Description(resourceKey="oracle.bi.management.adminservices.mbeans.BIComponentMBean.OpmnType",
             resourceBundleBaseName="oracle.bi.management.adminservices.rsc.BIMBeanMsg")
java.lang.String getOpmnType()

Returns the OPMN type of the component. This will match the type used within OPMN process management.

Since:

11.1.1.5.51

getProcessId

@Description(resourceKey="oracle.bi.management.adminservices.mbeans.BIComponentMBean.ProcessId",
             resourceBundleBaseName="oracle.bi.management.adminservices.rsc.BIMBeanMsg")
java.lang.String getProcessId()

Returns the process id of the component. e.g. coreapplication_obis1

getBIInstanceDeployment

@Description(resourceKey="oracle.bi.management.adminservices.mbeans.BIComponentMBean.BIInstanceDeployment",
             resourceBundleBaseName="oracle.bi.management.adminservices.rsc.BIMBeanMsg")
javax.management.ObjectName getBIInstanceDeployment()

Returns the object name of the mbean which represents the BI Instance deployment for this component.

See Also:

BIInstanceDeploymentMBean

getPort

@Description(resourceKey="oracle.bi.management.adminservices.mbeans.BIComponentMBean.Port",
             resourceBundleBaseName="oracle.bi.management.adminservices.rsc.BIMBeanMsg")
java.lang.Integer getPort()

Returns the main listening port in use for the component.

Returns:

the main listening port in use by the component or null if no port has yet been assigned.

setPort

void setPort(java.lang.Integer port)
             throws java.lang.IllegalArgumentException

Sets the main listening port to use for the component.

Parameters:

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.

Throws:

java.lang.IllegalArgumentException - if the specified value is outside the port range of the owning BIInstanceDeployment.

getMonitorPort

@Description(resourceKey="oracle.bi.management.adminservices.mbeans.BIComponentMBean.MonitorPort",
             resourceBundleBaseName="oracle.bi.management.adminservices.rsc.BIMBeanMsg")
java.lang.Integer getMonitorPort()

Returns the optional monitoring port in use for the component.

Returns:

the optional monitoring port in use by the component. This may be null if no monitoring port has yet been assigned or if the component does not have a monitoring port.

setMonitorPort

void setMonitorPort(java.lang.Integer port)
                    throws java.lang.IllegalArgumentException

Sets the monitoring port to use for the component.

Parameters:

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.

Throws:

java.lang.IllegalArgumentException - if the specified value is outside the port range of the owning BIInstanceDeployment.

getScriptRPCPort

@Description(resourceKey="oracle.bi.management.adminservices.mbeans.BIComponentMBean.ScriptRPCPort",
             resourceBundleBaseName="oracle.bi.management.adminservices.rsc.BIMBeanMsg")
java.lang.Integer getScriptRPCPort()

Returns the optional scriptRPC Port in use for the BISCH component.

Returns:

the optional Scheduler script engine RPC listen port in use by the component. This will be null if component is not scheduler or if no script listen port has yet been assigned for scheduler component.

setScriptRPCPort

void setScriptRPCPort(java.lang.Integer port)
                      throws java.lang.IllegalArgumentException

Sets the scriptRPC port to use for the component.

Parameters:

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.

Throws:

java.lang.IllegalArgumentException - if the specified value is outside the port range of the owning BIInstanceDeployment.

getListenAddress

@Description(resourceKey="oracle.bi.management.adminservices.mbeans.BIComponentMBean.ListenAddress",
             resourceBundleBaseName="oracle.bi.management.adminservices.rsc.BIMBeanMsg")
java.lang.String getListenAddress()

Returns the host name or ip address that all listening ports are bound to for this component. If the listen address is null then the parent instance is responsible for selecting which possible interfaces to bind ports to.

Returns:

the components listen address or null if delegating to parent instance

setListenAddress

void setListenAddress(java.lang.String address)
                      throws java.lang.IllegalArgumentException

Set the host name or ip address to bind listening ports to for this component. Setting to null will mean that the parent instance will be responsible for selecting which possible interfaces to bind ports to.

Parameters:

address -

Throws:

java.lang.IllegalArgumentException

getClusterStyle

@Description(resourceKey="oracle.bi.management.adminservices.mbeans.BIComponentMBean.ClusterStyle",
             resourceBundleBaseName="oracle.bi.management.adminservices.rsc.BIMBeanMsg")
java.lang.String getClusterStyle()

Returns an indication as to whether the component's clustering is managed by OPMN.

Returns:

"SELF_MANAGED" or "OPMN_MANAGED".

Since:

11.1.1.6.52

isStarted

@Description(resourceKey="oracle.bi.management.adminservices.mbeans.BIComponentMBean.Started",
             resourceBundleBaseName="oracle.bi.management.adminservices.rsc.BIMBeanMsg")
boolean isStarted()

Indicates whether the component is running.

stop

@Description(resourceKey="oracle.bi.management.adminservices.mbeans.BIComponentMBean.stop",
             resourceBundleBaseName="oracle.bi.management.adminservices.rsc.BIMBeanMsg")
void stop()
          throws javax.management.OperationsException

Stops the component so no further requests will be serviced. Waits for process to stop before returning.

Throws:

javax.management.OperationsException - if the BI Instance was not successfully stopped.

start

@Description(resourceKey="oracle.bi.management.adminservices.mbeans.BIComponentMBean.start",
             resourceBundleBaseName="oracle.bi.management.adminservices.rsc.BIMBeanMsg")
void start()
           throws javax.management.OperationsException

Starts the component and waits for component to start up before returning.

Throws:

javax.management.OperationsException - if the BI Instance was not successfully started.

getStatus

@Description(resourceKey="oracle.bi.management.adminservices.mbeans.BIComponentMBean.getStatus",
             resourceBundleBaseName="oracle.bi.management.adminservices.rsc.BIMBeanMsg")
java.lang.String getStatus()
                           throws javax.management.OperationsException

Query the underlying process for it's current status.

Returns:

one of: NONE, DOWN, INIT, ALIVE, STOP, STOPPED, BOUNCE, RESTART, INITFAIL, BOUNCEFAIL

Throws:

javax.management.OperationsException