org.seasar.portlet.util
Class PortletConfigUtil

java.lang.Object
  org.seasar.portlet.util.PortletConfigUtil

public class PortletConfigUtil
extends java.lang.Object

This class is a utility class to use PortletConfig on Seasar2 environment.

Author:

Shinsuke Sugaya

Constructor Summary

PortletConfigUtil()

Method Summary

static java.lang.String	getInitParameter(java.lang.String name) Returns a String containing the value of the named initialization parameter, or null if the parameter does not exist.
static java.util.Enumeration	getInitParameterNames() Returns the names of the portlet initialization parameters as an Enumeration of String objects, or an empty Enumeration if the portlet has no initialization parameters.
static javax.portlet.PortletConfig	getPortletConfig()
static javax.portlet.PortletContext	getPortletContext() Returns the PortletContext of the portlet application the portlet is in.
static java.lang.String	getPortletName() Returns the name of the portlet.
static java.util.ResourceBundle	getResourceBundle(java.util.Locale locale) Gets the resource bundle for the given locale based on the resource bundle defined in the deployment descriptor with resource-bundle tag or the inlined resources defined in the deployment descriptor.

Methods inherited from class java.lang.Object

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

Constructor Detail

PortletConfigUtil

public PortletConfigUtil()

Method Detail

getPortletConfig

public static javax.portlet.PortletConfig getPortletConfig()

getPortletName

public static java.lang.String getPortletName()

Returns the name of the portlet.

The name may be provided via server administration, assigned in the portlet application deployment descriptor with the portlet-name tag.

Returns:

the portlet name

getPortletContext

public static javax.portlet.PortletContext getPortletContext()

Returns the PortletContext of the portlet application the portlet is in.

Returns:

a PortletContext object, used by the caller to interact with its portlet container

See Also:

PortletContext

getResourceBundle

public static java.util.ResourceBundle getResourceBundle(java.util.Locale locale)

Gets the resource bundle for the given locale based on the resource bundle defined in the deployment descriptor with resource-bundle tag or the inlined resources defined in the deployment descriptor.

Parameters:

locale - the locale for which to retrieve the resource bundle

Returns:

the resource bundle for the given locale

getInitParameter

public static java.lang.String getInitParameter(java.lang.String name)

Returns a String containing the value of the named initialization parameter, or null if the parameter does not exist.

Parameters:

name - a String specifying the name of the initialization parameter

Returns:

a String containing the value of the initialization parameter

Throws:

java.lang.IllegalArgumentException - if name is null.

getInitParameterNames

public static java.util.Enumeration getInitParameterNames()

Returns the names of the portlet initialization parameters as an Enumeration of String objects, or an empty Enumeration if the portlet has no initialization parameters.

Returns:

an Enumeration of String objects containing the names of the portlet initialization parameters, or an empty Enumeration if the portlet has no initialization parameters.