View Javadoc

1   /************************************************************************
2    * Copyright (c) 2000-2006 The Apache Software Foundation.             *
3    * All rights reserved.                                                *
4    * ------------------------------------------------------------------- *
5    * Licensed under the Apache License, Version 2.0 (the "License"); you *
6    * may not use this file except in compliance with the License. You    *
7    * may obtain a copy of the License at:                                *
8    *                                                                     *
9    *     http://www.apache.org/licenses/LICENSE-2.0                      *
10   *                                                                     *
11   * Unless required by applicable law or agreed to in writing, software *
12   * distributed under the License is distributed on an "AS IS" BASIS,   *
13   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or     *
14   * implied.  See the License for the specific language governing       *
15   * permissions and limitations under the License.                      *
16   ***********************************************************************/
17  
18  package org.apache.james;
19  
20  /***
21   * An interface to expose James management functionality through JMX.  At
22   * the time of this writing, this interface is just an example.
23   * 
24   * @phoenix:mx-topic name="MainJAMESServerManagement"
25   */
26  public interface JamesMBean {
27  
28      /***
29       * Adds a user to this mail server.
30       *
31       * @phoenix:mx-operation
32       * @phoenix:mx-description Add a new user
33       *
34       * @param userName The name of the user being added
35       * @param password The password of the user being added
36       */
37      boolean addUser(String userName, String password);
38  }