Class GetRestEndpoints

java.lang.Object
com.uc4.communication.requests.XMLRequest
com.uc4.communication.requests.GetRestEndpoints
All Implemented Interfaces:
Iterable<GetRestEndpoints.RestEndpoint>

public class GetRestEndpoints extends XMLRequest implements Iterable<GetRestEndpoints.RestEndpoint>
Requests all available REST endpoints of a running AE. This request can also be executed before Connection.login() has been called. It only requires a CP connection, Connection.open() must have already been called.
  • Constructor Details

    • GetRestEndpoints

      public GetRestEndpoints()
  • Method Details

    • iterator

      Specified by:
      iterator in interface Iterable<GetRestEndpoints.RestEndpoint>
    • getCount

      public int getCount()
      Number of REST endpoints found in AE.
      Returns:
      Number of endpoints
    • getSrc

      protected String getSrc()
      Description copied from class: XMLRequest
      Returns the request source. This method is used internally.
      Specified by:
      getSrc in class XMLRequest
      Returns:
      Source
    • createRequest

      protected void createRequest(com.uc4.util.XMLDocument doc, Element request, ConnectionAttributes sessionInfo)
      Description copied from class: XMLRequest
      Creates the XML Document for the request. This method is used internally.
      Specified by:
      createRequest in class XMLRequest
      Parameters:
      doc - Document, used to create new Elements
      request - Request Element - classes append information to this request element
      sessionInfo - Information about the session
    • handleContent

      protected void handleContent(com.uc4.util.XMLDocument doc, ConnectionAttributes session)
      Description copied from class: XMLRequest
      Sub classes extract the values from the XML document and provide public getter methods.
      Overrides:
      handleContent in class XMLRequest
      Parameters:
      doc - XML Document
      session - Info about the user session
    • isAllowedInClientZero

      protected boolean isAllowedInClientZero()
      Description copied from class: XMLRequest
      This method is used internally. Tests if this XMLRequest is allowed in client 0. The default implementation returns false, subclasses may override.
      Overrides:
      isAllowedInClientZero in class XMLRequest
      Returns:
      true if this request is allowed in client 0, false otherwise