com.hp.ucmdb.discovery.library.execution

Interface BaseFramework

All Known Subinterfaces:

ExecutionRecordFramework

public interface BaseFramework

Run-time services for querying data, issuing messages, and creating and deleting objects.

Method Summary

Methods

Modifier and Type	Method and Description
void	deleteObject(ObjectStateHolder osh) Enqueue the object on the framework for deletion.
void	deleteObjects(ObjectStateHolderVector deletedObjects) Updates the framework with the CI objects deleted by a pattern while the pattern is still running.
void	flushObjects() Sends all the objects waiting for update, creation and deletion to the server and clears the cache.
java.lang.String	getParameter(java.lang.String paramName) Returns the value of the specified parameter defined on the pattern XML.
java.lang.String	getTriggerCIData(java.lang.String attributeName) Returns the value of the specified attribute from the CI that triggered the discovery
java.lang.String[]	getTriggerCIDataAsList(java.lang.String attributeName) Returns the values of the specified attribute from the CI that triggered the discovery
void	reportError(int msgCode, java.lang.String[] params) Reports an error during a script run and marks the trigger failed.
void	reportError(java.lang.String message) Reports an error during a script run and marks the trigger failed.
void	reportFatal(int msgCode, java.lang.String[] params) Reports a fatal error message on this trigger CI to the user interface during a script run.
void	reportFatal(java.lang.String message) Writes a fatal error message on this trigger CI to the user interface during a script run.
void	reportWarning(int msgCode, java.lang.String[] params) Reports a warning on this trigger CI during a script run.
void	reportWarning(java.lang.String message) Writes a warning on this trigger CI during a script run.
void	sendObject(ObjectStateHolder osh) Enqueue the object on the framework for create or update.
void	sendObjects(ObjectStateHolderVector discoveredObjects) Updates the framework with the CI objects created by a pattern while the pattern is still running.

Method Detail

getTriggerCIData

java.lang.String getTriggerCIData(java.lang.String attributeName)

Returns the value of the specified attribute from the CI that triggered the discovery

Parameters:

attributeName - The attribute name

Returns:

the attribute value

getTriggerCIDataAsList

java.lang.String[] getTriggerCIDataAsList(java.lang.String attributeName)

Returns the values of the specified attribute from the CI that triggered the discovery

Parameters:

attributeName - The attribute name

Returns:

the list of values of the given attribute

getParameter

java.lang.String getParameter(java.lang.String paramName)

Returns the value of the specified parameter defined on the pattern XML.

Parameters:

paramName - The parameter name

Returns:

The value of the parameter

reportError

void reportError(java.lang.String message)

Reports an error during a script run and marks the trigger failed.
The message sent using reportError is displayed on the user interface and is written to the log file. If the UCMDB is configured to create communication logs, a file is created for this message.
The information logged is the message and the session parameters in effect at the time of the reportError invocation.
Each error sent with reportError clears the previous error.
Examples of errors that can occur during a script run are connection failure, hardware problems, and timeouts.

Parameters:

message - The error message

See Also:

reportWarning(String), reportFatal(String)

reportFatal

void reportFatal(java.lang.String message)

Writes a fatal error message on this trigger CI to the user interface during a script run.

Parameters:

message - The error message

See Also:

reportError(String), reportWarning(String)

reportWarning

void reportWarning(java.lang.String message)

Writes a warning on this trigger CI during a script run. The warning is written to the user interface and to the log.
Writing a warning does not mark the trigger failed. To mark the trigger as failed, use reportError.

Parameters:

message - The warning message

See Also:

reportFatal(String), reportError(String)

sendObject

void sendObject(ObjectStateHolder osh)

Enqueue the object on the framework for create or update.

Parameters:

osh - The object to send

deleteObject

void deleteObject(ObjectStateHolder osh)

Enqueue the object on the framework for deletion.

Parameters:

osh - The object to delete

See Also:

deleteObjects(ObjectStateHolderVector)

sendObjects

void sendObjects(ObjectStateHolderVector discoveredObjects)

Updates the framework with the CI objects created by a pattern while the pattern is still running.
sendObjects does not wait for the script to complete and return the newly created CIs. It is designed for use in a script where the results are expected to be very large. Using sendObjects helps avoid OutOfMemory errors that can occur when the probe when stores too many results in memory.
Note: Ensure that when the script finishes, it does not return results that are duplicates of the records already handled with sendObjects. For example, after each sendObjects invocation, clear the ObjectStateHolderVector instance or use a new ObjectStateHolderVector object.

Parameters:

discoveredObjects - A vector of the objects that have been discovered at the time of the sendObjects invocation

deleteObjects

void deleteObjects(ObjectStateHolderVector deletedObjects)

Updates the framework with the CI objects deleted by a pattern while the pattern is still running.
deleteObjects collects the deleted objects and sends them to the server before the script run is finished.
Usually, the CIs in UCMDB are deleted by the aging mechanism. (See the UCMDB guide for more detail.) Where special circumstances require that CIs be deleted without waiting for the aging mechanism, this method is used to send an immediate deletion request.

Parameters:

deletedObjects - A Vector of Objects of the objects the probe has marked for deletion at the time of the deleteObjects invocation

See Also:

sendObjects(appilog.common.system.types.vectors.ObjectStateHolderVector)

flushObjects

void flushObjects()

Sends all the objects waiting for update, creation and deletion to the server and clears the cache.

See Also:

deleteObjects(ObjectStateHolderVector), sendObjects(ObjectStateHolderVector)

reportError

void reportError(int msgCode,
               java.lang.String[] params)

Reports an error during a script run and marks the trigger failed.

Parameters:

msgCode - the code of the error message

params - the parameters required for this error message (null - if no parameters are required)

reportWarning

void reportWarning(int msgCode,
                 java.lang.String[] params)

Reports a warning on this trigger CI during a script run.

Parameters:

msgCode - the code of the error message

params - the parameters required for this error message (null - if no parameters are required)

reportFatal

void reportFatal(int msgCode,
               java.lang.String[] params)

Reports a fatal error message on this trigger CI to the user interface during a script run.

Parameters:

msgCode - the code of the error message

params - the parameters required for this error message (null - if no parameters are required)