org.openstack4j.api.compute

Interface ComputeSecurityGroupService

All Superinterfaces:

RestService

All Known Implementing Classes:

ComputeSecurityGroupServiceImpl

public interface ComputeSecurityGroupService
extends RestService

Provides operations against the Security Group extension in OpenStack Extension Mapping: (os-security-groups)

Author:

Jeremy Unruh

Method Summary

Modifier and Type	Method and Description
SecGroupExtension	create(String name, String description) Creates a new Security Group
SecGroupExtension.Rule	createRule(SecGroupExtension.Rule rule) Creates a new Security Group Rule
ActionResponse	delete(String securityGroupId) Deletes the specified Security Group
ActionResponse	deleteRule(String ruleId) Deletes a Security Group Rule
SecGroupExtension	get(String securityGroupId) Gets the specified Security Group
List<? extends SecGroupExtension>	list() List all the Security Groups
List<? extends SecGroupExtension>	listServerGroups(String serverId) Lists the Security Groups for the specified server
SecGroupExtension	update(String securityGroupId, String name, String description) Updates the Name and Description for a Security Group

Method Detail

list

List<? extends SecGroupExtension> list()

List all the Security Groups

Returns:

the list of security groups

listServerGroups

List<? extends SecGroupExtension> listServerGroups(String serverId)

Lists the Security Groups for the specified server

Parameters:

serverId - the server identifier

Returns:

the list of security groups

get

SecGroupExtension get(String securityGroupId)

Gets the specified Security Group

Parameters:

securityGroupId - the security group identifier

Returns:

the security group or Null if not found

create

SecGroupExtension create(String name,
                         String description)

Creates a new Security Group

Parameters:

name - the name of the security group

description - the description of the security group

Returns:

the newly created security group

update

SecGroupExtension update(String securityGroupId,
                         String name,
                         String description)

Updates the Name and Description for a Security Group

Parameters:

securityGroupId - the security group identifier

name - the name of the security group

description - the description of the security group

Returns:

the newly created security group

delete

ActionResponse delete(String securityGroupId)

Deletes the specified Security Group

Parameters:

securityGroupId - the security group identifier

Returns:

the action response

createRule

SecGroupExtension.Rule createRule(SecGroupExtension.Rule rule)

Creates a new Security Group Rule

Parameters:

rule - the rule to create

Returns:

the newly created rule

deleteRule

ActionResponse deleteRule(String ruleId)

Deletes a Security Group Rule

Parameters:

ruleId - the rule identifier

Returns:

the action response