com.microsoft.windowsazure.services.management.ManagementConfiguration Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of microsoft-windowsazure-api Show documentation
API for Microsoft Windows Azure Clients
There is a newer version: 0.4.6
Show newest version
/**
 * Copyright Microsoft Corporation
 * 
 * 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 com.microsoft.windowsazure.services.management;

import com.microsoft.windowsazure.services.core.Configuration;

/**
 * Provides functionality to create a service management configuration.
 * 
 */
public class ManagementConfiguration {

    /**
     * Defines the path of the keystore.
     * 
     */
    public final static String KEYSTORE_PATH = "management.keystore.path";

    /**
     * Defines the password of the keystore.
     * 
     */
    public final static String KEYSTORE_PASSWORD = "management.keystore.password";

    /**
     * Defines the type of the keystore.
     */
    public static final String KEYSTORE_TYPE = "management.keystore.type";

    /**
     * Defines the URI of service management.
     * 
     */
    public final static String URI = "management.uri";

    /**
     * Defines the subscription ID of the Windows Azure account.
     */
    public static final String SUBSCRIPTION_ID = "management.subscription.id";

    /**
     * Creates a service management configuration using specified URI, and subscription ID.
     * 
     * @param uri
     *            A String object that represents the root URI of the service management service.
     * @param subscriptionId
     *            A String object that represents the subscription ID.
     * @return the configuration
     *         A Configuration object that can be used when creating an instance of the
     *         ManagementContract class.
     */
    public static Configuration configure(String uri, String subscriptionId) {
        return configure(null, Configuration.getInstance(), uri, subscriptionId, null, null);
    }

    /**
     * Creates a service management configuration with specified parameters.
     * 
     * @param profile
     *            A String object that represents the profile.
     * @param configuration
     *            A previously instantiated Configuration object.
     * @param uri
     *            A String object that represents the URI of the service management service.
     * @param subscriptionId
     *            A String object that represents the subscription ID.
     * @param keyStoreLocation
     *            the key store location
     * @param keyStorePassword
     *            A String object that represents the password of the keystore.
     * @return A Configuration object that can be used when creating an instance of the
     *         ManagementContract class.
     */
    public static Configuration configure(String profile, Configuration configuration, String uri,
            String subscriptionId, String keyStoreLocation, String keyStorePassword) {

        if (profile == null) {
            profile = "";
        }
        else if (profile.length() != 0 && !profile.endsWith(".")) {
            profile = profile + ".";
        }

        configuration.setProperty(profile + URI, "https://" + uri);
        configuration.setProperty(profile + SUBSCRIPTION_ID, subscriptionId);
        configuration.setProperty(profile + KEYSTORE_PATH, keyStoreLocation);
        configuration.setProperty(profile + KEYSTORE_PASSWORD, keyStorePassword);

        return configuration;
    }

}