View Javadoc

1   /**
2    * Licensed to jclouds, Inc. (jclouds) under one or more
3    * contributor license agreements.  See the NOTICE file
4    * distributed with this work for additional information
5    * regarding copyright ownership.  jclouds licenses this file
6    * to you under the Apache License, Version 2.0 (the
7    * "License"); you may not use this file except in compliance
8    * with the License.  You may obtain a copy of the License at
9    *
10   *   http://www.apache.org/licenses/LICENSE-2.0
11   *
12   * Unless required by applicable law or agreed to in writing,
13   * software distributed under the License is distributed on an
14   * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
15   * KIND, either express or implied.  See the License for the
16   * specific language governing permissions and limitations
17   * under the License.
18   */
19  package org.jclouds.savvis.vpdc;
20  
21  import java.util.Set;
22  import java.util.concurrent.TimeUnit;
23  
24  import org.jclouds.compute.domain.CIMOperatingSystem;
25  import org.jclouds.concurrent.Timeout;
26  import org.jclouds.rest.annotations.Delegate;
27  import org.jclouds.savvis.vpdc.domain.Resource;
28  import org.jclouds.savvis.vpdc.features.BrowsingClient;
29  import org.jclouds.savvis.vpdc.features.FirewallClient;
30  import org.jclouds.savvis.vpdc.features.ServiceManagementClient;
31  import org.jclouds.savvis.vpdc.features.VMClient;
32  
33  /**
34   * Provides synchronous access to VPDC.
35   * <p/>
36   * 
37   * @see VPDCAsyncClient
38   * @see <a href="https://api.sandbox.symphonyvpdc.savvis.net/doc/spec/api/index.html" />
39   * @author Adrian Cole
40   */
41  @Timeout(duration = 60, timeUnit = TimeUnit.SECONDS)
42  public interface VPDCClient {
43  
44     /**
45      * Provides synchronous access to Browsing features.
46      */
47     @Delegate
48     BrowsingClient getBrowsingClient();
49  
50     /**
51      * Provides synchronous access to VM Operation features.
52      */
53     @Delegate
54     VMClient getVMClient();
55  
56     /**
57      * Provides synchronous access to Firewall Operation features.
58      */
59     @Delegate
60     FirewallClient getFirewallClient();
61  
62     /**
63      * Provides synchronous access to ServiceManagement Operation features.
64      */
65     @Delegate
66     ServiceManagementClient getServiceManagementClient();
67  
68     /**
69      * 
70      * @return a listing of all orgs that the current user has access to.
71      */
72     Set<Resource> listOrgs();
73  
74     /**
75      * predefined by default in the classpath resource {@code
76      * /savvis-symphonyvpdc/predefined_operatingsystems.json}
77      * 
78      * @return the operating systems that are predefined in the provider
79      * @see <a href="https://api.sandbox.symphonyvpdc.savvis.net/doc/spec/api/addSingleVM.html" />
80      */
81     Set<CIMOperatingSystem> listPredefinedOperatingSystems();
82  }