Package com.uc4.communication.requests
Class GetCPProperties
java.lang.Object
com.uc4.communication.requests.XMLRequest
com.uc4.communication.requests.GetCPProperties
Returns the trace options for a Communication Process using existing XREQ
-
Constructor Summary
ConstructorsConstructorDescriptionGetCPProperties
(UC4ObjectName cpName) Creates an instance of GetWPPropertiesGetCPProperties
(String idnr) Creates an instance of GetWPProperties -
Method Summary
Modifier and TypeMethodDescriptionprotected void
createRequest
(com.uc4.util.XMLDocument doc, Element request, ConnectionAttributes sessionInfo) Creates the XML Document for the request.Returns the CP name.Returns the CP property elementReturns a value of the Server trace sectionReturns a CPTraceOptions ObjectgetIdnr()
Returns the idnr of the CP objectint
returns the max trace size parameterReturns the option elementprotected String
getSrc()
Returns the request source.int
getTraceFlag
(int index) Returns the trace flag value.getTraceFlagDescription
(int index) Returns a detailed description of a trace flag.int
returns the length of the trace flag arraygetTraceFlagText
(int index) Returns the caption of a trace flag.returns the trace typeprotected void
handleContent
(com.uc4.util.XMLDocument doc, ConnectionAttributes session) Sub classes extract the values from the XML document and provide public getter methods.protected boolean
This method is used internally.boolean
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
-
Constructor Details
-
GetCPProperties
Creates an instance of GetWPProperties- Parameters:
cpName
- Name of the CP HOST object
-
GetCPProperties
Creates an instance of GetWPProperties- Parameters:
idnr
- Idnr of the CP HOST object
-
-
Method Details
-
isServerAlive
public boolean isServerAlive()Returns true if the Server is running or false if not.- Returns:
- boolean
-
getCPName
Returns the CP name.- Returns:
- UC4ObjectName
-
getIdnr
Returns the idnr of the CP object- Returns:
- idnr
-
getSrc
Description copied from class:XMLRequest
Returns the request source. This method is used internally.- Specified by:
getSrc
in classXMLRequest
- 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 classXMLRequest
- Parameters:
doc
- Document, used to create new Elementsrequest
- Request Element - classes append information to this request elementsessionInfo
- Information about the session
-
handleContent
Description copied from class:XMLRequest
Sub classes extract the values from the XML document and provide public getter methods.- Overrides:
handleContent
in classXMLRequest
- Parameters:
doc
- XML Documentsession
- Info about the user session
-
getTraceFlagText
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
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 thisXMLRequest
is allowed in client 0. The default implementation returnsfalse
, subclasses may override.- Overrides:
isAllowedInClientZero
in classXMLRequest
- Returns:
true
if this request is allowed in client 0,false
otherwise
-
getCPTraceElement
Returns a value of the Server trace section- Returns:
- Element
-
getOptionsElement
Returns the option element- Returns:
- Element
-
getCPPropertiesElement
Returns the CP property element- Returns:
- Element
-
getCPTraceOptions
Returns a CPTraceOptions Object- Returns:
- CPTraceOptions
-
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
returns the trace type- Returns:
- String
-