KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > apache > james > smtpserver > SMTPServerMBean


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.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 JavaDoc 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 JavaDoc getSocketType();
61 }
62
Popular Tags