| /* |
| * 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.jclouds.providers; |
| |
| import java.net.URI; |
| import java.util.Properties; |
| import java.util.Set; |
| |
| import org.jclouds.apis.ApiMetadata; |
| import org.jclouds.javax.annotation.Nullable; |
| |
| import com.google.common.base.Optional; |
| |
| /** |
| * The ProviderMetadata interface allows jclouds to provide a plugin framework |
| * for gathering cloud provider metadata. |
| */ |
| public interface ProviderMetadata { |
| |
| /** |
| * |
| * @since 1.5 |
| */ |
| public interface Builder { |
| /** |
| * @see ProviderMetadata#getId() |
| */ |
| Builder id(String id); |
| |
| /** |
| * @see ProviderMetadata#getName() |
| */ |
| Builder name(String name); |
| |
| /** |
| * @see ProviderMetadata#getApiMetadata() |
| */ |
| Builder apiMetadata(ApiMetadata api); |
| |
| /** |
| * @see ProviderMetadata#getEndpoint() |
| */ |
| Builder endpoint(String endpoint); |
| |
| /** |
| * @see ProviderMetadata#getDefaultProperties() |
| */ |
| Builder defaultProperties(Properties defaultProperties); |
| |
| /** |
| * @see ProviderMetadata#getConsole() |
| */ |
| Builder console(@Nullable URI console); |
| |
| /** |
| * @see ProviderMetadata#getHomepage() |
| */ |
| Builder homepage(@Nullable URI homepage); |
| |
| /** |
| * @see ProviderMetadata#getLinkedServices() |
| */ |
| Builder linkedServices(Iterable<String> linkedServices); |
| |
| /** |
| * @see ProviderMetadata#getLinkedServices() |
| */ |
| Builder linkedServices(String... linkedServices); |
| |
| /** |
| * @see ProviderMetadata#getLinkedServices() |
| */ |
| Builder linkedService(String linkedService); |
| |
| /** |
| * @see ProviderMetadata#getIso3166Code() |
| */ |
| Builder iso3166Codes(Iterable<String> iso3166Codes); |
| |
| /** |
| * @see ProviderMetadata#getIso3166Code() |
| */ |
| Builder iso3166Codes(String... iso3166Codes); |
| |
| /** |
| * @see ProviderMetadata#getIso3166Code() |
| */ |
| Builder iso3166Code(String iso3166Code); |
| |
| ProviderMetadata build(); |
| |
| Builder fromProviderMetadata(ProviderMetadata in); |
| |
| } |
| |
| /** |
| * @see Builder |
| * @since 1.5 |
| */ |
| Builder toBuilder(); |
| |
| /** |
| * |
| * @return the provider's unique identifier (ex. aws-ec2, rackspace-cloudservers-us) |
| */ |
| String getId(); |
| |
| /** |
| * |
| * @return the name (display name) of the provider (ex. GoGrid) |
| */ |
| String getName(); |
| |
| /** |
| * |
| * @return the provider's api |
| * @since 1.5 |
| */ |
| ApiMetadata getApiMetadata(); |
| |
| /** |
| * @see ApiMetadata#getEndpoint |
| * @return the url for the provider's api |
| */ |
| String getEndpoint(); |
| |
| /** |
| * Configuration Properties used when creating connections to this provider. |
| * For example, location information, or default networking configuration. |
| * |
| * @return properties used to create connections to this provider |
| * @see ApiMetadata#getDefaultProperties |
| */ |
| Properties getDefaultProperties(); |
| |
| /** |
| * |
| * @return the url for the provider's console, or absent if one doesn't exist |
| */ |
| Optional<URI> getConsole(); |
| |
| /** |
| * |
| * @return the url for the provider's homepage, or absent if unknown |
| */ |
| Optional<URI> getHomepage(); |
| |
| /** |
| * |
| * @return ids of all known {@link ProviderMetadata providers} which have the |
| * same account as this. |
| */ |
| Set<String> getLinkedServices(); |
| |
| /** |
| * iso 3166 codes; ex. US-CA,US |
| * |
| * @return all known region/location ISO 3166 codes |
| */ |
| Set<String> getIso3166Codes(); |
| } |