org.rhq.enterprise.server.cloud

Interface TopologyManagerLocal

All Known Implementing Classes:

TopologyManagerBean

public interface TopologyManagerLocal

Author:

Joseph Marques

Method Summary

Methods

Modifier and Type	Method and Description
void	deleteServer(org.rhq.core.domain.auth.Subject subject, Integer serverId)
void	deleteServers(org.rhq.core.domain.auth.Subject subject, Integer[] serverIds)
org.rhq.core.domain.util.PageList<org.rhq.core.domain.cloud.Server>	findServersByCriteria(org.rhq.core.domain.auth.Subject subject, org.rhq.core.domain.criteria.ServerCriteria criteria) Fetches the server based on provided criteria.
List<org.rhq.core.domain.resource.Agent>	getAgentsByServerName(String serverName)
List<org.rhq.core.domain.cloud.Server>	getAllCloudServers() Return every server registered in the database considered part of the active cloud.
List<org.rhq.core.domain.cloud.Server>	getAllServers() Deprecated. Use the findServersByCriteria() instead.
org.rhq.core.domain.util.PageList<org.rhq.core.domain.cloud.FailoverListDetails>	getFailoverListDetailsByAgentId(org.rhq.core.domain.auth.Subject subject, int agentId, org.rhq.core.domain.util.PageControl pc) the subject needs to have MANAGE_SETTINGS permissions.
int	getNormalServerCount() Returns the number of servers that are part of the "server cloud" that are currently running in "normal" mode.
org.rhq.core.domain.cloud.Server	getServerById(int serverId) Deprecated. Use the findServersByCriteria() instead.
org.rhq.core.domain.cloud.Server	getServerByName(String serverName) Deprecated. Use the findServersByCriteria() instead.
org.rhq.core.domain.util.PageList<org.rhq.core.domain.cloud.composite.ServerWithAgentCountComposite>	getServerComposites(org.rhq.core.domain.auth.Subject subject, org.rhq.core.domain.util.PageControl pc) Returns all servers with the agent counts the subject needs to have MANAGE_INVENTORY and MANAGE_SETTINGS permissions.
int	getServerCount() Returns the number of servers that are part of the "server cloud", which excludes servers that have been installed but not associated with the cloud.
void	markStaleServersDown(org.rhq.core.domain.auth.Subject subject)
org.rhq.core.domain.cloud.Server	updateServer(org.rhq.core.domain.auth.Subject subject, org.rhq.core.domain.cloud.Server server) Updates the server.
void	updateServerMode(org.rhq.core.domain.auth.Subject subject, Integer[] serverIds, org.rhq.core.domain.cloud.Server.OperationMode mode) Updates the server operation mode for multiple servers.

Method Detail

deleteServers

void deleteServers(org.rhq.core.domain.auth.Subject subject,
                 Integer[] serverIds)
                   throws TopologyManagerException

Throws:

TopologyManagerException

deleteServer

void deleteServer(org.rhq.core.domain.auth.Subject subject,
                Integer serverId)
                  throws TopologyManagerException

Throws:

TopologyManagerException

getAgentsByServerName

List<org.rhq.core.domain.resource.Agent> getAgentsByServerName(String serverName)

getServerById

org.rhq.core.domain.cloud.Server getServerById(int serverId)

Deprecated. Use the findServersByCriteria() instead.

Parameters:

serverId -

Returns:

the server

getServerByName

org.rhq.core.domain.cloud.Server getServerByName(String serverName)

Deprecated. Use the findServersByCriteria() instead.

Parameters:

serverName -

Returns:

the server

getAllCloudServers

List<org.rhq.core.domain.cloud.Server> getAllCloudServers()

Return every server registered in the database considered part of the active cloud. This will exclude, for example, servers in INSTALLED mode or any other mode that should not be included when performing cloud operations such as partitioning.

Returns:

All servers available to the cloud.

getAllServers

List<org.rhq.core.domain.cloud.Server> getAllServers()

Deprecated. Use the findServersByCriteria() instead.

Return every server registered in the database.

Returns:

All servers, regardless of operation mode.

getServerComposites

org.rhq.core.domain.util.PageList<org.rhq.core.domain.cloud.composite.ServerWithAgentCountComposite> getServerComposites(org.rhq.core.domain.auth.Subject subject,
                                                                                                                       org.rhq.core.domain.util.PageControl pc)

Returns all servers with the agent counts the subject needs to have MANAGE_INVENTORY and MANAGE_SETTINGS permissions.

Parameters:

subject - the caller

pc -

Returns:

list of ServerWithAgentCountComposite

getServerCount

int getServerCount()

Returns the number of servers that are part of the "server cloud", which excludes servers that have been installed but not associated with the cloud. The returned count will include those servers that are down or in maintenance mode, in addition to those servers that are currently running in a normal state.

Returns:

count of servers in the cloud

getNormalServerCount

int getNormalServerCount()

Returns the number of servers that are part of the "server cloud" that are currently running in "normal" mode. This excludes all other servers such as those servers that have been installed but not associated with the cloud, servers that are down or in maintenance mode.

Returns:

count of servers in the cloud that are in a normal running state

updateServerMode

void updateServerMode(org.rhq.core.domain.auth.Subject subject,
                    Integer[] serverIds,
                    org.rhq.core.domain.cloud.Server.OperationMode mode)

Updates the server operation mode for multiple servers. the subject needs to have MANAGE_INVENTORY and MANAGE_SETTINGS permissions.

Parameters:

subject - the caller

serverIds -

mode - desired server operation mode

updateServer

org.rhq.core.domain.cloud.Server updateServer(org.rhq.core.domain.auth.Subject subject,
                                            org.rhq.core.domain.cloud.Server server)

Updates the server. the subject needs to have MANAGE_INVENTORY and MANAGE_SETTINGS permissions.

Parameters:

subject - the caller.

server -

Returns:

getFailoverListDetailsByAgentId

org.rhq.core.domain.util.PageList<org.rhq.core.domain.cloud.FailoverListDetails> getFailoverListDetailsByAgentId(org.rhq.core.domain.auth.Subject subject,
                                                                                                               int agentId,
                                                                                                               org.rhq.core.domain.util.PageControl pc)

the subject needs to have MANAGE_SETTINGS permissions.

Parameters:

subject -

agentId -

pc -

Returns:

markStaleServersDown

void markStaleServersDown(org.rhq.core.domain.auth.Subject subject)

findServersByCriteria

org.rhq.core.domain.util.PageList<org.rhq.core.domain.cloud.Server> findServersByCriteria(org.rhq.core.domain.auth.Subject subject,
                                                                                        org.rhq.core.domain.criteria.ServerCriteria criteria)

Fetches the server based on provided criteria. the subject needs to have MANAGE_SETTINGS permissions.

Parameters:

subject - caller

criteria - the criteria

Returns:

list of servers