Package   Class  Use  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

org.apache.maven.struts
Class Struts10WarFile

java.lang.Object
  extended by java.util.zip.ZipFile
      extended by java.util.jar.JarFile
          extended by org.apache.maven.j2ee.WarFile
              extended by org.apache.maven.struts.Struts10WarFile

public class Struts10WarFile
extends org.apache.maven.j2ee.WarFile

Encapsulates a Struts 1.0 War File. Holds functionality to access Struts specific resources and data in the war.

Version:
$Id: Struts10WarFile.java 170200 2005-05-15 06:24:19Z brett $
Author:
dion

Field Summary
static int CENATT
           
static int CENATX
           
static int CENCOM
           
static int CENCRC
           
static int CENDSK
           
static int CENEXT
           
static int CENFLG
           
static int CENHDR
           
static int CENHOW
           
static int CENLEN
           
static int CENNAM
           
static int CENOFF
           
static long CENSIG
           
static int CENSIZ
           
static int CENTIM
           
static int CENVEM
           
static int CENVER
           
static String DEFAULT_ACTIONSERVLET_NAME
          Default name of the action servlet in web.xml
static String DEFAULT_CONFIG
          Default location of Struts configuration file in the war
static int ENDCOM
           
static int ENDHDR
           
static int ENDOFF
           
static long ENDSIG
           
static int ENDSIZ
           
static int ENDSUB
           
static int ENDTOT
           
static int EXTCRC
           
static int EXTHDR
           
static int EXTLEN
           
static long EXTSIG
           
static int EXTSIZ
           
static int LOCCRC
           
static int LOCEXT
           
static int LOCFLG
           
static int LOCHDR
           
static int LOCHOW
           
static int LOCLEN
           
static int LOCNAM
           
static long LOCSIG
           
static int LOCSIZ
           
static int LOCTIM
           
static int LOCVER
           
 
Fields inherited from class org.apache.maven.j2ee.WarFile
LIB, WEB_XML
 
Fields inherited from class java.util.jar.JarFile
MANIFEST_NAME
 
Fields inherited from class java.util.zip.ZipFile
OPEN_DELETE, OPEN_READ
 
Constructor Summary
Struts10WarFile(File warFile)
          Creates a new instance of Struts10WarFile
Struts10WarFile(File warFile, boolean verify)
          Creates a new instance of Struts10WarFile
Struts10WarFile(File warFile, boolean verify, int mode)
          Creates a new instance of Struts10WarFile
Struts10WarFile(String name)
          Creates a new instance of Struts10WarFile
Struts10WarFile(String name, boolean verify)
          Creates a new instance of Struts10WarFile
 
Method Summary
 List getActions()
          retrieve the actions defined in the struts configuration file
 String getActionServletName()
          Getter for property actionServletName.
 String getActionServletPattern()
          retrieve the url pattern for the action servlet, or null if not found
 String getConfig()
          Provide the location of the Struts configuration file in the war.
 List getFormBeans()
          retrieves the form beans defined in the struts configuration file
 String getFormBeansType()
          retrieves the type attribute of the <form-beans> element if it exists, or null otherwise
 List getForwards()
          retrieve the global forwards defined in the struts configuration
 String getGlobalForwardsType()
          retrieves the type attribute of the <global-forwards> element if it exists, or null otherwise
 JarEntry getStrutsConfigEntry()
          Retrieves the Struts configuration (as specified by the config property) entry if it exists.
 void setActionServletName(String actionServletName)
          Setter for property actionServletName.
 void setConfig(String config)
          Set the location of the Struts configuration file in the war.
 
Methods inherited from class org.apache.maven.j2ee.WarFile
extract, getErrorPages, getFormLoginConfig, getJSPs, getLibEntries, getServletMappings, getServlets, getTaglibs, getWebXml, getWebXmlEntry, hasFile
 
Methods inherited from class java.util.jar.JarFile
entries, getEntry, getInputStream, getJarEntry, getManifest
 
Methods inherited from class java.util.zip.ZipFile
close, finalize, getName, size
 
Methods inherited from class java.lang.Object
clone, equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

DEFAULT_CONFIG

public static final String DEFAULT_CONFIG
Default location of Struts configuration file in the war

See Also:
Constant Field Values

DEFAULT_ACTIONSERVLET_NAME

public static final String DEFAULT_ACTIONSERVLET_NAME
Default name of the action servlet in web.xml

See Also:
Constant Field Values

LOCSIG

public static final long LOCSIG
See Also:
Constant Field Values

EXTSIG

public static final long EXTSIG
See Also:
Constant Field Values

CENSIG

public static final long CENSIG
See Also:
Constant Field Values

ENDSIG

public static final long ENDSIG
See Also:
Constant Field Values

LOCHDR

public static final int LOCHDR
See Also:
Constant Field Values

EXTHDR

public static final int EXTHDR
See Also:
Constant Field Values

CENHDR

public static final int CENHDR
See Also:
Constant Field Values

ENDHDR

public static final int ENDHDR
See Also:
Constant Field Values

LOCVER

public static final int LOCVER
See Also:
Constant Field Values

LOCFLG

public static final int LOCFLG
See Also:
Constant Field Values

LOCHOW

public static final int LOCHOW
See Also:
Constant Field Values

LOCTIM

public static final int LOCTIM
See Also:
Constant Field Values

LOCCRC

public static final int LOCCRC
See Also:
Constant Field Values

LOCSIZ

public static final int LOCSIZ
See Also:
Constant Field Values

LOCLEN

public static final int LOCLEN
See Also:
Constant Field Values

LOCNAM

public static final int LOCNAM
See Also:
Constant Field Values

LOCEXT

public static final int LOCEXT
See Also:
Constant Field Values

EXTCRC

public static final int EXTCRC
See Also:
Constant Field Values

EXTSIZ

public static final int EXTSIZ
See Also:
Constant Field Values

EXTLEN

public static final int EXTLEN
See Also:
Constant Field Values

CENVEM

public static final int CENVEM
See Also:
Constant Field Values

CENVER

public static final int CENVER
See Also:
Constant Field Values

CENFLG

public static final int CENFLG
See Also:
Constant Field Values

CENHOW

public static final int CENHOW
See Also:
Constant Field Values

CENTIM

public static final int CENTIM
See Also:
Constant Field Values

CENCRC

public static final int CENCRC
See Also:
Constant Field Values

CENSIZ

public static final int CENSIZ
See Also:
Constant Field Values

CENLEN

public static final int CENLEN
See Also:
Constant Field Values

CENNAM

public static final int CENNAM
See Also:
Constant Field Values

CENEXT

public static final int CENEXT
See Also:
Constant Field Values

CENCOM

public static final int CENCOM
See Also:
Constant Field Values

CENDSK

public static final int CENDSK
See Also:
Constant Field Values

CENATT

public static final int CENATT
See Also:
Constant Field Values

CENATX

public static final int CENATX
See Also:
Constant Field Values

CENOFF

public static final int CENOFF
See Also:
Constant Field Values

ENDSUB

public static final int ENDSUB
See Also:
Constant Field Values

ENDTOT

public static final int ENDTOT
See Also:
Constant Field Values

ENDSIZ

public static final int ENDSIZ
See Also:
Constant Field Values

ENDOFF

public static final int ENDOFF
See Also:
Constant Field Values

ENDCOM

public static final int ENDCOM
See Also:
Constant Field Values
Constructor Detail

Struts10WarFile

public Struts10WarFile(String name)
                throws IOException
Creates a new instance of Struts10WarFile

Parameters:
name - the file name of a war file containing a Struts web application
Throws:
IOException - when an I/O error occurs

Struts10WarFile

public Struts10WarFile(String name,
                       boolean verify)
                throws IOException
Creates a new instance of Struts10WarFile

Parameters:
name - the file name of a war file containing a Struts web application
verify - whether or not to verify the war file if it is signed
Throws:
IOException - when an I/O error occurs

Struts10WarFile

public Struts10WarFile(File warFile)
                throws IOException
Creates a new instance of Struts10WarFile

Parameters:
warFile - a J2EE .war file containing a Struts web application
Throws:
IOException - when an I/O error occurs

Struts10WarFile

public Struts10WarFile(File warFile,
                       boolean verify)
                throws IOException
Creates a new instance of Struts10WarFile

Parameters:
warFile - a J2EE .war file containing a Struts web application
verify - whether or not to verify the war file if it is signed
Throws:
IOException - when an I/O error occurs

Struts10WarFile

public Struts10WarFile(File warFile,
                       boolean verify,
                       int mode)
                throws IOException
Creates a new instance of Struts10WarFile

Parameters:
warFile - a J2EE .war file containing a Struts web application
verify - whether or not to verify the war file if it is signed
mode - the mode in which the file is to be opened
Throws:
IOException - when an I/O error occurs
Method Detail

getConfig

public String getConfig()
Provide the location of the Struts configuration file in the war.

Returns:
Value of property config.

setConfig

public void setConfig(String config)
Set the location of the Struts configuration file in the war.

Parameters:
config - New value of property config.

getStrutsConfigEntry

public JarEntry getStrutsConfigEntry()
Retrieves the Struts configuration (as specified by the config property) entry if it exists.

Returns:
a JarEntry for Struts config

getFormBeans

public List getFormBeans()
                  throws IOException
retrieves the form beans defined in the struts configuration file

Returns:
a collection of form beans
Throws:
IOException - when there are problems reading from the war

getActions

public List getActions()
                throws IOException
retrieve the actions defined in the struts configuration file

Returns:
a List] of {@link Action actions}
Throws:
IOException - when there are problems reading from the war

getFormBeansType

public String getFormBeansType()
                        throws IOException
retrieves the type attribute of the <form-beans> element if it exists, or null otherwise

Returns:
the form-bean type attribute
Throws:
IOException - when there are problems reading from the war

getGlobalForwardsType

public String getGlobalForwardsType()
                             throws IOException
retrieves the type attribute of the <global-forwards> element if it exists, or null otherwise

Returns:
the global-forwards type attribute
Throws:
IOException - when there are problems reading from the war

getForwards

public List getForwards()
                 throws IOException
retrieve the global forwards defined in the struts configuration

Returns:
a List of forwards
Throws:
IOException - when there are problems reading from the war

getActionServletPattern

public String getActionServletPattern()
                               throws IOException
retrieve the url pattern for the action servlet, or null if not found

Returns:
the <url-pattern> provided for the servlet named by getActionServletName()
Throws:
IOException - when there are problems reading from the war

getActionServletName

public String getActionServletName()
Getter for property actionServletName.

Returns:
Value of property actionServletName.

setActionServletName

public void setActionServletName(String actionServletName)
Setter for property actionServletName.

Parameters:
actionServletName - New value of property actionServletName.
Package   Class  Use  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD
Copyright © 2001-2006 Apache Software Foundation. All Rights Reserved.