Package com.uc4.communication.requests

Class GetCPProperties

java.lang.Object

com.uc4.communication.requests.XMLRequest

com.uc4.communication.requests.GetCPProperties

public class GetCPProperties
extends XMLRequest

Returns the trace options for a Communication Process using existing XREQ

Constructor Summary

Constructors

Constructor	Description
GetCPProperties(UC4ObjectName cpName)	Creates an instance of GetWPProperties
GetCPProperties(String idnr)	Creates an instance of GetWPProperties

Method Summary

Modifier and Type	Method	Description
protected void	createRequest(com.uc4.util.XMLDocument doc, Element request, ConnectionAttributes sessionInfo)	Creates the XML Document for the request.
UC4ObjectName	getCPName()	Returns the CP name.
Element	getCPPropertiesElement()	Returns the CP property element
Element	getCPTraceElement()	Returns a value of the Server trace section
CPTraceOptions	getCPTraceOptions()	Returns a CPTraceOptions Object
String	getIdnr()	Returns the idnr of the CP object
int	getMaxTraceSize()	returns the max trace size parameter
Element	getOptionsElement()	Returns the option element
protected String	getSrc()	Returns the request source.
int	getTraceFlag(int index)	Returns the trace flag value.
String	getTraceFlagDescription(int index)	Returns a detailed description of a trace flag.
int	getTraceFlagsSize()	returns the length of the trace flag array
String	getTraceFlagText(int index)	Returns the caption of a trace flag.
String	getTraceType()	returns the trace type
protected 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	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 Details

GetCPProperties

public GetCPProperties(UC4ObjectName cpName)

Creates an instance of GetWPProperties

Parameters:

cpName - Name of the CP HOST object

GetCPProperties

public GetCPProperties(String idnr)

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

public UC4ObjectName getCPName()

Returns the CP name.

Returns:

UC4ObjectName

getIdnr

public String getIdnr()

Returns the idnr of the CP object

Returns:

idnr

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

getCPTraceElement

public Element getCPTraceElement()

Returns a value of the Server trace section

Returns:

Element

getOptionsElement

public Element getOptionsElement()

Returns the option element

Returns:

Element

getCPPropertiesElement

public Element getCPPropertiesElement()

Returns the CP property element

Returns:

Element

getCPTraceOptions

public CPTraceOptions 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

public String getTraceType()

returns the trace type

Returns:

String