org.apache.brooklyn.entity.cloudfoundry.services.CloudFoundryService Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of deployer Show documentation
The newest version!
/*
 * 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.brooklyn.entity.cloudfoundry.services;


import org.apache.brooklyn.entity.cloudfoundry.CloudFoundryEntity;
import org.apache.brooklyn.entity.cloudfoundry.webapp.CloudFoundryWebAppImpl;
import org.apache.brooklyn.location.cloudfoundry.CloudFoundryPaasLocation;
import org.apache.brooklyn.api.entity.ImplementedBy;
import org.apache.brooklyn.api.sensor.AttributeSensor;
import org.apache.brooklyn.config.ConfigKey;
import org.apache.brooklyn.core.config.ConfigKeys;
import org.apache.brooklyn.core.sensor.AttributeSensorAndConfigKey;
import org.apache.brooklyn.core.sensor.Sensors;
import org.apache.brooklyn.util.core.flags.SetFromFlag;
import org.apache.brooklyn.util.text.Identifiers;

@ImplementedBy(CloudFoundryServiceImpl.class)
public interface CloudFoundryService extends CloudFoundryEntity {

    public static final AttributeSensor SERVICE_TYPE_ID= Sensors
            .newStringSensor("cloudFoundry.service.type.id", "Type Id of the service");

    @SetFromFlag("serviceInstanceName")
    ConfigKey SERVICE_INSTANCE_NAME = ConfigKeys.newStringConfigKey(
            "cloudFoundry.service.instance.name", "Given name for the service instance",
            "cf-service-" + Identifiers.makeRandomId(8));

    @SetFromFlag("plan")
    AttributeSensorAndConfigKey PLAN = ConfigKeys.newStringSensorAndConfigKey(
            "cloudFoundry.service.plan", "Selected plan for the service");

    AttributeSensor PAAS_LOCATION = Sensors.newSensor(
            CloudFoundryPaasLocation.class, "cloudFoundry.service.paasLocation",
            "Location used to deploy the service");

    /**
     * Retrieves the Service Type in cloud foundry, for example ClearDb.
     * @return
     */
    public String getServiceTypeId();


    /**
     * Operation of this service
     */
    public void operation(CloudFoundryWebAppImpl app);

    /**
     * Injects a set of sensors inside {@link org.apache.brooklyn.entity.cloudfoundry.webapp.CloudFoundryWebAppImpl} that provides the credentials.
     * @param webapp the application that contains the credentials for this service.
     */
    public void setBindingCredentialsFromApp(CloudFoundryWebAppImpl webapp);
}