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