flex.management.runtime.messaging.DestinationControlMBean Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of flex-messaging-core Show documentation

There is a newer version: 4.8.0

/*
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You under the Apache License, Version 2.0
 * (the "License"); you may not use this file except in compliance with
 * the License.  You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package flex.management.runtime.messaging;

import flex.management.BaseControlMBean;

import java.io.IOException;
import java.util.Date;

import javax.management.ObjectName;

/**
 * Defines the runtime monitoring and management interface for managed destinations.
 *
 * @author shodgson
 */
public interface DestinationControlMBean extends BaseControlMBean
{
    /**
     * Returns the ObjectName for the adapter associated with this
     * managed destination.
     *
     * @return The ObjectName for the adapter.
     * @throws IOException Throws IOException.
     */
    ObjectName getAdapter() throws IOException;;

    /**
     * Returns true if the Destination is running.
     *
     * @return true if the Destination is running.
     * @throws IOException Throws IOException.
     */
    Boolean isRunning() throws IOException;

    /**
     * Returns the start timestamp for the Destination.
     *
     * @return The start timestamp for the Destination.
     * @throws IOException Throws IOException.
     */
    Date getStartTimestamp() throws IOException;
}