|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
| Method Summary | |
void |
AssignJobFolder(java.lang.String bstrJobServer,
int lJobFolderID)
Assigns an admin folder to an existing Job Server |
java.lang.Object[] |
CreateJobHistoryEntry(int nJobID,
com.plumtree.openfoundation.util.XPDateTime dtRunTime,
java.lang.String bstrJobServer,
int lInstanceID)
These methods add an entry into the job history table as well as operations that occur during job processing. |
void |
DeleteJobHistory(com.plumtree.openfoundation.util.XPDateTime OlderThan)
Deletes entries from the history table and any associated log files as well. |
java.lang.Object[][] |
GetPage(int lPageNumber)
Returns entries comprising the page for the requested page number. |
IPTObjectManager |
GetScheduledJobs()
Returns an IPTJobManager interface |
void |
KillRunningJob(int nJobID,
int SoftKillTimeoutInSeconds)
Sends a kill request signal to a running job |
void |
LogOperationToJobHistory(java.lang.Object[] pvJHToken,
int nOperationClassID,
int nOperationObjectID,
java.lang.String bstrOperationObjectName,
int nResult,
java.lang.String bstrMessage)
Logs an operation run during a job. |
int |
OpenLogForRead(int lInstanceID,
int lLinesPerPage)
Opens a job log for purposes of reading lines through subsequent calls to GetPage. |
int |
OpenLogForSearch(int lInstanceID,
int lLinesPerPage,
java.lang.String bstrText)
Conducts a search against an existing job log. |
IPTQueryResult |
QueryJobAssignmentsByFolder(int lJobFolderID)
Queries for job servers that are assigned to a job folder. |
IPTQueryResult |
QueryJobAssignmentsByServer(java.lang.String bstrJobServer)
Queries for job folders that are assigned to a job server. |
IPTQueryResult |
QueryJobHistory(com.plumtree.openfoundation.util.XPDateTime FromDate,
com.plumtree.openfoundation.util.XPDateTime ToDate,
int JobID)
This returns a query result with a list of jobid/runtime pairs (as well as other information) |
IPTQueryResult |
QueryJobsByOperation(int nOpClassID,
int nOpObjectID)
Query for the jobs a particular operation object is in. |
IPTQueryResult |
QueryJobServerStatus(java.lang.String bstrServerName)
Queries the status for a given Job Server |
IPTQueryResult |
QueryOperationHistoryByJob(int nJobID,
com.plumtree.openfoundation.util.XPDateTime dtRunTime)
Query for operation history ran within the specified job at the time requested. |
IPTQueryResult |
QueryOperationHistoryByObject(com.plumtree.openfoundation.util.XPDateTime FromDate,
com.plumtree.openfoundation.util.XPDateTime ToDate,
int Class,
int ObjectID)
Query for operation history ran by a specific object or class of objects (ie, crawlers). |
IPTQueryResult |
QueryServerSchedule(java.lang.String bstrServerName)
Retrieves the list of jobs a server should run and their next runtimes |
void |
RegisterJobServer(java.lang.String bstrJobServer,
java.lang.String bstrNetAddress)
Registers a job processing server machine. |
void |
UnassignJobFolder(java.lang.String bstrJobServer,
int lJobFolderID)
Removes an administrative folder from a Job Server's purview |
void |
UnregisterJobServer(java.lang.String bstrJobServer)
Removes a Job Server machine from the known list of servers. |
void |
UpdateJobHistoryEntry(java.lang.Object[] pvJHToken,
com.plumtree.openfoundation.util.XPDateTime dtEndTime,
int nStatus,
java.lang.String bstrMessage,
int lInstanceID)
Updates an existing Job History Entry to reflect current status. |
void |
UpdateJobServerStatus(java.lang.String bstrJobServer,
int nStatus)
Updates the status of the given Job Server machine |
| Methods inherited from interface com.plumtree.server.IPTUnknown |
GetInterfaces |
| Method Detail |
public IPTObjectManager GetScheduledJobs()
public IPTQueryResult QueryServerSchedule(java.lang.String bstrServerName)
bstrServerName - The name of the server whose schedule is being queried.
public IPTQueryResult QueryJobHistory(com.plumtree.openfoundation.util.XPDateTime FromDate,
com.plumtree.openfoundation.util.XPDateTime ToDate,
int JobID)
FromDate - The XPDateTime from which the query will beginToDate - The XPDateTime to which the query will endJobID - The relevant Job object ID
public IPTQueryResult QueryOperationHistoryByObject(com.plumtree.openfoundation.util.XPDateTime FromDate,
com.plumtree.openfoundation.util.XPDateTime ToDate,
int Class,
int ObjectID)
FromDate - The XPDateTime from which the query will beginToDate - The XPDateTime to which the query will endClass - The Class ID of the operationObjectID - The Object ID of the operation
public IPTQueryResult QueryOperationHistoryByJob(int nJobID,
com.plumtree.openfoundation.util.XPDateTime dtRunTime)
nJobID - The Job ID containing the operation being queried.dtRunTime - The XPDateTime for the time this job ran.public void DeleteJobHistory(com.plumtree.openfoundation.util.XPDateTime OlderThan)
OlderThan - The XPDateTime before which, all job histories will be removed.
public java.lang.Object[] CreateJobHistoryEntry(int nJobID,
com.plumtree.openfoundation.util.XPDateTime dtRunTime,
java.lang.String bstrJobServer,
int lInstanceID)
nJobID - The affected Job IDdtRunTime - The XPDateTime marking the launch timebstrJobServer - The name of the Job Server launching this joblInstanceID - The instance ID of this particular launch
public void UpdateJobHistoryEntry(java.lang.Object[] pvJHToken,
com.plumtree.openfoundation.util.XPDateTime dtEndTime,
int nStatus,
java.lang.String bstrMessage,
int lInstanceID)
pvJHToken - An array of two Objects identifying this entry, Job ID, and launch timedtEndTime - An XPDateTime marking Job terminationnStatus - PT_JOBSTATUSbstrMessage - Readable summary of Job executionlInstanceID - Instance ID corresponding to execution
public void LogOperationToJobHistory(java.lang.Object[] pvJHToken,
int nOperationClassID,
int nOperationObjectID,
java.lang.String bstrOperationObjectName,
int nResult,
java.lang.String bstrMessage)
pvJHToken - An array of two Objects identifying this entry, Job ID, and launch timenOperationClassID - The Class ID of the operationnOperationObjectID - The Object ID of the operationbstrOperationObjectName - Name of the operationnResult - a PT_RESULTCODES entrybstrMessage - Readable summary for operation status
public void RegisterJobServer(java.lang.String bstrJobServer,
java.lang.String bstrNetAddress)
bstrJobServer - Name of new Job Server machinebstrNetAddress - Network address of machinepublic void UnregisterJobServer(java.lang.String bstrJobServer)
bstrJobServer - The name of the Job Server to be removed
public void UpdateJobServerStatus(java.lang.String bstrJobServer,
int nStatus)
bstrJobServer - The name of the Job Server machine whose status will be updatednStatus - a PT_JOBSERVERSTATUS memberpublic IPTQueryResult QueryJobServerStatus(java.lang.String bstrServerName)
bstrServerName - The name of the requested Job Server or to get all registered job servers.public IPTQueryResult QueryJobAssignmentsByServer(java.lang.String bstrJobServer)
bstrJobServer - Name of the relevant Job Serverpublic IPTQueryResult QueryJobAssignmentsByFolder(int lJobFolderID)
lJobFolderID - The ID of the admin folder being queried
public void AssignJobFolder(java.lang.String bstrJobServer,
int lJobFolderID)
bstrJobServer - Name of the Job Server to monitor this folderlJobFolderID - The ID of the administrative folder to be monitored.
public void UnassignJobFolder(java.lang.String bstrJobServer,
int lJobFolderID)
bstrJobServer - The name of the Job ServerlJobFolderID - The ID of the administrative folder to be removed
public void KillRunningJob(int nJobID,
int SoftKillTimeoutInSeconds)
nJobID - The ID of the Job targeted for terminationSoftKillTimeoutInSeconds - The number of seconds after which a hard kill will commence.
public IPTQueryResult QueryJobsByOperation(int nOpClassID,
int nOpObjectID)
nOpClassID - Class ID of the operationnOpObjectID - Object ID of the operation
public int OpenLogForRead(int lInstanceID,
int lLinesPerPage)
lInstanceID - The instance ID of the desired job loglLinesPerPage - The number of log lines returned from each call to GetPagepublic java.lang.Object[][] GetPage(int lPageNumber)
lPageNumber - The page number from the open log.
public int OpenLogForSearch(int lInstanceID,
int lLinesPerPage,
java.lang.String bstrText)
lInstanceID - The instance ID for the target log.lLinesPerPage - The desired page size of search results.bstrText - The text used in the search
|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||