com.ibm.portal.resolver.proxy.service
Interface PortletAjaxProxyServiceHome

public interface PortletAjaxProxyServiceHome

Home interface for the AJAX proxy for use in the scope of a JSR168 or JSR286. The PortletAjaxProxyService returned by this home is configured based on a proxy configuration that is packaged with the portlet WAR file. If no such configuration exists, the default portal configuration will be used.

Instances of the home interface can be accessed via the Eclipse lookup mechanisms.

Since:

6.1.5

Field Summary

static java.lang.String	ATTR_CLASS name of the class attribute used for instantiation
static java.lang.String	DEFAULT_EXTENSION_ID ID of the default implementation of the PortletAjaxProxyServiceHome
static java.lang.String	EXTENSION_POINT_ID ID of the PortletAjaxProxyServiceHome extension point
static java.lang.String	JNDI_NAME name for the JNDI lookup
static java.lang.String	KEY_REQUEST key for the portlet request in the parameters object that is passed to the AjaxProxyServiceHome.getAjaxProxyService(java.util.Map) method
static java.lang.String	KEY_RESPONSE key for the portlet response in the parameters object that is passed to the AjaxProxyServiceHome.getAjaxProxyService(java.util.Map) method
static java.lang.String	KEY_SERVLET_CONTEXT key for the ServletContext in the parameters object that is passed to the AjaxProxyServiceHome.getAjaxProxyService(java.util.Map) method

Method Summary

PortletAjaxProxyService

getAjaxProxyService(javax.portlet.PortletRequest aRequest, javax.portlet.PortletResponse aResponse) Returns the AjaxProxyService for use in a portlet request.

Field Detail

JNDI_NAME

static final java.lang.String JNDI_NAME

name for the JNDI lookup

See Also:

Constant Field Values

ATTR_CLASS

static final java.lang.String ATTR_CLASS

name of the class attribute used for instantiation

See Also:

Constant Field Values

DEFAULT_EXTENSION_ID

static final java.lang.String DEFAULT_EXTENSION_ID

ID of the default implementation of the PortletAjaxProxyServiceHome

See Also:

Constant Field Values

EXTENSION_POINT_ID

static final java.lang.String EXTENSION_POINT_ID

ID of the PortletAjaxProxyServiceHome extension point

See Also:

Constant Field Values

KEY_REQUEST

static final java.lang.String KEY_REQUEST

key for the portlet request in the parameters object that is passed to the AjaxProxyServiceHome.getAjaxProxyService(java.util.Map) method

KEY_RESPONSE

static final java.lang.String KEY_RESPONSE

key for the portlet response in the parameters object that is passed to the AjaxProxyServiceHome.getAjaxProxyService(java.util.Map) method

KEY_SERVLET_CONTEXT

static final java.lang.String KEY_SERVLET_CONTEXT

key for the ServletContext in the parameters object that is passed to the AjaxProxyServiceHome.getAjaxProxyService(java.util.Map) method

Method Detail

getAjaxProxyService

PortletAjaxProxyService getAjaxProxyService(javax.portlet.PortletRequest aRequest,
                                            javax.portlet.PortletResponse aResponse)
                                            throws com.ibm.mashups.proxy.exceptions.AjaxProxyServiceHomeException

Returns the AjaxProxyService for use in a portlet request.

Parameters:

aRequest - the portlet request, not null

aResponse - the portlet response, not null

Returns:

the proxy service, not null

Throws:

com.ibm.mashups.proxy.exceptions.AjaxProxyServiceHomeException