Package org.glassfish.web.deployment.annotation.handlers

Class ServletSecurityHandler

java.lang.Object

com.sun.enterprise.deployment.annotation.handlers.AbstractHandler

org.glassfish.web.deployment.annotation.handlers.ServletSecurityHandler

All Implemented Interfaces:

AnnotationHandler

@Service
public class ServletSecurityHandler
extends AbstractHandler

This handler is responsible in handling jakarta.servlet.annotation.ServletSecurity.

Author:

Shing Wai Chan

Field Summary

Fields

Modifier and Type	Field	Description
protected static LocalStringManagerImpl	localStrings

Fields inherited from class com.sun.enterprise.deployment.annotation.handlers.AbstractHandler

ejbProvider, logger

Fields inherited from interface org.glassfish.apf.AnnotationHandler

ANNOTATION_HANDLER_METADATA

Constructor Summary

Constructors

Constructor	Description
ServletSecurityHandler()

Method Summary

Modifier and Type	Method	Description
static SecurityConstraint	createSecurityConstraint(WebBundleDescriptor webBundleDesc, Set<String> urlPatterns, String[] rolesAllowed, jakarta.servlet.annotation.ServletSecurity.EmptyRoleSemantic emptyRoleSemantic, jakarta.servlet.annotation.ServletSecurity.TransportGuarantee transportGuarantee, String httpMethod)
Class<? extends Annotation>[]	getTypeDependencies()
static Set<String>	getUrlPatternsWithoutSecurityConstraint(WebComponentDescriptor webCompDesc)	Given a WebComponentDescriptor, find the set of urlPattern which does not have any existing url pattern in SecurityConstraint
HandlerProcessingResult	processAnnotation(AnnotationInfo ainfo)	Process a particular annotation which type is the same as the one returned by @see getAnnotationType().
protected HandlerProcessingResult	processAnnotation(AnnotationInfo ainfo, WebBundleContext webBundleContext)	Process Annotation with given WebBundleContext.
protected HandlerProcessingResult	processAnnotation(AnnotationInfo ainfo, WebComponentContext[] webCompContexts)	Process Annotation with given WebCompContexts.

Methods inherited from class com.sun.enterprise.deployment.annotation.handlers.AbstractHandler

getAnnotationType, getConnectorAnnotationTypes, getDefaultFailedResult, getDefaultProcessedResult, getEjbAndWebAnnotationTypes, getEjbAnnotationTypes, getInjectionMethodPropertyName, getInvalidAnnotatedElementHandlerResult, getOverallProcessingResult, getWebAnnotationTypes, log, validateInjectionMethod

Methods inherited from class java.lang.Object

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

Field Detail

localStrings

protected static final LocalStringManagerImpl localStrings

Constructor Detail

ServletSecurityHandler

public ServletSecurityHandler()

Method Detail

processAnnotation

protected HandlerProcessingResult processAnnotation(AnnotationInfo ainfo,
                                                    WebComponentContext[] webCompContexts)
                                             throws AnnotationProcessorException

Process Annotation with given WebCompContexts.

Returns:

HandlerProcessingResult

Throws:

AnnotationProcessorException

processAnnotation

protected HandlerProcessingResult processAnnotation(AnnotationInfo ainfo,
                                                    WebBundleContext webBundleContext)
                                             throws AnnotationProcessorException

Process Annotation with given WebBundleContext.

Returns:

HandlerProcessingResult

Throws:

AnnotationProcessorException

getTypeDependencies

public Class<? extends Annotation>[] getTypeDependencies()

Specified by:

getTypeDependencies in interface AnnotationHandler

Overrides:

getTypeDependencies in class AbstractHandler

Returns:

an array of annotation types this annotation handler would require to be processed (if present) before it processes it's own annotation type.

getUrlPatternsWithoutSecurityConstraint

public static Set<String> getUrlPatternsWithoutSecurityConstraint(WebComponentDescriptor webCompDesc)

Given a WebComponentDescriptor, find the set of urlPattern which does not have any existing url pattern in SecurityConstraint

Parameters:

webCompDesc -

Returns:

a list of url String

createSecurityConstraint

public static SecurityConstraint createSecurityConstraint(WebBundleDescriptor webBundleDesc,
                                                          Set<String> urlPatterns,
                                                          String[] rolesAllowed,
                                                          jakarta.servlet.annotation.ServletSecurity.EmptyRoleSemantic emptyRoleSemantic,
                                                          jakarta.servlet.annotation.ServletSecurity.TransportGuarantee transportGuarantee,
                                                          String httpMethod)

processAnnotation

public HandlerProcessingResult processAnnotation(AnnotationInfo ainfo)
                                          throws AnnotationProcessorException

Process a particular annotation which type is the same as the one returned by @see getAnnotationType(). All information pertinent to the annotation and its context is encapsulated in the passed AnnotationInfo instance. This is a method in interface AnnotationHandler.

Parameters:

ainfo - the annotation information

Throws:

AnnotationProcessorException