GetWPProperties (java-api 21.0.12 API)

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 Summary

Constructors
Constructor and Description
`GetWPProperties(java.lang.String idnr)` Creates an instance of GetWPProperties
`GetWPProperties(UC4ObjectName wpName)` Creates an instance of GetWPProperties

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`java.util.Iterator<java.lang.String>`	`agentPropertyKeyIterator()` Returns an `java.util.Iterator` over Server property keys.
`protected void`	`createRequest(com.uc4.util.XMLDocument doc, org.w3c.dom.Element request, ConnectionAttributes sessionInfo)` Creates the XML Document for the request.
`java.lang.String`	`getIdnr()` Returns idnr of the WP object
`int`	`getLastUse()`
`int`	`getLoggingDays()`
`int`	`getLoggingMb()`
`int`	`getMaxTraceSize()` returns the max trace size parameter
`int`	`getMinEventInterval()`
`long`	`getMqmemCache()` returns MQMEM cache
`long`	`getMqmemCacheActual()` returns Actual MQMEM cache
`int`	`getNumberOfWPDetails()` Returns the number of detail entries.
`long`	`getObjectCache()` returns object cache
`long`	`getObjectCacheActual()` returns Actual Object cache
`org.w3c.dom.Element`	`getOptionsElement()` Returns the option element
`int`	`getReservedApiUsers()`
`long`	`getScriptCache()` returns script cache
`long`	`getScriptCacheActual()` returns Actual Script cache
`java.lang.String`	`getServLanguage()` returns the language of the server
`java.lang.String`	`getSnmpInUse()` returns if SNMP is in use or not
`protected java.lang.String`	`getSrc()` Returns the request source.
`int`	`getTraceFlag(int index)` Returns the trace flag value.
`java.lang.String`	`getTraceFlagDescription(int index)` Returns a detailed description of a trace flag.
`int`	`getTraceFlagsSize()` returns the length of the trace flag array
`java.lang.String`	`getTraceFlagText(int index)` Returns the caption of a trace flag.
`java.lang.String`	`getTraceType()` returns the trace type
`java.lang.String`	`getTriggerText()` returns the trigger text
`long`	`getUserCache()` returns user cache
`long`	`getUserCacheActual()` returns Actual User cache
`long`	`getVaraCache()` returns vara cache
`long`	`getVaraCacheActual()` returns Actual Vara Cache
`org.w3c.dom.Element`	`getWPDetailElement()` Returns a value of the ServerDetail section
`UC4ObjectName`	`getWPName()` Returns the WP name.
`org.w3c.dom.Element`	`getWPPropertiesElement()` Returns the WP property element
`java.lang.String`	`getWPProperty(java.lang.String key)` Returns the value of an Server property or `null` if the key was not found.
`org.w3c.dom.Element`	`getWPTraceElement()` Returns a value of the ServerDetail section
`WPTraceOptions`	`getWPTraceOptions()` Returns a WPTraceOptions Object
`protected void`	`handleContent(com.uc4.util.XMLDocument doc, ConnectionAttributes session)`
`protected boolean`	`isAllowedInClientZero()` This method is used internally.
`boolean`	`isServerAlive()` Returns true if the Server is running or false if not.

Methods inherited from class com.uc4.communication.requests.XMLRequest
assertClientZero, assertServerVersion, checkClient, checkID, checkLnr, checkNull, checkSelStatisticsPrivilege, checkSystemOverviewPrivilege, checkUC4ObjectEmptyName, checkUC4ObjectName, createNATFor, createNATRequest, emptyAttributes, getAllMessageBoxes, getMessageBox, getRequestID, handleResponse, ignoreMessageBox, send, setMessageBox, showQuarantineNotification

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - GetWPProperties
```
public GetWPProperties(UC4ObjectName wpName)
```
    Creates an instance of GetWPProperties
    
    Parameters:
    
    wpName - Name of the WP
  - GetWPProperties
```
public GetWPProperties(java.lang.String idnr)
```
    Creates an instance of GetWPProperties
    
    Parameters:
    
    idnr - Idnr of the WP Object
- Method Detail
  - getWPProperty
```
public java.lang.String getWPProperty(java.lang.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 java.lang.String getIdnr()
```
    Returns idnr of the WP object
    
    Returns:
    
    idnr
  - agentPropertyKeyIterator
```
public java.util.Iterator<java.lang.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 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)
```
    Overrides:
    
    handleContent in class XMLRequest
  - getTraceFlagText
```
public java.lang.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 java.lang.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 org.w3c.dom.Element getWPTraceElement()
```
    Returns a value of the ServerDetail section
    
    Returns:
    
    Element
  - getWPDetailElement
```
public org.w3c.dom.Element getWPDetailElement()
```
    Returns a value of the ServerDetail section
    
    Returns:
    
    Element
  - getOptionsElement
```
public org.w3c.dom.Element getOptionsElement()
```
    Returns the option element
    
    Returns:
    
    Element
  - getWPPropertiesElement
```
public org.w3c.dom.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 java.lang.String getTraceType()
```
    returns the trace type
    
    Returns:
    
    String
  - getTriggerText
```
public java.lang.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 java.lang.String getServLanguage()
```
    returns the language of the server
    
    Returns:
    
    String
  - getSnmpInUse
```
public java.lang.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

Class GetWPProperties

Constructor Summary

Method Summary

Methods inherited from class com.uc4.communication.requests.XMLRequest

Methods inherited from class java.lang.Object

Constructor Detail

GetWPProperties

GetWPProperties

Method Detail

getWPProperty

getNumberOfWPDetails

isServerAlive

getWPName

getIdnr

agentPropertyKeyIterator

getSrc

createRequest

handleContent

getTraceFlagText

getTraceFlag

getTraceFlagDescription

isAllowedInClientZero

getWPTraceElement

getWPDetailElement

getOptionsElement

getWPPropertiesElement

getWPTraceOptions

getTraceFlagsSize

getMaxTraceSize

getTraceType

getTriggerText

getLoggingMb

getLoggingDays

getReservedApiUsers

getMinEventInterval

getLastUse

getServLanguage

getSnmpInUse

getScriptCache

getScriptCacheActual

getMqmemCache

getMqmemCacheActual

getObjectCache

getObjectCacheActual

getVaraCache

getVaraCacheActual

getUserCache

getUserCacheActual