View Javadoc

1   /****************************************************************
2    * Licensed to the Apache Software Foundation (ASF) under one   *
3    * or more contributor license agreements.  See the NOTICE file *
4    * distributed with this work for additional information        *
5    * regarding copyright ownership.  The ASF licenses this file   *
6    * to you under the Apache License, Version 2.0 (the            *
7    * "License"); you may not use this file except in compliance   *
8    * with the License.  You may obtain a copy of the License at   *
9    *                                                              *
10   *   http://www.apache.org/licenses/LICENSE-2.0                 *
11   *                                                              *
12   * Unless required by applicable law or agreed to in writing,   *
13   * software distributed under the License is distributed on an  *
14   * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY       *
15   * KIND, either express or implied.  See the License for the    *
16   * specific language governing permissions and limitations      *
17   * under the License.                                           *
18   ****************************************************************/
19  
20  
21  
22  package org.apache.james.fetchmail;
23  
24  /**
25   * An interface to expose James management functionality through JMX.
26   * 
27   * @phoenix:mx-topic name="FetchScheduler,type=Mail"
28   */
29  public interface FetchSchedulerMBean {
30      /**
31      * @phoenix:mx-attribute
32      * @phoenix:mx-description Returns flag indicating it this service is enabled 
33      * @phoenix:mx-isWriteable no
34      * 
35      * @return boolean The enabled flag     
36      */  
37      public boolean isEnabled();
38  
39  }