Package org.jclouds.cloudstack.compute.extensions

Class CloudStackSecurityGroupExtension

java.lang.Object

org.jclouds.cloudstack.compute.extensions.CloudStackSecurityGroupExtension

All Implemented Interfaces:

SecurityGroupExtension

public class CloudStackSecurityGroupExtension
extends Object
implements SecurityGroupExtension

An extension to compute service to allow for the manipulation of SecurityGroups. Implementation is optional by providers.

Field Summary

Fields

Modifier and Type	Field	Description
protected CloudStackApi	api
protected BlockUntilJobCompletesAndReturnResult	blockUntilJobCompletesAndReturnResult
protected com.google.common.base.Function<SecurityGroup,SecurityGroup>	groupConverter
protected com.google.common.cache.LoadingCache<ZoneAndName,SecurityGroup>	groupCreator
protected com.google.common.base.Predicate<String>	jobComplete
protected com.google.common.base.Supplier<Set<? extends Location>>	locations
protected GroupNamingConvention.Factory	namingConvention

Constructor Summary

Constructors

Constructor

Description

CloudStackSecurityGroupExtension(CloudStackApi api, com.google.common.base.Function<SecurityGroup,SecurityGroup> groupConverter, com.google.common.cache.LoadingCache<ZoneAndName,SecurityGroup> groupCreator, GroupNamingConvention.Factory namingConvention, com.google.common.base.Supplier<Set<? extends Location>> locations, BlockUntilJobCompletesAndReturnResult blockUntilJobCompletesAndReturnResult, com.google.common.base.Predicate<String> jobComplete)

Method Summary

Modifier and Type	Method	Description
SecurityGroup	addIpPermission(IpPermission ipPermission, SecurityGroup group)
SecurityGroup	addIpPermission(IpProtocol protocol, int startPort, int endPort, com.google.common.collect.Multimap<String,String> tenantIdGroupNamePairs, Iterable<String> ipRanges, Iterable<String> groupIds, SecurityGroup group)
SecurityGroup	createSecurityGroup(String name, Location location)
SecurityGroup	getSecurityGroupById(String id)
Set<SecurityGroup>	listSecurityGroups()
Set<SecurityGroup>	listSecurityGroupsForNode(String id)
Set<SecurityGroup>	listSecurityGroupsInLocation(Location location)	Note that for the time being, security groups are not scoped by location in CloudStack, so this will simply return listSecurityGroups().
SecurityGroup	removeIpPermission(IpPermission ipPermission, SecurityGroup group)
SecurityGroup	removeIpPermission(IpProtocol protocol, int startPort, int endPort, com.google.common.collect.Multimap<String,String> tenantIdGroupNamePairs, Iterable<String> ipRanges, Iterable<String> groupIds, SecurityGroup group)
boolean	removeSecurityGroup(String id)
boolean	supportsExclusionCidrBlocks()
boolean	supportsGroupIds()
boolean	supportsPortRangesForGroups()
boolean	supportsTenantIdGroupIdPairs()
boolean	supportsTenantIdGroupNamePairs()

Methods inherited from class java.lang.Object

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

Field Detail

api

protected final CloudStackApi api

groupConverter

protected final com.google.common.base.Function<SecurityGroup,SecurityGroup> groupConverter

groupCreator

protected final com.google.common.cache.LoadingCache<ZoneAndName,SecurityGroup> groupCreator

namingConvention

protected final GroupNamingConvention.Factory namingConvention

locations

protected final com.google.common.base.Supplier<Set<? extends Location>> locations

blockUntilJobCompletesAndReturnResult

protected final BlockUntilJobCompletesAndReturnResult blockUntilJobCompletesAndReturnResult

jobComplete

protected final com.google.common.base.Predicate<String> jobComplete

Constructor Detail

CloudStackSecurityGroupExtension

@Inject
public CloudStackSecurityGroupExtension(CloudStackApi api,
                                        com.google.common.base.Function<SecurityGroup,SecurityGroup> groupConverter,
                                        com.google.common.cache.LoadingCache<ZoneAndName,SecurityGroup> groupCreator,
                                        GroupNamingConvention.Factory namingConvention,
                                        com.google.common.base.Supplier<Set<? extends Location>> locations,
                                        BlockUntilJobCompletesAndReturnResult blockUntilJobCompletesAndReturnResult,
                                        com.google.common.base.Predicate<String> jobComplete)

Method Detail

listSecurityGroups

public Set<SecurityGroup> listSecurityGroups()

Specified by:

listSecurityGroups in interface SecurityGroupExtension

listSecurityGroupsInLocation

public Set<SecurityGroup> listSecurityGroupsInLocation(Location location)

Note that for the time being, security groups are not scoped by location in CloudStack, so this will simply return listSecurityGroups().

Specified by:

listSecurityGroupsInLocation in interface SecurityGroupExtension

Parameters:

location -

Returns:

security groups

listSecurityGroupsForNode

public Set<SecurityGroup> listSecurityGroupsForNode(String id)

Specified by:

listSecurityGroupsForNode in interface SecurityGroupExtension

getSecurityGroupById

public SecurityGroup getSecurityGroupById(String id)

Specified by:

getSecurityGroupById in interface SecurityGroupExtension

createSecurityGroup

public SecurityGroup createSecurityGroup(String name,
                                         Location location)

Specified by:

createSecurityGroup in interface SecurityGroupExtension

removeSecurityGroup

public boolean removeSecurityGroup(String id)

Specified by:

removeSecurityGroup in interface SecurityGroupExtension

addIpPermission

public SecurityGroup addIpPermission(IpPermission ipPermission,
                                     SecurityGroup group)

Specified by:

addIpPermission in interface SecurityGroupExtension

addIpPermission

public SecurityGroup addIpPermission(IpProtocol protocol,
                                     int startPort,
                                     int endPort,
                                     com.google.common.collect.Multimap<String,String> tenantIdGroupNamePairs,
                                     Iterable<String> ipRanges,
                                     Iterable<String> groupIds,
                                     SecurityGroup group)

Specified by:

addIpPermission in interface SecurityGroupExtension

removeIpPermission

public SecurityGroup removeIpPermission(IpPermission ipPermission,
                                        SecurityGroup group)

Specified by:

removeIpPermission in interface SecurityGroupExtension

removeIpPermission

public SecurityGroup removeIpPermission(IpProtocol protocol,
                                        int startPort,
                                        int endPort,
                                        com.google.common.collect.Multimap<String,String> tenantIdGroupNamePairs,
                                        Iterable<String> ipRanges,
                                        Iterable<String> groupIds,
                                        SecurityGroup group)

Specified by:

removeIpPermission in interface SecurityGroupExtension

supportsTenantIdGroupNamePairs

public boolean supportsTenantIdGroupNamePairs()

Specified by:

supportsTenantIdGroupNamePairs in interface SecurityGroupExtension

supportsTenantIdGroupIdPairs

public boolean supportsTenantIdGroupIdPairs()

Specified by:

supportsTenantIdGroupIdPairs in interface SecurityGroupExtension

supportsGroupIds

public boolean supportsGroupIds()

Specified by:

supportsGroupIds in interface SecurityGroupExtension

supportsPortRangesForGroups

public boolean supportsPortRangesForGroups()

Specified by:

supportsPortRangesForGroups in interface SecurityGroupExtension

supportsExclusionCidrBlocks

public boolean supportsExclusionCidrBlocks()

Specified by:

supportsExclusionCidrBlocks in interface SecurityGroupExtension