Class GetRAAgentNames

  • All Implemented Interfaces:
    java.lang.Iterable<UC4HostName>

    public class GetRAAgentNames
    extends XMLRequest
    implements java.lang.Iterable<UC4HostName>
    Returns a list of RA Agent names.
    • Constructor Detail

      • GetRAAgentNames

        public GetRAAgentNames​(java.lang.String type,
                               java.lang.String pattern)
        Parameters:
        type - Name of the RA Agent
        pattern - Pattern with wildcard characters (* and ?)
    • Method Detail

      • getSrc

        protected java.lang.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,
                                     org.w3c.dom.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
      • size

        public int size()
        Returns:
        Number of results
      • iterator

        public java.util.Iterator<UC4HostName> iterator()
        Specified by:
        iterator in interface java.lang.Iterable<UC4HostName>