Package org.dlese.dpc.ndr.reader

Class AgentReader

java.lang.Object
org.dlese.dpc.ndr.reader.NdrObjectReader
org.dlese.dpc.ndr.reader.AgentReader
public class AgentReader extends NdrObjectReader
Extension of NdrObjectReader for accessing properties, dataStreams, and relationships of NDR Agent Objects.

More Info:

  • Agent overview: http://wiki.nsdl.org/index.php/Community:NDR/ObjectTypes#Agent
  • Agent data model: http://wiki.nsdl.org/index.php/Community:NCore/Model/Objects/Agent
  • Agent API requests: http://wiki.nsdl.org/index.php/Community:NDR/APIRequestsByObject#Agent_requests
    • Author:
    ostwald

    • Constructor Details

      • AgentReader

        public AgentReader(String handle) throws Exception
        Constructor for the AgentReader with provided handle
        Parameters:
        handle - handle to Agent object in the NDR
        Throws:
        Exception - NOT YET DOCUMENTED

      • AgentReader

        public AgentReader(org.dom4j.Document response) throws Exception
        Constructor for the AgentReader object with provided response (to ndr "get" call)
        Parameters:
        response - a dom4j.Document reperesentation of ndr GET response.
        Throws:
        Exception - NOT YET DOCUMENTED

    • Method Details

      • getIdentifier

        public String getIdentifier()
        Gets the identifier attribute of the AgentReader object
        Returns:
        The identifier value

      • getIdentifierType

        public String getIdentifierType()
        Returns one of "HOST", "URL", "OTHER", depending on what form of id is present in the object.
        Returns:
        The identifierType value

      • agentInit

        protected void agentInit() throws Exception
        Throws:
        Exception

      • isAuthorizedToChange

        public boolean isAuthorizedToChange()
        Returns true if the configured NCS_AGENT is authorized to change this agent.
        Returns:
        The authorizedToChange value

      • getMetadataProviders

        public List getMetadataProviders() throws Exception
        Gets the metadataProviders that are related to this Agent via the metadataProviderFor relationship.
        Returns:
        The metadataProviders value
        Throws:
        Exception - NOT YET DOCUMENTED

      • getAggregators

        public List getAggregators() throws Exception
        Gets the aggregators that are related to this Agent via the aggregatorFor relationship.
        Returns:
        The aggregators value
        Throws:
        Exception - NOT YET DOCUMENTED

      • pp

        protected static void pp(org.dom4j.Node node)