KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > apache > james > pop3server > POP3ServerMBean


1 /***********************************************************************
2  * Copyright (c) 2000-2004 The Apache Software Foundation. *
3  * All rights reserved. *
4  * ------------------------------------------------------------------- *
5  * Licensed under the Apache License, Version 2.0 (the "License"); you *
6  * may not use this file except in compliance with the License. You *
7  * may obtain a copy of the License at: *
8  * *
9  * http://www.apache.org/licenses/LICENSE-2.0 *
10  * *
11  * Unless required by applicable law or agreed to in writing, software *
12  * distributed under the License is distributed on an "AS IS" BASIS, *
13  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or *
14  * implied. See the License for the specific language governing *
15  * permissions and limitations under the License. *
16  ***********************************************************************/
17
18 package org.apache.james.pop3server;
19
20 /**
21  * An interface to expose James management functionality through JMX.
22  *
23  * @phoenix:mx-topic name="POP3Server"
24  */
25 public interface POP3ServerMBean {
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 JavaDoc 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 JavaDoc getSocketType();
62 }
63
Popular Tags