org.springframework.roo.addon.security.addon.security

Interface SecurityOperations

All Superinterfaces:

org.springframework.roo.project.Feature

All Known Implementing Classes:

SecurityOperationsImpl

public interface SecurityOperations
extends org.springframework.roo.project.Feature

Interface for SecurityOperationsImpl.

Since:

1.0

Author:

Ben Alex, Sergio Clares, Juan Carlos García

Field Summary

Fields

Modifier and Type	Field and Description
static String	SECURITY_FEATURE_NAME

Method Summary

Modifier and Type	Method and Description
void	generateAuthorizeAnnotations(org.springframework.roo.model.JavaType klass, String methodName, String roles, String usernames) Defines RooSecurityAuthorizations annotation that include one or many RooSecurityAuthorization annotations which will be used by implementations to include PreAuthorize annotations in service methods.
void	generateFilterAnnotations(org.springframework.roo.model.JavaType klass, String methodName, String roles, String usernames, String when) Defines RooSecurityFilters annotation that include one or many RooSecurityFilter annotations which will be used by implementations to include PreFilter or PostFilter annotations in service methods.
List<SecurityProvider>	getAllSecurityProviders() Defines getAllSecurityProviders operation that will be used by implementations to get all security providers registered on the Spring Roo Shell.
String	getSpringSecurityAnnotationValue(String roles, String usernames) Defines getSpringSecurityAnnotationValue method that will be used by implementations to calculate the value of the Spring Security Annotations
void	installSecurity(SecurityProvider type, org.springframework.roo.project.maven.Pom module) Defines install operation that will be used by implementations to install the necessary components of Spring Security.

Methods inherited from interface org.springframework.roo.project.Feature

getName, isInstalledInModule

Field Detail

SECURITY_FEATURE_NAME

static final String SECURITY_FEATURE_NAME

See Also:

Constant Field Values

Method Detail

installSecurity

void installSecurity(SecurityProvider type,
                     org.springframework.roo.project.maven.Pom module)

Defines install operation that will be used by implementations to install the necessary components of Spring Security.

Parameters:

type - SecurityProvider type that will be install

module - Pom of the application module where Spring Security will be installed.

getAllSecurityProviders

List<SecurityProvider> getAllSecurityProviders()

Defines getAllSecurityProviders operation that will be used by implementations to get all security providers registered on the Spring Roo Shell.

Returns:

List with the registered security providers on the Spring Roo Shell.

getSpringSecurityAnnotationValue

String getSpringSecurityAnnotationValue(String roles,
                                        String usernames)

Defines getSpringSecurityAnnotationValue method that will be used by implementations to calculate the value of the Spring Security Annotations

Parameters:

roles - separated comma list with the roles to include in Spring Security annotation.

usernames - separated comma list with the usernames to include in Spring Security annotation

Returns:

String with the value of the Spring Security annotation

generateFilterAnnotations

void generateFilterAnnotations(org.springframework.roo.model.JavaType klass,
                               String methodName,
                               String roles,
                               String usernames,
                               String when)

Defines RooSecurityFilters annotation that include one or many RooSecurityFilter annotations which will be used by implementations to include PreFilter or PostFilter annotations in service methods.

Parameters:

klass - Class where include the annotations

methodName - Method where apply the filter

roles - Roles to apply by the filter

usernames - Usernames to apply by the filter

when - Indicate the type of filter 'PRE' (@PreFilter) or 'POST' (@PostFilter)

generateAuthorizeAnnotations

void generateAuthorizeAnnotations(org.springframework.roo.model.JavaType klass,
                                  String methodName,
                                  String roles,
                                  String usernames)

Defines RooSecurityAuthorizations annotation that include one or many RooSecurityAuthorization annotations which will be used by implementations to include PreAuthorize annotations in service methods.

Parameters:

klass - Class where include the annotations

methodName - Method where apply the authorization

roles - Roles to apply by the authorization

usernames - Usernames that have authorization