org.jclouds.vcloud.compute.CommonVCloudComputeClient Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of jclouds-vcloud Show documentation

jclouds Core components to access vcloud

The newest version!

/**
 *
 * Copyright (C) 2010 Cloud Conscious, LLC. 
 *
 * ====================================================================
 * 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.jclouds.vcloud.compute;

import java.net.URI;
import java.util.Set;

/**
 * 
 * @author Adrian Cole
 */
public interface CommonVCloudComputeClient {

   /**
    * returns a set of addresses that are only visible to the private network.
    */
   Set getPrivateAddresses(URI vAppId);

   /**
    * returns a set of addresses that are publically visible
    */
   Set getPublicAddresses(URI vAppId);

   /**
    * reboots the vApp, blocking until the following state transition is complete:
    * 
    * current -> {@code VAppStatus#OFF} -> {@code VAppStatus#ON}
    * 
    * @param vAppId
    *           vApp to reboot
    */
   void reset(URI vAppId);

   /**
    * Destroys dependent resources, powers off and deletes the vApp, blocking until the following
    * state transition is complete:
    * 
    * current -> {@code VAppStatus#OFF} -> deleted
    * 
    * @param vAppId
    *           vApp to stop
    */
   void stop(URI vAppId);

}