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