com.hp.ucmdb.api.discovery.services
Interface DDMManagementService

public interface DDMManagementService

Services to analyze and view the progress, results, and errors of the DDM run.

Method Summary

void	abortRun(DiscoveryContext context) Stops execution of all tasks associated with the specified context.
void	activateJobs(java.util.HashSet<java.lang.String> jobs) Activates the jobs in the collection.
void	deactivateJobs(java.util.HashSet<java.lang.String> jobs) Deactivate the jobs in the collection.
java.util.Collection<CIErrorData>	getCIsErrorData(ErrorID errorId) Returns a collection of CIErrorData with a specified errorId.
ContextFactory	getContextFactory() Returns the factory that creates DiscoveryContext objects.
DiagnosticInfo	getDiagnosticInfo(java.lang.String jobId, UcmdbId triggerCiId) Returns the DiagnosticInfo for the execution of the jobId against the specified triggerCiId.
DiagnosticInfo	getDiagnosticInfo(java.lang.String jobId, UcmdbId triggerCiId, long timeout) Returns the DiagnosticInfo for the execution of the jobId against the specified triggerCiId.
DiscoveryFactory	getDiscoveryFactory() Returns the factory that creates the objects required by this service.
java.util.Collection<ErrorStatus>	getErrors() Returns the errors that occurred during the last DDM run.
java.util.Collection<ErrorStatus>	getErrors(DiscoveryContext context) Returns the errors that occurred within the specified scope during the last DDM run.
java.util.Collection<ErrorStatus>	getErrors(DiscoveryContext context, ErrorsFilter filter) Returns the errors that occurred within the specified scope during the last DDM run and that match the specified filter.
java.util.Collection<ErrorStatus>	getErrors(ErrorsFilter filter) Returns the errors that occurred during the last DDM run and that match the specified filter.
DiscoveryProgress	getProgress() Returns the progress of the DDM run.
DiscoveryProgress	getProgress(DiscoveryContext context) Returns the progress of processing the specified context within the DDM run.
void	reRun(DiscoveryContext context) Sets all tasks associated with the specified context to be re-executed.

Method Detail

getProgress

DiscoveryProgress getProgress()

Returns the progress of the DDM run.

Returns:

an object that represents the progress of the DDM run.

getProgress

DiscoveryProgress getProgress(DiscoveryContext context)

Returns the progress of processing the specified context within the DDM run.

Parameters:

context - the scope on which the information is required.

Returns:

an object that represents the Progress of the DDM run on the specified scope.

getErrors

java.util.Collection<ErrorStatus> getErrors()

Returns the errors that occurred during the last DDM run.

Returns:

the ErrorStatus objects from the last DDM run.

getErrors

java.util.Collection<ErrorStatus> getErrors(DiscoveryContext context)

Returns the errors that occurred within the specified scope during the last DDM run.

Parameters:

context - the scope on which the information is required.

Returns:

the ErrorStatus objects from the specified context of the last DDM run.

getErrors

java.util.Collection<ErrorStatus> getErrors(DiscoveryContext context,
                                            ErrorsFilter filter)

Returns the errors that occurred within the specified scope during the last DDM run and that match the specified filter.

Parameters:

context - the scope on which the information is required.

filter - restrictions on the errors to be returned.

Returns:

the ErrorStatus objects from the specified scope of the last DDM run that match the filter.

getErrors

java.util.Collection<ErrorStatus> getErrors(ErrorsFilter filter)

Returns the errors that occurred during the last DDM run and that match the specified filter.

Parameters:

filter - restrictions on the errors to be returned.

Returns:

the ErrorStatus objects from the last DDM run that match the filter.

getCIsErrorData

java.util.Collection<CIErrorData> getCIsErrorData(ErrorID errorId)

Returns a collection of CIErrorData with a specified errorId.

Parameters:

errorId - the error ID.

Returns:

the CIs' data.

getDiagnosticInfo

DiagnosticInfo getDiagnosticInfo(java.lang.String jobId,
                                 UcmdbId triggerCiId)
                                 throws java.util.concurrent.TimeoutException

Returns the DiagnosticInfo for the execution of the jobId against the specified triggerCiId.

Parameters:

jobId - the desired DiagnosticInfo was collected during the execution of this job.

triggerCiId - the UcmdbId of the CI that is the subject of the DiagnosticInfo.

Returns:

the data regarding the execution of the input job against the input CI.

Throws:

java.util.concurrent.TimeoutException

getDiagnosticInfo

DiagnosticInfo getDiagnosticInfo(java.lang.String jobId,
                                 UcmdbId triggerCiId,
                                 long timeout)
                                 throws java.util.concurrent.TimeoutException

Returns the DiagnosticInfo for the execution of the jobId against the specified triggerCiId.

Parameters:

jobId - the of the job.

triggerCiId - the UcmdbId of the CI.

timeout - in milliseconds.

Returns:

the data on the execution of the job against the CI.

Throws:

java.util.concurrent.TimeoutException

reRun

void reRun(DiscoveryContext context)

Sets all tasks associated with the specified context to be re-executed.

Parameters:

context - the scope.

abortRun

void abortRun(DiscoveryContext context)

Stops execution of all tasks associated with the specified context.

Parameters:

context - the scope.

getDiscoveryFactory

DiscoveryFactory getDiscoveryFactory()

Returns the factory that creates the objects required by this service.

Returns:

the factory that creates the objects required by this service.

getContextFactory

ContextFactory getContextFactory()

Returns the factory that creates DiscoveryContext objects.

Returns:

the factory that creates DiscoveryContext objects.

activateJobs

void activateJobs(java.util.HashSet<java.lang.String> jobs)

Activates the jobs in the collection.

Parameters:

jobs - Collection of IDs of the jobs to activate.

deactivateJobs

void deactivateJobs(java.util.HashSet<java.lang.String> jobs)

Deactivate the jobs in the collection.

Parameters:

jobs - Collection of IDs of the jobs to deactivate.