Package com.uc4.communication.requests

Class GetWPProperties

java.lang.Object
com.uc4.communication.requests.XMLRequest
com.uc4.communication.requests.GetWPProperties
public class GetWPProperties extends XMLRequest
Returns the trace options for a Work Process using existing XREQ

  • Constructor Details

    • GetWPProperties

      public GetWPProperties(UC4ObjectName wpName)
      Creates an instance of GetWPProperties
      Parameters:
      wpName - Name of the WP

    • GetWPProperties

      public GetWPProperties(String idnr)
      Creates an instance of GetWPProperties
      Parameters:
      idnr - Idnr of the WP Object

  • Method Details

    • getWPProperty

      public String getWPProperty(String key)
      Returns the value of an Server property or null if the key was not found.
      Parameters:
      key - Property name
      Returns:
      Value or null if not found

    • getNumberOfWPDetails

      public int getNumberOfWPDetails()
      Returns the number of detail entries.
      Returns:
      Number of details

    • isServerAlive

      public boolean isServerAlive()
      Returns true if the Server is running or false if not.
      Returns:
      boolean

    • getWPName

      public UC4ObjectName getWPName()
      Returns the WP name.
      Returns:
      UC4ObjectName

    • getIdnr

      public String getIdnr()
      Returns idnr of the WP object
      Returns:
      idnr

    • agentPropertyKeyIterator

      public Iterator<String> agentPropertyKeyIterator()
      Returns an java.util.Iterator over Server property keys. These keys can be used with the method getWPProperty. The remove() method will throw an exception.
      Returns:
      Iterator over existing keys

    • 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

    • getTraceFlagText

      public String getTraceFlagText(int index)
      Returns the caption of a trace flag.
      Parameters:
      index - Index between 0 and 15
      Returns:
      Text

    • getTraceFlag

      public int getTraceFlag(int index)
      Returns the trace flag value.
      Parameters:
      index - Index between 0 and 15
      Returns:
      value

    • getTraceFlagDescription

      public String getTraceFlagDescription(int index)
      Returns a detailed description of a trace flag.
      Parameters:
      index - Index between 0 and 15
      Returns:
      Text

    • 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

    • getWPTraceElement

      public Element getWPTraceElement()
      Returns a value of the ServerDetail section
      Returns:
      Element

    • getWPDetailElement

      public Element getWPDetailElement()
      Returns a value of the ServerDetail section
      Returns:
      Element

    • getOptionsElement

      public Element getOptionsElement()
      Returns the option element
      Returns:
      Element

    • getWPPropertiesElement

      public Element getWPPropertiesElement()
      Returns the WP property element
      Returns:
      Element

    • getWPTraceOptions

      public WPTraceOptions getWPTraceOptions()
      Returns a WPTraceOptions Object
      Returns:
      WPTraceOptions

    • getTraceFlagsSize

      public int getTraceFlagsSize()
      returns the length of the trace flag array
      Returns:
      int

    • getMaxTraceSize

      public int getMaxTraceSize()
      returns the max trace size parameter
      Returns:
      int

    • getTraceType

      public String getTraceType()
      returns the trace type
      Returns:
      String

    • getTriggerText

      public String getTriggerText()
      returns the trigger text
      Returns:
      String

    • getLoggingMb

      public int getLoggingMb()
      Returns:
      logging size in Mb

    • getLoggingDays

      public int getLoggingDays()
      Returns:
      logging days

    • getReservedApiUsers

      public int getReservedApiUsers()
      Returns:
      Number of reserved API users

    • getMinEventInterval

      public int getMinEventInterval()
      Returns:
      minimum event interval

    • getLastUse

      public int getLastUse()
      Returns:
      last use

    • getServLanguage

      public String getServLanguage()
      returns the language of the server
      Returns:
      String

    • getSnmpInUse

      public String getSnmpInUse()
      returns if SNMP is in use or not
      Returns:
      String

    • getScriptCache

      public long getScriptCache()
      returns script cache
      Returns:
      the size of the script cache in bytes

    • getScriptCacheActual

      public long getScriptCacheActual()
      returns Actual Script cache
      Returns:
      the actual size of the script cache in bytes

    • getMqmemCache

      public long getMqmemCache()
      returns MQMEM cache
      Returns:
      the size of the MQMEM cache in bytes

    • getMqmemCacheActual

      public long getMqmemCacheActual()
      returns Actual MQMEM cache
      Returns:
      the actual size of the MQMEM cache in bytes

    • getObjectCache

      public long getObjectCache()
      returns object cache
      Returns:
      the size of the object cache in bytes

    • getObjectCacheActual

      public long getObjectCacheActual()
      returns Actual Object cache
      Returns:
      the actual size of the object cache in bytes

    • getVaraCache

      public long getVaraCache()
      returns vara cache
      Returns:
      the size of the vara cache in bytes

    • getVaraCacheActual

      public long getVaraCacheActual()
      returns Actual Vara Cache
      Returns:
      the actual size of the Vara cache in bytes

    • getUserCache

      public long getUserCache()
      returns user cache
      Returns:
      the size of the user cache in bytes

    • getUserCacheActual

      public long getUserCacheActual()
      returns Actual User cache
      Returns:
      the actual size of the user cache in bytes