Type

Method and Description

String[]

findBusinessEntitiesContainingCluster(ClusterResourceData clusterResourceData)

Returns business entities associated with the cluster given as parameter.

String[]

findBusinessEntitiesContainingDatabase(DatabaseResourceData databaseResourceData)

Returns business entities associated with the database given as parameter.

String[]

findBusinessEntitiesContainingHost(HostResourceData hostResourceData)

Returns business entities associated with the host given as parameter.

BusinessEntityData[]

getAllBusinessEntities()

Returns s list of all business entities in the system.

FullCycleData[]

getAllBusinessEntityFullCycles()

Returns all full cycle schedules which have "business entities" scope type.

BusinessEntityData

getBusinessEntity(String businessEntityName)

Returns a business entity according to the name provided as parameter.

BusinessEntityData

getBusinessEntityById(Integer id)

Returns a business entity according to the ID provided as parameter.

String[]

getBusinessEntityRoles()

Returns a list of all business entity roles in the system.

String[]

getBusinessEntityTypes()

Returns a list of all business entity types in the system.

FullCycleData

getFullCycleByName(String fullCycleConfigId)

Returns the full cycle scheduling configuration by the name of the scanning schedule identifier.

String[]

getSLAPolicyNames()

Returns a list of all SLA policy names in the system.

String

removeAssociations(String businessEntity, HostResourceData[] hostsToRemove, DatabaseResourceData[] databasesToRemove, ClusterResourceData[] clustersToRemove)

Removes association between [hosts or/and databases] and business entity.

String

removeBusinessEntity(BusinessEntityData businessEntityData)

Remove business entity from the system.

String

saveOrUpdateBusinessEntity(BusinessEntityData businessEntityData)

Creates or updates a business entity.

Type

Method and Description

ClusterData[]

getAllClusters()

Returns s list of all clusters in the system.

ClusterData

getCluster(String clusterName)

Returns a cluster according to the name provided as parameter.

ClusterData

getClusterById(Integer id)

Returns a cluster according to the ID provided as parameter.

Type

Method and Description

ComparisonGroupData

createComparisonGroup(WorksheetData worksheet, String groupName, HostData[] hosts, ClusterData[] clusters)

This method create a new comparison group for a given worksheet.

WorksheetData

createWorksheet(AppUserData appUserData, String name, String privacy, Boolean standbyAwareComparison)

This method create a new worksheet for the given application user.

ComparisonGroupData[]

getComparisonGroups(WorksheetData worksheet)

Returns all the comparison groups for a given worksheet.

WorksheetData[]

getWorksheetsByUser(AppUserData appUserData)

Returns a list of all worksheet in the system for a specific application user .

Boolean

removeComparisonGroup(WorksheetData worksheet, ComparisonGroupData groupData)

Removes a comparison group from a given worksheet in the system.

Boolean

removeWorksheet(WorksheetData worksheet)

Removes a worksheet from the system.

Type

Method and Description

String

executeSchduledReport(String reportId)

Create a task for executing the scheduled report and enqueue it.

String

executeScheduledScanTaskByTaskId(String scanTaskId)

Create a task for executing a scheduled scan and enqueue it, given the scan ID.

String[]

getAllScanTaskIds()

Returns all the currently queued scan task IDs.

ReportTaskData[]

getAllScheduledReports()

Get all scheduled reports.

AppUserData[]

getAppUsers()

Retrieves a list of application users.

ConnectivityPolicyData

getConnectivityPolicyByName(String name)

Returns connectivity policy object according to the name provided.

String[]

getConnectivityPolicyNames()

Returns a list of all connectivity policy names exist in the system.

String[]

getConnectivityPolicyTypes()

Returns a list of the available policy types.

String

getLastSAPIDatabaseViewsUpdate()

Execute Recreation of SAPI Database Views.

String[]

getProxyDefinitionNames()

Returns a list of all proxy definition names exist in the system.

String[]

getSudoDefinitionNames()

Returns a list of all sudo definition names exist in the system.

String

initiateDatabaseViewsCreation()

Execute Recreation of SAPI Database Views.

boolean

isSAPIDatabaseViewsTurnedOn()

Returns whether the SAPI Database Views feature turned on.

int

saveOrUpdateConnectivityPolicy(ConnectivityPolicyData policy)

Saves a connectivity policy.

Type

Method and Description

DatabaseData[]

getAllDatabases()

Returns s list of all database services in the system.

DatabaseData

getDatabase(String hostName, String databaseServiceName)

Returns a database according to the host name and database service name provided as parameter.

DatabaseData

getDatabaseById(Integer id)

Returns a database service according to the ID provided as parameter.

String[]

getDatabaseScanningGroupNames()

Returns all database scanning groups.

String[]

getDatabaseTypes()

Returns a list of all supported database types.

String

removeDatabase(DatabaseData databaseData)

Remove database service from the system.

String

saveOrUpdateDatabase(DatabaseData databaseData)

Creates or updates a database service.

Type

Method and Description

Boolean

changePassword(HostData host, String newChangedPassword)

Determines the basic configuration of the password for the password rotation process.

HostData[]

getAllHosts()

Returns s list of all hosts in the system.

HostData

getHost(String hostName)

Returns a host according to the name provided as parameter.

HostData

getHostById(Integer id)

Returns a host according to the ID provided as parameter.

String[]

getHostScanningGroupNames()

Returns all host scanning groups.

String[]

getOperatingSystemTypes()

Returns a list of all supported operating systems.

String

removeHost(HostData hostData)

Remove host from the system.

String

saveOrUpdateHost(HostData hostData)

Creates or updates a host.

Type

Method and Description

String

initiateHostDiscovery(HostData hostData)

Execute host discovery.

String

initiateHostLoginCheck(HostData hostData)

Verify connectivity and credentials to the host.

String

initiateHostPasswordRotation(HostData hostData)

Execute rotation of the host password.

String

initiateHostScan(HostData hostData)

Execute a full host scan.

String

initiateMultipleHostScan(HostData[] hostsData)

Execute a full host scan for multiple hosts.

Type

Method and Description

SiteData[]

getAllSites()

Returns a list of all sites in the system.

SiteData

getSite(String siteName)

Returns a site according to the name provided as parameter.

String

removeSite(SiteData siteData)

Remove the site from the system.

String

saveOrUpdateSite(SiteData siteData)

Creates or updates a site.

Type

Method and Description

void

cancelTask(String taskId)

Cancels a task and removes it from the task queue.

TaskOnQueue[]

getTasksOnQueue()

Returns a list of all tasks in queue (running and pending).

int

getTaskStatus(String taskId)

Returns the task status.

Type

Method and Description

Integer[]

getAllTicketIds()

Returns a list of all the existing ticket IDs.

TicketData[]

getAllTickets()

Returns a list of all the existing tickets.

String

getTicketByIdAsHtml(Integer ticketId)

Returns a ticket details (in HTML format) according to the ticketId provided as parameter.

String

suppressTicket(Integer ticketId)

Suppresses a ticket by ID.

Type

Method and Description

Integer

getId()

Returns the application user id.

String

getName()

Returns the application user name.

void

setId(Integer id)

Sets the application user id.

void

setName(String name)

Sets the application user name.

Type

Method and Description

BusinessEntityData[]

getAssignedBusinessEntities()

Returns the sub business entities of the business entity.

ClusterResourceData[]

getAssignedClusters()

Returns the clusters that are members of the business entity.

DatabaseResourceData[]

getAssignedDatabases()

Returns the database services that are of the business entity.

HostResourceData[]

getAssignedHosts()

Returns the hosts that are members of the business entity.

String

getDescription()

Returns the business entity description.

String[]

getFullCycleScheduleNames()

Returns the full cycle schedule configurations that this business entity is member of.

String

getName()

Returns the business entity name.

String

getType()

Returns the business entity type.

void

setAssignedBusinessEntities(BusinessEntityData[] assignedBusinessEntities)

Sets business entities that will be members of the business entity.

void

setAssignedClusters(ClusterResourceData[] assignedClusters)

Sets clusters that will be members of the business entity.

void

setAssignedDatabases(DatabaseResourceData[] assignedDatabases)

Sets database services that will be members of the business entity.

void

setAssignedHosts(HostResourceData[] assignedHosts)

Sets hosts that will be members of the business entity.

void

setDescription(String description)

Sets the business entity description.

void

setFullCycleScheduleNames(String[] fullCycleScheduleNames)

Sets the full cycle schedule configurations for this business entity.

void

setName(String name)

Sets the business entity name.

void

setType(String type)

Sets the business entity type.

Type

Method and Description

String

getRole()

Returns the role inside the business entity.

String

getSlaPolicyName()

Returns the SLA policy name associated with the entity inside the business entity.

boolean

isRemoveFromOtherBusinessEntities()

Whether this resource will be removed from any other business entity upon update operation.

void

setRemoveFromOtherBusinessEntities(boolean removeFromOtherBusinessEntities)

Sets the flag for the update operation to remove any association between the resource and other business entities it is currently member of.

void

setRole(String role)

Sets the role inside the business entity.

void

setSlaPolicyName(String slaPolicyName)

Sets the SLA policy name associated with the entity inside the business entity.

Type

Method and Description

String

getDiscovery()

Description of how the cluster found (Manually/Automatically).

String

getName()

Return the cluster name.

HostNodeData[]

getNodes()

Returns all the hosts in the cluster.

String

getType()

Return the cluster type.

Type

Method and Description

String

getName()

Returns the cluster name.

String

getType()

Returns the cluster type.

void

setName(String name)

Sets the cluster name.

void

setType(String type)

Sets the cluster type.

Type

Method and Description

static java.util.Set<String>

getClusterIds(ClusterData[] clusters)

Return the cluster IDs as strings, given a container of clusters.

ClusterData[]

getClusters()

Returns the clusters that are members of the comparison group entity.

static ClusterData[]

getClustersData(Set<String> clusterIds)

Return the clusters, given a set of cluster IDs (as strings).

Set<String>

getHostIds(HostData[] hosts)

Return the host IDs as strings, given a container of hosts.

HostData[]

getHosts()

Returns the hosts that are members of the comparison group entity.

static HostData[]

getHostsData(Set<String> hostIds)

Return the hosts, given a set of host IDs (as strings).

String

getName()

Returns the name of the comparison group.

String

getType()

Returns the type of the comparison group.

Boolean

isValid()

Validate comparison group name (must be a non empty name).

void

setClusters(ClusterData[] clusters)

Sets the clusters that are members of the comparison group entity.

void

setHosts(HostData[] hosts)

Sets the hosts that are members of the comparison group entity.

void

setName(String name)

Sets the name of the comparison group.

void

setType(String type)

Sets the name of the comparison group.

String

toString() 

Type

Method and Description

java.util.Date

getCredentialLastUpdateTime()

The last time the credential got updated.

Integer

getId()

Returns the ID of the connectivity policy.

String

getName()

Returns the connectivity policy name.

String

getPassword()

Returns the password defined in the connectivity policy.

String

getPasswordExpirationTime()

When chosing password rotation set the expiration time in days.

String

getProxyDefinitionName()

Returns the proxy definition.

String

getSudoDefinitionName()

Returns the sudo definition.

String

getType()

Returns the connectivity policy type.

String

getUsername()

Returns the username defined in the connectivity policy.

void

setId(Integer id)

Sets the ID of the connectivity policy.

void

setName(String name)

Sets the connectivity policy name.

void

setPassword(String password)

Sets a new password for the connectivity policy.

void

setPasswordExpirationTime(String passwordExpirationTime)

Sets the expiration time for the password of the connectivity policy (number of days or "Each Scan").

void

setProxyDefinitionName(String proxyDefinitionName)

Sets proxy definition.

void

setSudoDefinitionName(String sudoDefinitionName)

Sets sudo definition.

void

setType(String type)

Sets the connectivity policy type.

void

setUsername(String username)

Sets a new username for the connectivity policy.

Type

Method and Description

String

getConnectivityPolicyName()

Returns the database service connectivity policy name.

Integer

getHostId()

Returns the unique ID of host item.

String

getHostName()

Returns the host name.

String

getName()

Returns the database service name.

String

getPort()

Returns the database service port.

String[]

getScanningGroups()

Returns all scanning groups that this database service is assigned to.

String

getType()

Returns the database service type.

String

getVirtualIP()

Returns the database service virtual IP address.

void

setConnectivityPolicyName(String connectivityPolicyName)

Sets the database service connectivity policy name.

void

setHostId(Integer hostId)

Sets the unique ID of the host item.

void

setHostName(String hostName)

Sets the host name - CANNOT BE UPDATED - use this function only when adding new database service.

void

setName(String name)

Sets the database service name.

void

setPort(String port)

Sets the database service port.

void

setScanningGroups(String[] scanningGroups)

Sets the scanning groups for this database.

void

setType(String type)

Sets the database service name - CANNOT BE UPDATED - use this function only when adding new database service.

void

setVirtualIP(String virtualIP)

Sets the database service virtual IP address.

Type

Method and Description

Integer

getHostId()

Returns the host unique ID (in the system database).

String

getHostName()

Returns the host name.

String

getName()

Returns the database service name.

String

getType()

Returns the database service type.

void

setHostId(Integer hostId)

Sets the host unique ID (in the system database).

void

setHostName(String hostName)

Sets the host name.

void

setName(String name)

Sets the database service name.

void

setType(String type)

Sets the database service type.

Type

Method and Description

Integer

getId()

Returns the entity unique ID as presented in the Database Views.

String

getPresentationName() 

void

setId(Integer id)

Sets the entity unique ID as presented in the Database Views - USE THIS FUNCTION ONLY FOR UPDATE OPERATIONS.

Type

Method and Description

String

getName()

Returns the name of the Full Cycle entity.

String

getSchedule()

Returns the scheduling of the Full Cycle entity.

Type

Method and Description

String

getConnectivityPolicyName()

Returns the host connectivity policy name.

String

getConnectivityStatus()

Return the host connectivity status.

Date

getLastResetTimeForPassword()

Returns the last time the host.

String

getName()

Returns the host name.

String

getOperatingSystem()

Returns the host operating system.

String

getPrimaryIP()

Returns the host primary IP.

String[]

getScanningGroups()

Returns all scanning groups that this host is assigned to.

String

getScanStatus()

Return the host scan status.

ScanTroubleshootingData[]

getScanTroubleshootingData()

Return the scanning errors relevant to this host.

String

getSiteName()

Returns the host location (site name).

boolean

isWorkingWithInitialPassword()

Returns true if the host password has ever rotate.

void

setConnectivityPolicyName(String connectivityPolicyName)

Sets the host connectivity policy name.

void

setName(String name)

Sets the host name.

void

setOperatingSystem(String operatingSystem)

Sets the host operating system.

void

setPrimaryIP(String primaryIP)

Sets the host primary IP.

void

setScanningGroups(String[] scanningGroups)

Sets the scanning groups for this host.

void

setSiteName(String siteName)

Sets the host location (site name).

Type

Method and Description

String

getName()

Return host name.

String

getPrimaryIP()

Return host IP.

String

getSiteName()

Return the host's site.

String

getType()

Return operating system.

Type

Method and Description

String

getName()

Returns the host name.

String

getType()

Returns the host type (operating system).

void

setName(String name)

Sets the host name.

void

setType(String type)

Sets the host type (operating system).

Type

Method and Description

String

getFormat()

Returns the format of the scheduled report entity.

String

getFrequency()

Returns the frequency of the scheduled report entity.

String

getId()

Returns the ID of the scheduled report entity.

String

getName()

Returns the name of the scheduled report entity.

String

getRecipients()

Returns the recipients of the scheduled report entity.

String

getSubject()

Returns the subject of the scheduled report entity.

boolean

isEnabled()

Returns the enabled status of the scheduled report entity.

void

setEnabled(boolean enabled)

Sets the enabled status of the scheduled report entity.

void

setFormat(String format)

Sets the format of the scheduled report entity.

void

setFrequency(String frequency)

Sets the frequency of the scheduled report entity.

void

setId(String id)

Sets the ID of the scheduled report entity.

void

setName(String name)

Sets the name of the scheduled report entity.

void

setRecipients(String recipients)

Sets the recipients of the scheduled report entity.

void

setSubject(String subject)

Sets the subject of the scheduled report entity.

Type

Method and Description

String

getSeverity()

Return the severity.

String

getSummary()

Return the meaning of the event.

String

getType()

Return the type.

Type

Method and Description

String

getDescription()

Returns the site description.

String

getName()

Returns the site name.

void

setDescription(String description)

Sets the site description.

void

setName(String name)

Sets the site name.

Type

Method and Description

String

getId()

Returns the task id.

String

getName()

Returns the task name.

String

getStatus()

Returns the task status: Pending or Running.

Type

Method and Description

Integer

getId()

Returns the ticket id.

String

getSummary()

Returns the ticket summary.

Type

Method and Description

AppUserData

getAppUserData()

Returns the user associated with the comparison worksheet.

String

getDbId()

Returns the ID of the comparison worksheet.

String

getName()

Returns the name of the comparison worksheet.

String

getPrivacy()

Returns the privacy status of the comparison worksheet.

Boolean

getStandbyAwareComparison()

Returns the standby aware comparison status of the comparison worksheet.

Boolean

isValid()

Validate comparison worksheet (must have a non empty ID and an associated application user).

void

setAppUserData(AppUserData user)

Sets the user associated with the comparison worksheet.

void

setDbId(String dbId)

Sets the ID of the comparison worksheet.

void

setName(String name)

Sets the name of the comparison worksheet.

void

setPrivacy(String privacy)

Sets the privacy status of the comparison worksheet.

void

setStandbyAwareComparison(Boolean standbyAwareComparison)

Sets the standby aware comparison status of the comparison worksheet.