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

public interface PortalAjaxProxyServiceHome

Returns the AjaxProxyService service in the context of a portal request. The PortalAjaxProxyService returned by this home is configured based the default portal AJAX proxy configuration.

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

NOTE: This API may only be used in the scope of an HTTP request in WebSphere Portal, i.e. within a theme. The API can not be invoked directly by a custom servlet.

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 PortalAjaxProxyServiceHome
static java.lang.String	EXTENSION_POINT_ID ID of the PortalAjaxProxyServiceHome extension point
static java.lang.String	JNDI_NAME name for the JNDI lookup
static java.lang.String	KEY_REQUEST key for the servlet 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 servlet 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 servlet context in the parameters object that is passed to the AjaxProxyServiceHome.getAjaxProxyService(java.util.Map) method

Method Summary

PortalAjaxProxyService	getAjaxProxyService(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Returns the service in the context of request and response
PortalAjaxProxyService	getAjaxProxyService(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, java.lang.String mappingPath, javax.servlet.ServletContext servletContext) Returns the service in the context for the given request, response, mapping path and servlet context.

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 PortalAjaxProxyServiceHome

See Also:

Constant Field Values

EXTENSION_POINT_ID

static final java.lang.String EXTENSION_POINT_ID

ID of the PortalAjaxProxyServiceHome extension point

See Also:

Constant Field Values

KEY_REQUEST

static final java.lang.String KEY_REQUEST

key for the servlet 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 servlet 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 servlet context in the parameters object that is passed to the AjaxProxyServiceHome.getAjaxProxyService(java.util.Map) method

Method Detail

getAjaxProxyService

PortalAjaxProxyService getAjaxProxyService(javax.servlet.http.HttpServletRequest request,
                                           javax.servlet.http.HttpServletResponse response)
                                           throws com.ibm.mashups.proxy.exceptions.AjaxProxyServiceHomeException

Returns the service in the context of request and response

Parameters:

request - the request, not null

response - the response, not null

Returns:

the proxy service for this configuration, not null

Throws:

com.ibm.mashups.proxy.exceptions.AjaxProxyServiceHomeException

getAjaxProxyService

PortalAjaxProxyService getAjaxProxyService(javax.servlet.http.HttpServletRequest request,
                                           javax.servlet.http.HttpServletResponse response,
                                           java.lang.String mappingPath,
                                           javax.servlet.ServletContext servletContext)
                                           throws com.ibm.mashups.proxy.exceptions.AjaxProxyServiceHomeException

Returns the service in the context for the given request, response, mapping path and servlet context. The mapping path identifies the set of access policies the service should use to validate whether a target URL may be accessed or not. The mapping path refers to the mapping elements declared in the AJAX proxy configuration file proxy-config.xml. It corresponds with the value of the contextpath attribute of a mapping element (e.g. "/proxy").

Parameters:

request - the request, not null

response - the response, not null

mappingPath - The mapping path starting with a slash character as declared in the AJAX proxy configuration or null.

servletContext - The servlet context or null

Returns:

the proxy service for this configuration, not null

Throws:

com.ibm.mashups.proxy.exceptions.AjaxProxyServiceHomeException