org.apache.ambari.server.state

Interface Clusters

All Known Implementing Classes:

ClustersImpl

public interface Clusters

Single entity that tracks all clusters and hosts that are managed by the Ambari server

Method Summary

Modifier and Type	Method and Description
void	addCluster(String clusterName, StackId stackId) Add a new Cluster
void	addCluster(String clusterName, StackId stackId, SecurityType securityType) Add a new cluster
void	addHost(String hostname) Add a Host object to be managed by this server
void	addSessionAttributes(String name, Map<String,Object> attributes) Add the given map of attributes to the session for the cluster identified by the given name.
boolean	checkPermission(String clusterName, boolean readOnly) Determine whether or not access to the cluster resource identified by the given cluster name should be allowed based on the permissions granted to the current user.
void	debugDump(StringBuilder sb) Produces a debug dump into the supplied string buffer
void	deleteCluster(String clusterName) Deletes the cluster identified by the name
void	deleteHost(String hostname) Removes a host.
Cluster	getCluster(Long clusterId) Gets the Cluster given the cluster id
Cluster	getCluster(String clusterName) Gets the Cluster given the cluster name
Cluster	getClusterById(long id) Gets the cluster using the id.
Map<String,Cluster>	getClusters() Get all clusters
Set<Cluster>	getClustersForHost(String hostname) Returns all the cluster names for this hostname
int	getClusterSize(String clusterName) Returns the number of hosts that form the cluster identified by the given name.
Host	getHost(String hostname) Get a Host object managed by this server
Host	getHostById(Long hostId) Get a Host object managed by this server
Map<Long,Host>	getHostIdsForCluster(String clusterName) Gets all the host Ids associated with the cluster
List<Host>	getHosts() Get all hosts being tracked by the Ambari server
Map<String,Host>	getHostsForCluster(String clusterName) Gets all the hosts associated with the cluster
Map<String,Object>	getSessionAttributes(String name) Get the map of session attributes for the cluster identified by the given name.
boolean	hostExists(String hostname) Check if host exists
void	invalidate(Cluster cluster) Invalidates the specified cluster by retrieving it from the database and refreshing all of the internal stateful collections.
void	invalidateAllClusters() Invalidates all clusters by retrieving each from the database and refreshing all of its internal stateful collections.
boolean	isHostMappedToCluster(long clusterId, String hostName) Gets whether the specified cluster has a mapping for the specified host.
void	mapAndPublishHostsToCluster(Set<String> hostnames, String clusterName) Maps a set of hosts to the given cluster
void	mapHostToCluster(String hostname, String clusterName) Map host to the given cluster.
void	publishHostsDeletion(Set<Long> hostIds, Set<String> hostNames) Publish event set of hosts were removed
void	unmapHostFromCluster(String hostname, String clusterName) Removes a host from a cluster.
void	updateClusterName(String oldName, String newName) Updates the name of the cluster
void	updateHostMappings(Host host) Updates the internal mappings of hosts using the specified host.
void	updateHostWithClusterAndAttributes(Map<String,Set<String>> hostsClusters, Map<String,Map<String,String>> hostAttributes) Update the host set for clusters and the host attributes associated with the hosts

Method Detail

addCluster

void addCluster(String clusterName,
                StackId stackId)
         throws org.apache.ambari.server.AmbariException

Add a new Cluster

Parameters:

clusterName - the cluster name (not null).

stackId - the stack for the cluster (not null).

Throws:

org.apache.ambari.server.AmbariException

addCluster

void addCluster(String clusterName,
                StackId stackId,
                SecurityType securityType)
         throws org.apache.ambari.server.AmbariException

Add a new cluster

Parameters:

clusterName - the cluster name (not null).

stackId - the stack for the cluster (not null).

securityType - the cluster will be created with this security type.

Throws:

org.apache.ambari.server.AmbariException

getCluster

Cluster getCluster(String clusterName)
            throws org.apache.ambari.server.AmbariException

Gets the Cluster given the cluster name

Parameters:

clusterName - Name of the Cluster to retrieve

Returns:

Cluster identified by the given name

Throws:

org.apache.ambari.server.AmbariException

getCluster

Cluster getCluster(Long clusterId)
            throws org.apache.ambari.server.AmbariException

Gets the Cluster given the cluster id

Parameters:

clusterId - Id of the Cluster to retrieve

Returns:

Cluster identified by the given id

Throws:

org.apache.ambari.server.AmbariException

getClusters

Map<String,Cluster> getClusters()

Get all clusters

Returns:

Map of clusters with cluster name as key

getHosts

List<Host> getHosts()

Get all hosts being tracked by the Ambari server

Returns:

List of Host

getClustersForHost

Set<Cluster> getClustersForHost(String hostname)
                         throws org.apache.ambari.server.AmbariException

Returns all the cluster names for this hostname

Parameters:

hostname -

Returns:

List of cluster names

Throws:

org.apache.ambari.server.AmbariException

getHost

Host getHost(String hostname)
      throws org.apache.ambari.server.AmbariException

Get a Host object managed by this server

Parameters:

hostname - Name of the host requested

Returns:

Host object

Throws:

org.apache.ambari.server.AmbariException

hostExists

boolean hostExists(String hostname)

Check if host exists

Parameters:

hostname - Name of the host requested

Returns:

is host exists

isHostMappedToCluster

boolean isHostMappedToCluster(long clusterId,
                              String hostName)

Gets whether the specified cluster has a mapping for the specified host.

Parameters:

clusterId - the cluster ID

hostName - the host (not null).

Returns:

true if the host belongs to the cluster, false otherwise.

getHostById

Host getHostById(Long hostId)
          throws org.apache.ambari.server.AmbariException

Get a Host object managed by this server

Parameters:

hostId - Host Id from the HostEntity objecty

Returns:

Host object

Throws:

org.apache.ambari.server.AmbariException

updateHostMappings

void updateHostMappings(Host host)

Updates the internal mappings of hosts using the specified host.

Parameters:

host - the host to update the internal mappings for.

addHost

void addHost(String hostname)
      throws org.apache.ambari.server.AmbariException

Add a Host object to be managed by this server

Parameters:

hostname - Host to be added

Throws:

org.apache.ambari.server.AmbariException

mapHostToCluster

void mapHostToCluster(String hostname,
                      String clusterName)
               throws org.apache.ambari.server.AmbariException

Map host to the given cluster. A host can belong to multiple clusters

Parameters:

hostname -

clusterName -

Throws:

org.apache.ambari.server.AmbariException

mapAndPublishHostsToCluster

void mapAndPublishHostsToCluster(Set<String> hostnames,
                                 String clusterName)
                          throws org.apache.ambari.server.AmbariException

Maps a set of hosts to the given cluster

Parameters:

hostnames -

clusterName -

Throws:

org.apache.ambari.server.AmbariException

updateClusterName

void updateClusterName(String oldName,
                       String newName)

Updates the name of the cluster

Parameters:

oldName -

newName -

Throws:

org.apache.ambari.server.AmbariException

getClusterById

Cluster getClusterById(long id)
                throws org.apache.ambari.server.AmbariException

Gets the cluster using the id.

Parameters:

id - The identifier associated with the cluster

Returns:

Cluster identified by the identifier

Throws:

org.apache.ambari.server.AmbariException

debugDump

void debugDump(StringBuilder sb)

Produces a debug dump into the supplied string buffer

Parameters:

sb - The string buffer to add the debug dump to

getHostsForCluster

Map<String,Host> getHostsForCluster(String clusterName)

Gets all the hosts associated with the cluster

Parameters:

clusterName - The name of the cluster

Returns:

Map containing host name and Host

getHostIdsForCluster

Map<Long,Host> getHostIdsForCluster(String clusterName)
                             throws org.apache.ambari.server.AmbariException

Gets all the host Ids associated with the cluster

Parameters:

clusterName - The name of the cluster

Returns:

Map containing host id and Host

Throws:

org.apache.ambari.server.AmbariException

deleteCluster

void deleteCluster(String clusterName)
            throws org.apache.ambari.server.AmbariException

Deletes the cluster identified by the name

Parameters:

clusterName - The name of the cluster

Throws:

org.apache.ambari.server.AmbariException

updateHostWithClusterAndAttributes

void updateHostWithClusterAndAttributes(Map<String,Set<String>> hostsClusters,
                                        Map<String,Map<String,String>> hostAttributes)
                                 throws org.apache.ambari.server.AmbariException

Update the host set for clusters and the host attributes associated with the hosts

Parameters:

hostsClusters -

hostAttributes -

Throws:

org.apache.ambari.server.AmbariException

unmapHostFromCluster

void unmapHostFromCluster(String hostname,
                          String clusterName)
                   throws org.apache.ambari.server.AmbariException

Removes a host from a cluster. Inverts {@link #mapHostToCluster(String, String)

Parameters:

hostname -

clusterName -

Throws:

org.apache.ambari.server.AmbariException

deleteHost

void deleteHost(String hostname)
         throws org.apache.ambari.server.AmbariException

Removes a host. Inverts addHost(String)

Parameters:

hostname -

Throws:

org.apache.ambari.server.AmbariException

publishHostsDeletion

void publishHostsDeletion(Set<Long> hostIds,
                          Set<String> hostNames)
                   throws org.apache.ambari.server.AmbariException

Publish event set of hosts were removed

Throws:

org.apache.ambari.server.AmbariException

checkPermission

boolean checkPermission(String clusterName,
                        boolean readOnly)

Determine whether or not access to the cluster resource identified by the given cluster name should be allowed based on the permissions granted to the current user.

Parameters:

clusterName - the cluster name

readOnly - indicate whether or not this check is for a read only operation

Returns:

true if access to the cluster is allowed

addSessionAttributes

void addSessionAttributes(String name,
                          Map<String,Object> attributes)

Add the given map of attributes to the session for the cluster identified by the given name.

Parameters:

name - the cluster name

attributes - the session attributes

getSessionAttributes

Map<String,Object> getSessionAttributes(String name)

Get the map of session attributes for the cluster identified by the given name.

Parameters:

name - the cluster name

Returns:

the map of session attributes for the cluster; never null

getClusterSize

int getClusterSize(String clusterName)

Returns the number of hosts that form the cluster identified by the given name.

Parameters:

clusterName - the name that identifies the cluster

Returns:

number of hosts that form the cluster

invalidate

void invalidate(Cluster cluster)

Invalidates the specified cluster by retrieving it from the database and refreshing all of the internal stateful collections.

Parameters:

cluster - the cluster to invalidate and refresh (not null).

invalidateAllClusters

void invalidateAllClusters()

Invalidates all clusters by retrieving each from the database and refreshing all of its internal stateful collections.