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

Class SecurityOperationsImpl

java.lang.Object

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

All Implemented Interfaces:

SecurityOperations, org.springframework.roo.project.Feature

@Service
public class SecurityOperationsImpl
extends Object
implements SecurityOperations

Provides security installation services.

Since:

1.0

Author:

Ben Alex, Stefan Schmidt, Alan Stewart, Sergio Clares, Juan Carlos García

Field Summary

Fields

Modifier and Type	Field and Description
protected static Logger	LOGGER

Fields inherited from interface org.springframework.roo.addon.security.addon.security.SecurityOperations

SECURITY_FEATURE_NAME

Constructor Summary

Constructors

Constructor and Description
SecurityOperationsImpl()

Method Summary

Modifier and Type	Method and Description
protected void	activate(org.osgi.service.component.ComponentContext context)
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	getName()
org.springframework.roo.project.PathResolver	getPathResolver()
org.springframework.roo.project.ProjectOperations	getProjectOperations()
org.springframework.roo.addon.pushin.PushInOperations	getPushInOperations()
String	getSpringSecurityAnnotationValue(String roles, String usernames) Defines getSpringSecurityAnnotationValue method that will be used by implementations to calculate the value of the Spring Security Annotations
org.springframework.roo.classpath.TypeLocationService	getTypeLocationService()
org.springframework.roo.classpath.TypeManagementService	getTypeManagementService()
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.
boolean	isInstalledInModule(String moduleName)

Methods inherited from class java.lang.Object

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

Field Detail

LOGGER

protected static final Logger LOGGER

Constructor Detail

SecurityOperationsImpl

public SecurityOperationsImpl()

Method Detail

activate

protected void activate(org.osgi.service.component.ComponentContext context)

installSecurity

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

Description copied from interface: SecurityOperations

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

Specified by:

installSecurity in interface SecurityOperations

Parameters:

type - SecurityProvider type that will be install

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

generateFilterAnnotations

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

Description copied from interface: SecurityOperations

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.

Specified by:

generateFilterAnnotations in interface SecurityOperations

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

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

Description copied from interface: SecurityOperations

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

Specified by:

generateAuthorizeAnnotations in interface SecurityOperations

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

getSpringSecurityAnnotationValue

public String getSpringSecurityAnnotationValue(String roles,
                                               String usernames)

Description copied from interface: SecurityOperations

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

Specified by:

getSpringSecurityAnnotationValue in interface SecurityOperations

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

getAllSecurityProviders

public List<SecurityProvider> getAllSecurityProviders()

Description copied from interface: SecurityOperations

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

Specified by:

getAllSecurityProviders in interface SecurityOperations

Returns:

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

getProjectOperations

public org.springframework.roo.project.ProjectOperations getProjectOperations()

getTypeLocationService

public org.springframework.roo.classpath.TypeLocationService getTypeLocationService()

getTypeManagementService

public org.springframework.roo.classpath.TypeManagementService getTypeManagementService()

getPathResolver

public org.springframework.roo.project.PathResolver getPathResolver()

getPushInOperations

public org.springframework.roo.addon.pushin.PushInOperations getPushInOperations()

getName

public String getName()

Specified by:

getName in interface org.springframework.roo.project.Feature

isInstalledInModule

public boolean isInstalledInModule(String moduleName)

Specified by:

isInstalledInModule in interface org.springframework.roo.project.Feature