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  package org.apache.james;
21  
22  /***
23   * An interface to expose James management functionality through JMX.  At
24   * the time of this writing, this interface is just an example.
25   * 
26   * @phoenix:mx-topic name="MainJAMESServerManagement"
27   */
28  public interface JamesMBean {
29  
30      /***
31       * Adds a user to this mail server.
32       *
33       * @phoenix:mx-operation
34       * @phoenix:mx-description Add a new user
35       *
36       * @param userName The name of the user being added
37       * @param password The password of the user being added
38       */
39      boolean addUser(String userName, String password);
40  }