com.ibm.portal.resolver.service
Interface PortletMimePocService

All Superinterfaces:

Disposable, Identifiable, PocServerContextProvider, PocService, PocURIFactory, PortletPocService, ServerContextProvider

All Known Subinterfaces:

PortletRenderPocService, PortletResourcePocService

public interface PortletMimePocService
extends PortletPocService

Version of the PortletPocService that can be used in a render or resource request of a JSR286 compatible portlet.

This service must be disposed after it has been retrieved via its home interface.

Since:

8.5

See Also:

Disposable

Nested Class Summary

Nested classes/interfaces inherited from interface com.ibm.portal.resolver.service.PortletPocService

PortletPocService.URI_SCOPE

Method Summary

javax.portlet.ResourceURL	createResourceURL(Addressable aAddressable) Creates a ResourceURL that references a POC URI.
javax.portlet.ResourceURL	createResourceURL(java.net.URI pocURI) Creates a ResourceURL that references a POC URI.
javax.portlet.ResourceURL	createResourceURL(java.net.URI pocURI, java.util.Map<java.lang.String,java.lang.String[]> aParams) Creates a ResourceURL that references a POC URI.
MimeContext	getContext() Returns the COR Context for the environment that matches the service environment.

Methods inherited from interface com.ibm.portal.resolver.service.PortletPocService

createPortletURI, createResourceBundleURI, createResourceBundleURI, decodeParameters, decodePortletURI, encodeParameters, getObjectID

Methods inherited from interface com.ibm.portal.resolver.service.PocService

createContext, createDigestURI, createDigestURI, createURI, createURI, createURI, createXMLReader, getContextAccessor, getLookupService, getNonce, getServerContext, getURIParser, getURLFactory, getURLFactory, resolve, serveHeaders

Methods inherited from interface com.ibm.portal.Disposable

dispose

Method Detail

createResourceURL

javax.portlet.ResourceURL createResourceURL(Addressable aAddressable)
                                            throws java.net.URISyntaxException

Creates a ResourceURL that references a POC URI. When this resource URL is actually invoked, the portlet receives a callback to the ResourceServingPortlet.serveResource(javax.portlet.ResourceRequest, javax.portlet.ResourceResponse) method. The resource requests can be server conveniently via the PortletResourcePocService.serveResource(Addressable) method.

Parameters:

aAddressable - the identification of the POC, not null

Returns:

the resource URL

Throws:

java.net.URISyntaxException

Since:

8.5

createResourceURL

javax.portlet.ResourceURL createResourceURL(java.net.URI pocURI)

Creates a ResourceURL that references a POC URI. When this resource URL is actually invoked, the portlet receives a callback to the ResourceServingPortlet.serveResource(javax.portlet.ResourceRequest, javax.portlet.ResourceResponse) method. If additional parameters are required for resource serving, use the BaseURL.setParameters(java.util.Map) method (or equivalents) to set them. The resource requests can be server conveniently via the PortletResourcePocService#serveResource(URI)) method.

Parameters:

pocURI - the URI of the POC, not null

Returns:

the resource URL

createResourceURL

javax.portlet.ResourceURL createResourceURL(java.net.URI pocURI,
                                            java.util.Map<java.lang.String,java.lang.String[]> aParams)

Creates a ResourceURL that references a POC URI. When this resource URL is actually invoked, the portlet receives a callback to the ResourceServingPortlet.serveResource(javax.portlet.ResourceRequest, javax.portlet.ResourceResponse) method. The resource requests can be server conveniently via the PortletResourcePocService.serveResource(URI, java.util.Map) method.

Parameters:

pocURI - the URI of the POC, not null

aParams - the parameter map

Returns:

the resource URL

Since:

8.5

getContext

MimeContext getContext()

Description copied from interface: PocService

Returns the COR Context for the environment that matches the service environment. This context can be used to issue custom COR lookups.

Specified by:

getContext in interface PocService

Returns:

the COR context, not null