Skip navigation links

Oracle Communications Service Broker Platform MBean Java API Reference
6.0

E26173-01


oracle.axia.api.management.agent
Interface ManagementAgentMBean


public interface ManagementAgentMBean

This is the Management Agent MBean.

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

Method Summary
 void forceShutdown()
          Forces the server to shutdown without waiting gracefully for internal components to stop.
 java.lang.String getCurrentState()
          Retrieve the current state of the server.
 java.lang.String getErrorCause()
          Retrive the current error cause.
 int getStartLevel()
          Returns the current start level of the server.
 java.lang.String getTargetState()
          Retrieve the target state of the server.
 void goToAdminLevel()
          Brings the server to the ADMIN level.
 void goToRunningLevel()
          Brings the server to the RUNNING level.
 void goToSafeLevel()
          Brings the server to the SAFE level.
 boolean hasReachedAdminLevel()
          Returns true if the server has reached the ADMIN level.
 boolean hasReachedSafeLevel()
          Returns true if the server has reached the SAFE level.
 boolean serverIsRunning()
          Returns true if the server has reached the RUNNING level.
 void shutdown()
          Shuts down the server gracefully.

 

Method Detail

getStartLevel

int getStartLevel()
Returns the current start level of the server. The start level range goes from 0 (framework stopped) to the running level as defined in the domain.
Returns:
the current start level

goToSafeLevel

void goToSafeLevel()
Brings the server to the SAFE level. This operation will transition the server start level to the SAFE level, as defined in the domain.

hasReachedSafeLevel

boolean hasReachedSafeLevel()
Returns true if the server has reached the SAFE level.
Returns:
true if the server has reached the SAFE level

goToAdminLevel

void goToAdminLevel()
Brings the server to the ADMIN level. This operation will transition the server start level to the ADMIN level, as defined in the domain. In the ADMIN level, usually, the protocol adapters are active but the applications are not.

hasReachedAdminLevel

boolean hasReachedAdminLevel()
Returns true if the server has reached the ADMIN level.
Returns:
true if the server has reached the ADMIN level

goToRunningLevel

void goToRunningLevel()
Brings the server to the RUNNING level. This level means that the server is ready to accept incoming connections. This operation will transition the server start level to the RUNNING level, as defined in the domain.

serverIsRunning

boolean serverIsRunning()
Returns true if the server has reached the RUNNING level.
Returns:
true if the server has reached the RUNNING level

shutdown

void shutdown()
Shuts down the server gracefully.

forceShutdown

void forceShutdown()
Forces the server to shutdown without waiting gracefully for internal components to stop.

getTargetState

java.lang.String getTargetState()
Retrieve the target state of the server.

getCurrentState

java.lang.String getCurrentState()
Retrieve the current state of the server.

getErrorCause

java.lang.String getErrorCause()
Retrive the current error cause. 'null' if no error.

Skip navigation links

Oracle Communications Service Broker Platform MBean Java API Reference
6.0

E26173-01


Copyright © 2011, Oracle. All rights reserved.