com.ibm.portal.resolver.service
Interface PortletPocService

All Superinterfaces:

Disposable, Identifiable, PocServerContextProvider, PocService, PocURIFactory, ServerContextProvider

All Known Subinterfaces:

PortletActionPocService, PortletEventPocService, PortletMimePocService, PortletRenderPocService, PortletResourcePocService

public interface PortletPocService
extends PocService, Identifiable

Portlet version of the PocService that is associated with one portlet window. The Identifiable interface represents the ID of this portlet window.

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

Since:

6.0.1

See Also:

Disposable

Nested Class Summary

static class

PortletPocService.URI_SCOPE Constants that define the scope of the portlet URI

Method Summary

java.net.URI	createPortletURI(PortletPocService.URI_SCOPE scope, java.net.URI pocURI) Constructs a URI that addresses the portlet
java.net.URI	createResourceBundleURI() Creates a URI that addresses the default resource bundle for the portlet
java.net.URI	createResourceBundleURI(java.lang.String bundleName) Creates a URI that addresses a named bundle for the portlet
java.util.Map<java.lang.String,java.lang.String[]>	decodeParameters(java.lang.String aDigest) Converts the short parameter map representation back into a map
PortletURI	decodePortletURI(java.net.URI uri) Decodes a URI object as created via createPortletURI(URI_SCOPE, URI) into a PortletURI object that contains information about the addressed entity and the original URI
java.lang.String	encodeParameters(java.util.Map<java.lang.String,java.lang.String[]> aParams) Converts a parameter map, e.g.
ObjectID	getObjectID() Returns the ObjectID of the portlet window receiving this request.

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

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

Methods inherited from interface com.ibm.portal.Disposable

dispose

Method Detail

createPortletURI

java.net.URI createPortletURI(PortletPocService.URI_SCOPE scope,
                              java.net.URI pocURI)
                              throws java.net.URISyntaxException,
                                     java.io.IOException

Constructs a URI that addresses the portlet

Parameters:

scope - scope of the URI, may be null, the default is #URI_SCOPE.PORTLET_WINDOW

pocURI - the POC URI to the actual data, not null

Returns:

the portlet URI, not null

Throws:

java.net.URISyntaxException

java.io.IOException

Since:

6.1.0.3

createResourceBundleURI

java.net.URI createResourceBundleURI()
                                     throws java.net.URISyntaxException,
                                            java.io.IOException

Creates a URI that addresses the default resource bundle for the portlet

Returns:

the bundle URI

Throws:

java.net.URISyntaxException

java.io.IOException

Since:

8.0

See Also:

ResourceBundleURI

createResourceBundleURI

java.net.URI createResourceBundleURI(java.lang.String bundleName)
                                     throws java.net.URISyntaxException,
                                            java.io.IOException

Creates a URI that addresses a named bundle for the portlet

Parameters:

bundleName - the name of the resource bundle

Returns:

the bundle URI

Throws:

java.net.URISyntaxException

java.io.IOException

Since:

8.0

See Also:

ResourceBundleURI

decodeParameters

java.util.Map<java.lang.String,java.lang.String[]> decodeParameters(java.lang.String aDigest)
                                                                    throws java.io.IOException

Converts the short parameter map representation back into a map

Parameters:

aDigest - the short representation as generated by encodeParameters(Map)

Returns:

the decoded map or null if the map could not be decoded

Throws:

java.io.IOException

Since:

8.0

See Also:

encodeParameters(Map)

decodePortletURI

PortletURI decodePortletURI(java.net.URI uri)
                            throws SerializationException,
                                   java.net.URISyntaxException,
                                   java.io.IOException

Decodes a URI object as created via createPortletURI(URI_SCOPE, URI) into a PortletURI object that contains information about the addressed entity and the original URI

Parameters:

uri - the URI to decode, not null

Returns:

the decoded URI

Throws:

SerializationException

java.net.URISyntaxException

java.io.IOException

Since:

7.0

encodeParameters

java.lang.String encodeParameters(java.util.Map<java.lang.String,java.lang.String[]> aParams)
                                  throws java.io.IOException

Converts a parameter map, e.g. a map of private render parameters, into a short representation.

Parameters:

aParams - the render parameter map to encode, not null

Returns:

the short representation of the parameters

Throws:

java.io.IOException

Since:

8.0

See Also:

decodeParameters(String)

getObjectID

ObjectID getObjectID()

Returns the ObjectID of the portlet window receiving this request.

Specified by:

getObjectID in interface Identifiable

Returns:

the ObjectID of the portlet window, this can never be null