com.hp.ucmdb.api.discovery.types
Interface ProcessSignature

All Superinterfaces:

java.io.Serializable

public interface ProcessSignature
extends java.io.Serializable

Represents a set of rules to detect the existence of a specific process.

Method Summary

java.lang.String	getCmdLine() Returns the string that identifies this process if found in the command line.
java.lang.String	getName() Returns the name of this ProcessSignature object.
java.lang.String[]	getPorts() Returns the ports that are part of the definition of this process.
boolean	isPortsRequired() Checks whether the ports are required for the detection of this ProcessSignature.
boolean	isRequired() Checks whether this ProcessSignature is required for the detection of the SoftwareSignature it belongs.
ProcessSignature	notRequired() Sets this ProcessSignature to be optional for the detection of the SoftwareSignature it belongs to.
ProcessSignature	required() Sets this ProcessSignature to be required for the detection of the SoftwareSignature it belongs to.
void	setCmdLine(java.lang.String cmdLine) Sets the string that identifies this process if found in the command line.
void	setIsPortsRequired(boolean isPortReq) Sets the ports that are part of the detection to be required or optional.
void	setPorts(boolean isRequired, java.lang.String... ports) Sets the ports that are part of the detection of the process represented by this object.
void	setRequired(boolean isRequired) Sets whether this ProcessSignature is required for the detection of the SoftwareSignature it belongs to.
ProcessSignature	withCmdLine(java.lang.String cmdLine) Sets the string that identifies this process if found in the command line.
ProcessSignature	withPorts(java.lang.String... ports) Sets the ports that are part of the detection of the process represented by this object.

Method Detail

getName

java.lang.String getName()

Returns the name of this ProcessSignature object.

Returns:

name the name of this ProcessSignature object.

getPorts

java.lang.String[] getPorts()

Returns the ports that are part of the definition of this process.

Returns:

the ports that are part of the definition of this process. If there are no ports, returns an empty array.

getCmdLine

java.lang.String getCmdLine()

Returns the string that identifies this process if found in the command line.

Returns:

the string to find in the command line string.

isRequired

boolean isRequired()

Checks whether this ProcessSignature is required for the detection of the SoftwareSignature it belongs.

Returns:

true if this ProcessSignature is required for the detection of the SoftwareSignature it belongs to.

isPortsRequired

boolean isPortsRequired()

Checks whether the ports are required for the detection of this ProcessSignature.

Returns:

true if the ports are required for the detection of this ProcessSignature.

setPorts

void setPorts(boolean isRequired,
              java.lang.String... ports)

Sets the ports that are part of the detection of the process represented by this object. A call to this method overrides previous calls to it or to withPorts(int ... ports).

Parameters:

isRequired - If true, the ports have to be detected for the identification of this process. If false - the ports are optional.

ports - the ports that are part of the detection process.

setCmdLine

void setCmdLine(java.lang.String cmdLine)

Sets the string that identifies this process if found in the command line. A call to this method overrides the previous call to it or to withCmdLine(String CmdLine).

Parameters:

cmdLine - the string to find in the command line string.

setRequired

void setRequired(boolean isRequired)

Sets whether this ProcessSignature is required for the detection of the SoftwareSignature it belongs to. A call to this method overrides the previous call to it, to required() and to notRequired().

Parameters:

isRequired - true if this ProcessSignature is required to the detection of the SoftwareSignature it belongs to.

withCmdLine

ProcessSignature withCmdLine(java.lang.String cmdLine)

Sets the string that identifies this process if found in the command line. A call to this method overrides a previous call to it or to setCmdLine(String CmdLine).

Parameters:

cmdLine - a string which should be scanned in the command line in order to detect the process.

Returns:

this object with the change (for chaining)

required

ProcessSignature required()

Sets this ProcessSignature to be required for the detection of the SoftwareSignature it belongs to. A call to this method overrides a previous call to it, to setRequired(boolean isRequired) and to notRequired().

Returns:

this object with the change (for chaining)

notRequired

ProcessSignature notRequired()

Sets this ProcessSignature to be optional for the detection of the SoftwareSignature it belongs to. A call to this method overrides a previous call to it, to setRequired(boolean isRequired) and to required().

Returns:

this object with the change (for chaining)

withPorts

ProcessSignature withPorts(java.lang.String... ports)

Sets the ports that are part of the detection of the process represented by this object. A call to this method overrides previous calls to it or to setPorts(boolean isRequired, int ... ports). Ports that are set by this function are optional and not required for the detection process.

Returns:

this object with the change (for chaining)

setIsPortsRequired

void setIsPortsRequired(boolean isPortReq)

Sets the ports that are part of the detection to be required or optional.

Parameters:

isPortReq - true if required.