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.smtpserver;
21
22 /***
23 * An interface to expose James management functionality through JMX.
24 *
25 * @phoenix:mx-topic name="SMTPServer"
26 */
27 public interface SMTPServerMBean {
28 /***
29 * @phoenix:mx-attribute
30 * @phoenix:mx-description Returns flag indicating it this service is enabled
31 * @phoenix:mx-isWriteable no
32 *
33 * @return boolean The enabled flag
34 */
35 public boolean isEnabled();
36
37 /***
38 * @phoenix:mx-attribute
39 * @phoenix:mx-description Returns the port that the service is bound to
40 * @phoenix:mx-isWriteable no
41 *
42 * @return int The port number
43 */
44 public int getPort();
45
46 /***
47 * @phoenix:mx-attribute
48 * @phoenix:mx-description Returns the address if the network interface the socket is bound to
49 * @phoenix:mx-isWriteable no
50 *
51 * @return String The network interface name
52 */
53 public String getNetworkInterface();
54
55 /***
56 * @phoenix:mx-attribute
57 * @phoenix:mx-description Returns the server socket type, plain or SSL
58 * @phoenix:mx-isWriteable no
59 *
60 * @return String The scoekt type, plain or SSL
61 */
62 public String getSocketType();
63 }