All Downloads are FREE. Search and download functionalities are using the official Maven repository.

org.apache.brooklyn.entity.cloudfoundry.services.user.UserProvidedService Maven / Gradle / Ivy

The newest version!
/*
 * Copyright 2015 SeaClouds
 * Contact: [email protected]
 *
 * Licensed 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.user;

import org.apache.brooklyn.entity.cloudfoundry.services.CloudFoundryService;
import com.google.common.collect.ImmutableMap;
import org.apache.brooklyn.api.entity.ImplementedBy;
import org.apache.brooklyn.config.ConfigKey;
import org.apache.brooklyn.core.config.ConfigKeys;
import org.apache.brooklyn.core.config.MapConfigKey;
import org.apache.brooklyn.util.core.flags.SetFromFlag;

import java.util.Map;

/**
 * This Interface represent a generic and empty service.
 * It could be bound to any application but the operation it will be empty.
 * The ServiceType is not predefined and it should be defined for the service creation.
 */

@ImplementedBy(UserProvidedServiceImpl.class)
public interface UserProvidedService extends CloudFoundryService {

    @SetFromFlag("serviceType")
    public static final ConfigKey SERVICE_TYPE = ConfigKeys
            .newStringConfigKey("service.type", "Type Of Service", "user-provided");

    @SetFromFlag("credentials")
    public static final MapConfigKey CREDENTIALS =
            new MapConfigKey<>(Object.class, "cloudfoundry.service.user.credentials",
                    "Credentials to access the user-provided service",
                    ImmutableMap.of());

    public Map getCredentials();

    public String getServiceName();
}