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