org.apache.stratos.manager.subscription
Class CartridgeSubscription

java.lang.Object
  org.apache.stratos.manager.subscription.CartridgeSubscription

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

ApplicationCartridgeSubscription, DataCartridgeSubscription, FrameworkCartridgeSubscription, InternalRepoBasedCartridgeSubscription, LBCartridgeSubscription

public abstract class CartridgeSubscription
extends Object
implements Serializable

See Also:

Serialized Form

Constructor Summary

CartridgeSubscription(org.apache.stratos.cloud.controller.stub.pojo.CartridgeInfo cartridgeInfo, SubscriptionTenancyBehaviour subscriptionTenancyBehaviour)
Constructor

Method Summary

protected void	cleanupSubscription() Cleans up the subscription information after unsubscribing
void	connect(String connectingCartridgeAlias) Connect cartridges
void	createSubscription(Subscriber subscriber, String alias, String autoscalingPolicy, String deploymentPolicyName, Repository repository) Subscribes to this cartridge subscription
void	disconnect(String disconnectingCartridgeAlias) Disconnect from the cartridge subscription given by disconnectingCartridgeAlias
boolean	equals(Object other)
String	getAlias()
String	getAutoscalingPolicyName()
org.apache.stratos.cloud.controller.stub.pojo.CartridgeInfo	getCartridgeInfo()
Cluster	getCluster()
String	getClusterDomain()
String	getClusterSubDomain()
Map<String,String>	getCustomPayloadEntries()
String	getDeploymentPolicyName()
String	getHostName()
String	getLbClusterId()
String	getMappedDomain()
String	getMgtClusterDomain()
String	getMgtClusterSubDomain()
PayloadData	getPayloadData()
Repository	getRepository()
Subscriber	getSubscriber()
int	getSubscriptionId()
String	getSubscriptionKey()
String	getSubscriptionStatus()
SubscriptionTenancyBehaviour	getSubscriptionTenancyBehaviour()
String	getType()
int	hashCode()
abstract Repository	manageRepository(String repoURL, String repoUserName, String repoUserPassword, boolean privateRepo) Manages the repository for the cartridge subscription
CartridgeSubscriptionInfo	registerSubscription(org.apache.stratos.cloud.controller.stub.pojo.Properties properties) Registers the subscription
void	removeSubscription() Unsubscribe from this cartridge subscription
void	setAlias(String alias)
void	setAutoscalingPolicyName(String autoscalingPolicyName)
void	setCartridgeInfo(org.apache.stratos.cloud.controller.stub.pojo.CartridgeInfo cartridgeInfo)
void	setCluster(Cluster cluster)
void	setClusterDomain(String clusterDomain)
void	setClusterSubDomain(String clusterSubDomain)
void	setDeploymentPolicyName(String deploymentPolicyName)
void	setHostName(String hostName)
void	setLbClusterId(String lbClusterId)
void	setMappedDomain(String mappedDomain)
void	setMgtClusterDomain(String mgtClusterDomain)
void	setMgtClusterSubDomain(String mgtClusterSubDomain)
void	setPayloadData(PayloadData payloadData)
void	setRepository(Repository repository)
void	setSubscriber(Subscriber subscriber)
void	setSubscriptionId(int subscriptionId)
void	setSubscriptionKey(String subscriptionKey)
void	setSubscriptionStatus(String subscriptionStatus)
void	setSubscriptionTenancyBehaviour(SubscriptionTenancyBehaviour subscriptionTenancyBehaviour)
void	setType(String type)
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

CartridgeSubscription

public CartridgeSubscription(org.apache.stratos.cloud.controller.stub.pojo.CartridgeInfo cartridgeInfo,
                             SubscriptionTenancyBehaviour subscriptionTenancyBehaviour)

Constructor

Parameters:

cartridgeInfo - CartridgeInfo instance

subscriptionTenancyBehaviour - SubscriptionTenancyBehaviour instance

Method Detail

createSubscription

public void createSubscription(Subscriber subscriber,
                               String alias,
                               String autoscalingPolicy,
                               String deploymentPolicyName,
                               Repository repository)
                        throws ADCException,
                               PolicyException,
                               UnregisteredCartridgeException,
                               InvalidCartridgeAliasException,
                               DuplicateCartridgeAliasException,
                               RepositoryRequiredException,
                               AlreadySubscribedException,
                               RepositoryCredentialsRequiredException,
                               InvalidRepositoryException,
                               RepositoryTransportException

Subscribes to this cartridge subscription

Parameters:

subscriber - Subscriber subscription

alias - Alias of the cartridge subscription

autoscalingPolicy - Auto scaling policy

deploymentPolicyName - Deployment policy

repository - Relevenat Repository subscription

Throws:

ADCException

PolicyException

UnregisteredCartridgeException

InvalidCartridgeAliasException

DuplicateCartridgeAliasException

RepositoryRequiredException

AlreadySubscribedException

RepositoryCredentialsRequiredException

InvalidRepositoryException

RepositoryTransportException

removeSubscription

public void removeSubscription()
                        throws ADCException,
                               NotSubscribedException

Unsubscribe from this cartridge subscription

Throws:

ADCException

NotSubscribedException

registerSubscription

public CartridgeSubscriptionInfo registerSubscription(org.apache.stratos.cloud.controller.stub.pojo.Properties properties)
                                               throws ADCException,
                                                      UnregisteredCartridgeException

Registers the subscription

Parameters:

properties - Any additional properties needed

Returns:

CartridgeSubscriptionInfo subscription populated with relevant data

Throws:

ADCException

UnregisteredCartridgeException

connect

public void connect(String connectingCartridgeAlias)

Connect cartridges

Parameters:

connectingCartridgeAlias - Alias of connecting cartridge

disconnect

public void disconnect(String disconnectingCartridgeAlias)

Disconnect from the cartridge subscription given by disconnectingCartridgeAlias

Parameters:

disconnectingCartridgeAlias - Alias of the cartridge subscription to disconnect

manageRepository

public abstract Repository manageRepository(String repoURL,
                                            String repoUserName,
                                            String repoUserPassword,
                                            boolean privateRepo)
                                     throws ADCException,
                                            RepositoryRequiredException,
                                            RepositoryCredentialsRequiredException,
                                            RepositoryTransportException,
                                            InvalidRepositoryException

Manages the repository for the cartridge subscription

Parameters:

repoURL - Repository URL

repoUserName - Repository Username

repoUserPassword - Repository password

privateRepo - public/private repository

Returns:

Repository populated with relevant information or null of not repository is relevant to this cartridge subscription

Throws:

ADCException

RepositoryRequiredException

RepositoryCredentialsRequiredException

RepositoryTransportException

InvalidRepositoryException

cleanupSubscription

protected void cleanupSubscription()
                            throws ADCException

Cleans up the subscription information after unsubscribing

Throws:

ADCException

getCustomPayloadEntries

public Map<String,String> getCustomPayloadEntries()

getType

public String getType()

getAlias

public String getAlias()

getSubscriber

public Subscriber getSubscriber()

getRepository

public Repository getRepository()

getCartridgeInfo

public org.apache.stratos.cloud.controller.stub.pojo.CartridgeInfo getCartridgeInfo()

getHostName

public String getHostName()

setType

public void setType(String type)

setAlias

public void setAlias(String alias)

getClusterDomain

public String getClusterDomain()

setClusterDomain

public void setClusterDomain(String clusterDomain)

getClusterSubDomain

public String getClusterSubDomain()

setClusterSubDomain

public void setClusterSubDomain(String clusterSubDomain)

getMgtClusterDomain

public String getMgtClusterDomain()

setMgtClusterDomain

public void setMgtClusterDomain(String mgtClusterDomain)

getMgtClusterSubDomain

public String getMgtClusterSubDomain()

setMgtClusterSubDomain

public void setMgtClusterSubDomain(String mgtClusterSubDomain)

setHostName

public void setHostName(String hostName)

getAutoscalingPolicyName

public String getAutoscalingPolicyName()

setAutoscalingPolicyName

public void setAutoscalingPolicyName(String autoscalingPolicyName)

setSubscriber

public void setSubscriber(Subscriber subscriber)

setRepository

public void setRepository(Repository repository)

setCartridgeInfo

public void setCartridgeInfo(org.apache.stratos.cloud.controller.stub.pojo.CartridgeInfo cartridgeInfo)

getPayloadData

public PayloadData getPayloadData()

setPayloadData

public void setPayloadData(PayloadData payloadData)

getSubscriptionId

public int getSubscriptionId()

setSubscriptionId

public void setSubscriptionId(int subscriptionId)

getMappedDomain

public String getMappedDomain()

setMappedDomain

public void setMappedDomain(String mappedDomain)

getSubscriptionStatus

public String getSubscriptionStatus()

setSubscriptionStatus

public void setSubscriptionStatus(String subscriptionStatus)

getSubscriptionKey

public String getSubscriptionKey()

setSubscriptionKey

public void setSubscriptionKey(String subscriptionKey)

getCluster

public Cluster getCluster()

setCluster

public void setCluster(Cluster cluster)

getDeploymentPolicyName

public String getDeploymentPolicyName()

setDeploymentPolicyName

public void setDeploymentPolicyName(String deploymentPolicyName)

getSubscriptionTenancyBehaviour

public SubscriptionTenancyBehaviour getSubscriptionTenancyBehaviour()

setSubscriptionTenancyBehaviour

public void setSubscriptionTenancyBehaviour(SubscriptionTenancyBehaviour subscriptionTenancyBehaviour)

equals

public boolean equals(Object other)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object

getLbClusterId

public String getLbClusterId()

setLbClusterId

public void setLbClusterId(String lbClusterId)