Package com.sun.enterprise.web.pwc

Class PwcWebModule

    • Constructor Detail

      • PwcWebModule

        public PwcWebModule()

    • Method Detail

      • getID

        public String getID()
        Gets this web module's identifier.
        Returns:
        Web module identifier

      • setID

        public void setID​(String id)
        Sets this web module's identifier.
        Parameters:
        id - Web module identifier

      • getSessionCookieConfig

        public jakarta.servlet.SessionCookieConfig getSessionCookieConfig()
        Gets the session tracking cookie configuration of this ServletContext.
        Specified by:
        getSessionCookieConfig in interface Context
        Specified by:
        getSessionCookieConfig in interface jakarta.servlet.ServletContext
        Overrides:
        getSessionCookieConfig in class StandardContext
        Returns:
        the session tracking cookie configuration of this ServletContext.

      • getSessionCookieConfigFromSunWebXml

        public SessionCookieConfig getSessionCookieConfigFromSunWebXml()
        Return the session cookie configuration for this web module.

      • setSessionCookieConfigFromSunWebXml

        public void setSessionCookieConfigFromSunWebXml​(SessionCookieConfig cookieConfig)
        Set the session cookie configuration for this web module.
        Parameters:
        cookieConfig - The new session cookie configuration

      • getFormHintField

        public String getFormHintField()
        return parameter-encoding form-hint-field attribute value

      • getDefaultCharset

        public String getDefaultCharset()
        Gets the value of the default-charset attribute of the parameter-encoding element
        Returns:
        Value of the default-charset attribute of the parameter-encoding element, or null if not present

      • setResponseCTForHeaders

        public void setResponseCTForHeaders()
        sets _useResponseCTForHeaders property value. When _useResponseCTForHeaders is set to true, it means that we send the response header in the same encoding of the response charset instead of UTF-8, (see the method sendHeaders in com.sun.enterprise.web.connector.nsapi.nsapiNSAPIResponse)

      • setEncodeCookies

        public void setEncodeCookies​(boolean flag)
        Determines whether cookies should be encoded or not. If the property encodeCookies is set to false in sun-web.xml, cookies will not be URL encoded. The default behaviuor is that we always encode the cookies unless the property encodeCookies is set to false in sun-web.xml.

      • getResponseCTForHeaders

        public boolean getResponseCTForHeaders()
        return _useResponseCTForHeaders property value

      • getEncodeCookies

        public boolean getEncodeCookies()
        return _encodeCookies property value

      • getSTMPoolSize

        public int getSTMPoolSize()
        Return maximum number of instances that will be allocated when a single thread model servlet is used in this web module.

      • setSTMPoolSize

        public void setSTMPoolSize​(int newPoolSize)
        Set the maximum number of instances that will be allocated when a single thread model servlet is used in this web module.
        Parameters:
        newPoolSize - New value of SingleThreadModel servlet pool size

      • createWrapper

        public Wrapper createWrapper()
        Factory method to create and return a new Wrapper instance, of the Java implementation class appropriate for this Context implementation. The constructor of the instantiated Wrapper will have been called, but no properties will have been set.
        Specified by:
        createWrapper in interface Context
        Overrides:
        createWrapper in class StandardContext

      • getHasWebServices

        public boolean getHasWebServices()
        Return the hasWebServices flag for this web module.

      • setHasWebServices

        public void setHasWebServices​(boolean hasWebServices)
        Set the hasWebServices boolean flag for this web module.
        Parameters:
        hasWebServices - boolean flag hasWebServices for this web module

      • getEndpointAddresses

        public String[] getEndpointAddresses()
        Gets the URL addresses corresponding to the web services endpoints of this web module.
        Returns:
        Array of URL addresses corresponding to the web services endpoints of this web module

      • setEndpointAddresses

        public void setEndpointAddresses​(String[] endpointAddresses)
        Sets the URL addresses corresponding to the web services endpoints of this web module.
        Parameters:
        endpointAddresses - Array of URL addresses corresponding to the web services endpoints of this web module

      • getContextRoot

        public String getContextRoot()
        Gets this web module's context root.
        Returns:
        Web module context root

      • setContextRoot

        public void setContextRoot​(String contextRoot)
        Sets this web module's context root.
        Parameters:
        contextRoot - Web module context root

      • setHasWebXml

        public void setHasWebXml​(boolean hasWebXml)

      • hasWebXml

        public boolean hasWebXml()

      • setModuleName

        public void setModuleName​(String moduleName)
        Sets this web module's name.
        Parameters:
        moduleName - Web module name

      • getModuleName

        public String getModuleName()
        Gets this web module's name.
        Returns:
        Web module name

      • setCacheControls

        public void setCacheControls​(String[] cacheControls)
        Sets the Cache-Control configuration for this web module.
        Parameters:
        cacheControls - Cache-Control configuration settings for this web module

      • getCacheControls

        public String[] getCacheControls()
        Gets the Cache-Control settings of this web module.
        Returns:
        Cache-Control settings of this web module, or null if no such settings exist for this web module.

      • hasLocaleToCharsetMapping

        public abstract boolean hasLocaleToCharsetMapping()
        Returns true if this web module specifies a locale-charset-map in its sun-web.xml, false otherwise.
        Returns:
        true if this web module specifies a locale-charset-map in its sun-web.xml, false otherwise

      • mapLocalesToCharset

        public abstract String mapLocalesToCharset​(Enumeration locales)
        Matches the given request locales against the charsets specified in the locale-charset-map of this web module's sun-web.xml, and returns the first matching charset.
        Parameters:
        locales - Request locales
        Returns:
        First matching charset, or null if this web module does not specify any locale-charset-map in its sun-web.xml, or no match was found