com.hp.ucmdb.api.discovery.services

Interface DDMConfigurationService

public interface DDMConfigurationService

Services to configure Data Flow Probes, Clusters, IP Ranges and Credentials.
The Universal Discovery server can be configured with an XML or by getting the Data Flow Probe.

Method Summary

Modifier and Type	Method and Description
void	createNewResource(DiscoveryResType resType, String resName, byte[] resData) adds the given resource file by provided resource data and resource type
void	createNewResource(DiscoveryResType resType, String resPackage, String resName, byte[] resData) adds the given resource file by provided resource data and resource type
HashMap<String,ProbeDashboardSnapShotInfo>	getAllProbeDashboardInfo() get all probe dashboard infomation
DDMProbe	getDDMProbe(String probeName) Returns the specified Data Flow Probe.
Collection<DDMProbe>	getDDMProbes() Returns the Data Flow Probe objects that report to this Universal Discovery server.
List<String>	getDDMWindowsProbeNames()
String	getDiscoveryConfigurationXML() Returns the discovery system configuration XML.
DiscoveryFactory	getDiscoveryFactory() Returns the DiscoveryFactory used to create the objects required by this service.
HashMap<String,ArrayList<DomainProtocolsMetaData>>	getDomainProtocolsMetaData(String domainName)
String	getInfraSetting(String name)
JobSnapShotInfo	getJobSnapShotInfo(String probeName, String jobName) get jobsnapshot runtime info
ProbeCluster	getProbeCluster(String clusterName)
String	getProbeClusterRanges(String clusterName)
String	getProbeClusterRangesWithDescription(String clusterName) get probe range to the Data Flow probe.The probeRange with description The xml format is networkranges.xsd
Collection<ProbeCluster>	getProbeClusters(String domainName) Gets cluster list from domain
ProbeDashboardSnapShotInfo	getProbeDashboardInfo(String probeName) get probe dashboard infomation by probe name
ProbeData	getProbeData(String probeName, boolean isOverview) Get detailed data for a particular probe
HashMap<String,JobDiscoveryPatternClassStats>	getProbeDiscoveryStats(String probeName) get jobsnapshot runtime info
String	getProbeRanges(String probeName)
String	getProbeRangesWithDescription(String probeName) get probe range to the Data Flow probe.The probeRange with description The xml format is networkranges.xsd
DiscoveryResData	getResource(DiscoveryResType resType, String resName) get the resource properties according to given resource name and resource type
byte[]	getResourceData(DiscoveryResType resType, String resName) get the resource data according to given resource name and resource type
String	importIPRanges(HashMap<String,ArrayList<String>> probeLBGroup, HashMap<String,ArrayList<IPRange>> IPRangeGroup, HashMap<String,ArrayList<String>> domainGroup) Import IPRanges to Probes with load balance distribution for probe group.
Collection<DiscoveryResData>	listResources(DiscoveryResType resType) get the resource properties according to given resource type
List<String>	readResources(DiscoveryResType type) Get names list of all existing resource name by given resource type
void	RemoveResource(DiscoveryResType resType, String resName) removes the resource file by given resource type and resource name
void	setDiscoveryConfigurationXML(String xmlString) Sets the discovery system configuration based on input XML.
void	setDiscoveryConfigurationXML(String xmlString, boolean includeGroup) Sets the discovery system configuration based on input XML.
void	setDiscoveryConfigurationXML(String xmlString, String domainName) Sets the discovery system configuration based on input XML.
void	setProbeCluster(String domainName, String clusterName, String clusterNetworkConf, Collection<String> probeNamesList) Create/update cluster under specific domain
String	setProbeClusterRangesWithDescription(String clusterName, String probeClusterRangesXml) get probe range to the Data Flow probe.The probeRange with description The xml format is networkranges.xsd
String	setProbeRanges(String probeName, String probeNetworkConf)
String	setProbeRangesWithDescription(String probeName, String probeRangesXml) set probe range to the Data Flow probe.
void	updateDomainData(String domainString, String operation)
void	updateResourceData(DiscoveryResType resType, String resName, byte[] resData) updates the given resource file for the given resource type

Method Detail

getDDMProbes

Collection<DDMProbe> getDDMProbes()

Returns the Data Flow Probe objects that report to this Universal Discovery server.
Changes made to a Data Flow Probe affect the Universal Discovery server.

Returns:

the collection of Data Flow Probe objects that report to this Universal Discovery server.

getDDMWindowsProbeNames

List<String> getDDMWindowsProbeNames()

getInfraSetting

String getInfraSetting(String name)

getDDMProbe

DDMProbe getDDMProbe(String probeName)

Returns the specified Data Flow Probe.
Changes made to a Data Flow Probe affect the Universal Discovery server.

Parameters:

probeName - the name of the Data Flow Probe to return.

Returns:

the Data Flow Probe, or null if no probe of the specified name exists.

getProbeData

ProbeData getProbeData(String probeName,
                       boolean isOverview)

Get detailed data for a particular probe

Parameters:

probeName - the name of probe

isOverview - show overview or detailed probe data

setProbeCluster

void setProbeCluster(String domainName,
                     String clusterName,
                     String clusterNetworkConf,
                     Collection<String> probeNamesList)

Create/update cluster under specific domain

Parameters:

domainName - The domain name where to the cluster will be created/updated

clusterName - the cluster name for update; the if the cluster does not exist, then it is created

clusterNetworkConf - The range configuration, can be empty but not null

probeNamesList - The list of probes in the cluster, can be empty but not null

getProbeClusters

Collection<ProbeCluster> getProbeClusters(String domainName)

Gets cluster list from domain

Parameters:

domainName - The domain name where to search for clusters; if domainName is null then clusters from all domains will be returned

Returns:

The list of all found clusters found in domain

getProbeCluster

ProbeCluster getProbeCluster(String clusterName)

getProbeClusterRanges

String getProbeClusterRanges(String clusterName)

Parameters:

clusterName - The name of the cluster

Returns:

The xml representation of the cluster range

getDiscoveryFactory

DiscoveryFactory getDiscoveryFactory()

Returns the DiscoveryFactory used to create the objects required by this service.

Returns:

the DiscoveryFactory used to create the objects required by this service.

getDiscoveryConfigurationXML

String getDiscoveryConfigurationXML()

Returns the discovery system configuration XML. The XML contains the ranges information of each Data Flow Probe, the credentials information, discovery parameters, and an indication of whether the discovery Data Flow probe is active.

Returns:

the discovery system configuration XML.

getProbeRanges

String getProbeRanges(String probeName)

setProbeRanges

String setProbeRanges(String probeName,
                      String probeNetworkConf)

setDiscoveryConfigurationXML

void setDiscoveryConfigurationXML(String xmlString)

Sets the discovery system configuration based on input XML. The XML contains the ranges information of each Data Flow Probe, the credentials information, discovery parameters, and an indication of whether the Data Flow probe is active.

Parameters:

xmlString - the configuration XML as returned by getDiscoveryConfigurationXML.

setDiscoveryConfigurationXML

void setDiscoveryConfigurationXML(String xmlString,
                                  boolean includeGroup)

Sets the discovery system configuration based on input XML. The XML contains the ranges information of each Data Flow Probe, the credentials information, discovery parameters, and an indication of whether the Data Flow probe is active.

Parameters:

xmlString - the configuration XML as returned by getDiscoveryConfigurationXML.

includeGroup - whether it includes the group configuration.

setDiscoveryConfigurationXML

void setDiscoveryConfigurationXML(String xmlString,
                                  String domainName)

Sets the discovery system configuration based on input XML. The XML contains the ranges information of each Data Flow Probe, the credentials information, discovery parameters, and an indication of whether the Data Flow probe is active.

Parameters:

xmlString - the configuration XML as returned by getDiscoveryConfigurationXML.

domainName - The domainName where want to import the configuration.

readResources

List<String> readResources(DiscoveryResType type)

Get names list of all existing resource name by given resource type

Returns:

list of all resource name by given resource type

updateResourceData

void updateResourceData(DiscoveryResType resType,
                        String resName,
                        byte[] resData)

updates the given resource file for the given resource type

Parameters:

resType - resource type

resName - resource name

resData - the new content data of resource

createNewResource

void createNewResource(DiscoveryResType resType,
                       String resPackage,
                       String resName,
                       byte[] resData)

adds the given resource file by provided resource data and resource type

Parameters:

resType - resource type

resPackage - package name that resource will be added into

resName - resource name

resData - the new content data of resource

createNewResource

void createNewResource(DiscoveryResType resType,
                       String resName,
                       byte[] resData)

adds the given resource file by provided resource data and resource type

Parameters:

resType - resource type

resName - resource name

resData - the new content data of resource

RemoveResource

void RemoveResource(DiscoveryResType resType,
                    String resName)

removes the resource file by given resource type and resource name

Parameters:

resType - resource type

resName - package name that resource will be added into

getResourceData

byte[] getResourceData(DiscoveryResType resType,
                       String resName)

get the resource data according to given resource name and resource type

Parameters:

resType - resource type

resName - resource name

Returns:

content data of requested resource

listResources

Collection<DiscoveryResData> listResources(DiscoveryResType resType)

get the resource properties according to given resource type

Parameters:

resType - resource type

Returns:

properties of requested resource without resource content

getResource

DiscoveryResData getResource(DiscoveryResType resType,
                             String resName)

get the resource properties according to given resource name and resource type

Parameters:

resType - resource type

resName - resource name

Returns:

properties of requested resource

importIPRanges

String importIPRanges(HashMap<String,ArrayList<String>> probeLBGroup,
                      HashMap<String,ArrayList<IPRange>> IPRangeGroup,
                      HashMap<String,ArrayList<String>> domainGroup)
               throws IllegalNetworkRangeException

Import IPRanges to Probes with load balance distribution for probe group.

Parameters:

probeLBGroup - a map with the keys which represent probe group name and the value of group list

IPRangeGroup - the list of ip ranges to be added to probe group by corresponding key. value eg: 1.1.1.1-2.2.2.2

domainGroup - describe which probes are in same domain

Returns:

the message of this operation result

Throws:

IllegalNetworkRangeException - if the input is not of valid

setProbeRangesWithDescription

String setProbeRangesWithDescription(String probeName,
                                     String probeRangesXml)

set probe range to the Data Flow probe. The xml format is networkranges.xsd

Parameters:

probeName - the name of Data Flow probe

Returns:

the message of this operation result

getProbeRangesWithDescription

String getProbeRangesWithDescription(String probeName)

get probe range to the Data Flow probe.The probeRange with description The xml format is networkranges.xsd

Parameters:

probeName - the name of Data Flow probe

Returns:

the message of this operation result

setProbeClusterRangesWithDescription

String setProbeClusterRangesWithDescription(String clusterName,
                                            String probeClusterRangesXml)

get probe range to the Data Flow probe.The probeRange with description The xml format is networkranges.xsd

Parameters:

clusterName - the name of Data Flow probe

Returns:

the message of this operation result

getProbeClusterRangesWithDescription

String getProbeClusterRangesWithDescription(String clusterName)

get probe range to the Data Flow probe.The probeRange with description The xml format is networkranges.xsd

Parameters:

clusterName - the name of Data Flow probe

Returns:

the message of this operation result

getProbeDashboardInfo

ProbeDashboardSnapShotInfo getProbeDashboardInfo(String probeName)

get probe dashboard infomation by probe name

Parameters:

probeName - the name of Data Flow probe

Returns:

the message of this operation result

getAllProbeDashboardInfo

HashMap<String,ProbeDashboardSnapShotInfo> getAllProbeDashboardInfo()

get all probe dashboard infomation

Returns:

the message of this operation result

updateDomainData

void updateDomainData(String domainString,
                      String operation)

getJobSnapShotInfo

JobSnapShotInfo getJobSnapShotInfo(String probeName,
                                   String jobName)

get jobsnapshot runtime info

Parameters:

probeName - the name of Data Flow probe

jobName - the name of Data Flow probe

Returns:

the message of this operation result

getProbeDiscoveryStats

HashMap<String,JobDiscoveryPatternClassStats> getProbeDiscoveryStats(String probeName)

get jobsnapshot runtime info

Parameters:

probeName - the name of Data Flow probe

Returns:

the message of this operation result

getDomainProtocolsMetaData

HashMap<String,ArrayList<DomainProtocolsMetaData>> getDomainProtocolsMetaData(String domainName)