com.caucho.server.dispatch
Class ServletConfigImpl

java.lang.Object
  extended by com.caucho.server.dispatch.ServletConfigImpl
All Implemented Interfaces:
AlarmListener, java.util.EventListener, Registration, Registration.Dynamic, ServletConfig, ServletRegistration, ServletRegistration.Dynamic
Direct Known Subclasses:
ServletMapping

public class ServletConfigImpl
extends java.lang.Object
implements ServletConfig, ServletRegistration.Dynamic, AlarmListener

Configuration for a servlet.


Nested Class Summary
static class ServletConfigImpl.FRAGMENT_MODE
           
static class ServletConfigImpl.RunAs
           
 
Nested classes/interfaces inherited from interface javax.servlet.ServletRegistration
ServletRegistration.Dynamic
 
Field Summary
protected static java.util.logging.Logger log
           
 
Constructor Summary
ServletConfigImpl()
          Creates a new servlet configuration object.
ServletConfigImpl(ServletConfigImpl.FRAGMENT_MODE fragmentMode)
           
 
Method Summary
 java.util.Set<java.lang.String> addMapping(java.lang.String... urlPatterns)
          Maps or exists if any of the patterns in urlPatterns already map to a different servlet
 void addSecurityRoleRef(SecurityRoleRef ref)
          Adds a security role reference.
protected  java.lang.String calculateServletClassName()
           
 void checkConstructor()
          Checks the class constructor for the public-zero arg.
 void close()
           
protected  void copyFrom(ServletConfigImpl source)
           
 InitParam createInitParam()
          Sets an init-param
 MultipartConfigImpl createMultipartConfig()
           
 ServletConfigImpl createRegexpConfig(java.lang.String servletName)
           
 RunAt createRunAt()
          Creates the run-at configuration.
 FilterChain createServletChain()
           
protected  ConfigException error(java.lang.String msg)
           
protected  ConfigException error(java.lang.String msg, java.lang.Throwable e)
           
protected  java.lang.RuntimeException error(java.lang.Throwable e)
           
 Bean<?> getBean()
           
 java.lang.String getClassName()
           
 CronType getCron()
          Returns the cron configuration.
 java.lang.String getDisplayName()
          Gets the display name
 ContainerProgram getInit()
          Gets the init block
 java.lang.String getInitParameter(java.lang.String name)
          Gets the init params
 java.util.Enumeration getInitParameterNames()
          Gets the init params
 java.util.Map<java.lang.String,java.lang.String> getInitParameters()
           
 java.util.Map getInitParamMap()
          Gets the init params
 java.lang.String getJspFile()
          Gets the JSP file
 int getLoadOnStartup()
          Gets the load-on-startup value.
 java.util.Collection<java.lang.String> getMappings()
           
 MultipartConfigElement getMultipartConfig()
           
 java.lang.String getName()
           
 java.util.HashMap<java.lang.String,java.lang.String> getRoleMap()
          Adds a security role reference.
 java.lang.String getRunAsRole()
           
 RunAt getRunAt()
          Returns the run-at configuration.
 ServletSecurityElement getSecurityElement()
           
 java.lang.Object getServlet()
          Returns the servlet.
 java.lang.Class getServletClass()
          Gets the servlet class.
 java.lang.String getServletClassName()
          Gets the servlet name.
 ServletContext getServletContext()
          Returns the servlet context.
 ServletManager getServletManager()
          Returns the servlet manager.
 java.lang.String getServletName()
          Gets the servlet name.
 java.lang.String getServletNameDefault()
          Gets the servlet name default.
 void handleAlarm(Alarm alarm)
          Handles a cron alarm callback.
 void init()
          Initialize the servlet config.
 boolean isAsyncSupported()
           
 boolean isInFragmentMode()
           
 boolean isServletConfig()
           
 void merge(ServletConfigImpl config)
           
 void setAllowEL(boolean allowEL)
          Sets the allow value.
 void setAsyncSupported(boolean asyncSupported)
           
 void setBean(Bean<?> bean)
          Set the bean
 void setConfigUriLocation(java.lang.String location, int line)
          Sets the config location.
 void setCron(CronType cron)
           
 void setDescription(java.lang.String description)
          Sets the description
 void setDisplayName(java.lang.String displayName)
          Sets the display name
 void setIcon(Icon icon)
          Sets the icon
 void setId(java.lang.String id)
          Sets the id attribute
 void setInFragmentMode()
           
 void setInit(ContainerProgram init)
          Sets the init block
 void setInitException(ServletException exn)
          Sets the init exception
 void setInitParam(InitParam initParam)
          Sets an init-param
 void setInitParam(java.lang.String param, java.lang.String value)
          Sets an init-param
 boolean setInitParameter(java.lang.String name, java.lang.String value)
           
 java.util.Set<java.lang.String> setInitParameters(java.util.Map<java.lang.String,java.lang.String> initParameters)
           
 void setJndiName(java.lang.String jndiName)
           
 void setJspFile(java.lang.String jspFile)
          Sets the JSP file
 void setLoadOnStartup(int loadOnStartup)
          Sets the load-on-startup
 void setMultipartConfig(MultipartConfigElement multipartConfig)
           
 void setProtocol(ServletProtocolConfig protocol)
          Sets the web service protocol.
 void setProtocolFactory(ProtocolServletFactory factory)
          Sets the web service protocol.
 void setRunAs(ServletConfigImpl.RunAs runAs)
          Sets the run-as
 void setRunAsRole(java.lang.String roleName)
           
 void setServlet(Servlet servlet)
           
 void setServletClass(java.lang.Class<? extends Servlet> servletClass)
           
 void setServletClass(java.lang.String servletClassName)
          Sets the servlet class.
 void setServletContext(ServletContext app)
          Sets the servlet context.
 void setServletManager(ServletManager manager)
          Sets the servlet manager.
 void setServletMapper(ServletMapper servletMapper)
           
 void setServletName(java.lang.String name)
          Sets the servlet name.
 void setServletNameDefault(java.lang.String name)
          Sets the servlet name default when not specified
 java.util.Set<java.lang.String> setServletSecurity(ServletSecurityElement securityElement)
           
 void setVar(java.lang.String var)
           
 void setWebApp(WebApp webApp)
           
 java.lang.String toString()
          Returns a printable representation of the servlet config object.
protected  void validateClass(boolean requireClass)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

log

protected static final java.util.logging.Logger log
Constructor Detail

ServletConfigImpl

public ServletConfigImpl()
Creates a new servlet configuration object.


ServletConfigImpl

public ServletConfigImpl(ServletConfigImpl.FRAGMENT_MODE fragmentMode)
Method Detail

setConfigUriLocation

public void setConfigUriLocation(java.lang.String location,
                                 int line)
Sets the config location.


setId

public void setId(java.lang.String id)
Sets the id attribute


setServletName

public void setServletName(java.lang.String name)
Sets the servlet name.


getServletName

public java.lang.String getServletName()
Gets the servlet name.

Specified by:
getServletName in interface ServletConfig

getName

public java.lang.String getName()
Specified by:
getName in interface Registration

createRegexpConfig

public ServletConfigImpl createRegexpConfig(java.lang.String servletName)
                                     throws ServletException
Throws:
ServletException

getClassName

public java.lang.String getClassName()
Specified by:
getClassName in interface Registration

setInitParameter

public boolean setInitParameter(java.lang.String name,
                                java.lang.String value)
Specified by:
setInitParameter in interface Registration

setServletSecurity

public java.util.Set<java.lang.String> setServletSecurity(ServletSecurityElement securityElement)
Specified by:
setServletSecurity in interface ServletRegistration.Dynamic

getSecurityElement

public ServletSecurityElement getSecurityElement()

createMultipartConfig

public MultipartConfigImpl createMultipartConfig()

setMultipartConfig

public void setMultipartConfig(MultipartConfigElement multipartConfig)
Specified by:
setMultipartConfig in interface ServletRegistration.Dynamic

getMultipartConfig

public MultipartConfigElement getMultipartConfig()

addMapping

public java.util.Set<java.lang.String> addMapping(java.lang.String... urlPatterns)
Maps or exists if any of the patterns in urlPatterns already map to a different servlet

Specified by:
addMapping in interface ServletRegistration
Parameters:
urlPatterns -
Returns:
a Set of patterns previously mapped to a different servlet

getMappings

public java.util.Collection<java.lang.String> getMappings()
Specified by:
getMappings in interface ServletRegistration

setInitParameters

public java.util.Set<java.lang.String> setInitParameters(java.util.Map<java.lang.String,java.lang.String> initParameters)
Specified by:
setInitParameters in interface Registration

getInitParameters

public java.util.Map<java.lang.String,java.lang.String> getInitParameters()
Specified by:
getInitParameters in interface Registration

setAsyncSupported

public void setAsyncSupported(boolean asyncSupported)
Specified by:
setAsyncSupported in interface Registration.Dynamic

isAsyncSupported

public boolean isAsyncSupported()

setServletNameDefault

public void setServletNameDefault(java.lang.String name)
Sets the servlet name default when not specified


getServletNameDefault

public java.lang.String getServletNameDefault()
Gets the servlet name default.


getServletClassName

public java.lang.String getServletClassName()
Gets the servlet name.


setBean

@Configurable
public void setBean(Bean<?> bean)
Set the bean


getBean

public Bean<?> getBean()

isServletConfig

public boolean isServletConfig()

setServletClass

@Configurable
public void setServletClass(java.lang.String servletClassName)
Sets the servlet class.


setServletClass

@DisableConfig
public void setServletClass(java.lang.Class<? extends Servlet> servletClass)

getServletClass

public java.lang.Class getServletClass()
Gets the servlet class.


calculateServletClassName

protected java.lang.String calculateServletClassName()

setServlet

public void setServlet(Servlet servlet)

setJspFile

public void setJspFile(java.lang.String jspFile)
Sets the JSP file


getJspFile

public java.lang.String getJspFile()
Gets the JSP file


setAllowEL

public void setAllowEL(boolean allowEL)
Sets the allow value.


setInitParam

public void setInitParam(java.lang.String param,
                         java.lang.String value)
Sets an init-param


createInitParam

public InitParam createInitParam()
Sets an init-param


setInitParam

public void setInitParam(InitParam initParam)
Sets an init-param


getInitParamMap

public java.util.Map getInitParamMap()
Gets the init params


getInitParameter

public java.lang.String getInitParameter(java.lang.String name)
Gets the init params

Specified by:
getInitParameter in interface Registration
Specified by:
getInitParameter in interface ServletConfig
Parameters:
name - of the parameter
Returns:
the init parameter value

getInitParameterNames

public java.util.Enumeration getInitParameterNames()
Gets the init params

Specified by:
getInitParameterNames in interface ServletConfig

setRunAs

public void setRunAs(ServletConfigImpl.RunAs runAs)
Sets the run-as


getRunAsRole

public java.lang.String getRunAsRole()
Specified by:
getRunAsRole in interface ServletRegistration

setRunAsRole

public void setRunAsRole(java.lang.String roleName)
Specified by:
setRunAsRole in interface ServletRegistration.Dynamic

getServletContext

public ServletContext getServletContext()
Returns the servlet context.

Specified by:
getServletContext in interface ServletConfig

setServletContext

public void setServletContext(ServletContext app)
Sets the servlet context.


setWebApp

public void setWebApp(WebApp webApp)

getServletManager

public ServletManager getServletManager()
Returns the servlet manager.


setServletManager

public void setServletManager(ServletManager manager)
Sets the servlet manager.


setServletMapper

public void setServletMapper(ServletMapper servletMapper)

setInit

public void setInit(ContainerProgram init)
Sets the init block


getInit

public ContainerProgram getInit()
Gets the init block


setLoadOnStartup

public void setLoadOnStartup(int loadOnStartup)
Sets the load-on-startup

Specified by:
setLoadOnStartup in interface ServletRegistration.Dynamic

getLoadOnStartup

public int getLoadOnStartup()
Gets the load-on-startup value.


createRunAt

public RunAt createRunAt()
Creates the run-at configuration.


setCron

public void setCron(CronType cron)

setJndiName

public void setJndiName(java.lang.String jndiName)

setVar

public void setVar(java.lang.String var)

getRunAt

public RunAt getRunAt()
Returns the run-at configuration.


getCron

public CronType getCron()
Returns the cron configuration.


addSecurityRoleRef

public void addSecurityRoleRef(SecurityRoleRef ref)
Adds a security role reference.


getRoleMap

public java.util.HashMap<java.lang.String,java.lang.String> getRoleMap()
Adds a security role reference.


setDisplayName

public void setDisplayName(java.lang.String displayName)
Sets the display name


getDisplayName

public java.lang.String getDisplayName()
Gets the display name


setDescription

public void setDescription(java.lang.String description)
Sets the description


setIcon

public void setIcon(Icon icon)
Sets the icon


setProtocol

public void setProtocol(ServletProtocolConfig protocol)
Sets the web service protocol.


setProtocolFactory

public void setProtocolFactory(ProtocolServletFactory factory)
Sets the web service protocol.


setInitException

public void setInitException(ServletException exn)
Sets the init exception


setInFragmentMode

public void setInFragmentMode()

isInFragmentMode

public boolean isInFragmentMode()

getServlet

public java.lang.Object getServlet()
Returns the servlet.


merge

public void merge(ServletConfigImpl config)

init

@PostConstruct
public void init()
          throws ServletException
Initialize the servlet config.

Throws:
ServletException

validateClass

protected void validateClass(boolean requireClass)
                      throws ServletException
Throws:
ServletException

checkConstructor

public void checkConstructor()
                      throws ServletException
Checks the class constructor for the public-zero arg.

Throws:
ServletException

handleAlarm

public void handleAlarm(Alarm alarm)
Handles a cron alarm callback.

Specified by:
handleAlarm in interface AlarmListener

createServletChain

public FilterChain createServletChain()
                               throws ServletException
Throws:
ServletException

close

public void close()

error

protected ConfigException error(java.lang.String msg)

error

protected ConfigException error(java.lang.String msg,
                                java.lang.Throwable e)

error

protected java.lang.RuntimeException error(java.lang.Throwable e)

copyFrom

protected void copyFrom(ServletConfigImpl source)

toString

public java.lang.String toString()
Returns a printable representation of the servlet config object.

Overrides:
toString in class java.lang.Object