View Javadoc

1   /**
2    *
3    * Copyright (C) 2011 Cloud Conscious, LLC. <info@cloudconscious.com>
4    *
5    * ====================================================================
6    * Licensed under the Apache License, Version 2.0 (the "License");
7    * you may not use this file except in compliance with the License.
8    * 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, software
13   * distributed under the License is distributed on an "AS IS" BASIS,
14   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15   * See the License for the specific language governing permissions and
16   * limitations under the License.
17   * ====================================================================
18   */
19  package org.jclouds.compute.domain;
20  
21  import javax.annotation.Nullable;
22  
23  import org.jclouds.compute.domain.internal.ImageImpl;
24  import org.jclouds.domain.Credentials;
25  
26  import com.google.common.annotations.Beta;
27  import com.google.inject.ImplementedBy;
28  
29  /**
30   * Running Operating system
31   * 
32   * @author Adrian Cole
33   */
34  @ImplementedBy(ImageImpl.class)
35  public interface Image extends ComputeMetadata {
36     /**
37      * The operating system installed on this image
38      */
39     @Beta
40     OperatingSystem getOperatingSystem();
41  
42     /**
43      * Version of the image
44      */
45     String getVersion();
46  
47     /**
48      * Description of the image.
49      */
50     String getDescription();
51  
52     /**
53      * secures access to root with a password. This password is required to access either the console
54      * or run sudo as root.
55      * <p/>
56      * ex. {@code echo 'password' |sudo -S command}
57      * 
58      * @return root or console password, if configured, or null.
59      */
60     @Nullable
61     String getAdminPassword();
62  
63     /**
64      * Default credentials for the current image
65      */
66     Credentials getDefaultCredentials();
67  
68  }