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