Namespace: OpenEdge.Web
Type: Class PingWebHandler
Parent Classes:
Inherits: OpenEdge.Web.WebHandler


/* *************************************************************************************************************************
Copyright (c) 2017, 2021 by Progress Software Corporation and/or one of its subsidiaries or affiliates. All rights reserved.
File:PingWebHandler
Purpose:A service interface around the OpenEdge.Rest.Admin.AppServerStatus
class used to establish life on the server. See that class' ServerStatus
method for more information.
Author(s):pjudge
Created:2017-09-14
Notes:* To configure this, add in openedge.properties
handler<n>=OpenEdge.Web.PingWebHandler:_oepingService/_oeping
Any uri may be used
returned
identical (equality match) to the URI template;
a 404 status is otherwise returned
/* Default constructor



Method Summary
  Options Name Purpose
  INTEGER HandleGet (IWebRequest) /* Default handler for the HTTP GET method @param IWebRequest The request being serviced @return integer An optional status code. A zero or null value means this method will deal with all errors */
  INTEGER HandleNotAllowedMethod (IWebRequest)
  INTEGER HandleNotImplemented (IWebRequest)
  WriteResponse (IHttpResponse) /** Writes the response using the WebResponseWriter. This method allows us to unit test this handler (via gradle/batch). @param IHttpResponse The response to write */

Constructor Summary
  Options Name Purpose
  PingWebHandler () /* Default constructor */

Method Detail
Top

INTEGER HandleGet (IWebRequest)

/* Default handler for the HTTP GET method
method will deal with all errors
Parameters:
pReq OpenEdge.Web.IWebRequest
 
Returns INTEGER
  integer An optional status code. A zero or null value means this
Top

INTEGER HandleNotAllowedMethod (IWebRequest)

Parameters:
pRequest OpenEdge.Web.IWebRequest
 
Returns INTEGER
 
Top

INTEGER HandleNotImplemented (IWebRequest)

Parameters:
pRequest OpenEdge.Web.IWebRequest
 
Returns INTEGER
 
Top

WriteResponse (IHttpResponse)

Purpose: Writes the response using the WebResponseWriter.
This method allows us to unit test this handler (via gradle/batch).
Parameters:
pResponse OpenEdge.Net.HTTP.IHttpResponse
 


Constructor Detail
Top

PingWebHandler ()

/* Default constructor