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 receives when calling the discoveryMain function.

See Also:

ClientsFramework, BaseFramework

Method Summary

Methods

Modifier and Type	Method and Description
boolean	clearGlobalState(java.lang.String destination) Clears the saved GLOBAL (cross job) state.
boolean	clearState() Clears the saved state.
boolean	clearState(java.lang.String jobId, java.lang.String destination) Clears the saved state.
java.lang.String[]	filterJobsWithoutTrigger(java.lang.String[] jobIds, java.lang.String trigger_id) Gets an destination and job ids and finds which of those jobs exists for this destination
ClassModelServicesImpl	getClassModelServices() Returns the Class model service object, allowing querying for attribute existence in class model.
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() Returns the runtime environment information object for querying probe domain/IP information
java.lang.String[]	getJobsForAdapter(java.lang.String adapterId) Returns the jobs of a given adapter
boolean	isExecutionActive() Check if current execution (Job and CI) is active.
java.lang.String	loadGlobalState(java.lang.String destination) Returns the GLOBAL (cross job) state most recently saved to the database for this destination (any value) in this job.
java.lang.String	loadState() Returns the state most recently saved to the database for this trigger in this job.
boolean	saveGlobalState(java.lang.String destination, java.lang.String state) Saves GLOBAL (cross job) state of this invocation which can be accessed by other jobs
boolean	saveState(java.lang.String state) Saves the state of this invocation of the working trigger in the running job.
boolean	saveState(java.lang.String jobId, java.lang.String destination, java.lang.String state) Saves the state of a given job and trigger.

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

saveState

boolean saveState(java.lang.String jobId,
                java.lang.String destination,
                java.lang.String state)

Saves the state of a given job and trigger. 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:

jobId - the job id

destination - the trigger id

state - the state string is application-dependent

Returns:

true if sate save is successful

saveGlobalState

boolean saveGlobalState(java.lang.String destination,
                      java.lang.String state)

Saves GLOBAL (cross job) state of this invocation which can be accessed by other jobs

Parameters:

destination, - any value

state - any value

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.

loadGlobalState

java.lang.String loadGlobalState(java.lang.String destination)

Returns the GLOBAL (cross job) state most recently saved to the database for this destination (any value) 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

clearState

boolean clearState(java.lang.String jobId,
                 java.lang.String destination)

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

Parameters:

jobId - the job id

destination - the destination

Returns:

true if state is cleared successfully

clearGlobalState

boolean clearGlobalState(java.lang.String destination)

Clears the saved GLOBAL (cross job) state.

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.

Returns:

The code page value

getEnvironmentInformation

EnvironmentInformation getEnvironmentInformation()

Returns the runtime environment information object for querying probe domain/IP information

Returns:

The Environment Information object

getClassModelServices

ClassModelServicesImpl getClassModelServices()

Returns the Class model service object, allowing querying for attribute existence in class model.

Returns:

The Class Model service object.

isExecutionActive

boolean isExecutionActive()

Check if current execution (Job and CI) is active.

Returns:

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

getJobsForAdapter

java.lang.String[] getJobsForAdapter(java.lang.String adapterId)

Returns the jobs of a given adapter

Parameters:

adapterId - the id of the adapter

Returns:

List of jobs of the given adapter

filterJobsWithoutTrigger

java.lang.String[] filterJobsWithoutTrigger(java.lang.String[] jobIds,
                                          java.lang.String trigger_id)
                                            throws java.sql.SQLException

Gets an destination and job ids and finds which of those jobs exists for this destination

Parameters:

jobIds - the array of jobs that we want to check

trigger_id - the trigger id to find it's existing jobs

Returns:

String[] of the jobs from the given jobIds which exists for this destination

Throws:

java.sql.SQLException - when there was a problem retrieving the existing jobs of the destination