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.compute.domain;
20
21 import org.jclouds.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 }