01: /****************************************************************
02: * Licensed to the Apache Software Foundation (ASF) under one *
03: * or more contributor license agreements. See the NOTICE file *
04: * distributed with this work for additional information *
05: * regarding copyright ownership. The ASF licenses this file *
06: * to you under the Apache License, Version 2.0 (the *
07: * "License"); you may not use this file except in compliance *
08: * with the License. You may obtain a copy of the License at *
09: * *
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: ****************************************************************/package org.apache.james.smtpserver;
19:
20: /**
21: * An interface to expose James management functionality through JMX.
22: *
23: * @phoenix:mx-topic name="SMTPServer"
24: */
25: public interface SMTPServerMBean {
26: /**
27: * @phoenix:mx-attribute
28: * @phoenix:mx-description Returns flag indicating it this service is enabled
29: * @phoenix:mx-isWriteable no
30: *
31: * @return boolean The enabled flag
32: */
33: public boolean isEnabled();
34:
35: /**
36: * @phoenix:mx-attribute
37: * @phoenix:mx-description Returns the port that the service is bound to
38: * @phoenix:mx-isWriteable no
39: *
40: * @return int The port number
41: */
42: public int getPort();
43:
44: /**
45: * @phoenix:mx-attribute
46: * @phoenix:mx-description Returns the address if the network interface the socket is bound to
47: * @phoenix:mx-isWriteable no
48: *
49: * @return String The network interface name
50: */
51: public String getNetworkInterface();
52:
53: /**
54: * @phoenix:mx-attribute
55: * @phoenix:mx-description Returns the server socket type, plain or SSL
56: * @phoenix:mx-isWriteable no
57: *
58: * @return String The scoekt type, plain or SSL
59: */
60: public String getSocketType();
61: }
|