Skip navigation links

Oracle Communications Services Gatekeeper OAM Java API Reference
5.0

E21718-01


com.bea.wlcp.wlng.heartbeat.management
Interface HeartbeatMBean


public interface HeartbeatMBean

Plugin heartbeat service MBean interface.


Field Summary
static String contentMatch
          Content to match.
static boolean enabled
          Enables or disables the heartbeater.
static String heartbeatMethod
          The HTTP method to be used for the heartbeat.
static int interval
          Time in sec between heartbeats.
static String networkServiceUrl
          The URL to the network service to be pinged.
static String postContent
          Content to send in POST.
static int responseCodeToMatch
          Responsecode to match.
static boolean status
          Status of a heartbeater.

 

Method Summary
 void addHTTPHeader(String name, String value)
          Add HTTP header.
 String getContentMatch()
           
 String getHeartbeatMethod()
           
 int getInterval()
           
 String getNetworkServiceUrl()
           
 String getPostContent()
           
 int getResponseCodeToMatch()
           
 boolean getStatus()
           
 boolean isEnabled()
           
 String listHTTPHeaders()
          List HTTP headers that have been added.
 void removeHTTPHeader(String name)
          Remove a HTTP header.
 void setContentMatch(String contentMatch)
           
 void setEnabled(boolean enabled)
           
 void setHeartbeatMethod(String heartbeatMethod)
           
 void setInterval(int internval)
           
 void setNetworkServiceUrl(String networkURL)
           
 void setPostContent(String postContent)
           
 void setResponseCodeToMatch(int responseCodeToMatch)
           

 

Field Detail

contentMatch

public static final String contentMatch
Content to match. Empty string matches anything. Only valid if heartbeat method is GET.
See Also:
Constant Field Values

enabled

public static final boolean enabled
Enables or disables the heartbeater.
See Also:
Constant Field Values

heartbeatMethod

public static final String heartbeatMethod
The HTTP method to be used for the heartbeat. Valid values are GET or POST.

interval

public static final int interval
Time in sec between heartbeats.
See Also:
Constant Field Values

networkServiceUrl

public static final String networkServiceUrl
The URL to the network service to be pinged.

postContent

public static final String postContent
Content to send in POST. Only valid if heartbeat method is POST.
See Also:
Constant Field Values

responseCodeToMatch

public static final int responseCodeToMatch
Responsecode to match. Will be checked for heartbeatmethod GET and POST.
See Also:
Constant Field Values

status

public static final boolean status
Status of a heartbeater.
See Also:
Constant Field Values

Method Detail

addHTTPHeader

public void addHTTPHeader(String name,
                          String value)
                   throws ManagementException
Add HTTP header. If the header is already added the old value will be replaced. Headers will be added for heartbeatmethod GET and POST.
Throws:
ManagementException

getContentMatch

public String getContentMatch()
                       throws ManagementException
Throws:
ManagementException

getHeartbeatMethod

public String getHeartbeatMethod()
                          throws ManagementException
Throws:
ManagementException

getInterval

public int getInterval()
                throws ManagementException
Throws:
ManagementException

getNetworkServiceUrl

public String getNetworkServiceUrl()
                            throws ManagementException
Throws:
ManagementException

getPostContent

public String getPostContent()
                      throws ManagementException
Throws:
ManagementException

getResponseCodeToMatch

public int getResponseCodeToMatch()
                           throws ManagementException
Throws:
ManagementException

getStatus

public boolean getStatus()
                  throws ManagementException
Throws:
ManagementException

isEnabled

public boolean isEnabled()
                  throws ManagementException
Throws:
ManagementException

listHTTPHeaders

public String listHTTPHeaders()
                       throws ManagementException
List HTTP headers that have been added.
Throws:
ManagementException

removeHTTPHeader

public void removeHTTPHeader(String name)
                      throws ManagementException
Remove a HTTP header.
Throws:
ManagementException

setContentMatch

public void setContentMatch(String contentMatch)
                     throws ManagementException
Throws:
ManagementException

setEnabled

public void setEnabled(boolean enabled)
                throws ManagementException
Throws:
ManagementException

setHeartbeatMethod

public void setHeartbeatMethod(String heartbeatMethod)
                        throws ManagementException
Throws:
ManagementException

setInterval

public void setInterval(int internval)
                 throws ManagementException
Throws:
ManagementException

setNetworkServiceUrl

public void setNetworkServiceUrl(String networkURL)
                          throws ManagementException
Throws:
ManagementException

setPostContent

public void setPostContent(String postContent)
                    throws ManagementException
Throws:
ManagementException

setResponseCodeToMatch

public void setResponseCodeToMatch(int responseCodeToMatch)
                            throws ManagementException
Throws:
ManagementException

Skip navigation links

Oracle Communications Services Gatekeeper OAM Java API Reference
5.0

E21718-01


Copyright © 2008, 2011, Oracle and/or its affiliates. All rights reserved.