/*************************************************************************
* Copyright 2009-2014 Eucalyptus Systems, Inc.
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; version 3 of the License.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program. If not, see http://www.gnu.org/licenses/.
*
* Please contact Eucalyptus Systems, Inc., 6755 Hollister Ave., Goleta
* CA 93117, USA or visit http://www.eucalyptus.com/licenses/ if you need
* additional information or have any questions.
*
* This file may incorporate work covered under the following copyright
* and permission notice:
*
* Software License Agreement (BSD License)
*
* Copyright (c) 2008, Regents of the University of California
* All rights reserved.
*
* Redistribution and use of this software in source and binary forms,
* with or without modification, are permitted provided that the
* following conditions are met:
*
* Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
*
* Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer
* in the documentation and/or other materials provided with the
* distribution.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
* FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
* COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
* INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
* BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
* LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
* CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
* LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
* ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
* POSSIBILITY OF SUCH DAMAGE. USERS OF THIS SOFTWARE ACKNOWLEDGE
* THE POSSIBLE PRESENCE OF OTHER OPEN SOURCE LICENSED MATERIAL,
* COPYRIGHTED MATERIAL OR PATENTED MATERIAL IN THIS SOFTWARE,
* AND IF ANY SUCH MATERIAL IS DISCOVERED THE PARTY DISCOVERING
* IT MAY INFORM DR. RICH WOLSKI AT THE UNIVERSITY OF CALIFORNIA,
* SANTA BARBARA WHO WILL THEN ASCERTAIN THE MOST APPROPRIATE REMEDY,
* WHICH IN THE REGENTS' DISCRETION MAY INCLUDE, WITHOUT LIMITATION,
* REPLACEMENT OF THE CODE SO IDENTIFIED, LICENSING OF THE CODE SO
* IDENTIFIED, OR WITHDRAWAL OF THE CODE CAPABILITY TO THE EXTENT
* NEEDED TO COMPLY WITH ANY SUCH LICENSES OR RIGHTS.
************************************************************************/
package com.eucalyptus.compute.common;
import javax.annotation.Nullable;
import com.eucalyptus.auth.policy.annotation.PolicyResourceType;
import com.eucalyptus.bootstrap.SystemIds;
import com.google.common.base.Function;
import com.google.common.base.Predicate;
/** GRZE:WARN: values are intentionally opaque strings and /not/ a symbolic reference. **/
@PolicyResourceType( "image" )
public interface ImageMetadata extends CloudMetadata {
public static final String TYPE_MANIFEST_XPATH = "/manifest/image/type/text()";
public enum Type {
machine {
/**
* @see CloudMetadatas#isMachineImageIdentifier
*/
@Override
public String getTypePrefix( ) {
return "emi";
}
@Override
public String getManifestPath( ) {
return "/manifest/image/type/text()";
}
},
kernel {
/**
* @see CloudMetadatas#isKernelImageIdentifier
*/
@Override
public String getTypePrefix( ) {
return "eki";
}
@Override
public String getNamePrefix( ) {
return "vmlinuz";
}
@Override
public String getManifestPath( ) {
return "/manifest/machine_configuration/kernel_id/text()";
}
},
ramdisk {
/**
* @see CloudMetadatas#isRamdiskImageIdentifier
*/
@Override
public String getTypePrefix( ) {
return "eri";
}
@Override
public String getNamePrefix( ) {
return "initrd";
}
@Override
public String getManifestPath( ) {
return "/manifest/machine_configuration/ramdisk_id/text()";
}
};
public abstract String getTypePrefix( );
public abstract String getManifestPath( );
public String getNamePrefix( ) {
return SystemIds.cloudName( );//a really large random string which should never appear
}
}
public enum State implements Predicate<ImageMetadata> {
pending("pending"), pending_available("available"), pending_conversion("available"), available("available"),
failed("failed"), deregistered( false , "deregistered"), deregistered_cleanup( false, "deregistered"),
hidden( false , "hidden"), unavailable ( false, "unavailable");
private final boolean standardState;
private final String externalStateName;
private State( final String externalStateName){
this(true, externalStateName);
}
private State( final boolean standardState, final String externalStateName ){
this.standardState = standardState;
this.externalStateName = externalStateName;
}
public boolean standardState( ) {
return standardState;
}
@Override
public boolean apply( @Nullable final ImageMetadata input ) {
return input != null && this == input.getState();
}
public String getExternalStateName(){
return this.externalStateName;
}
}
public enum ImageFormat {
fulldisk, partitioned
}
public enum VirtualizationType {
paravirtualized {
@Override
public String toString() {
return "paravirtual";
}
},
hvm
;
public static Function<String,VirtualizationType> fromString( ) {
return FromString.INSTANCE;
}
private enum FromString implements Function<String,VirtualizationType> {
INSTANCE;
@Nullable
@Override
public VirtualizationType apply( @Nullable final String value ) {
for ( final VirtualizationType type : VirtualizationType.values() ) {
if ( type.toString( ).equals( value ) || type.name( ).equals( value ) ) return type;
}
return null;
}
}
}
public enum Hypervisor {
xen, kvm, other
}
public enum DeviceMappingType {
root, swap, suppress, ephemeral, blockstorage, ami
}
public enum Architecture {
i386, x86_64, other
}
public enum Platform {
linux {
public String toString( ) {
return "";
}
},
windows {
public String toString( ) {
return this.name( );
}
}
}
String getImageName( );
Type getImageType( );
Platform getPlatform( );
Architecture getArchitecture( );
State getState( );
}