org.mule.module.management.mbean.MuleServiceMBean Maven / Gradle / Ivy

Go to download
/*
 * $Id$
 * --------------------------------------------------------------------------------------
 * Copyright (c) MuleSoft, Inc.  All rights reserved.  http://www.mulesoft.com
 *
 * The software in this package is published under the terms of the CPAL v1.0
 * license, a copy of which has been included with this distribution in the
 * LICENSE.txt file.
 */

package org.mule.module.management.mbean;

import org.mule.api.MuleException;

import java.util.Date;

/**
 * MuleServiceMBean is a JMX service interface for the MuleContext.
 * 
 */
public interface MuleServiceMBean
{
    // CRITICAL: do not modify the order of key/value pairs here, it MUST
    // match the one returned by ObjectName.getCanonicalKeyPropertyListString()
    String DEFAULT_JMX_NAME = "name=MuleContext";

    boolean isInitialised();

    boolean isStopped();

    Date getStartTime();

    String getVersion();

    String getVendor();

    void start() throws MuleException;

    void stop() throws MuleException;

    void dispose() throws MuleException;

    long getFreeMemory();

    long getMaxMemory();

    long getTotalMemory();

    String getServerId();

    String getHostname();

    String getHostIp();

    String getOsVersion();

    String getJdkVersion();

    String getCopyright();

    String getLicense();

    String getBuildDate();

    String getBuildNumber();

    String getInstanceId();

    /**
     * Contains value of option -builder
     *
     * @return builder class name
     */
    String getConfigBuilderClassName();
}