com.hp.ucmdb.discovery.probe.services.dynamic.core
Interface DynamicServiceFramework

public interface DynamicServiceFramework

This interface is implemented by the framework object that the jython script recevies when calling the discoveryMain function.

See Also:

ClientsFramework, com.hp.ucmdb.discovery.library.execution.BaseFramework

Method Summary

boolean	clearState() Clears the saved state.
ClassModelServicesImpl	getClassModelServices()
java.lang.String	getCodePage() Returns the code page value.
BaseConfigFile	getConfigFile(java.lang.String configFileName) Returns the object that represents the specified configuration file.
EnvironmentInformation	getEnvironmentInformation()
boolean	isExecutionActive()
java.lang.String	loadState() Returns the state most recently saved to the database for this trigger in this job.
boolean	saveState(java.lang.String state) Saves the state of this invocation of the working trigger in the running job.

Method Detail

saveState

boolean saveState(java.lang.String state)

Saves the state of this invocation of the working trigger in the running job. The state can be any string. Use it in your application to save information from one invocation to the next. For example, if an invocation did not complete the discovery, you can save the information required to begin from the point at which the invocation exited.

Parameters:

state - the state string is application-dependent

Returns:

true if state save is successful

loadState

java.lang.String loadState()

Returns the state most recently saved to the database for this trigger in this job.

Returns:

A state string.

clearState

boolean clearState()

Clears the saved state. The next time loadState is called after clearState, loadState returns an empty string.

Returns:

true if state is cleared successfully

getConfigFile

BaseConfigFile getConfigFile(java.lang.String configFileName)
                             throws java.io.FileNotFoundException,
                                    java.lang.Exception

Returns the object that represents the specified configuration file.

Parameters:

configFileName - the name of the configuration file

Returns:

The object used to handle the file

Throws:

java.io.FileNotFoundException

java.lang.Exception

getCodePage

java.lang.String getCodePage()

Returns the code page value.

getEnvironmentInformation

EnvironmentInformation getEnvironmentInformation()

getClassModelServices

ClassModelServicesImpl getClassModelServices()

isExecutionActive

boolean isExecutionActive()

Returns:

- true if current execution (defined by job name and trigger ci id) is active; false otherwise