http://git-wip-us.apache.org/repos/asf/stratos/blob/8c359dc1/components/org.apache.stratos.cloud.controller/src/main/java/org/apache/stratos/cloud/controller/services/CloudControllerService.java
----------------------------------------------------------------------
diff --git
a/components/org.apache.stratos.cloud.controller/src/main/java/org/apache/stratos/cloud/controller/services/CloudControllerService.java
b/components/org.apache.stratos.cloud.controller/src/main/java/org/apache/stratos/cloud/controller/services/CloudControllerService.java
new file mode 100644
index 0000000..7a5aba6
--- /dev/null
+++
b/components/org.apache.stratos.cloud.controller/src/main/java/org/apache/stratos/cloud/controller/services/CloudControllerService.java
@@ -0,0 +1,231 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements. See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership. The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied. See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+package org.apache.stratos.cloud.controller.services;
+
+import org.apache.stratos.cloud.controller.domain.*;
+import org.apache.stratos.cloud.controller.domain.Partition;
+import org.apache.stratos.cloud.controller.exception.*;
+import org.apache.stratos.messaging.domain.topology.ClusterStatus;
+
+/**
+ * This API provides a way to communicate with underline
+ * Infrastructure which are supported by <i>jClouds</i>.
+ *
+ */
+public interface CloudControllerService {
+
+ /**
+ * Deploys a Cartridge configuration
+ * @param cartridgeConfig cartridge configuration to be deployed
+ * @throws InvalidCartridgeDefinitionException if the cartridge
configuration is not valid.
+ * @throws InvalidIaasProviderException if the iaas providers
configured are not valid.
+ * @throws IllegalArgumentException if the provided argument is not
valid.
+ */
+ void deployCartridgeDefinition(CartridgeConfig cartridgeConfig)
+ throws InvalidCartridgeDefinitionException,
InvalidIaasProviderException;
+
+ /**
+ * Undeploys a Cartridge configuration which is already deployed.
+ * @param cartridgeType type of the cartridge to be undeployed.
+ * @throws InvalidCartridgeTypeException if the cartridge type specified
is not a deployed cartridge.
+ */
+ public void undeployCartridgeDefinition(String cartridgeType) throws
InvalidCartridgeTypeException;
+
+ public void deployServiceGroup(ServiceGroup servicegroup) throws
InvalidServiceGroupException;
+
+ public void undeployServiceGroup(String name) throws
InvalidServiceGroupException;
+
+ public ServiceGroup getServiceGroup (String name) throws
InvalidServiceGroupException;
+
+ public String []getServiceGroupSubGroups (String name) throws
InvalidServiceGroupException;
+
+ public String [] getServiceGroupCartridges (String name) throws
InvalidServiceGroupException;
+
+ public Dependencies getServiceGroupDependencies (String name) throws
InvalidServiceGroupException;
+
+ /**
+ * Validate a given {@link Partition} for basic property existence.
+ * @param partition partition to be validated.
+ * @return whether the partition is a valid one.
+ * @throws InvalidPartitionException if the partition is invalid.
+ */
+ boolean validatePartition(Partition partition) throws
InvalidPartitionException;
+
+ /**
+ * Validate a given deployment policy.
+ * @param cartridgeType type of the cartridge
+ * @param partitions partitions
+ * @return whether the policy is a valid one against the given Cartridge.
+ * @throws InvalidPartitionException if the policy contains at least one
invalid partition.
+ * @throws InvalidCartridgeTypeException if the given Cartridge type is
not a valid one.
+ */
+ boolean validateDeploymentPolicy(String cartridgeType, Partition[]
partitions)
+ throws InvalidPartitionException, InvalidCartridgeTypeException;
+
+ /**
+ * <p>
+ * Registers the details of a newly created service cluster. This will
override an already
+ * present service cluster, if there is any. A service cluster is uniquely
identified by its
+ * domain and sub domain combination.
+ * </p>
+ * @param registrant information about the new subscription.
+ * @return whether the registration is successful or not.
+ *
+ * @throws UnregisteredCartridgeException
+ * when the cartridge type requested by this service is
+ * not a registered one.
+ */
+ boolean registerService(Registrant registrant) throws
UnregisteredCartridgeException;
+
+ /**
+ * Calling this method will result in an instance startup, which is belong
+ * to the provided Cluster ID. Also note that the instance that is
starting up
+ * belongs to the group whose name is derived from its Cluster ID,
replacing <i>.</i>
+ * by a hyphen (<i>-</i>).
+ * @param member Context with cluster id, partition etc.
+ * @return updated {@link MemberContext}
+ * @throws UnregisteredCartridgeException if the requested Cartridge type
is not a registered one.
+ * @throws InvalidIaasProviderException if the iaas requested is not valid.
+ */
+ MemberContext startInstance(MemberContext member) throws
UnregisteredCartridgeException, InvalidIaasProviderException;
+
+ /**
+ * Create a container cluster.
+ * @param {@link ContainerClusterContext} Context with cluster id, and
host cluster details.
+ * @return a list of {@link MemberContext}s correspond to each Pod created.
+ * @throws UnregisteredCartridgeException if the requested Cartridge type
is not a registered one.
+ */
+ MemberContext[] startContainers(ContainerClusterContext clusterContext)
throws UnregisteredCartridgeException;
+
+ /**
+ * Calling this method will result in termination of the instance with
given member id in the given Partition.
+ *
+ * @param memberId
+ * member ID of the instance to be terminated.
+ * @return whether an instance terminated successfully or not.
+ */
+ void terminateInstance(String memberId) throws InvalidMemberException,
InvalidCartridgeTypeException;
+
+ /**
+ * Calling this method will result in termination of all instances belong
+ * to the provided cluster ID.
+ *
+ * @param clusterId
+ * cluster ID of the instance to be terminated.
+ * @return whether an instance terminated successfully or not.
+ */
+ void terminateAllInstances(String clusterId) throws
InvalidClusterException;
+
+ /**
+ * Terminate all containers of the given cluster.
+ * @param clusterId id of the subjected cluster.
+ * @return terminated {@link MemberContext}s
+ * @throws InvalidClusterException
+ */
+ MemberContext[] terminateAllContainers(String clusterId) throws
InvalidClusterException;
+
+ /**
+ * Terminate a given member/Kubernetes Pod.
+ * @param memberId member/Pod id to be terminated.
+ * @return terminated {@link MemberContext}
+ * @throws MemberTerminationFailedException
+ */
+ MemberContext terminateContainer(String memberId) throws
MemberTerminationFailedException;
+
+ /**
+ * Update the Kubernetes controller created for the given cluster with the
specified number of replicas.
+ * @param clusterId id of the subjected cluster.
+ * @param replicas total number of replicas to be set to the controller.
+ * @return newly created Members if any / terminated {@link MemberContext}
in scale down scenario.
+ * @throws InvalidClusterException
+ */
+ MemberContext[] updateContainers(String clusterId, int replicas) throws
UnregisteredCartridgeException;
+
+ /**
+ * Update the topology with current cluster status.
+ * @param serviceName id of service which the cluster belongs to.
+ * @param clusterId id of the subjected cluster.
+ * @param instanceId id of the cluster instance.
+ * @param status total number of replicas to be set to the controller.
+ */
+ void updateClusterStatus(String serviceName, String clusterId, String
instanceId, ClusterStatus status);
+
+ /**
+ * Unregister a docker service identified by the given cluster id.
+ * @param clusterId service cluster id.
+ * @throws UnregisteredClusterException if the service cluster requested
is not a registered one.
+ */
+ void unregisterDockerService(String clusterId) throws
UnregisteredClusterException;
+
+ /**
+ * Unregister the service cluster identified by the given cluster id.
+ * @param clusterId service cluster id.
+ * @throws UnregisteredClusterException if the service cluster requested
is not a registered one.
+ */
+ void unregisterService(String clusterId) throws
UnregisteredClusterException;
+
+ /**
+ * This method will return the information regarding the given cartridge,
if present.
+ * Else this will return <code>null</code>.
+ *
+ * @param cartridgeType
+ * type of the cartridge.
+ * @return {@link
org.apache.stratos.cloud.controller.domain.CartridgeInfo} of the given
cartridge type or <code>null</code>.
+ * @throws UnregisteredCartridgeException if there is no registered
cartridge with this type.
+ */
+ CartridgeInfo getCartridgeInfo(String cartridgeType) throws
UnregisteredCartridgeException;
+
+ /**
+ * Calling this method will result in returning the types of {@link
org.apache.stratos.cloud.controller.domain.Cartridge}s
+ * registered in Cloud Controller.
+ *
+ * @return String array containing types of registered {@link
org.apache.stratos.cloud.controller.domain.Cartridge}s.
+ */
+ String[] getRegisteredCartridges();
+
+ /**
+ * Returns the {@link
org.apache.stratos.cloud.controller.domain.ClusterContext} object associated
with the given cluster id, or null if not found
+ *
+ * @param clusterId cluster id
+ * @return {@link
org.apache.stratos.cloud.controller.domain.ClusterContext} object associated
with the given cluster id, or null
+ */
+ public ClusterContext getClusterContext (String clusterId);
+
+ /**
+ * Creates the clusters relevant to an application in the topology model
+ *
+ * @param appId application id
+ * @param appClustersContexts cluster information holder object
+ * @throws ApplicationClusterRegistrationException if the cluster
information are null/empty
+ */
+ public void createApplicationClusters(String appId,
ApplicationClusterContextDTO[] appClustersContexts) throws
+ ApplicationClusterRegistrationException;
+
+ /**
+ * Creates a cluster instance with the given information
+ *
+ * @param serviceType serviceType
+ * @param clusterId cluster id
+ * @param alias alias provided in the subscription parameters
+ * @param instanceId instance id
+ * @throws ClusterInstanceCreationException if an y error occurs in
cluster instance creation
+ */
+ public void createClusterInstance (String serviceType, String clusterId,
String alias, String instanceId) throws
+ ClusterInstanceCreationException;
+}
