ParentComponent (Apache Stratos - Messaging 4.1.6 API)

java.lang.Object
- org.apache.stratos.messaging.domain.application.ParentComponent<T>

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

Application, Group
```
public abstract class ParentComponent<T extends Instance>
extends Object
implements Serializable
```
Abstraction for a an entity that can have child entities in an Application within the Topology

See Also:
Serialized Form

Field Summary

Fields
Modifier and Type Field and Description

protected Map<String,ClusterDataHolder> aliasToClusterDataMap

protected Map<String,Group> aliasToGroupMap

Fields
Modifier and Type	Field and Description
`protected Map<String,ClusterDataHolder>`	`aliasToClusterDataMap`
`protected Map<String,Group>`	`aliasToGroupMap`

Constructor Summary

Constructors
Constructor and Description

ParentComponent()

Constructors
Constructor and Description
`ParentComponent()`

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`addGroup(Group group)` Adds a group
`void`	`addInstance(String instanceId, T instance)` Adds InstanceContext of a child to the instanceIdToInstanceContextMap.
`boolean`	`containsInstanceContext(String instanceId)` Adds InstanceContext of a child to the instanceIdToInstanceContextMap.
`Map<String,String>`	`getAliasToDeploymentPolicyIdMap()`
`Map<String,Group>`	`getAliasToGroupMap()` Getter for alias to Group map Will not search recursively in the nested levels.
`Set<Group>`	`getAllGroupsRecursively()` Collects the Group for the parent component and all the child components recursively
`protected void`	`getClusterData(Set<ClusterDataHolder> clusterData, Collection<Group> groups)`
`ClusterDataHolder`	`getClusterData(String alias)` Getter for Cluster Data instance for the given alias Will not search recursively in the nested levels.
`Map<String,ClusterDataHolder>`	`getClusterDataForAlias()`
`Map<String,ClusterDataHolder>`	`getClusterDataForType()`
`ClusterDataHolder`	`getClusterDataHolderRecursivelyByAlias(String alias)` This will recursively search for the cluster data holder in the application by the alias.
`Map<String,ClusterDataHolder>`	`getClusterDataMap()` Getter for cluster alias to ClusterData map for this level
`Set<ClusterDataHolder>`	`getClusterDataRecursively()` Collects the Cluster Data for the parent component and all the child components recursively
`int`	`getComponentsCount()`
`DependencyOrder`	`getDependencyOrder()` Getter for Dependency Order for this level
`String`	`getDeploymentPolicy()`
`Group`	`getGroup(String groupAlias)` Get the Group for the given alias in the context of the parent entity.
`Group`	`getGroupRecursively(String groupAlias)` Get the Group for the given alias in the context of the parent entity.
`Collection<Group>`	`getGroups()` Collection of Groups in this level
`protected void`	`getGroupsRecursively(Set<Group> groupsSet, Collection<Group> groups)`
`int`	`getInstanceContextCount()` Retrieves the current number of instance contexts which are kept track in this node
`T`	`getInstanceContexts(String instanceId)` Retrieves InstanceContext obj.
`List<Instance>`	`getInstanceContextsWithParentId(String parentInstanceId)` Retrieves InstanceContext obj.
`Map<String,T>`	`getInstanceIdToInstanceContextMap()`
`String`	`getNextInstanceId(String alias)`
`abstract String`	`getUniqueIdentifier()` This method should be implemented in each concrete child class to return the unique identifier for each implementation ex.: group alias for a Group, app id for an Application
`boolean`	`isGroupInstanceMonitoringEnabled()`
`boolean`	`isGroupScalingEnabled()`
`void`	`removeInstance(String instanceId)` This will remove the instance from instanceIdToInstanceContextMap
`void`	`setAliasToDeploymentPolicyIdMap(Map<String,String> aliasToDeploymentPolicyIdMap)`
`void`	`setClusterData(Map<String,ClusterDataHolder> aliasToClusterData)` Setter for alias to Cluster Data map
`void`	`setClusterDataForType(Map<String,ClusterDataHolder> typeToClusterData)` Setter for alias to Cluster Data map
`void`	`setDependencyOrder(DependencyOrder dependencyOrder)` Setter for Dependency Order
`void`	`setDeploymentPolicy(String deploymentPolicy)`
`void`	`setGroupInstanceMonitoringEnabled(boolean isGroupInstanceMonitoringEnabled)`
`void`	`setGroups(Map<String,Group> groupAliasToGroup)` Setter for Group alias to Group map
`void`	`setGroupScalingEnabled(boolean isGroupScalingEnabled)`
`void`	`setInstanceIdToInstanceContextMap(Map<String,T> instanceIdToInstanceContextMap)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - aliasToGroupMap
```
protected final Map<String,Group> aliasToGroupMap
```
  - aliasToClusterDataMap
```
protected final Map<String,ClusterDataHolder> aliasToClusterDataMap
```
- Constructor Detail
  - ParentComponent
```
public ParentComponent()
```
- Method Detail
  - getUniqueIdentifier
```
public abstract String getUniqueIdentifier()
```
    This method should be implemented in each concrete child class to return the unique identifier for each implementation ex.: group alias for a Group, app id for an Application
    
    Returns:
    unique identifier String
  - addGroup
```
public void addGroup(Group group)
```
    Adds a group
    
    Parameters:
    group - Group instance to be added
  - getGroup
```
public Group getGroup(String groupAlias)
```
    Get the Group for the given alias in the context of the parent entity. Will not search recursively in the nested levels.
    
    Parameters:
    groupAlias - alias of the Group
    
    Returns:
    Group, if exists for the given alias, else null
  - getGroupRecursively
```
public Group getGroupRecursively(String groupAlias)
```
    Get the Group for the given alias in the context of the parent entity. Will search recursively in the nested levels.
    
    Parameters:
    groupAlias - alias of the Group
    
    Returns:
    Group, if exists for the given alias, else null
  - getClusterDataHolderRecursivelyByAlias
```
public ClusterDataHolder getClusterDataHolderRecursivelyByAlias(String alias)
```
    This will recursively search for the cluster data holder in the application by the alias.
    
    Parameters:
    alias - the alias of the cluster
    
    Returns:
    found data holder
  - getAliasToGroupMap
```
public Map<String,Group> getAliasToGroupMap()
```
    Getter for alias to Group map Will not search recursively in the nested levels.
    
    Returns:
    Map, key = alias given to the Group, value = Group
  - getClusterDataMap
```
public Map<String,ClusterDataHolder> getClusterDataMap()
```
    Getter for cluster alias to ClusterData map for this level
    
    Returns:
    Map, key = alias given to the cluster, value = ClusterData object
  - getGroups
```
public Collection<Group> getGroups()
```
    Collection of Groups in this level
    
    Returns:
    Group Collection object, empty if no Groups are found
  - setGroups
```
public void setGroups(Map<String,Group> groupAliasToGroup)
```
    Setter for Group alias to Group map
    
    Parameters:
    groupAliasToGroup - Map, key = alias given to the Group, value = Group
  - getDependencyOrder
```
public DependencyOrder getDependencyOrder()
```
    Getter for Dependency Order for this level
    
    Returns:
    Dependency Order object
  - setDependencyOrder
```
public void setDependencyOrder(DependencyOrder dependencyOrder)
```
    Setter for Dependency Order
    
    Parameters:
    dependencyOrder - Dependency Order object
  - setClusterData
```
public void setClusterData(Map<String,ClusterDataHolder> aliasToClusterData)
```
    Setter for alias to Cluster Data map
    
    Parameters:
    aliasToClusterData - Map, key = alias given to the cluster, value = ClusterData object
  - getClusterData
```
public ClusterDataHolder getClusterData(String alias)
```
    Getter for Cluster Data instance for the given alias Will not search recursively in the nested levels.
    
    Parameters:
    alias -
    
    Returns:
  - getClusterDataRecursively
```
public Set<ClusterDataHolder> getClusterDataRecursively()
```
    Collects the Cluster Data for the parent component and all the child components recursively
    
    Returns:
    Set of ClusterDataHolder objects if available, else null
  - getAllGroupsRecursively
```
public Set<Group> getAllGroupsRecursively()
```
    Collects the Group for the parent component and all the child components recursively
    
    Returns:
    Set of Group objects if available, else null
  - addInstance
```
public void addInstance(String instanceId,
               T instance)
```
    Adds InstanceContext of a child to the instanceIdToInstanceContextMap.
    
    Parameters:
    instanceId - instance id of child
    instance - InstanceContext object
  - removeInstance
```
public void removeInstance(String instanceId)
```
    This will remove the instance from instanceIdToInstanceContextMap
    
    Parameters:
    instanceId - instance id of child
  - containsInstanceContext
```
public boolean containsInstanceContext(String instanceId)
```
    Adds InstanceContext of a child to the instanceIdToInstanceContextMap.
    
    Parameters:
    instanceId - instance id of child
  - getInstanceContexts
```
public T getInstanceContexts(String instanceId)
```
    Retrieves InstanceContext obj. for the given instance id
    
    Parameters:
    instanceId - instance id
    
    Returns:
    InstanceContext obj. if exists, else null
  - getInstanceContextsWithParentId
```
public List<Instance> getInstanceContextsWithParentId(String parentInstanceId)
```
    Retrieves InstanceContext obj. for the given instance id
    
    Parameters:
    parentInstanceId - parent instance id
    
    Returns:
    InstanceContext obj. if exists, else null
  - getInstanceContextCount
```
public int getInstanceContextCount()
```
    Retrieves the current number of instance contexts which are kept track in this node
    
    Returns:
    number of instance contexts
  - getComponentsCount
```
public int getComponentsCount()
```
  - getClusterData
```
protected void getClusterData(Set<ClusterDataHolder> clusterData,
                  Collection<Group> groups)
```
  - getGroupsRecursively
```
protected void getGroupsRecursively(Set<Group> groupsSet,
                        Collection<Group> groups)
```
  - getInstanceIdToInstanceContextMap
```
public Map<String,T> getInstanceIdToInstanceContextMap()
```
  - isGroupScalingEnabled
```
public boolean isGroupScalingEnabled()
```
  - setGroupScalingEnabled
```
public void setGroupScalingEnabled(boolean isGroupScalingEnabled)
```
  - isGroupInstanceMonitoringEnabled
```
public boolean isGroupInstanceMonitoringEnabled()
```
  - setGroupInstanceMonitoringEnabled
```
public void setGroupInstanceMonitoringEnabled(boolean isGroupInstanceMonitoringEnabled)
```
  - getDeploymentPolicy
```
public String getDeploymentPolicy()
```
  - setDeploymentPolicy
```
public void setDeploymentPolicy(String deploymentPolicy)
```
  - getNextInstanceId
```
public String getNextInstanceId(String alias)
```
  - setInstanceIdToInstanceContextMap
```
public void setInstanceIdToInstanceContextMap(Map<String,T> instanceIdToInstanceContextMap)
```
  - getClusterDataForType
```
public Map<String,ClusterDataHolder> getClusterDataForType()
```
  - getClusterDataForAlias
```
public Map<String,ClusterDataHolder> getClusterDataForAlias()
```
  - setClusterDataForType
```
public void setClusterDataForType(Map<String,ClusterDataHolder> typeToClusterData)
```
    Setter for alias to Cluster Data map
    
    Parameters:
    typeToClusterData - Map, key = alias given to the cluster, value = ClusterData object
  - getAliasToDeploymentPolicyIdMap
```
public Map<String,String> getAliasToDeploymentPolicyIdMap()
```
  - setAliasToDeploymentPolicyIdMap
```
public void setAliasToDeploymentPolicyIdMap(Map<String,String> aliasToDeploymentPolicyIdMap)
```

Class ParentComponent<T extends Instance>

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

aliasToGroupMap

aliasToClusterDataMap

Constructor Detail

ParentComponent

Method Detail

getUniqueIdentifier

addGroup

getGroup

getGroupRecursively

getClusterDataHolderRecursivelyByAlias

getAliasToGroupMap

getClusterDataMap

getGroups

setGroups

getDependencyOrder

setDependencyOrder

setClusterData

getClusterData

getClusterDataRecursively

getAllGroupsRecursively

addInstance

removeInstance

containsInstanceContext

getInstanceContexts

getInstanceContextsWithParentId

getInstanceContextCount

getComponentsCount

getClusterData

getGroupsRecursively

getInstanceIdToInstanceContextMap

isGroupScalingEnabled

setGroupScalingEnabled

isGroupInstanceMonitoringEnabled

setGroupInstanceMonitoringEnabled

getDeploymentPolicy

setDeploymentPolicy

getNextInstanceId

setInstanceIdToInstanceContextMap

getClusterDataForType

getClusterDataForAlias

setClusterDataForType

getAliasToDeploymentPolicyIdMap

setAliasToDeploymentPolicyIdMap