org.dasein.cloud.cloudstack.network
Class IpAddress

java.lang.Object
  org.dasein.cloud.cloudstack.network.IpAddress

All Implemented Interfaces:

AccessControlledService, IpAddressSupport

public class IpAddress
extends Object
implements IpAddressSupport

Field Summary

Fields inherited from interface org.dasein.cloud.network.IpAddressSupport

ANY, ASSIGN, CREATE_IP_ADDRESS, FORWARD, GET_IP_ADDRESS, LIST_IP_ADDRESS, RELEASE, REMOVE_IP_ADDRESS

Constructor Summary

IpAddress(CSCloud provider)

Method Summary

void	assign(String addressId, String toServerId)
void	assignToNetworkInterface(String addressId, String nicId)
String	forward(String addressId, int publicPort, Protocol protocol, int privatePort, String onServerId)
IpAddress	getIpAddress(String addressId)
String	getProviderTermForIpAddress(Locale locale)
Requirement	identifyVlanForVlanIPRequirement()
boolean	isAssigned(AddressType type)
boolean	isAssigned(IPVersion version)
boolean	isForwarding()
boolean	isForwarding(IPVersion version)
boolean	isRequestable(AddressType type)
boolean	isRequestable(IPVersion version)
boolean	isSubscribed()
Iterable<IpAddress>	listIpPool(IPVersion version, boolean unassignedOnly)
Iterable<ResourceStatus>	listIpPoolStatus(IPVersion version)
Iterable<IpAddress>	listPrivateIpPool(boolean unassignedOnly) Deprecated.
Iterable<IpAddress>	listPublicIpPool(boolean unassignedOnly) Deprecated.
Collection<IpForwardingRule>	listRules(String addressId)
Iterable<IPVersion>	listSupportedIPVersions()
String[]	mapServiceAction(ServiceAction action)
void	releaseFromPool(String addressId)
void	releaseFromServer(String addressId)
String	request(AddressType typeOfAddress)
String	request(IPVersion version)
String	requestForVLAN(IPVersion version)
String	requestForVLAN(IPVersion version, String vlanId)
void	stopForward(String ruleId)
boolean	supportsVLANAddresses(IPVersion ofVersion)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

IpAddress

public IpAddress(CSCloud provider)

Method Detail

assign

public void assign(@Nonnull
                   String addressId,
                   @Nonnull
                   String toServerId)
            throws InternalException,
                   CloudException

Specified by:

assign in interface IpAddressSupport

Throws:

InternalException

CloudException

assignToNetworkInterface

public void assignToNetworkInterface(@Nonnull
                                     String addressId,
                                     @Nonnull
                                     String nicId)
                              throws InternalException,
                                     CloudException

Specified by:

assignToNetworkInterface in interface IpAddressSupport

Throws:

InternalException

CloudException

forward

@Nonnull
public String forward(@Nonnull
                              String addressId,
                              int publicPort,
                              @Nonnull
                              Protocol protocol,
                              int privatePort,
                              @Nonnull
                              String onServerId)
               throws InternalException,
                      CloudException

Specified by:

forward in interface IpAddressSupport

Throws:

InternalException

CloudException

getIpAddress

@Nullable
public IpAddress getIpAddress(@Nonnull
                                       String addressId)
                       throws InternalException,
                              CloudException

Specified by:

getIpAddress in interface IpAddressSupport

Throws:

InternalException

CloudException

getProviderTermForIpAddress

@Nonnull
public String getProviderTermForIpAddress(@Nonnull
                                                  Locale locale)

Specified by:

getProviderTermForIpAddress in interface IpAddressSupport

identifyVlanForVlanIPRequirement

@Nonnull
public Requirement identifyVlanForVlanIPRequirement()
                                             throws CloudException,
                                                    InternalException

Specified by:

identifyVlanForVlanIPRequirement in interface IpAddressSupport

Throws:

CloudException

InternalException

isAssigned

public boolean isAssigned(@Nonnull
                          AddressType type)

Specified by:

isAssigned in interface IpAddressSupport

isAssigned

public boolean isAssigned(@Nonnull
                          IPVersion version)
                   throws CloudException,
                          InternalException

Specified by:

isAssigned in interface IpAddressSupport

Throws:

CloudException

InternalException

isForwarding

public boolean isForwarding()

Specified by:

isForwarding in interface IpAddressSupport

isForwarding

public boolean isForwarding(@Nonnull
                            IPVersion version)
                     throws CloudException,
                            InternalException

Specified by:

isForwarding in interface IpAddressSupport

Throws:

CloudException

InternalException

isRequestable

public boolean isRequestable(@Nonnull
                             AddressType type)

Specified by:

isRequestable in interface IpAddressSupport

isRequestable

public boolean isRequestable(@Nonnull
                             IPVersion version)
                      throws CloudException,
                             InternalException

Specified by:

isRequestable in interface IpAddressSupport

Throws:

CloudException

InternalException

isSubscribed

public boolean isSubscribed()
                     throws CloudException,
                            InternalException

Specified by:

isSubscribed in interface IpAddressSupport

Throws:

CloudException

InternalException

listPrivateIpPool

@Deprecated
@Nonnull
public Iterable<IpAddress> listPrivateIpPool(boolean unassignedOnly)
                                      throws InternalException,
                                             CloudException

Deprecated.

Specified by:

listPrivateIpPool in interface IpAddressSupport

Throws:

InternalException

CloudException

listPublicIpPool

@Deprecated
@Nonnull
public Iterable<IpAddress> listPublicIpPool(boolean unassignedOnly)
                                     throws InternalException,
                                            CloudException

Deprecated.

Specified by:

listPublicIpPool in interface IpAddressSupport

Throws:

InternalException

CloudException

listIpPool

@Nonnull
public Iterable<IpAddress> listIpPool(@Nonnull
                                              IPVersion version,
                                              boolean unassignedOnly)
                               throws InternalException,
                                      CloudException

Specified by:

listIpPool in interface IpAddressSupport

Throws:

InternalException

CloudException

listIpPoolStatus

@Nonnull
public Iterable<ResourceStatus> listIpPoolStatus(@Nonnull
                                                         IPVersion version)
                                          throws InternalException,
                                                 CloudException

Specified by:

listIpPoolStatus in interface IpAddressSupport

Throws:

InternalException

CloudException

listRules

@Nonnull
public Collection<IpForwardingRule> listRules(@Nonnull
                                                      String addressId)
                                       throws InternalException,
                                              CloudException

Specified by:

listRules in interface IpAddressSupport

Throws:

InternalException

CloudException

listSupportedIPVersions

@Nonnull
public Iterable<IPVersion> listSupportedIPVersions()
                                            throws CloudException,
                                                   InternalException

Specified by:

listSupportedIPVersions in interface IpAddressSupport

Throws:

CloudException

InternalException

mapServiceAction

@Nonnull
public String[] mapServiceAction(@Nonnull
                                         ServiceAction action)

Specified by:

mapServiceAction in interface AccessControlledService

releaseFromPool

public void releaseFromPool(@Nonnull
                            String addressId)
                     throws InternalException,
                            CloudException

Specified by:

releaseFromPool in interface IpAddressSupport

Throws:

InternalException

CloudException

releaseFromServer

public void releaseFromServer(@Nonnull
                              String addressId)
                       throws InternalException,
                              CloudException

Specified by:

releaseFromServer in interface IpAddressSupport

Throws:

InternalException

CloudException

request

@Nonnull
public String request(@Nonnull
                              AddressType typeOfAddress)
               throws InternalException,
                      CloudException

Specified by:

request in interface IpAddressSupport

Throws:

InternalException

CloudException

request

@Nonnull
public String request(@Nonnull
                              IPVersion version)
               throws InternalException,
                      CloudException

Specified by:

request in interface IpAddressSupport

Throws:

InternalException

CloudException

requestForVLAN

@Nonnull
public String requestForVLAN(@Nonnull
                                     IPVersion version)
                      throws InternalException,
                             CloudException

Specified by:

requestForVLAN in interface IpAddressSupport

Throws:

InternalException

CloudException

requestForVLAN

@Nonnull
public String requestForVLAN(@Nonnull
                                     IPVersion version,
                                     @Nonnull
                                     String vlanId)
                      throws InternalException,
                             CloudException

Specified by:

requestForVLAN in interface IpAddressSupport

Throws:

InternalException

CloudException

stopForward

public void stopForward(@Nonnull
                        String ruleId)
                 throws InternalException,
                        CloudException

Specified by:

stopForward in interface IpAddressSupport

Throws:

InternalException

CloudException

supportsVLANAddresses

public boolean supportsVLANAddresses(@Nonnull
                                     IPVersion ofVersion)
                              throws InternalException,
                                     CloudException

Specified by:

supportsVLANAddresses in interface IpAddressSupport

Throws:

InternalException

CloudException