org.apache.brooklyn.location.jclouds.networking

Class SecurityGroupEditor

java.lang.Object

org.apache.brooklyn.location.jclouds.networking.SecurityGroupEditor

public class SecurityGroupEditor
extends java.lang.Object

Utility for manipulating security groups.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SecurityGroupEditor.AmbiguousGroupName

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	JCLOUDS_PREFIX_REGEX

Constructor Summary

Constructors

Constructor and Description
SecurityGroupEditor(org.jclouds.domain.Location location, org.jclouds.compute.extensions.SecurityGroupExtension securityGroupExtension) Constructor for editor that never retries requests if the attempted operation fails.
SecurityGroupEditor(org.jclouds.domain.Location location, org.jclouds.compute.extensions.SecurityGroupExtension securityGroupExtension, <any> isExceptionRetryable) Deprecated. since 0.10.0 Ideally it should be possible to determine a suitable predicate internally to this class by instantiating a type appropriate to the underlying cloud. TODO investigate and implement.

Method Summary

Modifier and Type	Method and Description
org.jclouds.compute.domain.SecurityGroup	addPermission(org.jclouds.compute.domain.SecurityGroup group, org.jclouds.net.domain.IpPermission permission) Add a permission to the security group.
org.jclouds.compute.domain.SecurityGroup	addPermissions(org.jclouds.compute.domain.SecurityGroup group, java.lang.Iterable<org.jclouds.net.domain.IpPermission> permissions) Add permissions to the security group, using addPermission(SecurityGroup, IpPermission).
org.jclouds.compute.domain.SecurityGroup	createSecurityGroup(java.lang.String name) Create the security group.
<any>	findSecurityGroupByName(java.lang.String name) Find a security group with the given name.
java.lang.Iterable<org.jclouds.compute.domain.SecurityGroup>	findSecurityGroupsMatching(Predicate predicate)
org.jclouds.domain.Location	getLocation() Get the location in which security groups will be created or searched.
java.util.Set<org.jclouds.compute.domain.SecurityGroup>	getSecurityGroupsForNode(java.lang.String nodeId)
java.util.Set<org.jclouds.compute.domain.SecurityGroup>	listSecurityGroupsForNode(java.lang.String nodeId)
org.jclouds.compute.domain.SecurityGroup	removePermission(org.jclouds.compute.domain.SecurityGroup group, org.jclouds.net.domain.IpPermission permission)
org.jclouds.compute.domain.SecurityGroup	removePermissions(org.jclouds.compute.domain.SecurityGroup group, java.lang.Iterable<org.jclouds.net.domain.IpPermission> permissions)
boolean	removeSecurityGroup(org.jclouds.compute.domain.SecurityGroup group) Removes a security group and its permissions.
boolean	removeSecurityGroup(java.lang.String groupId) Removes a security group and its permissions.
java.lang.String	toString()

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

JCLOUDS_PREFIX_REGEX

public static final java.lang.String JCLOUDS_PREFIX_REGEX

See Also:

Constant Field Values

Constructor Detail

SecurityGroupEditor

public SecurityGroupEditor(org.jclouds.domain.Location location,
                           org.jclouds.compute.extensions.SecurityGroupExtension securityGroupExtension)

Constructor for editor that never retries requests if the attempted operation fails.

Parameters:

location - JClouds location where security groups will be managed.

securityGroupExtension - The JClouds security group extension from the compute service for this location.

SecurityGroupEditor

@Deprecated
public SecurityGroupEditor(org.jclouds.domain.Location location,
                                       org.jclouds.compute.extensions.SecurityGroupExtension securityGroupExtension,
                                       <any> isExceptionRetryable)

Deprecated. since 0.10.0 Ideally it should be possible to determine a suitable predicate internally to this class by instantiating a type appropriate to the underlying cloud. TODO investigate and implement.

Constructor for editor that may retry operations upon exceptions.

Parameters:

location - JClouds location where security groups will be managed.

securityGroupExtension - The JClouds security group extension from the compute service for this location.

isExceptionRetryable - used to determine for an exception whether to retry the operation that failed.

Method Detail

getLocation

public org.jclouds.domain.Location getLocation()

Get the location in which security groups will be created or searched.

getSecurityGroupsForNode

public java.util.Set<org.jclouds.compute.domain.SecurityGroup> getSecurityGroupsForNode(java.lang.String nodeId)

createSecurityGroup

public org.jclouds.compute.domain.SecurityGroup createSecurityGroup(java.lang.String name)

Create the security group. As we use jclouds, groups are created with names prefixed with JCLOUDS_PREFIX_REGEX. This method is idempotent.

Parameters:

name - Name of the group to create

Returns:

The created group.

removeSecurityGroup

public boolean removeSecurityGroup(org.jclouds.compute.domain.SecurityGroup group)

Removes a security group and its permissions.

Parameters:

group - The security group.

Returns:

true if the group was found and removed.

removeSecurityGroup

public boolean removeSecurityGroup(java.lang.String groupId)

Removes a security group and its permissions.

Parameters:

groupId - The jclouds id (provider id) of the group (including region code)

Returns:

true if the group was found and removed.

listSecurityGroupsForNode

public java.util.Set<org.jclouds.compute.domain.SecurityGroup> listSecurityGroupsForNode(java.lang.String nodeId)

findSecurityGroupsMatching

public java.lang.Iterable<org.jclouds.compute.domain.SecurityGroup> findSecurityGroupsMatching(Predicate predicate)

findSecurityGroupByName

public <any> findSecurityGroupByName(java.lang.String name)

Find a security group with the given name. As we use jclouds, groups are created with names prefixed with JCLOUDS_PREFIX_REGEX. For convenience this method accepts names either with or without the prefix.

Parameters:

name - Name of the group to find.

Returns:

An optional of the group.

Throws:

SecurityGroupEditor.AmbiguousGroupName - in the unexpected case that the cloud returns more than one matching group.

addPermissions

public org.jclouds.compute.domain.SecurityGroup addPermissions(org.jclouds.compute.domain.SecurityGroup group,
                                                               java.lang.Iterable<org.jclouds.net.domain.IpPermission> permissions)

Add permissions to the security group, using addPermission(SecurityGroup, IpPermission).

Parameters:

group - The group to update

permissions - The new permissions

Returns:

The updated group with the added permissions.

addPermission

public org.jclouds.compute.domain.SecurityGroup addPermission(org.jclouds.compute.domain.SecurityGroup group,
                                                              org.jclouds.net.domain.IpPermission permission)

Add a permission to the security group. This operation is idempotent (will return the group unmodified if the permission already exists on it).

Parameters:

group - The group to update

permission - The new permission

Returns:

The updated group with the added permissions.

removePermission

public org.jclouds.compute.domain.SecurityGroup removePermission(org.jclouds.compute.domain.SecurityGroup group,
                                                                 org.jclouds.net.domain.IpPermission permission)

removePermissions

public org.jclouds.compute.domain.SecurityGroup removePermissions(org.jclouds.compute.domain.SecurityGroup group,
                                                                  java.lang.Iterable<org.jclouds.net.domain.IpPermission> permissions)

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object