Package com.jk.services.server.commons.models

Class EndPoint

java.lang.Object
com.jk.services.server.commons.models.EndPoint
public class EndPoint extends Object
This class represents an end-point definition.

It contains information about the path, HTTP method, method name, accepted MIME type, returned MIME type, and parameters associated with the end-point.

Version:
1.0
Author:
Dr. Jalal H. Kiswani

  • Constructor Summary

    Constructors
    Constructor
    Description
    EndPoint()
     

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    getAcceptMimeType()
    This method retrieves the accepted MIME type for incoming requests to the end-point.
    String
    getHttpMethod()
    This method retrieves the HTTP method used to access the end-point.
    String
    getMethod()
    This method retrieves the method name associated with the end-point.
    String
    getParams()
    This method retrieves the parameters associated with the end-point.
    String
    getPath()
    This method retrieves the path at which the end-point is accessible.
    String
    getReturnMimeType()
    This method retrieves the MIME type for the response returned by the end-point.
    void
    setAcceptMimeType(String acceptMimeType)
    This method sets the accepted MIME type for incoming requests to the end-point to the provided value.
    void
    setHttpMethod(String httpMethod)
    This method sets the HTTP method used to access the end-point to the provided value.
    void
    setMethod(String method)
    This method sets the method name associated with the end-point to the provided value.
    void
    setParams(String params)
    This method sets the parameters associated with the end-point to the provided value.
    void
    setPath(String path)
    This method sets the path at which the end-point is accessible to the provided value.
    void
    setReturnMimeType(String returnMimeType)
    This method sets the MIME type for the response returned by the end-point to the provided value.

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

  • Constructor Details

    • EndPoint

      public EndPoint()

  • Method Details

    • getPath

      public String getPath()
      This method retrieves the path at which the end-point is accessible.
      Returns:
      the path at which the end-point is accessible.

    • setPath

      public void setPath(String path)
      This method sets the path at which the end-point is accessible to the provided value.
      Parameters:
      path - Specifies the new path at which the end-point is accessible.

    • getMethod

      public String getMethod()
      This method retrieves the method name associated with the end-point.
      Returns:
      the method name associated with the end-point.

    • setMethod

      public void setMethod(String method)
      This method sets the method name associated with the end-point to the provided value.
      Parameters:
      method - Specifies the new method name associated with the end-point.

    • getAcceptMimeType

      public String getAcceptMimeType()
      This method retrieves the accepted MIME type for incoming requests to the end-point.
      Returns:
      the accepted MIME type for incoming requests to the end-point

    • setAcceptMimeType

      public void setAcceptMimeType(String acceptMimeType)
      This method sets the accepted MIME type for incoming requests to the end-point to the provided value.
      Parameters:
      acceptMimeType - Specifies the new accepted MIME type for incoming requests to the end-point.

    • getReturnMimeType

      public String getReturnMimeType()
      This method retrieves the MIME type for the response returned by the end-point.
      Returns:
      the MIME type for the response returned by the end-point.

    • setReturnMimeType

      public void setReturnMimeType(String returnMimeType)
      This method sets the MIME type for the response returned by the end-point to the provided value.
      Parameters:
      returnMimeType - Specifies the new MIME type for the response returned by the end-point.

    • getParams

      public String getParams()
      This method retrieves the parameters associated with the end-point.
      Returns:
      the parameters associated with the end-point.

    • setParams

      public void setParams(String params)
      This method sets the parameters associated with the end-point to the provided value.
      Parameters:
      params - Specifies the new parameters associated with the end-point.

    • getHttpMethod

      public String getHttpMethod()
      This method retrieves the HTTP method used to access the end-point.
      Returns:
      the HTTP method used to access the end-point.

    • setHttpMethod

      public void setHttpMethod(String httpMethod)
      This method sets the HTTP method used to access the end-point to the provided value.
      Parameters:
      httpMethod - Specifies the new HTTP method used to access the end-point.