|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface PortletResourcePocService
Version of the PortletPocService
that can be used in a resource
request of a JSR286 compatible portlet.
This service must be disposed after it has been retrieved via its home interface.
Disposable
Nested Class Summary |
---|
Nested classes/interfaces inherited from interface com.ibm.portal.resolver.service.PortletPocService |
---|
PortletPocService.URI_SCOPE |
Method Summary | |
---|---|
ResourceContext |
getContext()
Returns the COR Context for the environment that matches the
service environment. |
DataSourceHandler |
getDataSourceHandler()
Returns a handler that serializes a DataSource to the resource
response |
int |
serveResource()
Deprecated. use serveResource(URI, Map) instead |
int |
serveResource(Addressable aAddressable)
Same as calling serveResource(Addressable, Boolean) with
false as the caching parameter. |
int |
serveResource(Addressable aAddressable,
java.lang.Boolean bCached)
Same as calling serveResource(URI, Map, Boolean) . |
int |
serveResource(java.lang.Boolean bCached)
Deprecated. use serveResource(URI, Map, Boolean) instead |
int |
serveResource(java.net.URI aURI)
Same as calling serveResource(URI, Boolean) with
false as the caching parameter. |
int |
serveResource(java.net.URI aURI,
java.lang.Boolean bCached)
Same as calling serveResource(URI, Map, Boolean) with an empty
map |
int |
serveResource(java.net.URI aURI,
java.util.Map<java.lang.String,java.lang.String[]> aParams)
Same as calling serveResource(URI, Map, Boolean) with
false as the caching parameter. |
int |
serveResource(java.net.URI aURI,
java.util.Map<java.lang.String,java.lang.String[]> aParams,
java.lang.Boolean bCached)
This method is meant to be used inside the ResourceServingPortlet.serveResource(javax.portlet.ResourceRequest, ResourceResponse)
method of a portlet. |
Methods inherited from interface com.ibm.portal.resolver.service.PortletMimePocService |
---|
createResourceURL, createResourceURL, createResourceURL |
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 |
---|
ResourceContext getContext()
PocService
Context
for the environment that matches the
service environment. This context can be used to issue custom COR
lookups.
getContext
in interface PocService
getContext
in interface PortletMimePocService
null
DataSourceHandler getDataSourceHandler()
DataSource
to the resource
response
null
@Deprecated int serveResource() throws javax.portlet.PortletException, java.io.IOException
serveResource(URI, Map)
instead
Implements the
ResourceServingPortlet.serveResource(javax.portlet.ResourceRequest, javax.portlet.ResourceResponse)
method for a request that contains the POC URI as the resourceID.
Portlets would implement the method and dispatch to the
serveResource()
method
Compatible ResourceURL
s can be generates using the
PortletMimePocService.createResourceURL(java.net.URI)
method.
javax.portlet.PortletException
java.io.IOException
int serveResource(Addressable aAddressable) throws javax.portlet.PortletException, java.io.IOException, java.net.URISyntaxException
serveResource(Addressable, Boolean)
with
false
as the caching parameter.
aAddressable
- the object that identifies the resource, must not be
null
javax.portlet.PortletException
java.io.IOException
java.net.URISyntaxException
int serveResource(Addressable aAddressable, java.lang.Boolean bCached) throws javax.portlet.PortletException, java.io.IOException, java.net.URISyntaxException
serveResource(URI, Map, Boolean)
.
aAddressable
- the object that identifies the resource, must not be
null
bCached
- if true
the method uses a cache to lookup the POC
URI. If false
the method does not use a cache,
which is the same as calling the method without a parameter.
The value null
refers to the system default
javax.portlet.PortletException
java.io.IOException
java.net.URISyntaxException
@Deprecated int serveResource(java.lang.Boolean bCached) throws javax.portlet.PortletException, java.io.IOException
serveResource(URI, Map, Boolean)
instead
Implements the
ResourceServingPortlet.serveResource(javax.portlet.ResourceRequest, javax.portlet.ResourceResponse)
method for a request that contains the POC URI as the resourceID.
Portlets would implement the method and dispatch to the
serveResource()
method
Compatible ResourceURL
s can be generates using the
PortletMimePocService.createResourceURL(java.net.URI)
method.
bCached
- if true
the method uses a cache to lookup the POC
URI. If false
the method does not use a cache,
which is the same as calling the method without a parameter.
The value null
refers to the system default
javax.portlet.PortletException
java.io.IOException
int serveResource(java.net.URI aURI) throws javax.portlet.PortletException, java.io.IOException
serveResource(URI, Boolean)
with
false
as the caching parameter.
aURI
- the URI identifier to the resource, must not be
null
javax.portlet.PortletException
java.io.IOException
int serveResource(java.net.URI aURI, java.lang.Boolean bCached) throws javax.portlet.PortletException, java.io.IOException
serveResource(URI, Map, Boolean)
with an empty
map
aURI
- the URI identifier to the resource, must not be
null
bCached
- if true
the method uses a cache to lookup the POC
URI. If false
the method does not use a cache,
which is the same as calling the method without a parameter.
The value null
refers to the system default
javax.portlet.PortletException
java.io.IOException
int serveResource(java.net.URI aURI, java.util.Map<java.lang.String,java.lang.String[]> aParams) throws javax.portlet.PortletException, java.io.IOException
serveResource(URI, Map, Boolean)
with
false
as the caching parameter.
aURI
- the URI identifier to the resource, must not be
null
aParams
- the parameter map, must not be null
javax.portlet.PortletException
java.io.IOException
int serveResource(java.net.URI aURI, java.util.Map<java.lang.String,java.lang.String[]> aParams, java.lang.Boolean bCached) throws javax.portlet.PortletException, java.io.IOException
This method is meant to be used inside the
ResourceServingPortlet.serveResource(javax.portlet.ResourceRequest, ResourceResponse)
method of a portlet. If the HTTP request is a GET
request,
then the DataSource
identified via URI
and parameters
will be serialized onto the ResourceResponse
.
If the method is used for a PUT
or POST
or
DELETE
request, then the matching DataSink
will be
invoked and the result will be serialized onto the
ResourceResponse
.
Compatible ResourceURL
s can be generates using the
PortletMimePocService.createResourceURL(java.net.URI)
method.
aURI
- the URI identifier to the resource, must not be
null
aParams
- the parameter map, must not be null
bCached
- if true
the method uses a cache to lookup the POC
URI. If false
the method does not use a cache,
which is the same as calling the method without a parameter.
The value null
refers to the system default
javax.portlet.PortletException
java.io.IOException
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |