HealthCheckerConfigCR


1   /*
2    * The contents of this file are subject to the terms 
3    * of the Common Development and Distribution License 
4    * (the License).  You may not use this file except in
5    * compliance with the License.
6    * 
7    * You can obtain a copy of the license at 
8    * https://glassfish.dev.java.net/public/CDDLv1.0.html or
9    * glassfish/bootstrap/legal/CDDLv1.0.txt.
10   * See the License for the specific language governing 
11   * permissions and limitations under the License.
12   * 
13   * When distributing Covered Code, include this CDDL 
14   * Header Notice in each file and include the License file 
15   * at glassfish/bootstrap/legal/CDDLv1.0.txt.  
16   * If applicable, add the following below the CDDL Header, 
17   * with the fields enclosed by brackets [] replaced by
18   * you own identifying information: 
19   * "Portions Copyrighted [year] [name of copyright owner]"
20   * 
21   * Copyright 2006 Sun Microsystems, Inc. All rights reserved.
22   */
23   
24  /*
25   * $Header: /cvs/glassfish/admin-core/mbeanapi/src/java/com/sun/appserv/management/config/HealthCheckerConfigCR.java,v 1.6 2005/12/25 03:49:32 tcfujii Exp $
26   * $Revision: 1.6 $
27   * $Date: 2005/12/25 03:49:32 $
28   */
29  
30  package com.sun.appserv.management.config;
31  
32  import java.util.Map  ;
33  
34  /**
35      Supports creation and removal of health checker configurations.
36  */
37  public interface HealthCheckerConfigCR {
38      
39      /**
40        Creates a new health-checker.
41        @param url 
42            URL to ping so as to determine the health state of a
43            listener. This must be a relative URL.
44        @param intervalInSeconds     
45            Interval, in seconds, between health checks. 
46            A value of "0" means that the health check is 
47            disabled. Default is 30 seconds. Must be 0 or greater.
48        @param timeoutInSeconds      
49            Maximum time, in seconds, that a server must 
50            respond to a health check request to be considered 
51            healthy. Default is 10 seconds. Must be greater than 0.
52        @return A proxy to the HealthCheckerConfig MBean.
53      */
54      public HealthCheckerConfig createHealthCheckerConfig(String   url, 
55          String   intervalInSeconds, String   timeoutInSeconds);
56  
57      /**
58        Removes a health checker config from the container config element
59       */
60      public void removeHealthCheckerConfig();
61      
62      /**
63        @return A proxy to the HealthCheckerConfig MBean.
64        Could be null because the HealthCheckerConfig may not be present.
65       */
66      public HealthCheckerConfig getHealthCheckerConfig();
67  }
68
A to Z: JavaDoc & Examples Daily Java News & Articles Open Source Projects Open Source Codes Free Computer Books Remove Frame
Popular Tags