org.apache.struts.config

Class ControllerConfig

Implemented Interfaces:
Serializable

public class ControllerConfig
extends java.lang.Object
implements Serializable

A JavaBean representing the configuration information of a <controller> element in a Struts configuration file.
Version:
$Rev: 54929 $ $Date: 2004-10-16 17:38:42 +0100 (Sat, 16 Oct 2004) $
Since:
Struts 1.1

Field Summary

protected int
bufferSize
The input buffer size for file uploads.
protected boolean
configured
Has this component been completely configured?
protected String
contentType
The content type and character encoding to be set on each response.
protected String
forwardPattern
The replacement pattern used to determine a context-relative URL from a ForwardConfig element.
protected boolean
inputForward
Should the input property of ActionConfig instances associated with this module be treated as the name of a corresponding ForwardConfig.
protected boolean
locale
Should we store a Locale object in the user's session if needed?
protected String
maxFileSize
The maximum file size to process for file uploads.
protected String
memFileSize
The maximum file size to retain in memory.
protected String
multipartClass
The fully qualified Java class name of the MultipartRequestHandler class to be used.
protected boolean
nocache
Should we set no-cache HTTP headers on each response?
protected String
pagePattern
The replacement pattern used to determine a context-relative URL from the page attribute of Struts tags and configuration properties.
protected String
processorClass
The fully qualified class name of the RequestProcessor implementation class to be used for this module.
protected String
tempDir
The temporary working directory to use for file uploads.

Method Summary

void
freeze()
Freeze the configuration of this component.
int
getBufferSize()
String
getContentType()
String
getForwardPattern()
boolean
getInputForward()
boolean
getLocale()
String
getMaxFileSize()
String
getMemFileSize()
String
getMultipartClass()
boolean
getNocache()
String
getPagePattern()
String
getProcessorClass()
String
getTempDir()
void
setBufferSize(int bufferSize)
void
setContentType(String contentType)
void
setForwardPattern(String forwardPattern)
void
setInputForward(boolean inputForward)
void
setLocale(boolean locale)
void
setMaxFileSize(String maxFileSize)
void
setMemFileSize(String memFileSize)
void
setMultipartClass(String multipartClass)
void
setNocache(boolean nocache)
void
setPagePattern(String pagePattern)
void
setProcessorClass(String processorClass)
void
setTempDir(String tempDir)
String
toString()
Return a String representation of this object.

Field Details

bufferSize

protected int bufferSize
The input buffer size for file uploads.

configured

protected boolean configured
Has this component been completely configured?

contentType

protected String contentType
The content type and character encoding to be set on each response.

forwardPattern

protected String forwardPattern
The replacement pattern used to determine a context-relative URL from a ForwardConfig element. The pattern may consist of any combination of the following markers and characters:
  • $M - Replaced by the module prefix for the current module.
  • $P - Replaced by the path property of a ForwardConfig instance.
  • $$ - Renders a literal dollar sign ("$") character in the resulting URL.
  • A dollar sign followed by any other character is reserved for future use, and both characters are silently swallowed.
  • All other characters in the pattern are passed through unchanged.

If this property is set to null, a default pattern of $M$P is utilized, which is backwards compatible with the hard coded functionality in prior versions.


inputForward

protected boolean inputForward
Should the input property of ActionConfig instances associated with this module be treated as the name of a corresponding ForwardConfig. A false value treats them as a module-relative path (consistent with the hard coded behavior of earlier versions of Struts.
Since:
Struts 1.1

locale

protected boolean locale
Should we store a Locale object in the user's session if needed?

maxFileSize

protected String maxFileSize
The maximum file size to process for file uploads.

memFileSize

protected String memFileSize
The maximum file size to retain in memory.

multipartClass

protected String multipartClass
The fully qualified Java class name of the MultipartRequestHandler class to be used.

nocache

protected boolean nocache
Should we set no-cache HTTP headers on each response?

pagePattern

protected String pagePattern
The replacement pattern used to determine a context-relative URL from the page attribute of Struts tags and configuration properties. The pattern may consist of any combination of the following markers and characters:
  • $M - Replaced by the module prefix for the current module.
  • $P - Replaced by the page attribute value being evaluated.
  • $$ - Renders a literal dollar sign ("$") character in the resulting URL.
  • A dollar sign followed by any other character is reserved for future use, and both characters are silently swallowed.
  • All other characters in the pattern are passed through unchanged.

If this property is set to null, a default pattern of $M$P is utilized, which is backwards compatible with the hard coded functionality in prior versions.


processorClass

protected String processorClass
The fully qualified class name of the RequestProcessor implementation class to be used for this module.

tempDir

protected String tempDir
The temporary working directory to use for file uploads.

Method Details

freeze

public void freeze()
Freeze the configuration of this component.

getBufferSize

public int getBufferSize()

getContentType

public String getContentType()

getForwardPattern

public String getForwardPattern()

getInputForward

public boolean getInputForward()

getLocale

public boolean getLocale()

getMaxFileSize

public String getMaxFileSize()

getMemFileSize

public String getMemFileSize()

getMultipartClass

public String getMultipartClass()

getNocache

public boolean getNocache()

getPagePattern

public String getPagePattern()

getProcessorClass

public String getProcessorClass()

getTempDir

public String getTempDir()

setBufferSize

public void setBufferSize(int bufferSize)

setContentType

public void setContentType(String contentType)

setForwardPattern

public void setForwardPattern(String forwardPattern)

setInputForward

public void setInputForward(boolean inputForward)

setLocale

public void setLocale(boolean locale)

setMaxFileSize

public void setMaxFileSize(String maxFileSize)

setMemFileSize

public void setMemFileSize(String memFileSize)

setMultipartClass

public void setMultipartClass(String multipartClass)

setNocache

public void setNocache(boolean nocache)

setPagePattern

public void setPagePattern(String pagePattern)

setProcessorClass

public void setProcessorClass(String processorClass)

setTempDir

public void setTempDir(String tempDir)

toString

public String toString()
Return a String representation of this object.

Copyright B) 2000-2007 - The Apache Software Foundation