com.uc4.communication.requests

Class XMLRequest

java.lang.Object

com.uc4.communication.requests.XMLRequest

Direct Known Subclasses:

ActivateLDAPConnection, ActivateObject, ActivatorStatistics, ActiveNotifications, ActivityList, ActivityNotificationOn, AddComment, AddJobPlanTask, AddPromptSet, AddScheduleTask, AdoptTask, AgentAssignmentList, AgentGroupList, AgentGroupMonitor, AgentGroupSimulation, AgentList, AuthenticateAgent, AutoForecastRange, CacheList, CalculateForecast, CalendarList, CancelForm, CancelTask, CauDeploy, CauSkipWaiting, ChangeLogging, ChangePassword, ChangeServerMode, CheckAuthorizations, CheckILMPartition, CheckUserPrivileges, ChildStatistics, ClearTransportCase, ClientList, CloseObject, CloseProcessFlowModification, ClosePrompt, CockpitMonitorDefiniton, ConfirmQuarantineMessage, CreateFolder, CreateObject, CreateSession, DeactivateLDAPConnection, DeactivateTask, DeepRename, DeleteAgentAssignment, DeleteForecast, DeleteLink, DeleteMQMemList, DeleteObject, DeleteQuarantineMessage, DeleteStaticVaraRow, DeleteStorageEntry, DisconnectAgentGroup, DisconnectHost, DisconnectUser, DownloadBinary, DropILMPartition, DuplicateObject, EnforcePreConditionEvaluation, ExecuteAgentAssignment, ExecuteObject, ExecuteObjects, ExitList, ExportAuthenticationPackage, ExportCompanyKey, ExportObject, ExportWithReferences, FindReferencedObjects, FolderList, FolderTree, ForceMemoryTrace, ForecastList, ForecastTree, GenericStatistics, GetActivitiesFilter, GetAgentGroupMonitorProperties, GetAgentProperties, GetCAUAgentVersions, GetChangeLog, GetComments, GetComponentTemplates, GetComponentWorkflows, GetCPProperties, GetDatabaseInfo, GetDeploymentProperties, GetDeployObjectProperties, GetDynamicComboList, GetExecuteOnce, GetExecutePeriod, GetGroupMonitorProperties, GetLastRuntimes, GetModifyQueue, GetObjectDocu, GetObjectProperties, GetOutputDirectory, GetRAAgentNames, GetRAConnectionNames, GetRAConnectionValues, GetRAJobNames, GetReplaceList, GetRestartInformation, GetSessionTZ, GetStaticVaraRows, GetStorageItems, GetSyncMonitor, GetSyncUsage, GetUnreadMessages, GetWPProperties, GroupMonitor, IgnoreConditions, IgnoreQueueLimit, IgnoreTaskSyncCondition, ILMList, ImportObject, JobPlanMonitor, JWPRequest, LatestReport, LicenseList, LinkTo, MessageList, ModifyNotificationMonitor, ModifyProcessFlowMonitor, ModifyQueue, ModifyQueueStatus, ModifyRecurringTask, ModifyStartTime, ModifyTaskPriority, ModifyTaskState, ModifyUISettings, MoveAgentAssignment, MoveObject, MoveUserToClient, MQMemList, NavigatorAgentTree, NavigatorCATree, NavigatorQueueTree, NavigatorStatusTree, NavigatorZDUTree, NotificationMonitor, NotificationState, ObjectStatistics, OpenObject, OpenProcessFlowModification, ParentStatistics, PreviewAssignment, PreviewVariable, PromptInputHelp, QuarantineList, QueryAutoforecast, QueryData, QueueList, QuickSearch, QuitTask, RecalculateAutoForecast, RefreshCockpitMonitor, RefreshServiceManagerScan, ReleaseManually, ReleaseQuarantineMessage, ReloadNextTurnaround, RemoteRestart, RemoveJobPlanBreakPoint, RenameForecast, RenameObject, RenewTransferKey, ReplaceObject, Report, ReportTypeList, RerunWorkflow, ResetLastRuntimes, ResetOpenFlag, ResetScheduleTask, RestartTask, RestoreObject, RestoreObjectVersion, ResumeClient, ResumeTask, RollbackTask, RollbackTo, RunJobPlanTask, RunScheduledTask, SaveAgentAssignment, SaveObject, ScheduleMonitor, SearchIndex, SearchObject, ServerList, ServiceFulfillmentList, ServiceLevelObjectiveList, SetAgentGroupMonitorProperties, SetAgentProperties, SetCPProperties, SetGroupMonitorProperties, SetHostAuthorizations, SetJobPlanBreakPoint, SetJobPlanTaskActive, SetJobPlanTaskInactive, SetObjectProperties, SetStaticVaraRows, SetSyncMonitor, SetWPProperties, SetZDUStep, ShowQuarantineMessage, StartHost, StartILM, StartServer, StopILM, SubmitForm, SubmitPrompt, SuspendClient, SuspendTask, SwitchOutILM, SynchronizeLDAP, SystemWorkload, TaskDetails, TaskPromptSetContent, TaskPromptSetNames, TaskStatistics, TemplateList, TerminateAgentGroup, TerminateHost, TerminateServer, TransportObject, UnblockJobPlanTask, UnblockWorkflow, UnlockAutoForecast, UnregisterTask, UploadBinary, UserList, VersionControlList, ZDUControl, ZduStep, ZduWizard

public abstract class XMLRequest
extends java.lang.Object

This is the super class of all request classes.

Constructor Summary

Constructors

Constructor and Description
XMLRequest()

Method Summary

Methods

Modifier and Type	Method and Description
java.util.List<MessageBox>	getAllMessageBoxes() Returns a List of all MessageBoxes object if the server returns messages for this request.
MessageBox	getMessageBox() Returns a MessageBox object if the server returns a message for this request.
java.lang.String	getRequestID(java.lang.String defaultValue) Sub classes may override to send a UUID instead.
void	handleResponse(com.uc4.util.XMLDocument doc, ConnectionAttributes session) Handles the response from the server.
void	send(org.w3c.dom.Document doc, ConnectionAttributes sessioninfo, java.lang.String nr) Prepares the request for sending.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

XMLRequest

public XMLRequest()

Method Detail

handleResponse

public final void handleResponse(com.uc4.util.XMLDocument doc,
                  ConnectionAttributes session)

Handles the response from the server. This method should be called from IResponseHandler#handleResponse.

Parameters:

doc - Document returned from the server

session - Information about the session

getMessageBox

public final MessageBox getMessageBox()

Returns a MessageBox object if the server returns a message for this request. The message can indicate an error.

Returns:

MessageBox or null if there is no message

getAllMessageBoxes

public final java.util.List<MessageBox> getAllMessageBoxes()

Returns a List of all MessageBoxes object if the server returns messages for this request. The messages can indicate an error, warning or information.

Returns:

List list of MessageBox received in the request.

send

public void send(org.w3c.dom.Document doc,
        ConnectionAttributes sessioninfo,
        java.lang.String nr)

Prepares the request for sending.

Parameters:

doc - DOM

sessioninfo - Information about the UC4 session

nr - Request number

getRequestID

public java.lang.String getRequestID(java.lang.String defaultValue)

Sub classes may override to send a UUID instead. This is used for a file transfer from the Agent to the client

Parameters:

defaultValue - Unique number which is not used so far

Returns:

ID to use to send this request